From b9a471a7a81858ccbe69354763d5f6bee6feae48 Mon Sep 17 00:00:00 2001 From: anakin87 <44616784+anakin87@users.noreply.github.com> Date: Mon, 13 Jul 2026 11:15:13 +0000 Subject: [PATCH] Sync Haystack API reference on Docusaurus --- .../reference/haystack-api/generators_api.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs-website/reference/haystack-api/generators_api.md b/docs-website/reference/haystack-api/generators_api.md index 0692611cdb8..a083fd24a28 100644 --- a/docs-website/reference/haystack-api/generators_api.md +++ b/docs-website/reference/haystack-api/generators_api.md @@ -1323,8 +1323,21 @@ in the OpenAI client. - `summary`: The summary of the reasoning. - `effort`: The level of effort to put into the reasoning. Can be `low`, `medium` or `high`. - `generate_summary`: Whether to generate a summary of the reasoning. + - `mode`: The reasoning mode. Can be `standard`, or `pro`. Supported since GPT-5.6. Note: OpenAI does not return the reasoning tokens, but we can view summary if its enabled. For details, see the [OpenAI Reasoning documentation](https://platform.openai.com/docs/guides/reasoning). +- `include`: Specify additional output data to include in the model response. Supported values are: + - web_search_call.action.sources: Include the sources of the web search tool call. + - code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool + call items. + - computer_call_output.output.image_url: Include image urls from the computer call output. + - file_search_call.results: Include the search results of the file search tool call. + - message.input_image.image_url: Include image urls from the input message. + - message.output_text.logprobs: Include logprobs with assistant messages. + - reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item + outputs. This enables reasoning items to be used in multi-turn conversations when using the + Responses API statelessly (like when the store parameter is set to false, or when an organization + is enrolled in the zero data retention program). - **timeout** (float | None) – Timeout for OpenAI client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment variable, or 30 seconds. - **max_retries** (int | None) – Maximum number of retries to contact OpenAI after an internal error.