The Basics of the Agents SDK

[jhall-openai]

Summary

Providing simple examples and a walkthrough of the recently released Agents SDK. This example walks through a simple golf application that also takes advantage of our Hosted Tools - File Search, and Web Search.

Motivation

New examples for the Agent SDK and use of hosted tools

---

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.

[MW-OAI]

Name in diagram don't align with agent names in description below it

[MW-OAI]

Data Prep takes 45min to run, around 1k rows to process. This might be a bit long for anyone to wait while looking into the cookbook

Error ValueError: Expected a non-empty value for vector_store_id but received None
The CB doesn't set or create the vector store, and you need to manually add the key to a store for it to work

[MW-OAI]

The upload_cache.json files exist in your example, because of this they are blocking the file upload. Blocking a new filestore to be used. It also leads to error missmatch on missing files due to not having the right IDs being generated

deleting all caches allows to upload the files into the vector store - takes 8min

[MW-OAI]

Ran into this issue twice, which has to do with the history being persistent

Where if I run the prompt without any history it works