File tree Expand file tree Collapse file tree 4 files changed +24
-0
lines changed
version-2.17/integrations-api
version-2.18/integrations-api
version-2.19/integrations-api
reference/integrations-api Expand file tree Collapse file tree 4 files changed +24
-0
lines changed Original file line number Diff line number Diff line change @@ -86,6 +86,12 @@ Some of the supported parameters:
8686 events as they become available, with the stream terminated by a data: [ DONE] message.
8787- ` safe_prompt ` : Whether to inject a safety prompt before all conversations.
8888- ` random_seed ` : The seed to use for random sampling.
89+ - ` response_format ` : A JSON schema or a Pydantic model that enforces the structure of the model's response.
90+ If provided, the output will always be validated against this
91+ format (unless the model returns a tool call).
92+ For details, see the [ OpenAI Structured Outputs documentation] ( https://platform.openai.com/docs/guides/structured-outputs ) .
93+ For structured outputs with streaming, the ` response_format ` must be a JSON
94+ schema and not a Pydantic model.
8995- ` tools ` : A list of Tool and/or Toolset objects, or a single Toolset for which the model can prepare calls.
9096Each tool should have a unique name.
9197
Original file line number Diff line number Diff line change @@ -86,6 +86,12 @@ Some of the supported parameters:
8686 events as they become available, with the stream terminated by a data: [ DONE] message.
8787- ` safe_prompt ` : Whether to inject a safety prompt before all conversations.
8888- ` random_seed ` : The seed to use for random sampling.
89+ - ` response_format ` : A JSON schema or a Pydantic model that enforces the structure of the model's response.
90+ If provided, the output will always be validated against this
91+ format (unless the model returns a tool call).
92+ For details, see the [ OpenAI Structured Outputs documentation] ( https://platform.openai.com/docs/guides/structured-outputs ) .
93+ For structured outputs with streaming, the ` response_format ` must be a JSON
94+ schema and not a Pydantic model.
8995- ` tools ` : A list of Tool and/or Toolset objects, or a single Toolset for which the model can prepare calls.
9096Each tool should have a unique name.
9197
Original file line number Diff line number Diff line change @@ -86,6 +86,12 @@ Some of the supported parameters:
8686 events as they become available, with the stream terminated by a data: [ DONE] message.
8787- ` safe_prompt ` : Whether to inject a safety prompt before all conversations.
8888- ` random_seed ` : The seed to use for random sampling.
89+ - ` response_format ` : A JSON schema or a Pydantic model that enforces the structure of the model's response.
90+ If provided, the output will always be validated against this
91+ format (unless the model returns a tool call).
92+ For details, see the [ OpenAI Structured Outputs documentation] ( https://platform.openai.com/docs/guides/structured-outputs ) .
93+ For structured outputs with streaming, the ` response_format ` must be a JSON
94+ schema and not a Pydantic model.
8995- ` tools ` : A list of Tool and/or Toolset objects, or a single Toolset for which the model can prepare calls.
9096Each tool should have a unique name.
9197
Original file line number Diff line number Diff line change @@ -86,6 +86,12 @@ Some of the supported parameters:
8686 events as they become available, with the stream terminated by a data: [ DONE] message.
8787- ` safe_prompt ` : Whether to inject a safety prompt before all conversations.
8888- ` random_seed ` : The seed to use for random sampling.
89+ - ` response_format ` : A JSON schema or a Pydantic model that enforces the structure of the model's response.
90+ If provided, the output will always be validated against this
91+ format (unless the model returns a tool call).
92+ For details, see the [ OpenAI Structured Outputs documentation] ( https://platform.openai.com/docs/guides/structured-outputs ) .
93+ For structured outputs with streaming, the ` response_format ` must be a JSON
94+ schema and not a Pydantic model.
8995- ` tools ` : A list of Tool and/or Toolset objects, or a single Toolset for which the model can prepare calls.
9096Each tool should have a unique name.
9197
You can’t perform that action at this time.
0 commit comments