|
4 | 4 | "cell_type": "markdown",
|
5 | 5 | "metadata": {},
|
6 | 6 | "source": [
|
7 |
| - "## What is the Responses API\n", |
| 7 | + "## What is the Responses API?\n", |
8 | 8 | "\n",
|
9 |
| - "The Responses API is a new API that focuses on greater simplicity and greater expressivity when using our APIs. It is designed for multiple tools, multiple turns, and multiple modalities — as opposed to current APIs, which either have these features bolted onto an API designed primarily for text in and out (chat completions) or need a lot bootstrapping to perform simple actions (assistants api).\n", |
| 9 | + "The Responses API is a new way to interact with OpenAI models, designed to be simpler and more flexible than previous APIs. It makes it easy to build advanced AI applications that use multiple tools, handle multi-turn conversations, and work with different types of data (not just text).\n", |
10 | 10 | "\n",
|
11 |
| - "Here I will show you a couple of new features that the Responses API has to offer and tie it all together at the end.\n", |
12 |
| - "`responses` solves for a number of user painpoints with our current set of APIs. During our time with the completions API, we found that folks wanted:\n", |
| 11 | + "Unlike older APIs—such as Chat Completions, which were built mainly for text, or the Assistants API, which can require a lot of setup—the Responses API is built from the ground up for:\n", |
13 | 12 | "\n",
|
14 |
| - "- the ability to easily perform multi-turn model interactions in a single API call\n", |
15 |
| - "- to have access to our hosted tools (file_search, web_search, code_interpreter)\n", |
16 |
| - "- granular control over the context sent to the model\n", |
| 13 | + "- Seamless multi-turn interactions (carry on a conversation across several steps in a single API call)\n", |
| 14 | + "- Easy access to powerful hosted tools (like file search, web search, and code interpreter)\n", |
| 15 | + "- Fine-grained control over the context you send to the model\n", |
17 | 16 | "\n",
|
18 |
| - "As models start to develop longer running reasoning and thinking capabilities, users will want an async-friendly and stateful primitive. Response solves for this. \n" |
| 17 | + "As AI models become more capable of complex, long-running reasoning, developers need an API that is both asynchronous and stateful. The Responses API is designed to meet these needs.\n", |
| 18 | + "\n", |
| 19 | + "In this guide, you'll see some of the new features the Responses API offers, along with practical examples to help you get started." |
19 | 20 | ]
|
20 | 21 | },
|
21 | 22 | {
|
|
181 | 182 | "\n",
|
182 | 183 | "Another benefit of the Responses API is that it adds support for hosted tools like `file_search` and `web_search`. Instead of manually calling the tools, simply pass in the tools and the API will decide which tool to use and use it.\n",
|
183 | 184 | "\n",
|
184 |
| - "Here is an example of using the `web_search` tool to incorporate web search results into the response. You may already be familiar with how ChatGPT can search the web. You can now build similar experiences too! The web search tool uses the OpenAI Index, the one that powers the web search in ChatGPT, having being optimized for chat applications.\n" |
| 185 | + "Here is an example of using the `web_search` tool to incorporate web search results into the response." |
185 | 186 | ]
|
186 | 187 | },
|
187 | 188 | {
|
|
0 commit comments