llama-stack-client 0.6.1 → 0.7.1

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

@@ -14,6 +14,14 @@ import * as CompletionsAPI from './completions';
 import * as ChatAPI from './chat';
 import { Stream } from '../../streaming';
 
+/**
+ * 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 class Completions extends APIResource {
   /**
    * Generate an OpenAI-compatible chat completion for the given messages using the
@@ -93,7 +101,17 @@ 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;
 }
@@ -116,334 +134,148 @@ export 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;
   }
 
   export namespace Choice {
     /**
-     * A message from the user in an OpenAI-compatible chat completion request.
-     */
-    export 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';
-    }
-
-    export namespace OpenAIUserMessageParamOutput {
-      /**
-       * Text content part for OpenAI-compatible chat completion messages.
-       */
-      export 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.
-       */
-      export 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';
-      }
-
-      export namespace OpenAIChatCompletionContentPartImageParam {
-        /**
-         * Image URL specification and processing details.
-         */
-        export 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;
-        }
-      }
-
-      export interface OpenAIFile {
-        /**
-         * File specification.
-         */
-        file: OpenAIFile.File;
-
-        /**
-         * Must be 'file' to identify this as file content.
-         */
-        type?: 'file';
-      }
-
-      export namespace OpenAIFile {
-        /**
-         * File specification.
-         */
-        export 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.
      */
-    export interface OpenAISystemMessageParam {
+    export 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.
-       */
-      name?: string | null;
-
-      /**
-       * Must be 'system' to identify this as a system message.
+       * Audio response data when using audio output modality.
        */
-      role?: 'system';
-    }
+      audio?: { [key: string]: unknown } | null;
 
-    export namespace OpenAISystemMessageParam {
       /**
-       * Text content part for OpenAI-compatible chat completion messages.
+       * The content of the message.
        */
-      export interface ListOpenAIChatCompletionContentPartTextParam {
-        /**
-         * The text content of the message.
-         */
-        text: string;
-
-        /**
-         * Must be 'text' to identify this as text content.
-         */
-        type?: 'text';
-      }
-    }
+      content?: string | null;
 
-    /**
-     * A message containing the model's (assistant) response in an OpenAI-compatible
-     * chat completion request.
-     */
-    export interface OpenAIAssistantMessageParamOutput {
       /**
-       * 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>;
     }
 
-    export namespace OpenAIAssistantMessageParamOutput {
+    export namespace Message {
       /**
-       * Text content part for OpenAI-compatible chat completion messages.
+       * Deprecated: the name and arguments of a function that should be called.
        */
-      export interface ListOpenAIChatCompletionContentPartTextParam {
+      export 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.
        */
-      export interface ToolCall {
+      export 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';
       }
 
-      export namespace ToolCall {
+      export namespace Function {
         /**
-         * Function call details for OpenAI-compatible tool calls.
+         * Function call details.
          */
         export 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.
-     */
-    export 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.
+       * A call to a custom tool created by the model.
        */
-      role?: 'tool';
-    }
-
-    export namespace OpenAIToolMessageParam {
-      /**
-       * Text content part for OpenAI-compatible chat completion messages.
-       */
-      export interface ListOpenAIChatCompletionContentPartTextParam {
+      export 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';
-      }
-    }
+        custom: Custom.Custom;
 
-    /**
-     * A message from the developer in an OpenAI-compatible chat completion request.
-     */
-    export 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';
-    }
-
-    export namespace OpenAIDeveloperMessageParam {
-      /**
-       * Text content part for OpenAI-compatible chat completion messages.
-       */
-      export interface ListOpenAIChatCompletionContentPartTextParam {
         /**
-         * The text content of the message.
+         * The type of the tool. Always 'custom'.
          */
-        text: string;
+        type: 'custom';
+      }
 
+      export namespace Custom {
         /**
-         * Must be 'text' to identify this as text content.
+         * The custom tool that the model called.
          */
-        type?: 'text';
+        export 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.
      */
     export interface Logprobs {
       /**
@@ -559,58 +391,61 @@ export namespace CompletionCreateResponse {
   }
 
   /**
-   * Usage information for OpenAI chat completion.
+   * Token usage information for the completion.
    */
   export 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;
   }
 
   export namespace Usage {
     /**
-     * Token details for output tokens in OpenAI chat completion usage.
+     * Detailed breakdown of output token usage.
      */
     export 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.
      */
     export 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.
@@ -649,9 +484,19 @@ export interface CompletionRetrieveResponse {
   object?: 'chat.completion';
 
   /**
-   * Usage information for OpenAI chat completion.
+   * The service tier that was used for this response.
    */
-  usage?: CompletionRetrieveResponse.Usage | null;
+  service_tier?: string | null;
+
+  /**
+   * System fingerprint for this completion.
+   */
+  system_fingerprint?: string;
+
+  /**
+   * Token usage information for the completion.
+   */
+  usage?: CompletionRetrieveResponse.Usage;
 }
 
 export namespace CompletionRetrieveResponse {
@@ -672,334 +517,148 @@ export namespace CompletionRetrieveResponse {
     /**
      * 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;
   }
 
   export namespace Choice {
     /**
-     * A message from the user in an OpenAI-compatible chat completion request.
-     */
-    export 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';
-    }
-
-    export namespace OpenAIUserMessageParamOutput {
-      /**
-       * Text content part for OpenAI-compatible chat completion messages.
-       */
-      export 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.
-       */
-      export 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';
-      }
-
-      export namespace OpenAIChatCompletionContentPartImageParam {
-        /**
-         * Image URL specification and processing details.
-         */
-        export 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;
-        }
-      }
-
-      export interface OpenAIFile {
-        /**
-         * File specification.
-         */
-        file: OpenAIFile.File;
-
-        /**
-         * Must be 'file' to identify this as file content.
-         */
-        type?: 'file';
-      }
-
-      export namespace OpenAIFile {
-        /**
-         * File specification.
-         */
-        export 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.
      */
-    export interface OpenAISystemMessageParam {
-      /**
-       * The content of the 'system prompt'. If multiple system messages are provided,
-       * they are concatenated.
-       */
-      content: string | Array<OpenAISystemMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
-
+    export 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';
-    }
+      audio?: { [key: string]: unknown } | null;
 
-    export namespace OpenAISystemMessageParam {
       /**
-       * Text content part for OpenAI-compatible chat completion messages.
+       * The content of the message.
        */
-      export interface ListOpenAIChatCompletionContentPartTextParam {
-        /**
-         * The text content of the message.
-         */
-        text: string;
-
-        /**
-         * Must be 'text' to identify this as text content.
-         */
-        type?: 'text';
-      }
-    }
+      content?: string | null;
 
-    /**
-     * A message containing the model's (assistant) response in an OpenAI-compatible
-     * chat completion request.
-     */
-    export interface OpenAIAssistantMessageParamOutput {
       /**
-       * 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>;
     }
 
-    export namespace OpenAIAssistantMessageParamOutput {
+    export namespace Message {
       /**
-       * Text content part for OpenAI-compatible chat completion messages.
+       * Deprecated: the name and arguments of a function that should be called.
        */
-      export interface ListOpenAIChatCompletionContentPartTextParam {
+      export 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.
        */
-      export interface ToolCall {
+      export 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';
       }
 
-      export namespace ToolCall {
+      export namespace Function {
         /**
-         * Function call details for OpenAI-compatible tool calls.
+         * Function call details.
          */
         export 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.
-     */
-    export 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';
-    }
 
-    export namespace OpenAIToolMessageParam {
       /**
-       * Text content part for OpenAI-compatible chat completion messages.
+       * A call to a custom tool created by the model.
        */
-      export interface ListOpenAIChatCompletionContentPartTextParam {
+      export 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.
-     */
-    export 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';
-    }
+        custom: Custom.Custom;
 
-    export namespace OpenAIDeveloperMessageParam {
-      /**
-       * Text content part for OpenAI-compatible chat completion messages.
-       */
-      export interface ListOpenAIChatCompletionContentPartTextParam {
         /**
-         * The text content of the message.
+         * The type of the tool. Always 'custom'.
          */
-        text: string;
+        type: 'custom';
+      }
 
+      export namespace Custom {
         /**
-         * Must be 'text' to identify this as text content.
+         * The custom tool that the model called.
          */
-        type?: 'text';
+        export 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.
      */
     export interface Logprobs {
       /**
@@ -1188,6 +847,9 @@ export namespace CompletionRetrieveResponse {
       }
     }
 
+    /**
+     * File content part for OpenAI-compatible chat completion messages.
+     */
     export interface OpenAIFile {
       /**
        * File specification.
@@ -1288,6 +950,8 @@ export namespace CompletionRetrieveResponse {
      * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
      */
     tool_calls?: Array<OpenAIAssistantMessageParamOutput.ToolCall> | null;
+
+    [k: string]: unknown;
   }
 
   export namespace OpenAIAssistantMessageParamOutput {
@@ -1313,38 +977,33 @@ export namespace CompletionRetrieveResponse {
       /**
        * 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: ToolCall.Function;
 
       /**
        * Must be 'function' to identify this as a function call.
        */
-      type?: 'function';
+      type: 'function';
     }
 
     export namespace ToolCall {
       /**
-       * Function call details for OpenAI-compatible tool calls.
+       * Function call details.
        */
       export 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;
       }
     }
   }
@@ -1425,54 +1084,54 @@ export namespace CompletionRetrieveResponse {
   }
 
   /**
-   * Usage information for OpenAI chat completion.
+   * Token usage information for the completion.
    */
   export 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;
   }
 
   export namespace Usage {
     /**
-     * Token details for output tokens in OpenAI chat completion usage.
+     * Detailed breakdown of output token usage.
      */
     export 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.
      */
     export interface PromptTokensDetails {
       /**
        * Number of tokens retrieved from cache.
        */
-      cached_tokens?: number | null;
+      cached_tokens?: number;
     }
   }
 }
@@ -1508,6 +1167,9 @@ export interface CompletionListResponse {
 }
 
 export namespace CompletionListResponse {
+  /**
+   * Chat completion response extended with the original input messages.
+   */
   export interface Data {
     /**
      * The ID of the chat completion.
@@ -1546,9 +1208,19 @@ export 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.
      */
-    usage?: Data.Usage | null;
+    system_fingerprint?: string;
+
+    /**
+     * Token usage information for the completion.
+     */
+    usage?: Data.Usage;
   }
 
   export namespace Data {
@@ -1569,334 +1241,148 @@ export 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;
     }
 
     export namespace Choice {
       /**
-       * A message from the user in an OpenAI-compatible chat completion request.
-       */
-      export 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';
-      }
-
-      export namespace OpenAIUserMessageParamOutput {
-        /**
-         * Text content part for OpenAI-compatible chat completion messages.
-         */
-        export 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.
-         */
-        export 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';
-        }
-
-        export namespace OpenAIChatCompletionContentPartImageParam {
-          /**
-           * Image URL specification and processing details.
-           */
-          export 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;
-          }
-        }
-
-        export interface OpenAIFile {
-          /**
-           * File specification.
-           */
-          file: OpenAIFile.File;
-
-          /**
-           * Must be 'file' to identify this as file content.
-           */
-          type?: 'file';
-        }
-
-        export namespace OpenAIFile {
-          /**
-           * File specification.
-           */
-          export 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.
        */
-      export interface OpenAISystemMessageParam {
-        /**
-         * The content of the 'system prompt'. If multiple system messages are provided,
-         * they are concatenated.
-         */
-        content: string | Array<OpenAISystemMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
-
+      export 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';
-      }
+        audio?: { [key: string]: unknown } | null;
 
-      export namespace OpenAISystemMessageParam {
         /**
-         * Text content part for OpenAI-compatible chat completion messages.
+         * The content of the message.
          */
-        export interface ListOpenAIChatCompletionContentPartTextParam {
-          /**
-           * The text content of the message.
-           */
-          text: string;
+        content?: string | null;
 
-          /**
-           * 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.
-       */
-      export interface OpenAIAssistantMessageParamOutput {
         /**
-         * 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>;
       }
 
-      export namespace OpenAIAssistantMessageParamOutput {
+      export namespace Message {
         /**
-         * Text content part for OpenAI-compatible chat completion messages.
+         * Deprecated: the name and arguments of a function that should be called.
          */
-        export interface ListOpenAIChatCompletionContentPartTextParam {
+        export 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.
          */
-        export interface ToolCall {
+        export 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';
         }
 
-        export namespace ToolCall {
+        export namespace Function {
           /**
-           * Function call details for OpenAI-compatible tool calls.
+           * Function call details.
            */
           export 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.
-       */
-      export 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';
-      }
 
-      export namespace OpenAIToolMessageParam {
         /**
-         * Text content part for OpenAI-compatible chat completion messages.
+         * A call to a custom tool created by the model.
          */
-        export interface ListOpenAIChatCompletionContentPartTextParam {
+        export 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.
-       */
-      export 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';
-      }
+          custom: Custom.Custom;
 
-      export namespace OpenAIDeveloperMessageParam {
-        /**
-         * Text content part for OpenAI-compatible chat completion messages.
-         */
-        export interface ListOpenAIChatCompletionContentPartTextParam {
           /**
-           * The text content of the message.
+           * The type of the tool. Always 'custom'.
            */
-          text: string;
+          type: 'custom';
+        }
 
+        export namespace Custom {
           /**
-           * Must be 'text' to identify this as text content.
+           * The custom tool that the model called.
            */
-          type?: 'text';
+          export 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.
        */
       export interface Logprobs {
         /**
@@ -2085,6 +1571,9 @@ export namespace CompletionListResponse {
         }
       }
 
+      /**
+       * File content part for OpenAI-compatible chat completion messages.
+       */
       export interface OpenAIFile {
         /**
          * File specification.
@@ -2185,6 +1674,8 @@ export namespace CompletionListResponse {
        * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
        */
       tool_calls?: Array<OpenAIAssistantMessageParamOutput.ToolCall> | null;
+
+      [k: string]: unknown;
     }
 
     export namespace OpenAIAssistantMessageParamOutput {
@@ -2210,38 +1701,33 @@ export 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';
       }
 
       export namespace ToolCall {
         /**
-         * Function call details for OpenAI-compatible tool calls.
+         * Function call details.
          */
         export 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;
         }
       }
     }
@@ -2322,54 +1808,54 @@ export namespace CompletionListResponse {
     }
 
     /**
-     * Usage information for OpenAI chat completion.
+     * Token usage information for the completion.
      */
     export 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;
     }
 
     export namespace Usage {
       /**
-       * Token details for output tokens in OpenAI chat completion usage.
+       * Detailed breakdown of output token usage.
        */
       export 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.
        */
       export interface PromptTokensDetails {
         /**
          * Number of tokens retrieved from cache.
          */
-        cached_tokens?: number | null;
+        cached_tokens?: number;
       }
     }
   }
@@ -2444,6 +1930,11 @@ export interface CompletionCreateParamsBase {
    */
   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.
    */
@@ -2468,6 +1959,11 @@ export interface CompletionCreateParamsBase {
    */
   seed?: number | null;
 
+  /**
+   * The service tier for the request.
+   */
+  service_tier?: 'auto' | 'default' | 'flex' | 'priority' | null;
+
   /**
    * The stop tokens to use.
    */
@@ -2499,7 +1995,7 @@ export interface CompletionCreateParamsBase {
   tools?: Array<{ [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;
 
@@ -2591,6 +2087,9 @@ export namespace CompletionCreateParams {
       }
     }
 
+    /**
+     * File content part for OpenAI-compatible chat completion messages.
+     */
     export interface OpenAIFile {
       /**
        * File specification.
@@ -2691,6 +2190,8 @@ export namespace CompletionCreateParams {
      * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
      */
     tool_calls?: Array<OpenAIAssistantMessageParamInput.ToolCall> | null;
+
+    [k: string]: unknown;
   }
 
   export namespace OpenAIAssistantMessageParamInput {
@@ -2716,38 +2217,33 @@ export 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';
     }
 
     export namespace ToolCall {
       /**
-       * Function call details for OpenAI-compatible tool calls.
+       * Function call details.
        */
       export 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;
       }
     }
   }
@@ -2916,7 +2412,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;
 }