llama-stack-client 0.2.16 → 0.2.17

package/resources/responses/responses.d.ts

@@ -23,20 +23,65 @@ export declare class Responses extends APIResource {
     list(query?: ResponseListParams, options?: Core.RequestOptions): Core.APIPromise<ResponseListResponse>;
     list(options?: Core.RequestOptions): Core.APIPromise<ResponseListResponse>;
 }
+/**
+ * Complete OpenAI response object containing generation results and metadata.
+ */
 export interface ResponseObject {
+    /**
+     * Unique identifier for this response
+     */
     id: string;
+    /**
+     * Unix timestamp when the response was created
+     */
     created_at: number;
+    /**
+     * Model identifier used for generation
+     */
     model: string;
+    /**
+     * Object type identifier, always "response"
+     */
     object: 'response';
+    /**
+     * List of generated output items (messages, tool calls, etc.)
+     */
     output: Array<ResponseObject.OpenAIResponseMessage | ResponseObject.OpenAIResponseOutputMessageWebSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFileSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFunctionToolCall | ResponseObject.OpenAIResponseOutputMessageMcpCall | ResponseObject.OpenAIResponseOutputMessageMcpListTools>;
+    /**
+     * Whether tool calls can be executed in parallel
+     */
     parallel_tool_calls: boolean;
+    /**
+     * Current status of the response generation
+     */
     status: string;
+    /**
+     * Text formatting configuration for the response
+     */
     text: ResponseObject.Text;
+    /**
+     * (Optional) Error details if the response generation failed
+     */
     error?: ResponseObject.Error;
+    /**
+     * (Optional) ID of the previous response in a conversation
+     */
     previous_response_id?: string;
+    /**
+     * (Optional) Sampling temperature used for generation
+     */
     temperature?: number;
+    /**
+     * (Optional) Nucleus sampling parameter used for generation
+     */
     top_p?: number;
+    /**
+     * (Optional) Truncation strategy applied to the response
+     */
     truncation?: string;
+    /**
+     * (Optional) User identifier associated with the request
+     */
     user?: string;
 }
 export declare namespace ResponseObject {
@@ -53,13 +98,34 @@ export declare namespace ResponseObject {
         status?: string;
     }
     namespace OpenAIResponseMessage {
+        /**
+         * Text content for input messages in OpenAI response format.
+         */
         interface OpenAIResponseInputMessageContentText {
+            /**
+             * The text content of the input message
+             */
             text: string;
+            /**
+             * Content type identifier, always "input_text"
+             */
             type: 'input_text';
         }
+        /**
+         * Image content for input messages in OpenAI response format.
+         */
         interface OpenAIResponseInputMessageContentImage {
+            /**
+             * Level of detail for image processing, can be "low", "high", or "auto"
+             */
             detail: 'low' | 'high' | 'auto';
+            /**
+             * Content type identifier, always "input_image"
+             */
             type: 'input_image';
+            /**
+             * (Optional) URL of the image content
+             */
             image_url?: string;
         }
         interface UnionMember2 {
@@ -68,17 +134,50 @@ export declare namespace ResponseObject {
             type: 'output_text';
         }
         namespace UnionMember2 {
+            /**
+             * File citation annotation for referencing specific files in response content.
+             */
             interface OpenAIResponseAnnotationFileCitation {
+                /**
+                 * Unique identifier of the referenced file
+                 */
                 file_id: string;
+                /**
+                 * Name of the referenced file
+                 */
                 filename: string;
+                /**
+                 * Position index of the citation within the content
+                 */
                 index: number;
+                /**
+                 * Annotation type identifier, always "file_citation"
+                 */
                 type: 'file_citation';
             }
+            /**
+             * URL citation annotation for referencing external web resources.
+             */
             interface OpenAIResponseAnnotationCitation {
+                /**
+                 * End position of the citation span in the content
+                 */
                 end_index: number;
+                /**
+                 * Start position of the citation span in the content
+                 */
                 start_index: number;
+                /**
+                 * Title of the referenced web resource
+                 */
                 title: string;
+                /**
+                 * Annotation type identifier, always "url_citation"
+                 */
                 type: 'url_citation';
+                /**
+                 * URL of the referenced web resource
+                 */
                 url: string;
             }
             interface OpenAIResponseAnnotationContainerFileCitation {
@@ -96,61 +195,166 @@ export declare namespace ResponseObject {
             }
         }
     }
+    /**
+     * Web search tool call output message for OpenAI responses.
+     */
     interface OpenAIResponseOutputMessageWebSearchToolCall {
+        /**
+         * Unique identifier for this tool call
+         */
         id: string;
+        /**
+         * Current status of the web search operation
+         */
         status: string;
+        /**
+         * Tool call type identifier, always "web_search_call"
+         */
         type: 'web_search_call';
     }
+    /**
+     * File search tool call output message for OpenAI responses.
+     */
     interface OpenAIResponseOutputMessageFileSearchToolCall {
+        /**
+         * Unique identifier for this tool call
+         */
         id: string;
+        /**
+         * List of search queries executed
+         */
         queries: Array<string>;
+        /**
+         * Current status of the file search operation
+         */
         status: string;
+        /**
+         * Tool call type identifier, always "file_search_call"
+         */
         type: 'file_search_call';
+        /**
+         * (Optional) Search results returned by the file search operation
+         */
         results?: Array<{
             [key: string]: boolean | number | string | Array<unknown> | unknown | null;
         }>;
     }
+    /**
+     * Function tool call output message for OpenAI responses.
+     */
     interface OpenAIResponseOutputMessageFunctionToolCall {
+        /**
+         * JSON string containing the function arguments
+         */
         arguments: string;
+        /**
+         * Unique identifier for the function call
+         */
         call_id: string;
+        /**
+         * Name of the function being called
+         */
         name: string;
+        /**
+         * Tool call type identifier, always "function_call"
+         */
         type: 'function_call';
+        /**
+         * (Optional) Additional identifier for the tool call
+         */
         id?: string;
+        /**
+         * (Optional) Current status of the function call execution
+         */
         status?: string;
     }
+    /**
+     * Model Context Protocol (MCP) call output message for OpenAI responses.
+     */
     interface OpenAIResponseOutputMessageMcpCall {
+        /**
+         * Unique identifier for this MCP call
+         */
         id: string;
+        /**
+         * JSON string containing the MCP call arguments
+         */
         arguments: string;
+        /**
+         * Name of the MCP method being called
+         */
         name: string;
+        /**
+         * Label identifying the MCP server handling the call
+         */
         server_label: string;
+        /**
+         * Tool call type identifier, always "mcp_call"
+         */
         type: 'mcp_call';
+        /**
+         * (Optional) Error message if the MCP call failed
+         */
         error?: string;
+        /**
+         * (Optional) Output result from the successful MCP call
+         */
         output?: string;
     }
+    /**
+     * MCP list tools output message containing available tools from an MCP server.
+     */
     interface OpenAIResponseOutputMessageMcpListTools {
+        /**
+         * Unique identifier for this MCP list tools operation
+         */
         id: string;
+        /**
+         * Label identifying the MCP server providing the tools
+         */
         server_label: string;
+        /**
+         * List of available tools provided by the MCP server
+         */
         tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
+        /**
+         * Tool call type identifier, always "mcp_list_tools"
+         */
         type: 'mcp_list_tools';
     }
     namespace OpenAIResponseOutputMessageMcpListTools {
+        /**
+         * Tool definition returned by MCP list tools operation.
+         */
         interface Tool {
+            /**
+             * JSON schema defining the tool's input parameters
+             */
             input_schema: {
                 [key: string]: boolean | number | string | Array<unknown> | unknown | null;
             };
+            /**
+             * Name of the tool
+             */
             name: string;
+            /**
+             * (Optional) Description of what the tool does
+             */
             description?: string;
         }
     }
+    /**
+     * Text formatting configuration for the response
+     */
     interface Text {
         /**
-         * Configuration for Responses API text format.
+         * (Optional) Text format configuration specifying output format requirements
          */
         format?: Text.Format;
     }
     namespace Text {
         /**
-         * Configuration for Responses API text format.
+         * (Optional) Text format configuration specifying output format requirements
          */
         interface Format {
             /**
@@ -179,27 +383,61 @@ export declare namespace ResponseObject {
             strict?: boolean;
         }
     }
+    /**
+     * (Optional) Error details if the response generation failed
+     */
     interface Error {
+        /**
+         * Error code identifying the type of failure
+         */
         code: string;
+        /**
+         * Human-readable error message describing the failure
+         */
         message: string;
     }
 }
+/**
+ * Streaming event indicating a new response has been created.
+ */
 export type ResponseObjectStream = ResponseObjectStream.OpenAIResponseObjectStreamResponseCreated | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputItemAdded | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputItemDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputTextDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseOutputTextDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseWebSearchCallInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseWebSearchCallSearching | ResponseObjectStream.OpenAIResponseObjectStreamResponseWebSearchCallCompleted | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpListToolsInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpListToolsFailed | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpListToolsCompleted | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallArgumentsDone | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallInProgress | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallFailed | ResponseObjectStream.OpenAIResponseObjectStreamResponseMcpCallCompleted | ResponseObjectStream.OpenAIResponseObjectStreamResponseCompleted;
 export declare namespace ResponseObjectStream {
+    /**
+     * Streaming event indicating a new response has been created.
+     */
     interface OpenAIResponseObjectStreamResponseCreated {
+        /**
+         * The newly created response object
+         */
         response: ResponsesAPI.ResponseObject;
+        /**
+         * Event type identifier, always "response.created"
+         */
         type: 'response.created';
     }
+    /**
+     * Streaming event for when a new output item is added to the response.
+     */
     interface OpenAIResponseObjectStreamResponseOutputItemAdded {
         /**
-         * Corresponds to the various Message types in the Responses API. They are all
-         * under one type because the Responses API gives them all the same "type" value,
-         * and there is no way to tell them apart in certain scenarios.
+         * The output item that was added (message, tool call, etc.)
          */
         item: OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseMessage | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageWebSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageFileSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageFunctionToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpListTools;
+        /**
+         * Index position of this item in the output list
+         */
         output_index: number;
+        /**
+         * Unique identifier of the response containing this output
+         */
         response_id: string;
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Event type identifier, always "response.output_item.added"
+         */
         type: 'response.output_item.added';
     }
     namespace OpenAIResponseObjectStreamResponseOutputItemAdded {
@@ -216,13 +454,34 @@ export declare namespace ResponseObjectStream {
             status?: string;
         }
         namespace OpenAIResponseMessage {
+            /**
+             * Text content for input messages in OpenAI response format.
+             */
             interface OpenAIResponseInputMessageContentText {
+                /**
+                 * The text content of the input message
+                 */
                 text: string;
+                /**
+                 * Content type identifier, always "input_text"
+                 */
                 type: 'input_text';
             }
+            /**
+             * Image content for input messages in OpenAI response format.
+             */
             interface OpenAIResponseInputMessageContentImage {
+                /**
+                 * Level of detail for image processing, can be "low", "high", or "auto"
+                 */
                 detail: 'low' | 'high' | 'auto';
+                /**
+                 * Content type identifier, always "input_image"
+                 */
                 type: 'input_image';
+                /**
+                 * (Optional) URL of the image content
+                 */
                 image_url?: string;
             }
             interface UnionMember2 {
@@ -231,17 +490,50 @@ export declare namespace ResponseObjectStream {
                 type: 'output_text';
             }
             namespace UnionMember2 {
+                /**
+                 * File citation annotation for referencing specific files in response content.
+                 */
                 interface OpenAIResponseAnnotationFileCitation {
+                    /**
+                     * Unique identifier of the referenced file
+                     */
                     file_id: string;
+                    /**
+                     * Name of the referenced file
+                     */
                     filename: string;
+                    /**
+                     * Position index of the citation within the content
+                     */
                     index: number;
+                    /**
+                     * Annotation type identifier, always "file_citation"
+                     */
                     type: 'file_citation';
                 }
+                /**
+                 * URL citation annotation for referencing external web resources.
+                 */
                 interface OpenAIResponseAnnotationCitation {
+                    /**
+                     * End position of the citation span in the content
+                     */
                     end_index: number;
+                    /**
+                     * Start position of the citation span in the content
+                     */
                     start_index: number;
+                    /**
+                     * Title of the referenced web resource
+                     */
                     title: string;
+                    /**
+                     * Annotation type identifier, always "url_citation"
+                     */
                     type: 'url_citation';
+                    /**
+                     * URL of the referenced web resource
+                     */
                     url: string;
                 }
                 interface OpenAIResponseAnnotationContainerFileCitation {
@@ -259,63 +551,178 @@ export declare namespace ResponseObjectStream {
                 }
             }
         }
+        /**
+         * Web search tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageWebSearchToolCall {
+            /**
+             * Unique identifier for this tool call
+             */
             id: string;
+            /**
+             * Current status of the web search operation
+             */
             status: string;
+            /**
+             * Tool call type identifier, always "web_search_call"
+             */
             type: 'web_search_call';
         }
+        /**
+         * File search tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageFileSearchToolCall {
+            /**
+             * Unique identifier for this tool call
+             */
             id: string;
+            /**
+             * List of search queries executed
+             */
             queries: Array<string>;
+            /**
+             * Current status of the file search operation
+             */
             status: string;
+            /**
+             * Tool call type identifier, always "file_search_call"
+             */
             type: 'file_search_call';
+            /**
+             * (Optional) Search results returned by the file search operation
+             */
             results?: Array<{
                 [key: string]: boolean | number | string | Array<unknown> | unknown | null;
             }>;
         }
+        /**
+         * Function tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageFunctionToolCall {
+            /**
+             * JSON string containing the function arguments
+             */
             arguments: string;
+            /**
+             * Unique identifier for the function call
+             */
             call_id: string;
+            /**
+             * Name of the function being called
+             */
             name: string;
+            /**
+             * Tool call type identifier, always "function_call"
+             */
             type: 'function_call';
+            /**
+             * (Optional) Additional identifier for the tool call
+             */
             id?: string;
+            /**
+             * (Optional) Current status of the function call execution
+             */
             status?: string;
         }
+        /**
+         * Model Context Protocol (MCP) call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageMcpCall {
+            /**
+             * Unique identifier for this MCP call
+             */
             id: string;
+            /**
+             * JSON string containing the MCP call arguments
+             */
             arguments: string;
+            /**
+             * Name of the MCP method being called
+             */
             name: string;
+            /**
+             * Label identifying the MCP server handling the call
+             */
             server_label: string;
+            /**
+             * Tool call type identifier, always "mcp_call"
+             */
             type: 'mcp_call';
+            /**
+             * (Optional) Error message if the MCP call failed
+             */
             error?: string;
+            /**
+             * (Optional) Output result from the successful MCP call
+             */
             output?: string;
         }
+        /**
+         * MCP list tools output message containing available tools from an MCP server.
+         */
         interface OpenAIResponseOutputMessageMcpListTools {
+            /**
+             * Unique identifier for this MCP list tools operation
+             */
             id: string;
+            /**
+             * Label identifying the MCP server providing the tools
+             */
             server_label: string;
+            /**
+             * List of available tools provided by the MCP server
+             */
             tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
+            /**
+             * Tool call type identifier, always "mcp_list_tools"
+             */
             type: 'mcp_list_tools';
         }
         namespace OpenAIResponseOutputMessageMcpListTools {
+            /**
+             * Tool definition returned by MCP list tools operation.
+             */
             interface Tool {
+                /**
+                 * JSON schema defining the tool's input parameters
+                 */
                 input_schema: {
                     [key: string]: boolean | number | string | Array<unknown> | unknown | null;
                 };
+                /**
+                 * Name of the tool
+                 */
                 name: string;
+                /**
+                 * (Optional) Description of what the tool does
+                 */
                 description?: string;
             }
         }
     }
+    /**
+     * Streaming event for when an output item is completed.
+     */
     interface OpenAIResponseObjectStreamResponseOutputItemDone {
         /**
-         * Corresponds to the various Message types in the Responses API. They are all
-         * under one type because the Responses API gives them all the same "type" value,
-         * and there is no way to tell them apart in certain scenarios.
+         * The completed output item (message, tool call, etc.)
          */
         item: OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseMessage | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageWebSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageFileSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageFunctionToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpListTools;
+        /**
+         * Index position of this item in the output list
+         */
         output_index: number;
+        /**
+         * Unique identifier of the response containing this output
+         */
         response_id: string;
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Event type identifier, always "response.output_item.done"
+         */
         type: 'response.output_item.done';
     }
     namespace OpenAIResponseObjectStreamResponseOutputItemDone {
@@ -332,13 +739,34 @@ export declare namespace ResponseObjectStream {
             status?: string;
         }
         namespace OpenAIResponseMessage {
+            /**
+             * Text content for input messages in OpenAI response format.
+             */
             interface OpenAIResponseInputMessageContentText {
+                /**
+                 * The text content of the input message
+                 */
                 text: string;
+                /**
+                 * Content type identifier, always "input_text"
+                 */
                 type: 'input_text';
             }
+            /**
+             * Image content for input messages in OpenAI response format.
+             */
             interface OpenAIResponseInputMessageContentImage {
+                /**
+                 * Level of detail for image processing, can be "low", "high", or "auto"
+                 */
                 detail: 'low' | 'high' | 'auto';
+                /**
+                 * Content type identifier, always "input_image"
+                 */
                 type: 'input_image';
+                /**
+                 * (Optional) URL of the image content
+                 */
                 image_url?: string;
             }
             interface UnionMember2 {
@@ -347,17 +775,50 @@ export declare namespace ResponseObjectStream {
                 type: 'output_text';
             }
             namespace UnionMember2 {
+                /**
+                 * File citation annotation for referencing specific files in response content.
+                 */
                 interface OpenAIResponseAnnotationFileCitation {
+                    /**
+                     * Unique identifier of the referenced file
+                     */
                     file_id: string;
+                    /**
+                     * Name of the referenced file
+                     */
                     filename: string;
+                    /**
+                     * Position index of the citation within the content
+                     */
                     index: number;
+                    /**
+                     * Annotation type identifier, always "file_citation"
+                     */
                     type: 'file_citation';
                 }
+                /**
+                 * URL citation annotation for referencing external web resources.
+                 */
                 interface OpenAIResponseAnnotationCitation {
+                    /**
+                     * End position of the citation span in the content
+                     */
                     end_index: number;
+                    /**
+                     * Start position of the citation span in the content
+                     */
                     start_index: number;
+                    /**
+                     * Title of the referenced web resource
+                     */
                     title: string;
+                    /**
+                     * Annotation type identifier, always "url_citation"
+                     */
                     type: 'url_citation';
+                    /**
+                     * URL of the referenced web resource
+                     */
                     url: string;
                 }
                 interface OpenAIResponseAnnotationContainerFileCitation {
@@ -375,87 +836,282 @@ export declare namespace ResponseObjectStream {
                 }
             }
         }
+        /**
+         * Web search tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageWebSearchToolCall {
+            /**
+             * Unique identifier for this tool call
+             */
             id: string;
+            /**
+             * Current status of the web search operation
+             */
             status: string;
+            /**
+             * Tool call type identifier, always "web_search_call"
+             */
             type: 'web_search_call';
         }
+        /**
+         * File search tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageFileSearchToolCall {
+            /**
+             * Unique identifier for this tool call
+             */
             id: string;
+            /**
+             * List of search queries executed
+             */
             queries: Array<string>;
+            /**
+             * Current status of the file search operation
+             */
             status: string;
+            /**
+             * Tool call type identifier, always "file_search_call"
+             */
             type: 'file_search_call';
+            /**
+             * (Optional) Search results returned by the file search operation
+             */
             results?: Array<{
                 [key: string]: boolean | number | string | Array<unknown> | unknown | null;
             }>;
         }
+        /**
+         * Function tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageFunctionToolCall {
+            /**
+             * JSON string containing the function arguments
+             */
             arguments: string;
+            /**
+             * Unique identifier for the function call
+             */
             call_id: string;
+            /**
+             * Name of the function being called
+             */
             name: string;
+            /**
+             * Tool call type identifier, always "function_call"
+             */
             type: 'function_call';
+            /**
+             * (Optional) Additional identifier for the tool call
+             */
             id?: string;
+            /**
+             * (Optional) Current status of the function call execution
+             */
             status?: string;
         }
+        /**
+         * Model Context Protocol (MCP) call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageMcpCall {
+            /**
+             * Unique identifier for this MCP call
+             */
             id: string;
+            /**
+             * JSON string containing the MCP call arguments
+             */
             arguments: string;
+            /**
+             * Name of the MCP method being called
+             */
             name: string;
+            /**
+             * Label identifying the MCP server handling the call
+             */
             server_label: string;
+            /**
+             * Tool call type identifier, always "mcp_call"
+             */
             type: 'mcp_call';
+            /**
+             * (Optional) Error message if the MCP call failed
+             */
             error?: string;
+            /**
+             * (Optional) Output result from the successful MCP call
+             */
             output?: string;
         }
+        /**
+         * MCP list tools output message containing available tools from an MCP server.
+         */
         interface OpenAIResponseOutputMessageMcpListTools {
+            /**
+             * Unique identifier for this MCP list tools operation
+             */
             id: string;
+            /**
+             * Label identifying the MCP server providing the tools
+             */
             server_label: string;
+            /**
+             * List of available tools provided by the MCP server
+             */
             tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
+            /**
+             * Tool call type identifier, always "mcp_list_tools"
+             */
             type: 'mcp_list_tools';
         }
         namespace OpenAIResponseOutputMessageMcpListTools {
+            /**
+             * Tool definition returned by MCP list tools operation.
+             */
             interface Tool {
+                /**
+                 * JSON schema defining the tool's input parameters
+                 */
                 input_schema: {
                     [key: string]: boolean | number | string | Array<unknown> | unknown | null;
                 };
+                /**
+                 * Name of the tool
+                 */
                 name: string;
+                /**
+                 * (Optional) Description of what the tool does
+                 */
                 description?: string;
             }
         }
     }
+    /**
+     * Streaming event for incremental text content updates.
+     */
     interface OpenAIResponseObjectStreamResponseOutputTextDelta {
+        /**
+         * Index position within the text content
+         */
         content_index: number;
+        /**
+         * Incremental text content being added
+         */
         delta: string;
+        /**
+         * Unique identifier of the output item being updated
+         */
         item_id: string;
+        /**
+         * Index position of the item in the output list
+         */
         output_index: number;
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Event type identifier, always "response.output_text.delta"
+         */
         type: 'response.output_text.delta';
     }
+    /**
+     * Streaming event for when text output is completed.
+     */
     interface OpenAIResponseObjectStreamResponseOutputTextDone {
+        /**
+         * Index position within the text content
+         */
         content_index: number;
+        /**
+         * Unique identifier of the completed output item
+         */
         item_id: string;
+        /**
+         * Index position of the item in the output list
+         */
         output_index: number;
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Final complete text content of the output item
+         */
         text: string;
+        /**
+         * Event type identifier, always "response.output_text.done"
+         */
         type: 'response.output_text.done';
     }
+    /**
+     * Streaming event for incremental function call argument updates.
+     */
     interface OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta {
+        /**
+         * Incremental function call arguments being added
+         */
         delta: string;
+        /**
+         * Unique identifier of the function call being updated
+         */
         item_id: string;
+        /**
+         * Index position of the item in the output list
+         */
         output_index: number;
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Event type identifier, always "response.function_call_arguments.delta"
+         */
         type: 'response.function_call_arguments.delta';
     }
+    /**
+     * Streaming event for when function call arguments are completed.
+     */
     interface OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone {
+        /**
+         * Final complete arguments JSON string for the function call
+         */
         arguments: string;
+        /**
+         * Unique identifier of the completed function call
+         */
         item_id: string;
+        /**
+         * Index position of the item in the output list
+         */
         output_index: number;
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Event type identifier, always "response.function_call_arguments.done"
+         */
         type: 'response.function_call_arguments.done';
     }
+    /**
+     * Streaming event for web search calls in progress.
+     */
     interface OpenAIResponseObjectStreamResponseWebSearchCallInProgress {
+        /**
+         * Unique identifier of the web search call
+         */
         item_id: string;
+        /**
+         * Index position of the item in the output list
+         */
         output_index: number;
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Event type identifier, always "response.web_search_call.in_progress"
+         */
         type: 'response.web_search_call.in_progress';
     }
     interface OpenAIResponseObjectStreamResponseWebSearchCallSearching {
@@ -464,10 +1120,25 @@ export declare namespace ResponseObjectStream {
         sequence_number: number;
         type: 'response.web_search_call.searching';
     }
+    /**
+     * Streaming event for completed web search calls.
+     */
     interface OpenAIResponseObjectStreamResponseWebSearchCallCompleted {
+        /**
+         * Unique identifier of the completed web search call
+         */
         item_id: string;
+        /**
+         * Index position of the item in the output list
+         */
         output_index: number;
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Event type identifier, always "response.web_search_call.completed"
+         */
         type: 'response.web_search_call.completed';
     }
     interface OpenAIResponseObjectStreamResponseMcpListToolsInProgress {
@@ -496,71 +1167,230 @@ export declare namespace ResponseObjectStream {
         sequence_number: number;
         type: 'response.mcp_call.arguments.done';
     }
+    /**
+     * Streaming event for MCP calls in progress.
+     */
     interface OpenAIResponseObjectStreamResponseMcpCallInProgress {
+        /**
+         * Unique identifier of the MCP call
+         */
         item_id: string;
+        /**
+         * Index position of the item in the output list
+         */
         output_index: number;
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Event type identifier, always "response.mcp_call.in_progress"
+         */
         type: 'response.mcp_call.in_progress';
     }
+    /**
+     * Streaming event for failed MCP calls.
+     */
     interface OpenAIResponseObjectStreamResponseMcpCallFailed {
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Event type identifier, always "response.mcp_call.failed"
+         */
         type: 'response.mcp_call.failed';
     }
+    /**
+     * Streaming event for completed MCP calls.
+     */
     interface OpenAIResponseObjectStreamResponseMcpCallCompleted {
+        /**
+         * Sequential number for ordering streaming events
+         */
         sequence_number: number;
+        /**
+         * Event type identifier, always "response.mcp_call.completed"
+         */
         type: 'response.mcp_call.completed';
     }
+    /**
+     * Streaming event indicating a response has been completed.
+     */
     interface OpenAIResponseObjectStreamResponseCompleted {
+        /**
+         * The completed response object
+         */
         response: ResponsesAPI.ResponseObject;
+        /**
+         * Event type identifier, always "response.completed"
+         */
         type: 'response.completed';
     }
 }
+/**
+ * Paginated list of OpenAI response objects with navigation metadata.
+ */
 export interface ResponseListResponse {
+    /**
+     * List of response objects with their input context
+     */
     data: Array<ResponseListResponse.Data>;
+    /**
+     * Identifier of the first item in this page
+     */
     first_id: string;
+    /**
+     * Whether there are more results available beyond this page
+     */
     has_more: boolean;
+    /**
+     * Identifier of the last item in this page
+     */
     last_id: string;
+    /**
+     * Object type identifier, always "list"
+     */
     object: 'list';
 }
 export declare namespace ResponseListResponse {
+    /**
+     * OpenAI response object extended with input context information.
+     */
     interface Data {
+        /**
+         * Unique identifier for this response
+         */
         id: string;
+        /**
+         * Unix timestamp when the response was created
+         */
         created_at: number;
+        /**
+         * List of input items that led to this response
+         */
         input: Array<Data.OpenAIResponseOutputMessageWebSearchToolCall | Data.OpenAIResponseOutputMessageFileSearchToolCall | Data.OpenAIResponseOutputMessageFunctionToolCall | Data.OpenAIResponseInputFunctionToolCallOutput | Data.OpenAIResponseMessage>;
+        /**
+         * Model identifier used for generation
+         */
         model: string;
+        /**
+         * Object type identifier, always "response"
+         */
         object: 'response';
+        /**
+         * List of generated output items (messages, tool calls, etc.)
+         */
         output: Array<Data.OpenAIResponseMessage | Data.OpenAIResponseOutputMessageWebSearchToolCall | Data.OpenAIResponseOutputMessageFileSearchToolCall | Data.OpenAIResponseOutputMessageFunctionToolCall | Data.OpenAIResponseOutputMessageMcpCall | Data.OpenAIResponseOutputMessageMcpListTools>;
+        /**
+         * Whether tool calls can be executed in parallel
+         */
         parallel_tool_calls: boolean;
+        /**
+         * Current status of the response generation
+         */
         status: string;
+        /**
+         * Text formatting configuration for the response
+         */
         text: Data.Text;
+        /**
+         * (Optional) Error details if the response generation failed
+         */
         error?: Data.Error;
+        /**
+         * (Optional) ID of the previous response in a conversation
+         */
         previous_response_id?: string;
+        /**
+         * (Optional) Sampling temperature used for generation
+         */
         temperature?: number;
+        /**
+         * (Optional) Nucleus sampling parameter used for generation
+         */
         top_p?: number;
+        /**
+         * (Optional) Truncation strategy applied to the response
+         */
         truncation?: string;
+        /**
+         * (Optional) User identifier associated with the request
+         */
         user?: string;
     }
     namespace Data {
+        /**
+         * Web search tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageWebSearchToolCall {
+            /**
+             * Unique identifier for this tool call
+             */
             id: string;
+            /**
+             * Current status of the web search operation
+             */
             status: string;
+            /**
+             * Tool call type identifier, always "web_search_call"
+             */
             type: 'web_search_call';
         }
+        /**
+         * File search tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageFileSearchToolCall {
+            /**
+             * Unique identifier for this tool call
+             */
             id: string;
+            /**
+             * List of search queries executed
+             */
             queries: Array<string>;
+            /**
+             * Current status of the file search operation
+             */
             status: string;
+            /**
+             * Tool call type identifier, always "file_search_call"
+             */
             type: 'file_search_call';
+            /**
+             * (Optional) Search results returned by the file search operation
+             */
             results?: Array<{
                 [key: string]: boolean | number | string | Array<unknown> | unknown | null;
             }>;
         }
+        /**
+         * Function tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageFunctionToolCall {
+            /**
+             * JSON string containing the function arguments
+             */
             arguments: string;
+            /**
+             * Unique identifier for the function call
+             */
             call_id: string;
+            /**
+             * Name of the function being called
+             */
             name: string;
+            /**
+             * Tool call type identifier, always "function_call"
+             */
             type: 'function_call';
+            /**
+             * (Optional) Additional identifier for the tool call
+             */
             id?: string;
+            /**
+             * (Optional) Current status of the function call execution
+             */
             status?: string;
         }
         /**
@@ -587,13 +1417,34 @@ export declare namespace ResponseListResponse {
             status?: string;
         }
         namespace OpenAIResponseMessage {
+            /**
+             * Text content for input messages in OpenAI response format.
+             */
             interface OpenAIResponseInputMessageContentText {
+                /**
+                 * The text content of the input message
+                 */
                 text: string;
+                /**
+                 * Content type identifier, always "input_text"
+                 */
                 type: 'input_text';
             }
+            /**
+             * Image content for input messages in OpenAI response format.
+             */
             interface OpenAIResponseInputMessageContentImage {
+                /**
+                 * Level of detail for image processing, can be "low", "high", or "auto"
+                 */
                 detail: 'low' | 'high' | 'auto';
+                /**
+                 * Content type identifier, always "input_image"
+                 */
                 type: 'input_image';
+                /**
+                 * (Optional) URL of the image content
+                 */
                 image_url?: string;
             }
             interface UnionMember2 {
@@ -602,17 +1453,50 @@ export declare namespace ResponseListResponse {
                 type: 'output_text';
             }
             namespace UnionMember2 {
+                /**
+                 * File citation annotation for referencing specific files in response content.
+                 */
                 interface OpenAIResponseAnnotationFileCitation {
+                    /**
+                     * Unique identifier of the referenced file
+                     */
                     file_id: string;
+                    /**
+                     * Name of the referenced file
+                     */
                     filename: string;
+                    /**
+                     * Position index of the citation within the content
+                     */
                     index: number;
+                    /**
+                     * Annotation type identifier, always "file_citation"
+                     */
                     type: 'file_citation';
                 }
+                /**
+                 * URL citation annotation for referencing external web resources.
+                 */
                 interface OpenAIResponseAnnotationCitation {
+                    /**
+                     * End position of the citation span in the content
+                     */
                     end_index: number;
+                    /**
+                     * Start position of the citation span in the content
+                     */
                     start_index: number;
+                    /**
+                     * Title of the referenced web resource
+                     */
                     title: string;
+                    /**
+                     * Annotation type identifier, always "url_citation"
+                     */
                     type: 'url_citation';
+                    /**
+                     * URL of the referenced web resource
+                     */
                     url: string;
                 }
                 interface OpenAIResponseAnnotationContainerFileCitation {
@@ -643,13 +1527,34 @@ export declare namespace ResponseListResponse {
             status?: string;
         }
         namespace OpenAIResponseMessage {
+            /**
+             * Text content for input messages in OpenAI response format.
+             */
             interface OpenAIResponseInputMessageContentText {
+                /**
+                 * The text content of the input message
+                 */
                 text: string;
+                /**
+                 * Content type identifier, always "input_text"
+                 */
                 type: 'input_text';
             }
+            /**
+             * Image content for input messages in OpenAI response format.
+             */
             interface OpenAIResponseInputMessageContentImage {
+                /**
+                 * Level of detail for image processing, can be "low", "high", or "auto"
+                 */
                 detail: 'low' | 'high' | 'auto';
+                /**
+                 * Content type identifier, always "input_image"
+                 */
                 type: 'input_image';
+                /**
+                 * (Optional) URL of the image content
+                 */
                 image_url?: string;
             }
             interface UnionMember2 {
@@ -658,17 +1563,50 @@ export declare namespace ResponseListResponse {
                 type: 'output_text';
             }
             namespace UnionMember2 {
+                /**
+                 * File citation annotation for referencing specific files in response content.
+                 */
                 interface OpenAIResponseAnnotationFileCitation {
+                    /**
+                     * Unique identifier of the referenced file
+                     */
                     file_id: string;
+                    /**
+                     * Name of the referenced file
+                     */
                     filename: string;
+                    /**
+                     * Position index of the citation within the content
+                     */
                     index: number;
+                    /**
+                     * Annotation type identifier, always "file_citation"
+                     */
                     type: 'file_citation';
                 }
+                /**
+                 * URL citation annotation for referencing external web resources.
+                 */
                 interface OpenAIResponseAnnotationCitation {
+                    /**
+                     * End position of the citation span in the content
+                     */
                     end_index: number;
+                    /**
+                     * Start position of the citation span in the content
+                     */
                     start_index: number;
+                    /**
+                     * Title of the referenced web resource
+                     */
                     title: string;
+                    /**
+                     * Annotation type identifier, always "url_citation"
+                     */
                     type: 'url_citation';
+                    /**
+                     * URL of the referenced web resource
+                     */
                     url: string;
                 }
                 interface OpenAIResponseAnnotationContainerFileCitation {
@@ -686,61 +1624,166 @@ export declare namespace ResponseListResponse {
                 }
             }
         }
+        /**
+         * Web search tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageWebSearchToolCall {
+            /**
+             * Unique identifier for this tool call
+             */
             id: string;
+            /**
+             * Current status of the web search operation
+             */
             status: string;
+            /**
+             * Tool call type identifier, always "web_search_call"
+             */
             type: 'web_search_call';
         }
+        /**
+         * File search tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageFileSearchToolCall {
+            /**
+             * Unique identifier for this tool call
+             */
             id: string;
+            /**
+             * List of search queries executed
+             */
             queries: Array<string>;
+            /**
+             * Current status of the file search operation
+             */
             status: string;
+            /**
+             * Tool call type identifier, always "file_search_call"
+             */
             type: 'file_search_call';
+            /**
+             * (Optional) Search results returned by the file search operation
+             */
             results?: Array<{
                 [key: string]: boolean | number | string | Array<unknown> | unknown | null;
             }>;
         }
+        /**
+         * Function tool call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageFunctionToolCall {
+            /**
+             * JSON string containing the function arguments
+             */
             arguments: string;
+            /**
+             * Unique identifier for the function call
+             */
             call_id: string;
+            /**
+             * Name of the function being called
+             */
             name: string;
+            /**
+             * Tool call type identifier, always "function_call"
+             */
             type: 'function_call';
+            /**
+             * (Optional) Additional identifier for the tool call
+             */
             id?: string;
+            /**
+             * (Optional) Current status of the function call execution
+             */
             status?: string;
         }
+        /**
+         * Model Context Protocol (MCP) call output message for OpenAI responses.
+         */
         interface OpenAIResponseOutputMessageMcpCall {
+            /**
+             * Unique identifier for this MCP call
+             */
             id: string;
+            /**
+             * JSON string containing the MCP call arguments
+             */
             arguments: string;
+            /**
+             * Name of the MCP method being called
+             */
             name: string;
+            /**
+             * Label identifying the MCP server handling the call
+             */
             server_label: string;
+            /**
+             * Tool call type identifier, always "mcp_call"
+             */
             type: 'mcp_call';
+            /**
+             * (Optional) Error message if the MCP call failed
+             */
             error?: string;
+            /**
+             * (Optional) Output result from the successful MCP call
+             */
             output?: string;
         }
+        /**
+         * MCP list tools output message containing available tools from an MCP server.
+         */
         interface OpenAIResponseOutputMessageMcpListTools {
+            /**
+             * Unique identifier for this MCP list tools operation
+             */
             id: string;
+            /**
+             * Label identifying the MCP server providing the tools
+             */
             server_label: string;
+            /**
+             * List of available tools provided by the MCP server
+             */
             tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
+            /**
+             * Tool call type identifier, always "mcp_list_tools"
+             */
             type: 'mcp_list_tools';
         }
         namespace OpenAIResponseOutputMessageMcpListTools {
+            /**
+             * Tool definition returned by MCP list tools operation.
+             */
             interface Tool {
+                /**
+                 * JSON schema defining the tool's input parameters
+                 */
                 input_schema: {
                     [key: string]: boolean | number | string | Array<unknown> | unknown | null;
                 };
+                /**
+                 * Name of the tool
+                 */
                 name: string;
+                /**
+                 * (Optional) Description of what the tool does
+                 */
                 description?: string;
             }
         }
+        /**
+         * Text formatting configuration for the response
+         */
         interface Text {
             /**
-             * Configuration for Responses API text format.
+             * (Optional) Text format configuration specifying output format requirements
              */
             format?: Text.Format;
         }
         namespace Text {
             /**
-             * Configuration for Responses API text format.
+             * (Optional) Text format configuration specifying output format requirements
              */
             interface Format {
                 /**
@@ -769,8 +1812,17 @@ export declare namespace ResponseListResponse {
                 strict?: boolean;
             }
         }
+        /**
+         * (Optional) Error details if the response generation failed
+         */
         interface Error {
+            /**
+             * Error code identifying the type of failure
+             */
             code: string;
+            /**
+             * Human-readable error message describing the failure
+             */
             message: string;
         }
     }
@@ -796,30 +1848,84 @@ export interface ResponseCreateParamsBase {
     store?: boolean;
     stream?: boolean;
     temperature?: number;
+    /**
+     * Text response configuration for OpenAI responses.
+     */
     text?: ResponseCreateParams.Text;
     tools?: Array<ResponseCreateParams.OpenAIResponseInputToolWebSearch | ResponseCreateParams.OpenAIResponseInputToolFileSearch | ResponseCreateParams.OpenAIResponseInputToolFunction | ResponseCreateParams.OpenAIResponseInputToolMcp>;
 }
 export declare namespace ResponseCreateParams {
+    /**
+     * Web search tool call output message for OpenAI responses.
+     */
     interface OpenAIResponseOutputMessageWebSearchToolCall {
+        /**
+         * Unique identifier for this tool call
+         */
         id: string;
+        /**
+         * Current status of the web search operation
+         */
         status: string;
+        /**
+         * Tool call type identifier, always "web_search_call"
+         */
         type: 'web_search_call';
     }
+    /**
+     * File search tool call output message for OpenAI responses.
+     */
     interface OpenAIResponseOutputMessageFileSearchToolCall {
+        /**
+         * Unique identifier for this tool call
+         */
         id: string;
+        /**
+         * List of search queries executed
+         */
         queries: Array<string>;
+        /**
+         * Current status of the file search operation
+         */
         status: string;
+        /**
+         * Tool call type identifier, always "file_search_call"
+         */
         type: 'file_search_call';
+        /**
+         * (Optional) Search results returned by the file search operation
+         */
         results?: Array<{
             [key: string]: boolean | number | string | Array<unknown> | unknown | null;
         }>;
     }
+    /**
+     * Function tool call output message for OpenAI responses.
+     */
     interface OpenAIResponseOutputMessageFunctionToolCall {
+        /**
+         * JSON string containing the function arguments
+         */
         arguments: string;
+        /**
+         * Unique identifier for the function call
+         */
         call_id: string;
+        /**
+         * Name of the function being called
+         */
         name: string;
+        /**
+         * Tool call type identifier, always "function_call"
+         */
         type: 'function_call';
+        /**
+         * (Optional) Additional identifier for the tool call
+         */
         id?: string;
+        /**
+         * (Optional) Current status of the function call execution
+         */
         status?: string;
     }
     /**
@@ -846,13 +1952,34 @@ export declare namespace ResponseCreateParams {
         status?: string;
     }
     namespace OpenAIResponseMessage {
+        /**
+         * Text content for input messages in OpenAI response format.
+         */
         interface OpenAIResponseInputMessageContentText {
+            /**
+             * The text content of the input message
+             */
             text: string;
+            /**
+             * Content type identifier, always "input_text"
+             */
             type: 'input_text';
         }
+        /**
+         * Image content for input messages in OpenAI response format.
+         */
         interface OpenAIResponseInputMessageContentImage {
+            /**
+             * Level of detail for image processing, can be "low", "high", or "auto"
+             */
             detail: 'low' | 'high' | 'auto';
+            /**
+             * Content type identifier, always "input_image"
+             */
             type: 'input_image';
+            /**
+             * (Optional) URL of the image content
+             */
             image_url?: string;
         }
         interface UnionMember2 {
@@ -861,17 +1988,50 @@ export declare namespace ResponseCreateParams {
             type: 'output_text';
         }
         namespace UnionMember2 {
+            /**
+             * File citation annotation for referencing specific files in response content.
+             */
             interface OpenAIResponseAnnotationFileCitation {
+                /**
+                 * Unique identifier of the referenced file
+                 */
                 file_id: string;
+                /**
+                 * Name of the referenced file
+                 */
                 filename: string;
+                /**
+                 * Position index of the citation within the content
+                 */
                 index: number;
+                /**
+                 * Annotation type identifier, always "file_citation"
+                 */
                 type: 'file_citation';
             }
+            /**
+             * URL citation annotation for referencing external web resources.
+             */
             interface OpenAIResponseAnnotationCitation {
+                /**
+                 * End position of the citation span in the content
+                 */
                 end_index: number;
+                /**
+                 * Start position of the citation span in the content
+                 */
                 start_index: number;
+                /**
+                 * Title of the referenced web resource
+                 */
                 title: string;
+                /**
+                 * Annotation type identifier, always "url_citation"
+                 */
                 type: 'url_citation';
+                /**
+                 * URL of the referenced web resource
+                 */
                 url: string;
             }
             interface OpenAIResponseAnnotationContainerFileCitation {
@@ -889,15 +2049,18 @@ export declare namespace ResponseCreateParams {
             }
         }
     }
+    /**
+     * Text response configuration for OpenAI responses.
+     */
     interface Text {
         /**
-         * Configuration for Responses API text format.
+         * (Optional) Text format configuration specifying output format requirements
          */
         format?: Text.Format;
     }
     namespace Text {
         /**
-         * Configuration for Responses API text format.
+         * (Optional) Text format configuration specifying output format requirements
          */
         interface Format {
             /**
@@ -926,50 +2089,140 @@ export declare namespace ResponseCreateParams {
             strict?: boolean;
         }
     }
+    /**
+     * Web search tool configuration for OpenAI response inputs.
+     */
     interface OpenAIResponseInputToolWebSearch {
+        /**
+         * Web search tool type variant to use
+         */
         type: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11';
+        /**
+         * (Optional) Size of search context, must be "low", "medium", or "high"
+         */
         search_context_size?: string;
     }
+    /**
+     * File search tool configuration for OpenAI response inputs.
+     */
     interface OpenAIResponseInputToolFileSearch {
+        /**
+         * Tool type identifier, always "file_search"
+         */
         type: 'file_search';
+        /**
+         * List of vector store identifiers to search within
+         */
         vector_store_ids: Array<string>;
+        /**
+         * (Optional) Additional filters to apply to the search
+         */
         filters?: {
             [key: string]: boolean | number | string | Array<unknown> | unknown | null;
         };
+        /**
+         * (Optional) Maximum number of search results to return (1-50)
+         */
         max_num_results?: number;
+        /**
+         * (Optional) Options for ranking and scoring search results
+         */
         ranking_options?: OpenAIResponseInputToolFileSearch.RankingOptions;
     }
     namespace OpenAIResponseInputToolFileSearch {
+        /**
+         * (Optional) Options for ranking and scoring search results
+         */
         interface RankingOptions {
+            /**
+             * (Optional) Name of the ranking algorithm to use
+             */
             ranker?: string;
+            /**
+             * (Optional) Minimum relevance score threshold for results
+             */
             score_threshold?: number;
         }
     }
+    /**
+     * Function tool configuration for OpenAI response inputs.
+     */
     interface OpenAIResponseInputToolFunction {
+        /**
+         * Name of the function that can be called
+         */
         name: string;
+        /**
+         * Tool type identifier, always "function"
+         */
         type: 'function';
+        /**
+         * (Optional) Description of what the function does
+         */
         description?: string;
+        /**
+         * (Optional) JSON schema defining the function's parameters
+         */
         parameters?: {
             [key: string]: boolean | number | string | Array<unknown> | unknown | null;
         };
+        /**
+         * (Optional) Whether to enforce strict parameter validation
+         */
         strict?: boolean;
     }
+    /**
+     * Model Context Protocol (MCP) tool configuration for OpenAI response inputs.
+     */
     interface OpenAIResponseInputToolMcp {
+        /**
+         * Approval requirement for tool calls ("always", "never", or filter)
+         */
         require_approval: 'always' | 'never' | OpenAIResponseInputToolMcp.ApprovalFilter;
+        /**
+         * Label to identify this MCP server
+         */
         server_label: string;
+        /**
+         * URL endpoint of the MCP server
+         */
         server_url: string;
+        /**
+         * Tool type identifier, always "mcp"
+         */
         type: 'mcp';
+        /**
+         * (Optional) Restriction on which tools can be used from this server
+         */
         allowed_tools?: Array<string> | OpenAIResponseInputToolMcp.AllowedToolsFilter;
+        /**
+         * (Optional) HTTP headers to include when connecting to the server
+         */
         headers?: {
             [key: string]: boolean | number | string | Array<unknown> | unknown | null;
         };
     }
     namespace OpenAIResponseInputToolMcp {
+        /**
+         * Filter configuration for MCP tool approval requirements.
+         */
         interface ApprovalFilter {
+            /**
+             * (Optional) List of tool names that always require approval
+             */
             always?: Array<string>;
+            /**
+             * (Optional) List of tool names that never require approval
+             */
             never?: Array<string>;
         }
+        /**
+         * Filter configuration for restricting which MCP tools can be used.
+         */
         interface AllowedToolsFilter {
+            /**
+             * (Optional) List of specific tool names that are allowed
+             */
             tool_names?: Array<string>;
         }
     }