Skip to content

Commit 12afaca

Browse files
docs: sync Haystack API reference on Docusaurus (#11984)
Co-authored-by: anakin87 <44616784+anakin87@users.noreply.github.com>
1 parent a17ac98 commit 12afaca

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

docs-website/reference/haystack-api/generators_api.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1323,8 +1323,21 @@ in the OpenAI client.
13231323
- `summary`: The summary of the reasoning.
13241324
- `effort`: The level of effort to put into the reasoning. Can be `low`, `medium` or `high`.
13251325
- `generate_summary`: Whether to generate a summary of the reasoning.
1326+
- `mode`: The reasoning mode. Can be `standard`, or `pro`. Supported since GPT-5.6.
13261327
Note: OpenAI does not return the reasoning tokens, but we can view summary if its enabled.
13271328
For details, see the [OpenAI Reasoning documentation](https://platform.openai.com/docs/guides/reasoning).
1329+
- `include`: Specify additional output data to include in the model response. Supported values are:
1330+
- web_search_call.action.sources: Include the sources of the web search tool call.
1331+
- code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool
1332+
call items.
1333+
- computer_call_output.output.image_url: Include image urls from the computer call output.
1334+
- file_search_call.results: Include the search results of the file search tool call.
1335+
- message.input_image.image_url: Include image urls from the input message.
1336+
- message.output_text.logprobs: Include logprobs with assistant messages.
1337+
- reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item
1338+
outputs. This enables reasoning items to be used in multi-turn conversations when using the
1339+
Responses API statelessly (like when the store parameter is set to false, or when an organization
1340+
is enrolled in the zero data retention program).
13281341
- **timeout** (<code>float | None</code>) – Timeout for OpenAI client calls. If not set, it defaults to either the
13291342
`OPENAI_TIMEOUT` environment variable, or 30 seconds.
13301343
- **max_retries** (<code>int | None</code>) – Maximum number of retries to contact OpenAI after an internal error.

0 commit comments

Comments
 (0)