You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The content in a response in the Responses API can be an array of different outputs and types (with a type parameter):
"content": [
{
"type": "output_text",
"text": "In a peaceful grove beneath a silver moon...",
"annotations": []
}
Responses vs Chat Completion API notes:
instructions is a parameter that essentially replaces the system/developer role messages. When using this parameter with previous_response_id, the Responses API will not carry forward the system/developer messages meaning that we can replace the agent's system message at each turn (which we need to!)
Use an input parameter (instead of messages) that supports an array of different type objects. This includes the ability to put in a PDF file (which will use their vision model to). Uses their Files API.
The input parameter can still take a set of messages as we do with the Chat Completion API.
Simpler way of getting the outputs (no longer have to use choices[0] and they also have an output_text attribute)
Responses can contain an array of different types (as noted above)
Ability to only send the latest message and use a previous_response_id
Reasoning summary available in the output. Including the ability to set the reasoning model effort
Can force the model to always call at least one tool (tool_choice = required) - could be very useful to ensure that certain agents always call a tool.
For structured outputs you can now get the Pydantic model directly from the response (response.output[0].content[0].parsed)
Considerations:
Could have an OpenAI Web Search tool that uses this Responses API's web_search tool (or could add as an option to an existing search tool)
@davorrunje, @sonichi - the Responses API has some useful features and could be used to make some tools and agents (noted in description). See full description of issue with differences.
Is your feature request related to a problem? Please describe.
OpenAI has released their responses API.
previous_response_id
functions
parameter (deprecated)store: true
reasoning
parameter witheffort
msg_...
)For the tools:
Output:
content
in a response in the Responses API can be an array of different outputs and types (with atype
parameter):Responses vs Chat Completion API notes:
instructions
is a parameter that essentially replaces the system/developer role messages. When using this parameter withprevious_response_id
, the Responses API will not carry forward the system/developer messages meaning that we can replace the agent's system message at each turn (which we need to!)input
parameter (instead ofmessages
) that supports an array of different type objects. This includes the ability to put in a PDF file (which will use their vision model to). Uses their Files API.input
parameter can still take a set of messages as we do with the Chat Completion API.choices[0]
and they also have anoutput_text
attribute)previous_response_id
effort
required
) - could be very useful to ensure that certain agents always call a tool.response.output[0].content[0].parsed
)Considerations:
The text was updated successfully, but these errors were encountered: