ogx-client 0.7.2-rc1

package/resources/conversations/items.d.ts

@@ -0,0 +1,1408 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import { OpenAICursorPage, type OpenAICursorPageParams } from "../../pagination.js";
+/**
+ * Protocol for conversation management operations.
+ */
+export declare class Items extends APIResource {
+    /**
+     * Create items in the conversation.
+     */
+    create(conversationId: string, body: ItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<ItemCreateResponse>;
+    /**
+     * List items in the conversation.
+     */
+    list(conversationId: string, query?: ItemListParams, options?: Core.RequestOptions): Core.PagePromise<ItemListResponsesOpenAICursorPage, ItemListResponse>;
+    list(conversationId: string, options?: Core.RequestOptions): Core.PagePromise<ItemListResponsesOpenAICursorPage, ItemListResponse>;
+    /**
+     * Delete a conversation item.
+     */
+    delete(conversationId: string, itemId: string, options?: Core.RequestOptions): Core.APIPromise<ItemDeleteResponse>;
+    /**
+     * Retrieve a conversation item.
+     */
+    get(conversationId: string, itemId: string, options?: Core.RequestOptions): Core.APIPromise<ItemGetResponse>;
+}
+export declare class ItemListResponsesOpenAICursorPage extends OpenAICursorPage<ItemListResponse> {
+}
+/**
+ * List of conversation items with pagination.
+ */
+export interface ItemCreateResponse {
+    /**
+     * List of conversation items
+     */
+    data: Array<ItemCreateResponse.OpenAIResponseMessageOutput | ItemCreateResponse.OpenAIResponseOutputMessageWebSearchToolCall | ItemCreateResponse.OpenAIResponseOutputMessageFileSearchToolCall | ItemCreateResponse.OpenAIResponseOutputMessageFunctionToolCall | ItemCreateResponse.OpenAIResponseInputFunctionToolCallOutput | ItemCreateResponse.OpenAIResponseMcpApprovalRequest | ItemCreateResponse.OpenAIResponseMcpApprovalResponse | ItemCreateResponse.OpenAIResponseOutputMessageMcpCall | ItemCreateResponse.OpenAIResponseOutputMessageMcpListTools | ItemCreateResponse.OpenAIResponseOutputMessageReasoningItem>;
+    /**
+     * The ID of the first item in the list
+     */
+    first_id?: string | null;
+    /**
+     * Whether there are more items available
+     */
+    has_more?: boolean;
+    /**
+     * The ID of the last item in the list
+     */
+    last_id?: string | null;
+    /**
+     * Object type
+     */
+    object?: string;
+}
+export declare namespace ItemCreateResponse {
+    /**
+     * 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.
+     */
+    interface OpenAIResponseMessageOutput {
+        content: string | Array<OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentText | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessageOutput.OpenAIResponseOutputMessageContentOutputTextOutput | OpenAIResponseMessageOutput.OpenAIResponseContentPartRefusal>;
+        role: 'system' | 'developer' | 'user' | 'assistant';
+        id?: string | null;
+        status?: string | null;
+        type?: 'message';
+    }
+    namespace OpenAIResponseMessageOutput {
+        /**
+         * Text content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentText {
+            text: string;
+            type?: 'input_text';
+        }
+        /**
+         * Image content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentImage {
+            detail?: 'low' | 'high' | 'auto';
+            file_id?: string | null;
+            image_url?: string | null;
+            type?: 'input_image';
+        }
+        /**
+         * File content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentFile {
+            file_data?: string | null;
+            file_id?: string | null;
+            file_url?: string | null;
+            filename?: string | null;
+            type?: 'input_file';
+        }
+        /**
+         * Text content within an output message of an OpenAI response.
+         */
+        interface OpenAIResponseOutputMessageContentOutputTextOutput {
+            text: string;
+            annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
+            logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.Logprob> | null;
+            type?: 'output_text';
+        }
+        namespace OpenAIResponseOutputMessageContentOutputTextOutput {
+            /**
+             * File citation annotation for referencing specific files in response content.
+             */
+            interface OpenAIResponseAnnotationFileCitation {
+                file_id: string;
+                filename: string;
+                index: number;
+                type?: 'file_citation';
+            }
+            /**
+             * URL citation annotation for referencing external web resources.
+             */
+            interface OpenAIResponseAnnotationCitation {
+                end_index: number;
+                start_index: number;
+                title: string;
+                url: string;
+                type?: 'url_citation';
+            }
+            /**
+             * Container file citation annotation referencing a file within a container.
+             */
+            interface OpenAIResponseAnnotationContainerFileCitation {
+                container_id: string;
+                end_index: number;
+                file_id: string;
+                filename: string;
+                start_index: number;
+                type?: 'container_file_citation';
+            }
+            /**
+             * File path annotation referencing a generated file in response content.
+             */
+            interface OpenAIResponseAnnotationFilePath {
+                file_id: string;
+                index: number;
+                type?: 'file_path';
+            }
+            /**
+             * The log probability for a token from an OpenAI-compatible chat completion
+             * response.
+             */
+            interface Logprob {
+                /**
+                 * The token.
+                 */
+                token: string;
+                /**
+                 * The log probability of the token.
+                 */
+                logprob: number;
+                /**
+                 * The bytes for the token.
+                 */
+                bytes?: Array<number> | null;
+                /**
+                 * The top log probabilities for the token.
+                 */
+                top_logprobs?: Array<Logprob.TopLogprob> | null;
+            }
+            namespace Logprob {
+                /**
+                 * The top log probability for a token from an OpenAI-compatible chat completion
+                 * response.
+                 */
+                interface TopLogprob {
+                    /**
+                     * The token.
+                     */
+                    token: string;
+                    /**
+                     * The log probability of the token.
+                     */
+                    logprob: number;
+                    /**
+                     * The bytes for the token.
+                     */
+                    bytes?: Array<number> | null;
+                }
+            }
+        }
+        /**
+         * Refusal content within a streamed response part.
+         */
+        interface OpenAIResponseContentPartRefusal {
+            refusal: string;
+            type?: 'refusal';
+        }
+    }
+    /**
+     * Web search tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageWebSearchToolCall {
+        id: string;
+        status: string;
+        type?: 'web_search_call';
+    }
+    /**
+     * File search tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageFileSearchToolCall {
+        id: string;
+        queries: Array<string>;
+        status: string;
+        results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
+        type?: 'file_search_call';
+    }
+    namespace OpenAIResponseOutputMessageFileSearchToolCall {
+        /**
+         * Search results returned by the file search operation.
+         */
+        interface Result {
+            attributes: {
+                [key: string]: unknown;
+            };
+            file_id: string;
+            filename: string;
+            score: number;
+            text: string;
+        }
+    }
+    /**
+     * Function tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageFunctionToolCall {
+        arguments: string;
+        call_id: string;
+        name: string;
+        id?: string | null;
+        status?: string | null;
+        type?: 'function_call';
+    }
+    /**
+     * This represents the output of a function call that gets passed back to the
+     * model.
+     */
+    interface OpenAIResponseInputFunctionToolCallOutput {
+        call_id: string;
+        output: string | Array<OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentText | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentFile>;
+        id?: string | null;
+        status?: string | null;
+        type?: 'function_call_output';
+    }
+    namespace OpenAIResponseInputFunctionToolCallOutput {
+        /**
+         * Text content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentText {
+            text: string;
+            type?: 'input_text';
+        }
+        /**
+         * Image content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentImage {
+            detail?: 'low' | 'high' | 'auto';
+            file_id?: string | null;
+            image_url?: string | null;
+            type?: 'input_image';
+        }
+        /**
+         * File content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentFile {
+            file_data?: string | null;
+            file_id?: string | null;
+            file_url?: string | null;
+            filename?: string | null;
+            type?: 'input_file';
+        }
+    }
+    /**
+     * A request for human approval of a tool invocation.
+     */
+    interface OpenAIResponseMcpApprovalRequest {
+        id: string;
+        arguments: string;
+        name: string;
+        server_label: string;
+        type?: 'mcp_approval_request';
+    }
+    /**
+     * A response to an MCP approval request.
+     */
+    interface OpenAIResponseMcpApprovalResponse {
+        approval_request_id: string;
+        approve: boolean;
+        id?: string | null;
+        reason?: string | null;
+        type?: 'mcp_approval_response';
+    }
+    /**
+     * Model Context Protocol (MCP) call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageMcpCall {
+        id: string;
+        arguments: string;
+        name: string;
+        server_label: string;
+        error?: string | null;
+        output?: string | null;
+        type?: 'mcp_call';
+    }
+    /**
+     * MCP list tools output message containing available tools from an MCP server.
+     */
+    interface OpenAIResponseOutputMessageMcpListTools {
+        id: string;
+        server_label: string;
+        tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
+        type?: 'mcp_list_tools';
+    }
+    namespace OpenAIResponseOutputMessageMcpListTools {
+        /**
+         * Tool definition returned by MCP list tools operation.
+         */
+        interface Tool {
+            input_schema: {
+                [key: string]: unknown;
+            };
+            name: string;
+            description?: string | null;
+        }
+    }
+    /**
+     * Reasoning output from the model, representing the model's thinking process.
+     */
+    interface OpenAIResponseOutputMessageReasoningItem {
+        /**
+         * Unique identifier for the reasoning output item.
+         */
+        id: string;
+        /**
+         * Summary of the reasoning output.
+         */
+        summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
+        /**
+         * The reasoning content from the model.
+         */
+        content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
+        /**
+         * The status of the reasoning output.
+         */
+        status?: 'in_progress' | 'completed' | 'incomplete' | null;
+        /**
+         * The type identifier, always 'reasoning'.
+         */
+        type?: 'reasoning';
+    }
+    namespace OpenAIResponseOutputMessageReasoningItem {
+        /**
+         * A summary of reasoning output from the model.
+         */
+        interface Summary {
+            /**
+             * The summary text of the reasoning output.
+             */
+            text: string;
+            /**
+             * The type identifier, always 'summary_text'.
+             */
+            type?: 'summary_text';
+        }
+        /**
+         * Reasoning text from the model.
+         */
+        interface Content {
+            /**
+             * The reasoning text content from the model.
+             */
+            text: string;
+            /**
+             * The type identifier, always 'reasoning_text'.
+             */
+            type?: 'reasoning_text';
+        }
+    }
+}
+/**
+ * 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.
+ */
+export type ItemListResponse = ItemListResponse.OpenAIResponseMessageOutput | ItemListResponse.OpenAIResponseOutputMessageWebSearchToolCall | ItemListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ItemListResponse.OpenAIResponseOutputMessageFunctionToolCall | ItemListResponse.OpenAIResponseInputFunctionToolCallOutput | ItemListResponse.OpenAIResponseMcpApprovalRequest | ItemListResponse.OpenAIResponseMcpApprovalResponse | ItemListResponse.OpenAIResponseOutputMessageMcpCall | ItemListResponse.OpenAIResponseOutputMessageMcpListTools | ItemListResponse.OpenAIResponseOutputMessageReasoningItem;
+export declare namespace ItemListResponse {
+    /**
+     * 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.
+     */
+    interface OpenAIResponseMessageOutput {
+        content: string | Array<OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentText | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessageOutput.OpenAIResponseOutputMessageContentOutputTextOutput | OpenAIResponseMessageOutput.OpenAIResponseContentPartRefusal>;
+        role: 'system' | 'developer' | 'user' | 'assistant';
+        id?: string | null;
+        status?: string | null;
+        type?: 'message';
+    }
+    namespace OpenAIResponseMessageOutput {
+        /**
+         * Text content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentText {
+            text: string;
+            type?: 'input_text';
+        }
+        /**
+         * Image content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentImage {
+            detail?: 'low' | 'high' | 'auto';
+            file_id?: string | null;
+            image_url?: string | null;
+            type?: 'input_image';
+        }
+        /**
+         * File content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentFile {
+            file_data?: string | null;
+            file_id?: string | null;
+            file_url?: string | null;
+            filename?: string | null;
+            type?: 'input_file';
+        }
+        /**
+         * Text content within an output message of an OpenAI response.
+         */
+        interface OpenAIResponseOutputMessageContentOutputTextOutput {
+            text: string;
+            annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
+            logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.Logprob> | null;
+            type?: 'output_text';
+        }
+        namespace OpenAIResponseOutputMessageContentOutputTextOutput {
+            /**
+             * File citation annotation for referencing specific files in response content.
+             */
+            interface OpenAIResponseAnnotationFileCitation {
+                file_id: string;
+                filename: string;
+                index: number;
+                type?: 'file_citation';
+            }
+            /**
+             * URL citation annotation for referencing external web resources.
+             */
+            interface OpenAIResponseAnnotationCitation {
+                end_index: number;
+                start_index: number;
+                title: string;
+                url: string;
+                type?: 'url_citation';
+            }
+            /**
+             * Container file citation annotation referencing a file within a container.
+             */
+            interface OpenAIResponseAnnotationContainerFileCitation {
+                container_id: string;
+                end_index: number;
+                file_id: string;
+                filename: string;
+                start_index: number;
+                type?: 'container_file_citation';
+            }
+            /**
+             * File path annotation referencing a generated file in response content.
+             */
+            interface OpenAIResponseAnnotationFilePath {
+                file_id: string;
+                index: number;
+                type?: 'file_path';
+            }
+            /**
+             * The log probability for a token from an OpenAI-compatible chat completion
+             * response.
+             */
+            interface Logprob {
+                /**
+                 * The token.
+                 */
+                token: string;
+                /**
+                 * The log probability of the token.
+                 */
+                logprob: number;
+                /**
+                 * The bytes for the token.
+                 */
+                bytes?: Array<number> | null;
+                /**
+                 * The top log probabilities for the token.
+                 */
+                top_logprobs?: Array<Logprob.TopLogprob> | null;
+            }
+            namespace Logprob {
+                /**
+                 * The top log probability for a token from an OpenAI-compatible chat completion
+                 * response.
+                 */
+                interface TopLogprob {
+                    /**
+                     * The token.
+                     */
+                    token: string;
+                    /**
+                     * The log probability of the token.
+                     */
+                    logprob: number;
+                    /**
+                     * The bytes for the token.
+                     */
+                    bytes?: Array<number> | null;
+                }
+            }
+        }
+        /**
+         * Refusal content within a streamed response part.
+         */
+        interface OpenAIResponseContentPartRefusal {
+            refusal: string;
+            type?: 'refusal';
+        }
+    }
+    /**
+     * Web search tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageWebSearchToolCall {
+        id: string;
+        status: string;
+        type?: 'web_search_call';
+    }
+    /**
+     * File search tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageFileSearchToolCall {
+        id: string;
+        queries: Array<string>;
+        status: string;
+        results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
+        type?: 'file_search_call';
+    }
+    namespace OpenAIResponseOutputMessageFileSearchToolCall {
+        /**
+         * Search results returned by the file search operation.
+         */
+        interface Result {
+            attributes: {
+                [key: string]: unknown;
+            };
+            file_id: string;
+            filename: string;
+            score: number;
+            text: string;
+        }
+    }
+    /**
+     * Function tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageFunctionToolCall {
+        arguments: string;
+        call_id: string;
+        name: string;
+        id?: string | null;
+        status?: string | null;
+        type?: 'function_call';
+    }
+    /**
+     * This represents the output of a function call that gets passed back to the
+     * model.
+     */
+    interface OpenAIResponseInputFunctionToolCallOutput {
+        call_id: string;
+        output: string | Array<OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentText | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentFile>;
+        id?: string | null;
+        status?: string | null;
+        type?: 'function_call_output';
+    }
+    namespace OpenAIResponseInputFunctionToolCallOutput {
+        /**
+         * Text content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentText {
+            text: string;
+            type?: 'input_text';
+        }
+        /**
+         * Image content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentImage {
+            detail?: 'low' | 'high' | 'auto';
+            file_id?: string | null;
+            image_url?: string | null;
+            type?: 'input_image';
+        }
+        /**
+         * File content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentFile {
+            file_data?: string | null;
+            file_id?: string | null;
+            file_url?: string | null;
+            filename?: string | null;
+            type?: 'input_file';
+        }
+    }
+    /**
+     * A request for human approval of a tool invocation.
+     */
+    interface OpenAIResponseMcpApprovalRequest {
+        id: string;
+        arguments: string;
+        name: string;
+        server_label: string;
+        type?: 'mcp_approval_request';
+    }
+    /**
+     * A response to an MCP approval request.
+     */
+    interface OpenAIResponseMcpApprovalResponse {
+        approval_request_id: string;
+        approve: boolean;
+        id?: string | null;
+        reason?: string | null;
+        type?: 'mcp_approval_response';
+    }
+    /**
+     * Model Context Protocol (MCP) call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageMcpCall {
+        id: string;
+        arguments: string;
+        name: string;
+        server_label: string;
+        error?: string | null;
+        output?: string | null;
+        type?: 'mcp_call';
+    }
+    /**
+     * MCP list tools output message containing available tools from an MCP server.
+     */
+    interface OpenAIResponseOutputMessageMcpListTools {
+        id: string;
+        server_label: string;
+        tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
+        type?: 'mcp_list_tools';
+    }
+    namespace OpenAIResponseOutputMessageMcpListTools {
+        /**
+         * Tool definition returned by MCP list tools operation.
+         */
+        interface Tool {
+            input_schema: {
+                [key: string]: unknown;
+            };
+            name: string;
+            description?: string | null;
+        }
+    }
+    /**
+     * Reasoning output from the model, representing the model's thinking process.
+     */
+    interface OpenAIResponseOutputMessageReasoningItem {
+        /**
+         * Unique identifier for the reasoning output item.
+         */
+        id: string;
+        /**
+         * Summary of the reasoning output.
+         */
+        summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
+        /**
+         * The reasoning content from the model.
+         */
+        content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
+        /**
+         * The status of the reasoning output.
+         */
+        status?: 'in_progress' | 'completed' | 'incomplete' | null;
+        /**
+         * The type identifier, always 'reasoning'.
+         */
+        type?: 'reasoning';
+    }
+    namespace OpenAIResponseOutputMessageReasoningItem {
+        /**
+         * A summary of reasoning output from the model.
+         */
+        interface Summary {
+            /**
+             * The summary text of the reasoning output.
+             */
+            text: string;
+            /**
+             * The type identifier, always 'summary_text'.
+             */
+            type?: 'summary_text';
+        }
+        /**
+         * Reasoning text from the model.
+         */
+        interface Content {
+            /**
+             * The reasoning text content from the model.
+             */
+            text: string;
+            /**
+             * The type identifier, always 'reasoning_text'.
+             */
+            type?: 'reasoning_text';
+        }
+    }
+}
+/**
+ * Response for deleted conversation item.
+ */
+export interface ItemDeleteResponse {
+    /**
+     * The deleted item identifier
+     */
+    id: string;
+    /**
+     * Whether the object was deleted
+     */
+    deleted?: boolean;
+    /**
+     * Object type
+     */
+    object?: string;
+}
+/**
+ * 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.
+ */
+export type ItemGetResponse = ItemGetResponse.OpenAIResponseMessageOutput | ItemGetResponse.OpenAIResponseOutputMessageWebSearchToolCall | ItemGetResponse.OpenAIResponseOutputMessageFileSearchToolCall | ItemGetResponse.OpenAIResponseOutputMessageFunctionToolCall | ItemGetResponse.OpenAIResponseInputFunctionToolCallOutput | ItemGetResponse.OpenAIResponseMcpApprovalRequest | ItemGetResponse.OpenAIResponseMcpApprovalResponse | ItemGetResponse.OpenAIResponseOutputMessageMcpCall | ItemGetResponse.OpenAIResponseOutputMessageMcpListTools | ItemGetResponse.OpenAIResponseOutputMessageReasoningItem;
+export declare namespace ItemGetResponse {
+    /**
+     * 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.
+     */
+    interface OpenAIResponseMessageOutput {
+        content: string | Array<OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentText | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessageOutput.OpenAIResponseOutputMessageContentOutputTextOutput | OpenAIResponseMessageOutput.OpenAIResponseContentPartRefusal>;
+        role: 'system' | 'developer' | 'user' | 'assistant';
+        id?: string | null;
+        status?: string | null;
+        type?: 'message';
+    }
+    namespace OpenAIResponseMessageOutput {
+        /**
+         * Text content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentText {
+            text: string;
+            type?: 'input_text';
+        }
+        /**
+         * Image content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentImage {
+            detail?: 'low' | 'high' | 'auto';
+            file_id?: string | null;
+            image_url?: string | null;
+            type?: 'input_image';
+        }
+        /**
+         * File content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentFile {
+            file_data?: string | null;
+            file_id?: string | null;
+            file_url?: string | null;
+            filename?: string | null;
+            type?: 'input_file';
+        }
+        /**
+         * Text content within an output message of an OpenAI response.
+         */
+        interface OpenAIResponseOutputMessageContentOutputTextOutput {
+            text: string;
+            annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
+            logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.Logprob> | null;
+            type?: 'output_text';
+        }
+        namespace OpenAIResponseOutputMessageContentOutputTextOutput {
+            /**
+             * File citation annotation for referencing specific files in response content.
+             */
+            interface OpenAIResponseAnnotationFileCitation {
+                file_id: string;
+                filename: string;
+                index: number;
+                type?: 'file_citation';
+            }
+            /**
+             * URL citation annotation for referencing external web resources.
+             */
+            interface OpenAIResponseAnnotationCitation {
+                end_index: number;
+                start_index: number;
+                title: string;
+                url: string;
+                type?: 'url_citation';
+            }
+            /**
+             * Container file citation annotation referencing a file within a container.
+             */
+            interface OpenAIResponseAnnotationContainerFileCitation {
+                container_id: string;
+                end_index: number;
+                file_id: string;
+                filename: string;
+                start_index: number;
+                type?: 'container_file_citation';
+            }
+            /**
+             * File path annotation referencing a generated file in response content.
+             */
+            interface OpenAIResponseAnnotationFilePath {
+                file_id: string;
+                index: number;
+                type?: 'file_path';
+            }
+            /**
+             * The log probability for a token from an OpenAI-compatible chat completion
+             * response.
+             */
+            interface Logprob {
+                /**
+                 * The token.
+                 */
+                token: string;
+                /**
+                 * The log probability of the token.
+                 */
+                logprob: number;
+                /**
+                 * The bytes for the token.
+                 */
+                bytes?: Array<number> | null;
+                /**
+                 * The top log probabilities for the token.
+                 */
+                top_logprobs?: Array<Logprob.TopLogprob> | null;
+            }
+            namespace Logprob {
+                /**
+                 * The top log probability for a token from an OpenAI-compatible chat completion
+                 * response.
+                 */
+                interface TopLogprob {
+                    /**
+                     * The token.
+                     */
+                    token: string;
+                    /**
+                     * The log probability of the token.
+                     */
+                    logprob: number;
+                    /**
+                     * The bytes for the token.
+                     */
+                    bytes?: Array<number> | null;
+                }
+            }
+        }
+        /**
+         * Refusal content within a streamed response part.
+         */
+        interface OpenAIResponseContentPartRefusal {
+            refusal: string;
+            type?: 'refusal';
+        }
+    }
+    /**
+     * Web search tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageWebSearchToolCall {
+        id: string;
+        status: string;
+        type?: 'web_search_call';
+    }
+    /**
+     * File search tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageFileSearchToolCall {
+        id: string;
+        queries: Array<string>;
+        status: string;
+        results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
+        type?: 'file_search_call';
+    }
+    namespace OpenAIResponseOutputMessageFileSearchToolCall {
+        /**
+         * Search results returned by the file search operation.
+         */
+        interface Result {
+            attributes: {
+                [key: string]: unknown;
+            };
+            file_id: string;
+            filename: string;
+            score: number;
+            text: string;
+        }
+    }
+    /**
+     * Function tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageFunctionToolCall {
+        arguments: string;
+        call_id: string;
+        name: string;
+        id?: string | null;
+        status?: string | null;
+        type?: 'function_call';
+    }
+    /**
+     * This represents the output of a function call that gets passed back to the
+     * model.
+     */
+    interface OpenAIResponseInputFunctionToolCallOutput {
+        call_id: string;
+        output: string | Array<OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentText | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentFile>;
+        id?: string | null;
+        status?: string | null;
+        type?: 'function_call_output';
+    }
+    namespace OpenAIResponseInputFunctionToolCallOutput {
+        /**
+         * Text content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentText {
+            text: string;
+            type?: 'input_text';
+        }
+        /**
+         * Image content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentImage {
+            detail?: 'low' | 'high' | 'auto';
+            file_id?: string | null;
+            image_url?: string | null;
+            type?: 'input_image';
+        }
+        /**
+         * File content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentFile {
+            file_data?: string | null;
+            file_id?: string | null;
+            file_url?: string | null;
+            filename?: string | null;
+            type?: 'input_file';
+        }
+    }
+    /**
+     * A request for human approval of a tool invocation.
+     */
+    interface OpenAIResponseMcpApprovalRequest {
+        id: string;
+        arguments: string;
+        name: string;
+        server_label: string;
+        type?: 'mcp_approval_request';
+    }
+    /**
+     * A response to an MCP approval request.
+     */
+    interface OpenAIResponseMcpApprovalResponse {
+        approval_request_id: string;
+        approve: boolean;
+        id?: string | null;
+        reason?: string | null;
+        type?: 'mcp_approval_response';
+    }
+    /**
+     * Model Context Protocol (MCP) call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageMcpCall {
+        id: string;
+        arguments: string;
+        name: string;
+        server_label: string;
+        error?: string | null;
+        output?: string | null;
+        type?: 'mcp_call';
+    }
+    /**
+     * MCP list tools output message containing available tools from an MCP server.
+     */
+    interface OpenAIResponseOutputMessageMcpListTools {
+        id: string;
+        server_label: string;
+        tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
+        type?: 'mcp_list_tools';
+    }
+    namespace OpenAIResponseOutputMessageMcpListTools {
+        /**
+         * Tool definition returned by MCP list tools operation.
+         */
+        interface Tool {
+            input_schema: {
+                [key: string]: unknown;
+            };
+            name: string;
+            description?: string | null;
+        }
+    }
+    /**
+     * Reasoning output from the model, representing the model's thinking process.
+     */
+    interface OpenAIResponseOutputMessageReasoningItem {
+        /**
+         * Unique identifier for the reasoning output item.
+         */
+        id: string;
+        /**
+         * Summary of the reasoning output.
+         */
+        summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
+        /**
+         * The reasoning content from the model.
+         */
+        content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
+        /**
+         * The status of the reasoning output.
+         */
+        status?: 'in_progress' | 'completed' | 'incomplete' | null;
+        /**
+         * The type identifier, always 'reasoning'.
+         */
+        type?: 'reasoning';
+    }
+    namespace OpenAIResponseOutputMessageReasoningItem {
+        /**
+         * A summary of reasoning output from the model.
+         */
+        interface Summary {
+            /**
+             * The summary text of the reasoning output.
+             */
+            text: string;
+            /**
+             * The type identifier, always 'summary_text'.
+             */
+            type?: 'summary_text';
+        }
+        /**
+         * Reasoning text from the model.
+         */
+        interface Content {
+            /**
+             * The reasoning text content from the model.
+             */
+            text: string;
+            /**
+             * The type identifier, always 'reasoning_text'.
+             */
+            type?: 'reasoning_text';
+        }
+    }
+}
+export interface ItemCreateParams {
+    /**
+     * Items to include in the conversation context. You may add up to 20 items at a
+     * time.
+     */
+    items: Array<ItemCreateParams.OpenAIResponseMessageInput | ItemCreateParams.OpenAIResponseOutputMessageWebSearchToolCall | ItemCreateParams.OpenAIResponseOutputMessageFileSearchToolCall | ItemCreateParams.OpenAIResponseOutputMessageFunctionToolCall | ItemCreateParams.OpenAIResponseInputFunctionToolCallOutput | ItemCreateParams.OpenAIResponseMcpApprovalRequest | ItemCreateParams.OpenAIResponseMcpApprovalResponse | ItemCreateParams.OpenAIResponseOutputMessageMcpCall | ItemCreateParams.OpenAIResponseOutputMessageMcpListTools | ItemCreateParams.OpenAIResponseOutputMessageReasoningItem>;
+}
+export declare namespace ItemCreateParams {
+    /**
+     * 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.
+     */
+    interface OpenAIResponseMessageInput {
+        content: string | Array<OpenAIResponseMessageInput.OpenAIResponseInputMessageContentText | OpenAIResponseMessageInput.OpenAIResponseInputMessageContentImage | OpenAIResponseMessageInput.OpenAIResponseInputMessageContentFile> | Array<OpenAIResponseMessageInput.OpenAIResponseOutputMessageContentOutputTextInput | OpenAIResponseMessageInput.OpenAIResponseContentPartRefusal>;
+        role: 'system' | 'developer' | 'user' | 'assistant';
+        id?: string | null;
+        status?: string | null;
+        type?: 'message';
+    }
+    namespace OpenAIResponseMessageInput {
+        /**
+         * Text content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentText {
+            text: string;
+            type?: 'input_text';
+        }
+        /**
+         * Image content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentImage {
+            detail?: 'low' | 'high' | 'auto';
+            file_id?: string | null;
+            image_url?: string | null;
+            type?: 'input_image';
+        }
+        /**
+         * File content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentFile {
+            file_data?: string | null;
+            file_id?: string | null;
+            file_url?: string | null;
+            filename?: string | null;
+            type?: 'input_file';
+        }
+        /**
+         * Text content within an output message of an OpenAI response.
+         */
+        interface OpenAIResponseOutputMessageContentOutputTextInput {
+            text: string;
+            annotations?: Array<OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationFilePath>;
+            logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextInput.Logprob> | null;
+            type?: 'output_text';
+        }
+        namespace OpenAIResponseOutputMessageContentOutputTextInput {
+            /**
+             * File citation annotation for referencing specific files in response content.
+             */
+            interface OpenAIResponseAnnotationFileCitation {
+                file_id: string;
+                filename: string;
+                index: number;
+                type?: 'file_citation';
+            }
+            /**
+             * URL citation annotation for referencing external web resources.
+             */
+            interface OpenAIResponseAnnotationCitation {
+                end_index: number;
+                start_index: number;
+                title: string;
+                url: string;
+                type?: 'url_citation';
+            }
+            /**
+             * Container file citation annotation referencing a file within a container.
+             */
+            interface OpenAIResponseAnnotationContainerFileCitation {
+                container_id: string;
+                end_index: number;
+                file_id: string;
+                filename: string;
+                start_index: number;
+                type?: 'container_file_citation';
+            }
+            /**
+             * File path annotation referencing a generated file in response content.
+             */
+            interface OpenAIResponseAnnotationFilePath {
+                file_id: string;
+                index: number;
+                type?: 'file_path';
+            }
+            /**
+             * The log probability for a token from an OpenAI-compatible chat completion
+             * response.
+             */
+            interface Logprob {
+                /**
+                 * The token.
+                 */
+                token: string;
+                /**
+                 * The log probability of the token.
+                 */
+                logprob: number;
+                /**
+                 * The bytes for the token.
+                 */
+                bytes?: Array<number> | null;
+                /**
+                 * The top log probabilities for the token.
+                 */
+                top_logprobs?: Array<Logprob.TopLogprob> | null;
+            }
+            namespace Logprob {
+                /**
+                 * The top log probability for a token from an OpenAI-compatible chat completion
+                 * response.
+                 */
+                interface TopLogprob {
+                    /**
+                     * The token.
+                     */
+                    token: string;
+                    /**
+                     * The log probability of the token.
+                     */
+                    logprob: number;
+                    /**
+                     * The bytes for the token.
+                     */
+                    bytes?: Array<number> | null;
+                }
+            }
+        }
+        /**
+         * Refusal content within a streamed response part.
+         */
+        interface OpenAIResponseContentPartRefusal {
+            refusal: string;
+            type?: 'refusal';
+        }
+    }
+    /**
+     * Web search tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageWebSearchToolCall {
+        id: string;
+        status: string;
+        type?: 'web_search_call';
+    }
+    /**
+     * File search tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageFileSearchToolCall {
+        id: string;
+        queries: Array<string>;
+        status: string;
+        results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
+        type?: 'file_search_call';
+    }
+    namespace OpenAIResponseOutputMessageFileSearchToolCall {
+        /**
+         * Search results returned by the file search operation.
+         */
+        interface Result {
+            attributes: {
+                [key: string]: unknown;
+            };
+            file_id: string;
+            filename: string;
+            score: number;
+            text: string;
+        }
+    }
+    /**
+     * Function tool call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageFunctionToolCall {
+        arguments: string;
+        call_id: string;
+        name: string;
+        id?: string | null;
+        status?: string | null;
+        type?: 'function_call';
+    }
+    /**
+     * This represents the output of a function call that gets passed back to the
+     * model.
+     */
+    interface OpenAIResponseInputFunctionToolCallOutput {
+        call_id: string;
+        output: string | Array<OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentText | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentFile>;
+        id?: string | null;
+        status?: string | null;
+        type?: 'function_call_output';
+    }
+    namespace OpenAIResponseInputFunctionToolCallOutput {
+        /**
+         * Text content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentText {
+            text: string;
+            type?: 'input_text';
+        }
+        /**
+         * Image content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentImage {
+            detail?: 'low' | 'high' | 'auto';
+            file_id?: string | null;
+            image_url?: string | null;
+            type?: 'input_image';
+        }
+        /**
+         * File content for input messages in OpenAI response format.
+         */
+        interface OpenAIResponseInputMessageContentFile {
+            file_data?: string | null;
+            file_id?: string | null;
+            file_url?: string | null;
+            filename?: string | null;
+            type?: 'input_file';
+        }
+    }
+    /**
+     * A request for human approval of a tool invocation.
+     */
+    interface OpenAIResponseMcpApprovalRequest {
+        id: string;
+        arguments: string;
+        name: string;
+        server_label: string;
+        type?: 'mcp_approval_request';
+    }
+    /**
+     * A response to an MCP approval request.
+     */
+    interface OpenAIResponseMcpApprovalResponse {
+        approval_request_id: string;
+        approve: boolean;
+        id?: string | null;
+        reason?: string | null;
+        type?: 'mcp_approval_response';
+    }
+    /**
+     * Model Context Protocol (MCP) call output message for OpenAI responses.
+     */
+    interface OpenAIResponseOutputMessageMcpCall {
+        id: string;
+        arguments: string;
+        name: string;
+        server_label: string;
+        error?: string | null;
+        output?: string | null;
+        type?: 'mcp_call';
+    }
+    /**
+     * MCP list tools output message containing available tools from an MCP server.
+     */
+    interface OpenAIResponseOutputMessageMcpListTools {
+        id: string;
+        server_label: string;
+        tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
+        type?: 'mcp_list_tools';
+    }
+    namespace OpenAIResponseOutputMessageMcpListTools {
+        /**
+         * Tool definition returned by MCP list tools operation.
+         */
+        interface Tool {
+            input_schema: {
+                [key: string]: unknown;
+            };
+            name: string;
+            description?: string | null;
+        }
+    }
+    /**
+     * Reasoning output from the model, representing the model's thinking process.
+     */
+    interface OpenAIResponseOutputMessageReasoningItem {
+        /**
+         * Unique identifier for the reasoning output item.
+         */
+        id: string;
+        /**
+         * Summary of the reasoning output.
+         */
+        summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
+        /**
+         * The reasoning content from the model.
+         */
+        content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
+        /**
+         * The status of the reasoning output.
+         */
+        status?: 'in_progress' | 'completed' | 'incomplete' | null;
+        /**
+         * The type identifier, always 'reasoning'.
+         */
+        type?: 'reasoning';
+    }
+    namespace OpenAIResponseOutputMessageReasoningItem {
+        /**
+         * A summary of reasoning output from the model.
+         */
+        interface Summary {
+            /**
+             * The summary text of the reasoning output.
+             */
+            text: string;
+            /**
+             * The type identifier, always 'summary_text'.
+             */
+            type?: 'summary_text';
+        }
+        /**
+         * Reasoning text from the model.
+         */
+        interface Content {
+            /**
+             * The reasoning text content from the model.
+             */
+            text: string;
+            /**
+             * The type identifier, always 'reasoning_text'.
+             */
+            type?: 'reasoning_text';
+        }
+    }
+}
+export interface ItemListParams extends OpenAICursorPageParams {
+    include?: Array<'web_search_call.action.sources' | 'code_interpreter_call.outputs' | 'computer_call_output.output.image_url' | 'file_search_call.results' | 'message.input_image.image_url' | 'message.output_text.logprobs' | 'reasoning.encrypted_content'> | null;
+    order?: 'asc' | 'desc' | null;
+}
+export declare namespace Items {
+    export { type ItemCreateResponse as ItemCreateResponse, type ItemListResponse as ItemListResponse, type ItemDeleteResponse as ItemDeleteResponse, type ItemGetResponse as ItemGetResponse, ItemListResponsesOpenAICursorPage as ItemListResponsesOpenAICursorPage, type ItemCreateParams as ItemCreateParams, type ItemListParams as ItemListParams, };
+}
+//# sourceMappingURL=items.d.ts.map