Skip to content

Conversation

@Soumya123Mishra
Copy link

Summary

Briefly describe the changes and the goal of this PR. Make sure the PR title summarizes the changes effectively.

Motivation

Why are these changes necessary? How do they improve the cookbook?


For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • I have conducted a self-review of my content based on the contribution guidelines:
    • Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • Correctness: The information I include is correct and all of my code executes successfully.
    • Completeness: I have explained everything fully, including all necessary references and citations.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@@ -0,0 +1,100 @@
<!DOCTYPE html>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P0 Badge Relocate and rename the new example file

The new content is added at the repository root with a space-containing filename and no extension, which violates the repo guideline to place runnable examples under examples/<topic>/ with lowercase dash/underscore names; this makes the example hard to discover and inconsistent with the cookbook’s structure, so it should be moved into an appropriate examples/<topic>/ folder with a descriptive .html (or .md) filename.

Useful? React with 👍 / 👎.

@@ -0,0 +1,100 @@
<!DOCTYPE html>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P0 Badge Add registry metadata for the new content

This commit introduces a new piece of content but does not add a corresponding entry in registry.yaml, which is required for new content to appear on cookbook.openai.com per the repo guidelines; please register the new example with a path, date, and tags so it is included in the site build.

Useful? React with 👍 / 👎.

</div>

<script>
const apiKey = "YOUR_API_KEY";

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P0 Badge Avoid hard-coding API keys in the example

The example hard-codes apiKey as a string literal, which encourages users to paste real secrets directly into source files; the repo guidelines require documenting required environment variables instead of embedding keys, so this should be switched to a documented configuration mechanism (or clearly gated placeholder) to avoid accidental key exposure.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant