llama-stack-client 0.7.0 → 0.7.2

package/dist/resources/chat/completions.d.ts

@@ -4,6 +4,14 @@ import * as Core from "../../core.js";
 import * as CompletionsAPI from "./completions.js";
 import * as ChatAPI from "./chat.js";
 import { Stream } from "../../streaming.js";
+/**
+ * Llama Stack Inference API for generating completions, chat completions, and embeddings.
+ *
+ * This API provides the raw interface to the underlying models. Three kinds of models are supported:
+ * - LLM models: these models generate "raw" and "chat" (conversational) completions.
+ * - Embedding models: these models generate embeddings to be used for semantic search.
+ * - Rerank models: these models reorder the documents based on their relevance to a query.
+ */
 export declare class Completions extends APIResource {
     /**
      * Generate an OpenAI-compatible chat completion for the given messages using the
@@ -47,7 +55,15 @@ export interface CompletionCreateResponse {
      */
     object?: 'chat.completion';
     /**
-     * Usage information for OpenAI chat completion.
+     * The service tier that was used for this response.
+     */
+    service_tier?: string | null;
+    /**
+     * System fingerprint for this completion.
+     */
+    system_fingerprint?: string | null;
+    /**
+     * Token usage information for the completion.
      */
     usage?: CompletionCreateResponse.Usage | null;
 }
@@ -67,277 +83,131 @@ export declare namespace CompletionCreateResponse {
         /**
          * The message from the model.
          */
-        message: Choice.OpenAIUserMessageParamOutput | Choice.OpenAISystemMessageParam | Choice.OpenAIAssistantMessageParamOutput | Choice.OpenAIToolMessageParam | Choice.OpenAIDeveloperMessageParam;
+        message: Choice.Message;
         /**
-         * The log probabilities for the tokens in the message from an OpenAI-compatible
-         * chat completion response.
+         * The log probabilities for the tokens in the message.
          */
         logprobs?: Choice.Logprobs | null;
     }
     namespace Choice {
         /**
-         * A message from the user in an OpenAI-compatible chat completion request.
-         */
-        interface OpenAIUserMessageParamOutput {
-            /**
-             * The content of the message, which can include text and other media.
-             */
-            content: string | Array<OpenAIUserMessageParamOutput.OpenAIChatCompletionContentPartTextParam | OpenAIUserMessageParamOutput.OpenAIChatCompletionContentPartImageParam | OpenAIUserMessageParamOutput.OpenAIFile>;
-            /**
-             * The name of the user message participant.
-             */
-            name?: string | null;
-            /**
-             * Must be 'user' to identify this as a user message.
-             */
-            role?: 'user';
-        }
-        namespace OpenAIUserMessageParamOutput {
-            /**
-             * Text content part for OpenAI-compatible chat completion messages.
-             */
-            interface OpenAIChatCompletionContentPartTextParam {
-                /**
-                 * The text content of the message.
-                 */
-                text: string;
-                /**
-                 * Must be 'text' to identify this as text content.
-                 */
-                type?: 'text';
-            }
-            /**
-             * Image content part for OpenAI-compatible chat completion messages.
-             */
-            interface OpenAIChatCompletionContentPartImageParam {
-                /**
-                 * Image URL specification and processing details.
-                 */
-                image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
-                /**
-                 * Must be 'image_url' to identify this as image content.
-                 */
-                type?: 'image_url';
-            }
-            namespace OpenAIChatCompletionContentPartImageParam {
-                /**
-                 * Image URL specification and processing details.
-                 */
-                interface ImageURL {
-                    /**
-                     * URL of the image to include in the message.
-                     */
-                    url: string;
-                    /**
-                     * Level of detail for image processing. Can be 'low', 'high', or 'auto'.
-                     */
-                    detail?: 'low' | 'high' | 'auto' | null;
-                }
-            }
-            interface OpenAIFile {
-                /**
-                 * File specification.
-                 */
-                file: OpenAIFile.File;
-                /**
-                 * Must be 'file' to identify this as file content.
-                 */
-                type?: 'file';
-            }
-            namespace OpenAIFile {
-                /**
-                 * File specification.
-                 */
-                interface File {
-                    /**
-                     * Base64-encoded file data.
-                     */
-                    file_data?: string | null;
-                    /**
-                     * ID of an uploaded file.
-                     */
-                    file_id?: string | null;
-                    /**
-                     * Name of the file.
-                     */
-                    filename?: string | null;
-                }
-            }
-        }
-        /**
-         * A system message providing instructions or context to the model.
+         * The message from the model.
          */
-        interface OpenAISystemMessageParam {
+        interface Message {
             /**
-             * The content of the 'system prompt'. If multiple system messages are provided,
-             * they are concatenated.
+             * Annotations for the message, when applicable.
              */
-            content: string | Array<OpenAISystemMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
+            annotations?: Array<{
+                [key: string]: unknown;
+            }>;
             /**
-             * The name of the system message participant.
+             * Audio response data when using audio output modality.
              */
-            name?: string | null;
+            audio?: {
+                [key: string]: unknown;
+            } | null;
             /**
-             * Must be 'system' to identify this as a system message.
+             * The content of the message.
              */
-            role?: 'system';
-        }
-        namespace OpenAISystemMessageParam {
+            content?: string | null;
             /**
-             * Text content part for OpenAI-compatible chat completion messages.
+             * Deprecated: the name and arguments of a function that should be called.
              */
-            interface ListOpenAIChatCompletionContentPartTextParam {
-                /**
-                 * The text content of the message.
-                 */
-                text: string;
-                /**
-                 * Must be 'text' to identify this as text content.
-                 */
-                type?: 'text';
-            }
-        }
-        /**
-         * A message containing the model's (assistant) response in an OpenAI-compatible
-         * chat completion request.
-         */
-        interface OpenAIAssistantMessageParamOutput {
-            /**
-             * The content of the model's response.
-             */
-            content?: string | Array<OpenAIAssistantMessageParamOutput.ListOpenAIChatCompletionContentPartTextParam> | null;
+            function_call?: Message.FunctionCall;
             /**
-             * The name of the assistant message participant.
+             * The refusal message generated by the model.
              */
-            name?: string | null;
+            refusal?: string | null;
             /**
-             * Must be 'assistant' to identify this as the model's response.
+             * The role of the message author, always 'assistant' in responses.
              */
             role?: 'assistant';
             /**
-             * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
+             * The tool calls generated by the model.
              */
-            tool_calls?: Array<OpenAIAssistantMessageParamOutput.ToolCall> | null;
+            tool_calls?: Array<Message.Function | Message.Custom>;
         }
-        namespace OpenAIAssistantMessageParamOutput {
+        namespace Message {
             /**
-             * Text content part for OpenAI-compatible chat completion messages.
+             * Deprecated: the name and arguments of a function that should be called.
              */
-            interface ListOpenAIChatCompletionContentPartTextParam {
+            interface FunctionCall {
                 /**
-                 * The text content of the message.
+                 * Arguments to pass to the function as a JSON string.
                  */
-                text: string;
+                arguments: string;
                 /**
-                 * Must be 'text' to identify this as text content.
+                 * Name of the function to call.
                  */
-                type?: 'text';
+                name: string;
             }
             /**
              * Tool call specification for OpenAI-compatible chat completion responses.
              */
-            interface ToolCall {
+            interface Function {
                 /**
                  * Unique identifier for the tool call.
                  */
-                id?: string | null;
-                /**
-                 * Function call details for OpenAI-compatible tool calls.
-                 */
-                function?: ToolCall.Function | null;
+                id: string;
                 /**
-                 * Index of the tool call in the list.
+                 * Function call details.
                  */
-                index?: number | null;
+                function: Function.Function;
                 /**
                  * Must be 'function' to identify this as a function call.
                  */
-                type?: 'function';
+                type: 'function';
             }
-            namespace ToolCall {
+            namespace Function {
                 /**
-                 * Function call details for OpenAI-compatible tool calls.
+                 * Function call details.
                  */
                 interface Function {
                     /**
                      * Arguments to pass to the function as a JSON string.
                      */
-                    arguments?: string | null;
+                    arguments: string;
                     /**
                      * Name of the function to call.
                      */
-                    name?: string | null;
+                    name: string;
                 }
             }
-        }
-        /**
-         * A message representing the result of a tool invocation in an OpenAI-compatible
-         * chat completion request.
-         */
-        interface OpenAIToolMessageParam {
-            /**
-             * The response content from the tool.
-             */
-            content: string | Array<OpenAIToolMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
             /**
-             * Unique identifier for the tool call this response is for.
+             * A call to a custom tool created by the model.
              */
-            tool_call_id: string;
-            /**
-             * Must be 'tool' to identify this as a tool response.
-             */
-            role?: 'tool';
-        }
-        namespace OpenAIToolMessageParam {
-            /**
-             * Text content part for OpenAI-compatible chat completion messages.
-             */
-            interface ListOpenAIChatCompletionContentPartTextParam {
+            interface Custom {
                 /**
-                 * The text content of the message.
+                 * The ID of the tool call.
                  */
-                text: string;
+                id: string;
                 /**
-                 * Must be 'text' to identify this as text content.
+                 * The custom tool that the model called.
                  */
-                type?: 'text';
-            }
-        }
-        /**
-         * A message from the developer in an OpenAI-compatible chat completion request.
-         */
-        interface OpenAIDeveloperMessageParam {
-            /**
-             * The content of the developer message.
-             */
-            content: string | Array<OpenAIDeveloperMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
-            /**
-             * The name of the developer message participant.
-             */
-            name?: string | null;
-            /**
-             * Must be 'developer' to identify this as a developer message.
-             */
-            role?: 'developer';
-        }
-        namespace OpenAIDeveloperMessageParam {
-            /**
-             * Text content part for OpenAI-compatible chat completion messages.
-             */
-            interface ListOpenAIChatCompletionContentPartTextParam {
+                custom: Custom.Custom;
                 /**
-                 * The text content of the message.
+                 * The type of the tool. Always 'custom'.
                  */
-                text: string;
+                type: 'custom';
+            }
+            namespace Custom {
                 /**
-                 * Must be 'text' to identify this as text content.
+                 * The custom tool that the model called.
                  */
-                type?: 'text';
+                interface Custom {
+                    /**
+                     * The input for the custom tool call generated by the model.
+                     */
+                    input: string;
+                    /**
+                     * The name of the custom tool to call.
+                     */
+                    name: string;
+                }
             }
         }
         /**
-         * The log probabilities for the tokens in the message from an OpenAI-compatible
-         * chat completion response.
+         * The log probabilities for the tokens in the message.
          */
         interface Logprobs {
             /**
@@ -437,51 +307,54 @@ export declare namespace CompletionCreateResponse {
         }
     }
     /**
-     * Usage information for OpenAI chat completion.
+     * Token usage information for the completion.
      */
     interface Usage {
         /**
          * Number of tokens in the completion.
          */
-        completion_tokens: number;
+        completion_tokens?: number;
         /**
-         * Number of tokens in the prompt.
+         * Detailed breakdown of output token usage.
          */
-        prompt_tokens: number;
+        completion_tokens_details?: Usage.CompletionTokensDetails;
         /**
-         * Total tokens used (prompt + completion).
+         * Number of tokens in the prompt.
          */
-        total_tokens: number;
+        prompt_tokens?: number;
         /**
-         * Token details for output tokens in OpenAI chat completion usage.
+         * Detailed breakdown of input token usage.
          */
-        completion_tokens_details?: Usage.CompletionTokensDetails | null;
+        prompt_tokens_details?: Usage.PromptTokensDetails;
         /**
-         * Token details for prompt tokens in OpenAI chat completion usage.
+         * Total tokens used (prompt + completion).
          */
-        prompt_tokens_details?: Usage.PromptTokensDetails | null;
+        total_tokens?: number;
     }
     namespace Usage {
         /**
-         * Token details for output tokens in OpenAI chat completion usage.
+         * Detailed breakdown of output token usage.
          */
         interface CompletionTokensDetails {
             /**
              * Number of tokens used for reasoning (o1/o3 models).
              */
-            reasoning_tokens?: number | null;
+            reasoning_tokens?: number;
         }
         /**
-         * Token details for prompt tokens in OpenAI chat completion usage.
+         * Detailed breakdown of input token usage.
          */
         interface PromptTokensDetails {
             /**
              * Number of tokens retrieved from cache.
              */
-            cached_tokens?: number | null;
+            cached_tokens?: number;
         }
     }
 }
+/**
+ * Chat completion response extended with the original input messages.
+ */
 export interface CompletionRetrieveResponse {
     /**
      * The ID of the chat completion.
@@ -508,9 +381,17 @@ export interface CompletionRetrieveResponse {
      */
     object?: 'chat.completion';
     /**
-     * Usage information for OpenAI chat completion.
+     * The service tier that was used for this response.
+     */
+    service_tier?: string | null;
+    /**
+     * System fingerprint for this completion.
+     */
+    system_fingerprint?: string;
+    /**
+     * Token usage information for the completion.
      */
-    usage?: CompletionRetrieveResponse.Usage | null;
+    usage?: CompletionRetrieveResponse.Usage;
 }
 export declare namespace CompletionRetrieveResponse {
     /**
@@ -518,287 +399,141 @@ export declare namespace CompletionRetrieveResponse {
      */
     interface Choice {
         /**
-         * The reason the model stopped generating.
-         */
-        finish_reason: 'stop' | 'length' | 'tool_calls' | 'content_filter' | 'function_call';
-        /**
-         * The index of the choice.
-         */
-        index: number;
-        /**
-         * The message from the model.
-         */
-        message: Choice.OpenAIUserMessageParamOutput | Choice.OpenAISystemMessageParam | Choice.OpenAIAssistantMessageParamOutput | Choice.OpenAIToolMessageParam | Choice.OpenAIDeveloperMessageParam;
-        /**
-         * The log probabilities for the tokens in the message from an OpenAI-compatible
-         * chat completion response.
-         */
-        logprobs?: Choice.Logprobs | null;
-    }
-    namespace Choice {
-        /**
-         * A message from the user in an OpenAI-compatible chat completion request.
-         */
-        interface OpenAIUserMessageParamOutput {
-            /**
-             * The content of the message, which can include text and other media.
-             */
-            content: string | Array<OpenAIUserMessageParamOutput.OpenAIChatCompletionContentPartTextParam | OpenAIUserMessageParamOutput.OpenAIChatCompletionContentPartImageParam | OpenAIUserMessageParamOutput.OpenAIFile>;
-            /**
-             * The name of the user message participant.
-             */
-            name?: string | null;
-            /**
-             * Must be 'user' to identify this as a user message.
-             */
-            role?: 'user';
-        }
-        namespace OpenAIUserMessageParamOutput {
-            /**
-             * Text content part for OpenAI-compatible chat completion messages.
-             */
-            interface OpenAIChatCompletionContentPartTextParam {
-                /**
-                 * The text content of the message.
-                 */
-                text: string;
-                /**
-                 * Must be 'text' to identify this as text content.
-                 */
-                type?: 'text';
-            }
-            /**
-             * Image content part for OpenAI-compatible chat completion messages.
-             */
-            interface OpenAIChatCompletionContentPartImageParam {
-                /**
-                 * Image URL specification and processing details.
-                 */
-                image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
-                /**
-                 * Must be 'image_url' to identify this as image content.
-                 */
-                type?: 'image_url';
-            }
-            namespace OpenAIChatCompletionContentPartImageParam {
-                /**
-                 * Image URL specification and processing details.
-                 */
-                interface ImageURL {
-                    /**
-                     * URL of the image to include in the message.
-                     */
-                    url: string;
-                    /**
-                     * Level of detail for image processing. Can be 'low', 'high', or 'auto'.
-                     */
-                    detail?: 'low' | 'high' | 'auto' | null;
-                }
-            }
-            interface OpenAIFile {
-                /**
-                 * File specification.
-                 */
-                file: OpenAIFile.File;
-                /**
-                 * Must be 'file' to identify this as file content.
-                 */
-                type?: 'file';
-            }
-            namespace OpenAIFile {
-                /**
-                 * File specification.
-                 */
-                interface File {
-                    /**
-                     * Base64-encoded file data.
-                     */
-                    file_data?: string | null;
-                    /**
-                     * ID of an uploaded file.
-                     */
-                    file_id?: string | null;
-                    /**
-                     * Name of the file.
-                     */
-                    filename?: string | null;
-                }
-            }
-        }
-        /**
-         * A system message providing instructions or context to the model.
+         * The reason the model stopped generating.
          */
-        interface OpenAISystemMessageParam {
-            /**
-             * The content of the 'system prompt'. If multiple system messages are provided,
-             * they are concatenated.
-             */
-            content: string | Array<OpenAISystemMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
+        finish_reason: 'stop' | 'length' | 'tool_calls' | 'content_filter' | 'function_call';
+        /**
+         * The index of the choice.
+         */
+        index: number;
+        /**
+         * The message from the model.
+         */
+        message: Choice.Message;
+        /**
+         * The log probabilities for the tokens in the message.
+         */
+        logprobs?: Choice.Logprobs | null;
+    }
+    namespace Choice {
+        /**
+         * The message from the model.
+         */
+        interface Message {
             /**
-             * The name of the system message participant.
+             * Annotations for the message, when applicable.
              */
-            name?: string | null;
+            annotations?: Array<{
+                [key: string]: unknown;
+            }>;
             /**
-             * Must be 'system' to identify this as a system message.
+             * Audio response data when using audio output modality.
              */
-            role?: 'system';
-        }
-        namespace OpenAISystemMessageParam {
+            audio?: {
+                [key: string]: unknown;
+            } | null;
             /**
-             * Text content part for OpenAI-compatible chat completion messages.
+             * The content of the message.
              */
-            interface ListOpenAIChatCompletionContentPartTextParam {
-                /**
-                 * The text content of the message.
-                 */
-                text: string;
-                /**
-                 * Must be 'text' to identify this as text content.
-                 */
-                type?: 'text';
-            }
-        }
-        /**
-         * A message containing the model's (assistant) response in an OpenAI-compatible
-         * chat completion request.
-         */
-        interface OpenAIAssistantMessageParamOutput {
+            content?: string | null;
             /**
-             * The content of the model's response.
+             * Deprecated: the name and arguments of a function that should be called.
              */
-            content?: string | Array<OpenAIAssistantMessageParamOutput.ListOpenAIChatCompletionContentPartTextParam> | null;
+            function_call?: Message.FunctionCall;
             /**
-             * The name of the assistant message participant.
+             * The refusal message generated by the model.
              */
-            name?: string | null;
+            refusal?: string | null;
             /**
-             * Must be 'assistant' to identify this as the model's response.
+             * The role of the message author, always 'assistant' in responses.
              */
             role?: 'assistant';
             /**
-             * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
+             * The tool calls generated by the model.
              */
-            tool_calls?: Array<OpenAIAssistantMessageParamOutput.ToolCall> | null;
+            tool_calls?: Array<Message.Function | Message.Custom>;
         }
-        namespace OpenAIAssistantMessageParamOutput {
+        namespace Message {
             /**
-             * Text content part for OpenAI-compatible chat completion messages.
+             * Deprecated: the name and arguments of a function that should be called.
              */
-            interface ListOpenAIChatCompletionContentPartTextParam {
+            interface FunctionCall {
                 /**
-                 * The text content of the message.
+                 * Arguments to pass to the function as a JSON string.
                  */
-                text: string;
+                arguments: string;
                 /**
-                 * Must be 'text' to identify this as text content.
+                 * Name of the function to call.
                  */
-                type?: 'text';
+                name: string;
             }
             /**
              * Tool call specification for OpenAI-compatible chat completion responses.
              */
-            interface ToolCall {
+            interface Function {
                 /**
                  * Unique identifier for the tool call.
                  */
-                id?: string | null;
+                id: string;
                 /**
-                 * Function call details for OpenAI-compatible tool calls.
+                 * Function call details.
                  */
-                function?: ToolCall.Function | null;
-                /**
-                 * Index of the tool call in the list.
-                 */
-                index?: number | null;
+                function: Function.Function;
                 /**
                  * Must be 'function' to identify this as a function call.
                  */
-                type?: 'function';
+                type: 'function';
             }
-            namespace ToolCall {
+            namespace Function {
                 /**
-                 * Function call details for OpenAI-compatible tool calls.
+                 * Function call details.
                  */
                 interface Function {
                     /**
                      * Arguments to pass to the function as a JSON string.
                      */
-                    arguments?: string | null;
+                    arguments: string;
                     /**
                      * Name of the function to call.
                      */
-                    name?: string | null;
+                    name: string;
                 }
             }
-        }
-        /**
-         * A message representing the result of a tool invocation in an OpenAI-compatible
-         * chat completion request.
-         */
-        interface OpenAIToolMessageParam {
-            /**
-             * The response content from the tool.
-             */
-            content: string | Array<OpenAIToolMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
-            /**
-             * Unique identifier for the tool call this response is for.
-             */
-            tool_call_id: string;
-            /**
-             * Must be 'tool' to identify this as a tool response.
-             */
-            role?: 'tool';
-        }
-        namespace OpenAIToolMessageParam {
             /**
-             * Text content part for OpenAI-compatible chat completion messages.
+             * A call to a custom tool created by the model.
              */
-            interface ListOpenAIChatCompletionContentPartTextParam {
+            interface Custom {
                 /**
-                 * The text content of the message.
+                 * The ID of the tool call.
                  */
-                text: string;
+                id: string;
                 /**
-                 * Must be 'text' to identify this as text content.
+                 * The custom tool that the model called.
                  */
-                type?: 'text';
-            }
-        }
-        /**
-         * A message from the developer in an OpenAI-compatible chat completion request.
-         */
-        interface OpenAIDeveloperMessageParam {
-            /**
-             * The content of the developer message.
-             */
-            content: string | Array<OpenAIDeveloperMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
-            /**
-             * The name of the developer message participant.
-             */
-            name?: string | null;
-            /**
-             * Must be 'developer' to identify this as a developer message.
-             */
-            role?: 'developer';
-        }
-        namespace OpenAIDeveloperMessageParam {
-            /**
-             * Text content part for OpenAI-compatible chat completion messages.
-             */
-            interface ListOpenAIChatCompletionContentPartTextParam {
+                custom: Custom.Custom;
                 /**
-                 * The text content of the message.
+                 * The type of the tool. Always 'custom'.
                  */
-                text: string;
+                type: 'custom';
+            }
+            namespace Custom {
                 /**
-                 * Must be 'text' to identify this as text content.
+                 * The custom tool that the model called.
                  */
-                type?: 'text';
+                interface Custom {
+                    /**
+                     * The input for the custom tool call generated by the model.
+                     */
+                    input: string;
+                    /**
+                     * The name of the custom tool to call.
+                     */
+                    name: string;
+                }
             }
         }
         /**
-         * The log probabilities for the tokens in the message from an OpenAI-compatible
-         * chat completion response.
+         * The log probabilities for the tokens in the message.
          */
         interface Logprobs {
             /**
@@ -956,6 +691,9 @@ export declare namespace CompletionRetrieveResponse {
                 detail?: 'low' | 'high' | 'auto' | null;
             }
         }
+        /**
+         * File content part for OpenAI-compatible chat completion messages.
+         */
         interface OpenAIFile {
             /**
              * File specification.
@@ -1040,6 +778,7 @@ export declare namespace CompletionRetrieveResponse {
          * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
          */
         tool_calls?: Array<OpenAIAssistantMessageParamOutput.ToolCall> | null;
+        [k: string]: unknown;
     }
     namespace OpenAIAssistantMessageParamOutput {
         /**
@@ -1062,33 +801,29 @@ export declare namespace CompletionRetrieveResponse {
             /**
              * Unique identifier for the tool call.
              */
-            id?: string | null;
-            /**
-             * Function call details for OpenAI-compatible tool calls.
-             */
-            function?: ToolCall.Function | null;
+            id: string;
             /**
-             * Index of the tool call in the list.
+             * Function call details.
              */
-            index?: number | null;
+            function: ToolCall.Function;
             /**
              * Must be 'function' to identify this as a function call.
              */
-            type?: 'function';
+            type: 'function';
         }
         namespace ToolCall {
             /**
-             * Function call details for OpenAI-compatible tool calls.
+             * Function call details.
              */
             interface Function {
                 /**
                  * Arguments to pass to the function as a JSON string.
                  */
-                arguments?: string | null;
+                arguments: string;
                 /**
                  * Name of the function to call.
                  */
-                name?: string | null;
+                name: string;
             }
         }
     }
@@ -1158,48 +893,48 @@ export declare namespace CompletionRetrieveResponse {
         }
     }
     /**
-     * Usage information for OpenAI chat completion.
+     * Token usage information for the completion.
      */
     interface Usage {
         /**
          * Number of tokens in the completion.
          */
-        completion_tokens: number;
+        completion_tokens?: number;
         /**
-         * Number of tokens in the prompt.
+         * Detailed breakdown of output token usage.
          */
-        prompt_tokens: number;
+        completion_tokens_details?: Usage.CompletionTokensDetails;
         /**
-         * Total tokens used (prompt + completion).
+         * Number of tokens in the prompt.
          */
-        total_tokens: number;
+        prompt_tokens?: number;
         /**
-         * Token details for output tokens in OpenAI chat completion usage.
+         * Detailed breakdown of input token usage.
          */
-        completion_tokens_details?: Usage.CompletionTokensDetails | null;
+        prompt_tokens_details?: Usage.PromptTokensDetails;
         /**
-         * Token details for prompt tokens in OpenAI chat completion usage.
+         * Total tokens used (prompt + completion).
          */
-        prompt_tokens_details?: Usage.PromptTokensDetails | null;
+        total_tokens?: number;
     }
     namespace Usage {
         /**
-         * Token details for output tokens in OpenAI chat completion usage.
+         * Detailed breakdown of output token usage.
          */
         interface CompletionTokensDetails {
             /**
              * Number of tokens used for reasoning (o1/o3 models).
              */
-            reasoning_tokens?: number | null;
+            reasoning_tokens?: number;
         }
         /**
-         * Token details for prompt tokens in OpenAI chat completion usage.
+         * Detailed breakdown of input token usage.
          */
         interface PromptTokensDetails {
             /**
              * Number of tokens retrieved from cache.
              */
-            cached_tokens?: number | null;
+            cached_tokens?: number;
         }
     }
 }
@@ -1229,6 +964,9 @@ export interface CompletionListResponse {
     object?: 'list';
 }
 export declare namespace CompletionListResponse {
+    /**
+     * Chat completion response extended with the original input messages.
+     */
     interface Data {
         /**
          * The ID of the chat completion.
@@ -1255,9 +993,17 @@ export declare namespace CompletionListResponse {
          */
         object?: 'chat.completion';
         /**
-         * Usage information for OpenAI chat completion.
+         * The service tier that was used for this response.
+         */
+        service_tier?: string | null;
+        /**
+         * System fingerprint for this completion.
+         */
+        system_fingerprint?: string;
+        /**
+         * Token usage information for the completion.
          */
-        usage?: Data.Usage | null;
+        usage?: Data.Usage;
     }
     namespace Data {
         /**
@@ -1275,277 +1021,131 @@ export declare namespace CompletionListResponse {
             /**
              * The message from the model.
              */
-            message: Choice.OpenAIUserMessageParamOutput | Choice.OpenAISystemMessageParam | Choice.OpenAIAssistantMessageParamOutput | Choice.OpenAIToolMessageParam | Choice.OpenAIDeveloperMessageParam;
+            message: Choice.Message;
             /**
-             * The log probabilities for the tokens in the message from an OpenAI-compatible
-             * chat completion response.
+             * The log probabilities for the tokens in the message.
              */
             logprobs?: Choice.Logprobs | null;
         }
         namespace Choice {
             /**
-             * A message from the user in an OpenAI-compatible chat completion request.
-             */
-            interface OpenAIUserMessageParamOutput {
-                /**
-                 * The content of the message, which can include text and other media.
-                 */
-                content: string | Array<OpenAIUserMessageParamOutput.OpenAIChatCompletionContentPartTextParam | OpenAIUserMessageParamOutput.OpenAIChatCompletionContentPartImageParam | OpenAIUserMessageParamOutput.OpenAIFile>;
-                /**
-                 * The name of the user message participant.
-                 */
-                name?: string | null;
-                /**
-                 * Must be 'user' to identify this as a user message.
-                 */
-                role?: 'user';
-            }
-            namespace OpenAIUserMessageParamOutput {
-                /**
-                 * Text content part for OpenAI-compatible chat completion messages.
-                 */
-                interface OpenAIChatCompletionContentPartTextParam {
-                    /**
-                     * The text content of the message.
-                     */
-                    text: string;
-                    /**
-                     * Must be 'text' to identify this as text content.
-                     */
-                    type?: 'text';
-                }
-                /**
-                 * Image content part for OpenAI-compatible chat completion messages.
-                 */
-                interface OpenAIChatCompletionContentPartImageParam {
-                    /**
-                     * Image URL specification and processing details.
-                     */
-                    image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
-                    /**
-                     * Must be 'image_url' to identify this as image content.
-                     */
-                    type?: 'image_url';
-                }
-                namespace OpenAIChatCompletionContentPartImageParam {
-                    /**
-                     * Image URL specification and processing details.
-                     */
-                    interface ImageURL {
-                        /**
-                         * URL of the image to include in the message.
-                         */
-                        url: string;
-                        /**
-                         * Level of detail for image processing. Can be 'low', 'high', or 'auto'.
-                         */
-                        detail?: 'low' | 'high' | 'auto' | null;
-                    }
-                }
-                interface OpenAIFile {
-                    /**
-                     * File specification.
-                     */
-                    file: OpenAIFile.File;
-                    /**
-                     * Must be 'file' to identify this as file content.
-                     */
-                    type?: 'file';
-                }
-                namespace OpenAIFile {
-                    /**
-                     * File specification.
-                     */
-                    interface File {
-                        /**
-                         * Base64-encoded file data.
-                         */
-                        file_data?: string | null;
-                        /**
-                         * ID of an uploaded file.
-                         */
-                        file_id?: string | null;
-                        /**
-                         * Name of the file.
-                         */
-                        filename?: string | null;
-                    }
-                }
-            }
-            /**
-             * A system message providing instructions or context to the model.
+             * The message from the model.
              */
-            interface OpenAISystemMessageParam {
-                /**
-                 * The content of the 'system prompt'. If multiple system messages are provided,
-                 * they are concatenated.
-                 */
-                content: string | Array<OpenAISystemMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
+            interface Message {
                 /**
-                 * The name of the system message participant.
+                 * Annotations for the message, when applicable.
                  */
-                name?: string | null;
+                annotations?: Array<{
+                    [key: string]: unknown;
+                }>;
                 /**
-                 * Must be 'system' to identify this as a system message.
+                 * Audio response data when using audio output modality.
                  */
-                role?: 'system';
-            }
-            namespace OpenAISystemMessageParam {
+                audio?: {
+                    [key: string]: unknown;
+                } | null;
                 /**
-                 * Text content part for OpenAI-compatible chat completion messages.
+                 * The content of the message.
                  */
-                interface ListOpenAIChatCompletionContentPartTextParam {
-                    /**
-                     * The text content of the message.
-                     */
-                    text: string;
-                    /**
-                     * Must be 'text' to identify this as text content.
-                     */
-                    type?: 'text';
-                }
-            }
-            /**
-             * A message containing the model's (assistant) response in an OpenAI-compatible
-             * chat completion request.
-             */
-            interface OpenAIAssistantMessageParamOutput {
+                content?: string | null;
                 /**
-                 * The content of the model's response.
+                 * Deprecated: the name and arguments of a function that should be called.
                  */
-                content?: string | Array<OpenAIAssistantMessageParamOutput.ListOpenAIChatCompletionContentPartTextParam> | null;
+                function_call?: Message.FunctionCall;
                 /**
-                 * The name of the assistant message participant.
+                 * The refusal message generated by the model.
                  */
-                name?: string | null;
+                refusal?: string | null;
                 /**
-                 * Must be 'assistant' to identify this as the model's response.
+                 * The role of the message author, always 'assistant' in responses.
                  */
                 role?: 'assistant';
                 /**
-                 * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
+                 * The tool calls generated by the model.
                  */
-                tool_calls?: Array<OpenAIAssistantMessageParamOutput.ToolCall> | null;
+                tool_calls?: Array<Message.Function | Message.Custom>;
             }
-            namespace OpenAIAssistantMessageParamOutput {
+            namespace Message {
                 /**
-                 * Text content part for OpenAI-compatible chat completion messages.
+                 * Deprecated: the name and arguments of a function that should be called.
                  */
-                interface ListOpenAIChatCompletionContentPartTextParam {
+                interface FunctionCall {
                     /**
-                     * The text content of the message.
+                     * Arguments to pass to the function as a JSON string.
                      */
-                    text: string;
+                    arguments: string;
                     /**
-                     * Must be 'text' to identify this as text content.
+                     * Name of the function to call.
                      */
-                    type?: 'text';
+                    name: string;
                 }
                 /**
                  * Tool call specification for OpenAI-compatible chat completion responses.
                  */
-                interface ToolCall {
+                interface Function {
                     /**
                      * Unique identifier for the tool call.
                      */
-                    id?: string | null;
+                    id: string;
                     /**
-                     * Function call details for OpenAI-compatible tool calls.
+                     * Function call details.
                      */
-                    function?: ToolCall.Function | null;
-                    /**
-                     * Index of the tool call in the list.
-                     */
-                    index?: number | null;
+                    function: Function.Function;
                     /**
                      * Must be 'function' to identify this as a function call.
                      */
-                    type?: 'function';
+                    type: 'function';
                 }
-                namespace ToolCall {
+                namespace Function {
                     /**
-                     * Function call details for OpenAI-compatible tool calls.
+                     * Function call details.
                      */
                     interface Function {
                         /**
                          * Arguments to pass to the function as a JSON string.
                          */
-                        arguments?: string | null;
+                        arguments: string;
                         /**
                          * Name of the function to call.
                          */
-                        name?: string | null;
+                        name: string;
                     }
                 }
-            }
-            /**
-             * A message representing the result of a tool invocation in an OpenAI-compatible
-             * chat completion request.
-             */
-            interface OpenAIToolMessageParam {
-                /**
-                 * The response content from the tool.
-                 */
-                content: string | Array<OpenAIToolMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
-                /**
-                 * Unique identifier for the tool call this response is for.
-                 */
-                tool_call_id: string;
-                /**
-                 * Must be 'tool' to identify this as a tool response.
-                 */
-                role?: 'tool';
-            }
-            namespace OpenAIToolMessageParam {
                 /**
-                 * Text content part for OpenAI-compatible chat completion messages.
+                 * A call to a custom tool created by the model.
                  */
-                interface ListOpenAIChatCompletionContentPartTextParam {
+                interface Custom {
                     /**
-                     * The text content of the message.
+                     * The ID of the tool call.
                      */
-                    text: string;
+                    id: string;
                     /**
-                     * Must be 'text' to identify this as text content.
+                     * The custom tool that the model called.
                      */
-                    type?: 'text';
-                }
-            }
-            /**
-             * A message from the developer in an OpenAI-compatible chat completion request.
-             */
-            interface OpenAIDeveloperMessageParam {
-                /**
-                 * The content of the developer message.
-                 */
-                content: string | Array<OpenAIDeveloperMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
-                /**
-                 * The name of the developer message participant.
-                 */
-                name?: string | null;
-                /**
-                 * Must be 'developer' to identify this as a developer message.
-                 */
-                role?: 'developer';
-            }
-            namespace OpenAIDeveloperMessageParam {
-                /**
-                 * Text content part for OpenAI-compatible chat completion messages.
-                 */
-                interface ListOpenAIChatCompletionContentPartTextParam {
+                    custom: Custom.Custom;
                     /**
-                     * The text content of the message.
+                     * The type of the tool. Always 'custom'.
                      */
-                    text: string;
+                    type: 'custom';
+                }
+                namespace Custom {
                     /**
-                     * Must be 'text' to identify this as text content.
+                     * The custom tool that the model called.
                      */
-                    type?: 'text';
+                    interface Custom {
+                        /**
+                         * The input for the custom tool call generated by the model.
+                         */
+                        input: string;
+                        /**
+                         * The name of the custom tool to call.
+                         */
+                        name: string;
+                    }
                 }
             }
             /**
-             * The log probabilities for the tokens in the message from an OpenAI-compatible
-             * chat completion response.
+             * The log probabilities for the tokens in the message.
              */
             interface Logprobs {
                 /**
@@ -1703,6 +1303,9 @@ export declare namespace CompletionListResponse {
                     detail?: 'low' | 'high' | 'auto' | null;
                 }
             }
+            /**
+             * File content part for OpenAI-compatible chat completion messages.
+             */
             interface OpenAIFile {
                 /**
                  * File specification.
@@ -1787,6 +1390,7 @@ export declare namespace CompletionListResponse {
              * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
              */
             tool_calls?: Array<OpenAIAssistantMessageParamOutput.ToolCall> | null;
+            [k: string]: unknown;
         }
         namespace OpenAIAssistantMessageParamOutput {
             /**
@@ -1809,33 +1413,29 @@ export declare namespace CompletionListResponse {
                 /**
                  * Unique identifier for the tool call.
                  */
-                id?: string | null;
-                /**
-                 * Function call details for OpenAI-compatible tool calls.
-                 */
-                function?: ToolCall.Function | null;
+                id: string;
                 /**
-                 * Index of the tool call in the list.
+                 * Function call details.
                  */
-                index?: number | null;
+                function: ToolCall.Function;
                 /**
                  * Must be 'function' to identify this as a function call.
                  */
-                type?: 'function';
+                type: 'function';
             }
             namespace ToolCall {
                 /**
-                 * Function call details for OpenAI-compatible tool calls.
+                 * Function call details.
                  */
                 interface Function {
                     /**
                      * Arguments to pass to the function as a JSON string.
                      */
-                    arguments?: string | null;
+                    arguments: string;
                     /**
                      * Name of the function to call.
                      */
-                    name?: string | null;
+                    name: string;
                 }
             }
         }
@@ -1905,48 +1505,48 @@ export declare namespace CompletionListResponse {
             }
         }
         /**
-         * Usage information for OpenAI chat completion.
+         * Token usage information for the completion.
          */
         interface Usage {
             /**
              * Number of tokens in the completion.
              */
-            completion_tokens: number;
+            completion_tokens?: number;
             /**
-             * Number of tokens in the prompt.
+             * Detailed breakdown of output token usage.
              */
-            prompt_tokens: number;
+            completion_tokens_details?: Usage.CompletionTokensDetails;
             /**
-             * Total tokens used (prompt + completion).
+             * Number of tokens in the prompt.
              */
-            total_tokens: number;
+            prompt_tokens?: number;
             /**
-             * Token details for output tokens in OpenAI chat completion usage.
+             * Detailed breakdown of input token usage.
              */
-            completion_tokens_details?: Usage.CompletionTokensDetails | null;
+            prompt_tokens_details?: Usage.PromptTokensDetails;
             /**
-             * Token details for prompt tokens in OpenAI chat completion usage.
+             * Total tokens used (prompt + completion).
              */
-            prompt_tokens_details?: Usage.PromptTokensDetails | null;
+            total_tokens?: number;
         }
         namespace Usage {
             /**
-             * Token details for output tokens in OpenAI chat completion usage.
+             * Detailed breakdown of output token usage.
              */
             interface CompletionTokensDetails {
                 /**
                  * Number of tokens used for reasoning (o1/o3 models).
                  */
-                reasoning_tokens?: number | null;
+                reasoning_tokens?: number;
             }
             /**
-             * Token details for prompt tokens in OpenAI chat completion usage.
+             * Detailed breakdown of input token usage.
              */
             interface PromptTokensDetails {
                 /**
                  * Number of tokens retrieved from cache.
                  */
-                cached_tokens?: number | null;
+                cached_tokens?: number;
             }
         }
     }
@@ -2007,6 +1607,10 @@ export interface CompletionCreateParamsBase {
      * The penalty for repeated tokens.
      */
     presence_penalty?: number | null;
+    /**
+     * A key to use when reading from or writing to the prompt cache.
+     */
+    prompt_cache_key?: string | null;
     /**
      * The effort level for reasoning models.
      */
@@ -2023,6 +1627,10 @@ export interface CompletionCreateParamsBase {
      * The seed to use.
      */
     seed?: number | null;
+    /**
+     * The service tier for the request.
+     */
+    service_tier?: 'auto' | 'default' | 'flex' | 'priority' | null;
     /**
      * The stop tokens to use.
      */
@@ -2054,7 +1662,7 @@ export interface CompletionCreateParamsBase {
         [key: string]: unknown;
     }> | null;
     /**
-     * The top log probabilities to use.
+     * The number of most likely tokens to return at each position.
      */
     top_logprobs?: number | null;
     /**
@@ -2127,6 +1735,9 @@ export declare namespace CompletionCreateParams {
                 detail?: 'low' | 'high' | 'auto' | null;
             }
         }
+        /**
+         * File content part for OpenAI-compatible chat completion messages.
+         */
         interface OpenAIFile {
             /**
              * File specification.
@@ -2211,6 +1822,7 @@ export declare namespace CompletionCreateParams {
          * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
          */
         tool_calls?: Array<OpenAIAssistantMessageParamInput.ToolCall> | null;
+        [k: string]: unknown;
     }
     namespace OpenAIAssistantMessageParamInput {
         /**
@@ -2233,33 +1845,29 @@ export declare namespace CompletionCreateParams {
             /**
              * Unique identifier for the tool call.
              */
-            id?: string | null;
-            /**
-             * Function call details for OpenAI-compatible tool calls.
-             */
-            function?: ToolCall.Function | null;
+            id: string;
             /**
-             * Index of the tool call in the list.
+             * Function call details.
              */
-            index?: number | null;
+            function: ToolCall.Function;
             /**
              * Must be 'function' to identify this as a function call.
              */
-            type?: 'function';
+            type: 'function';
         }
         namespace ToolCall {
             /**
-             * Function call details for OpenAI-compatible tool calls.
+             * Function call details.
              */
             interface Function {
                 /**
                  * Arguments to pass to the function as a JSON string.
                  */
-                arguments?: string | null;
+                arguments: string;
                 /**
                  * Name of the function to call.
                  */
-                name?: string | null;
+                name: string;
             }
         }
     }
@@ -2403,7 +2011,7 @@ export interface CompletionListParams {
      */
     model?: string | null;
     /**
-     * Sort order for paginated responses.
+     * The order to sort the chat completions by: "asc" or "desc". Defaults to "desc".
      */
     order?: 'asc' | 'desc' | null;
 }