docs: add page for OpenAI Responses API model provider#590
docs: add page for OpenAI Responses API model provider#590notgitika wants to merge 1 commit intostrands-agents:mainfrom
Conversation
notgitika
requested a deployment
to
manual-approval
GitHub Actions
Waiting
notgitika
requested a deployment
to
manual-approval
GitHub Actions
Waiting
mkmeral
left a comment
mkmeral
left a comment
There was a problem hiding this comment.
You also need to merge from live, there are some conflicts
|
|
||
| The [OpenAI Responses API](https://platform.openai.com/docs/api-reference/responses/create) is OpenAI's latest API for interacting with their models. The Strands Agents SDK provides a dedicated `OpenAIResponsesModel` provider that uses this API, supporting streaming, tool calling, and structured output. | ||
|
|
||
| !!! note "Looking for the Chat Completions API?" |
There was a problem hiding this comment.
As a customer, how do I choose between the two? Which one is recommended/deprecated?
Assume someone who wants to develop agent with some openai model. which one should they choose?
There was a problem hiding this comment.
For the python sdk, I think the obvious path should be the chat api, since thats what the expectation is today. Moving forward to typescript, we might want to flip that to be responses by default. Power users should be able to investigate this and switch between the two api's though
mkmeral
left a comment
mkmeral
left a comment
There was a problem hiding this comment.
This doc doesn't actually work, you need to explicitly force latest version of openai after installing Strands
1. pip install 'strands-agents[openai]' → gets openai 1.109.1
2. from strands.models.openai_responses... → 💥 ImportError
3. pip install -U openai → gets openai 2.28.0 (silently violates constraint)
4. Try again → ✅ works
3 participants
Description
Adds a new documentation page for the OpenAI Responses API model provider (OpenAIResponsesModel), covering installation, usage, configuration, structured output, and reasoning model support.
Also updates the existing OpenAI page title to "OpenAI (Chat Completions)" with a cross-reference note to the new Responses API page.
Unrelated note: I ran
npm run format:checkand it seems like there are a couple files that are not formatted correctly. This PR doesn't include those filesRelated Issues
Closes https://github.com/strands-agents/private-sdk-python-staging/issues/253
Type of Change
New content
Checklist
mkdocs serveBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.