openai 4.67.3 → 4.68.0

package/src/resources/chat/completions.ts

@@ -11,7 +11,10 @@ import { Stream } from '../../streaming';
 
 export class Completions extends APIResource {
   /**
-   * Creates a model response for the given chat conversation.
+   * Creates a model response for the given chat conversation. Learn more in the
+   * [text generation](https://platform.openai.com/docs/guides/text-generation),
+   * [vision](https://platform.openai.com/docs/guides/vision), and
+   * [audio](https://platform.openai.com/docs/guides/audio) guides.
    */
   create(
     body: ChatCompletionCreateParamsNonStreaming,
@@ -138,6 +141,12 @@ export interface ChatCompletionAssistantMessageParam {
    */
   role: 'assistant';
 
+  /**
+   * Data about a previous audio response from the model.
+   * [Learn more](https://platform.openai.com/docs/guides/audio).
+   */
+  audio?: ChatCompletionAssistantMessageParam.Audio | null;
+
   /**
    * The contents of the assistant message. Required unless `tool_calls` or
    * `function_call` is specified.
@@ -168,6 +177,17 @@ export interface ChatCompletionAssistantMessageParam {
 }
 
 export namespace ChatCompletionAssistantMessageParam {
+  /**
+   * Data about a previous audio response from the model.
+   * [Learn more](https://platform.openai.com/docs/guides/audio).
+   */
+  export interface Audio {
+    /**
+     * Unique identifier for a previous audio response from the model.
+     */
+    id: string;
+  }
+
   /**
    * @deprecated: Deprecated and replaced by `tool_calls`. The name and arguments of
    * a function that should be called, as generated by the model.
@@ -188,6 +208,54 @@ export namespace ChatCompletionAssistantMessageParam {
   }
 }
 
+/**
+ * If the audio output modality is requested, this object contains data about the
+ * audio response from the model.
+ * [Learn more](https://platform.openai.com/docs/guides/audio).
+ */
+export interface ChatCompletionAudio {
+  /**
+   * Unique identifier for this audio response.
+   */
+  id: string;
+
+  /**
+   * Base64 encoded audio bytes generated by the model, in the format specified in
+   * the request.
+   */
+  data: string;
+
+  /**
+   * The Unix timestamp (in seconds) for when this audio response will no longer be
+   * accessible on the server for use in multi-turn conversations.
+   */
+  expires_at: number;
+
+  /**
+   * Transcript of the audio generated by the model.
+   */
+  transcript: string;
+}
+
+/**
+ * Parameters for audio output. Required when audio output is requested with
+ * `modalities: ["audio"]`.
+ * [Learn more](https://platform.openai.com/docs/guides/audio).
+ */
+export interface ChatCompletionAudioParam {
+  /**
+   * Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`,
+   * or `pcm16`.
+   */
+  format: 'wav' | 'mp3' | 'flac' | 'opus' | 'pcm16';
+
+  /**
+   * Specifies the voice type. Supported voices are `alloy`, `echo`, `fable`, `onyx`,
+   * `nova`, and `shimmer`.
+   */
+  voice: 'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer';
+}
+
 /**
  * Represents a streamed chunk of a chat completion response returned by model,
  * based on the provided input.
@@ -371,8 +439,18 @@ export namespace ChatCompletionChunk {
   }
 }
 
-export type ChatCompletionContentPart = ChatCompletionContentPartText | ChatCompletionContentPartImage;
+/**
+ * Learn about
+ * [text inputs](https://platform.openai.com/docs/guides/text-generation).
+ */
+export type ChatCompletionContentPart =
+  | ChatCompletionContentPartText
+  | ChatCompletionContentPartImage
+  | ChatCompletionContentPartInputAudio;
 
+/**
+ * Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
+ */
 export interface ChatCompletionContentPartImage {
   image_url: ChatCompletionContentPartImage.ImageURL;
 
@@ -397,6 +475,32 @@ export namespace ChatCompletionContentPartImage {
   }
 }
 
+/**
+ * Learn about [audio inputs](https://platform.openai.com/docs/guides/audio).
+ */
+export interface ChatCompletionContentPartInputAudio {
+  input_audio: ChatCompletionContentPartInputAudio.InputAudio;
+
+  /**
+   * The type of the content part. Always `input_audio`.
+   */
+  type: 'input_audio';
+}
+
+export namespace ChatCompletionContentPartInputAudio {
+  export interface InputAudio {
+    /**
+     * Base64 encoded audio data.
+     */
+    data: string;
+
+    /**
+     * The format of the encoded audio data. Currently supports "wav" and "mp3".
+     */
+    format: 'wav' | 'mp3';
+  }
+}
+
 export interface ChatCompletionContentPartRefusal {
   /**
    * The refusal message generated by the model.
@@ -409,6 +513,10 @@ export interface ChatCompletionContentPartRefusal {
   type: 'refusal';
 }
 
+/**
+ * Learn about
+ * [text inputs](https://platform.openai.com/docs/guides/text-generation).
+ */
 export interface ChatCompletionContentPartText {
   /**
    * The text content.
@@ -471,6 +579,13 @@ export interface ChatCompletionMessage {
    */
   role: 'assistant';
 
+  /**
+   * If the audio output modality is requested, this object contains data about the
+   * audio response from the model.
+   * [Learn more](https://platform.openai.com/docs/guides/audio).
+   */
+  audio?: ChatCompletionAudio | null;
+
   /**
    * @deprecated: Deprecated and replaced by `tool_calls`. The name and arguments of
    * a function that should be called, as generated by the model.
@@ -548,6 +663,8 @@ export namespace ChatCompletionMessageToolCall {
   }
 }
 
+export type ChatCompletionModality = 'text' | 'audio';
+
 /**
  * Specifies a tool the model should use. Use to force the model to call a specific
  * function.
@@ -743,6 +860,13 @@ export interface ChatCompletionCreateParamsBase {
    */
   model: (string & {}) | ChatAPI.ChatModel;
 
+  /**
+   * Parameters for audio output. Required when audio output is requested with
+   * `modalities: ["audio"]`.
+   * [Learn more](https://platform.openai.com/docs/guides/audio).
+   */
+  audio?: ChatCompletionAudioParam | null;
+
   /**
    * Number between -2.0 and 2.0. Positive values penalize new tokens based on their
    * existing frequency in the text so far, decreasing the model's likelihood to
@@ -812,10 +936,24 @@ export interface ChatCompletionCreateParamsBase {
 
   /**
    * Developer-defined tags and values used for filtering completions in the
-   * [dashboard](https://platform.openai.com/completions).
+   * [dashboard](https://platform.openai.com/chat-completions).
    */
   metadata?: Record<string, string> | null;
 
+  /**
+   * Output types that you would like the model to generate for this request. Most
+   * models are capable of generating text, which is the default:
+   *
+   * `["text"]`
+   *
+   * The `gpt-4o-audio-preview` model can also be used to
+   * [generate audio](https://platform.openai.com/docs/guides/audio). To request that
+   * this model generate both text and audio responses, you can use:
+   *
+   * `["text", "audio"]`
+   */
+  modalities?: Array<ChatCompletionModality> | null;
+
   /**
    * How many chat completion choices to generate for each input message. Note that
    * you will be charged based on the number of generated tokens across all of the
@@ -900,8 +1038,9 @@ export interface ChatCompletionCreateParamsBase {
   stop?: string | null | Array<string>;
 
   /**
-   * Whether or not to store the output of this completion request for traffic
-   * logging in the [dashboard](https://platform.openai.com/completions).
+   * Whether or not to store the output of this chat completion request for use in
+   * our [model distillation](https://platform.openai.com/docs/guides/distillation)
+   * or [evals](https://platform.openai.com/docs/guides/evals) products.
    */
   store?: boolean | null;
 
@@ -1049,9 +1188,12 @@ export type CompletionCreateParamsStreaming = ChatCompletionCreateParamsStreamin
 export namespace Completions {
   export import ChatCompletion = ChatCompletionsAPI.ChatCompletion;
   export import ChatCompletionAssistantMessageParam = ChatCompletionsAPI.ChatCompletionAssistantMessageParam;
+  export import ChatCompletionAudio = ChatCompletionsAPI.ChatCompletionAudio;
+  export import ChatCompletionAudioParam = ChatCompletionsAPI.ChatCompletionAudioParam;
   export import ChatCompletionChunk = ChatCompletionsAPI.ChatCompletionChunk;
   export import ChatCompletionContentPart = ChatCompletionsAPI.ChatCompletionContentPart;
   export import ChatCompletionContentPartImage = ChatCompletionsAPI.ChatCompletionContentPartImage;
+  export import ChatCompletionContentPartInputAudio = ChatCompletionsAPI.ChatCompletionContentPartInputAudio;
   export import ChatCompletionContentPartRefusal = ChatCompletionsAPI.ChatCompletionContentPartRefusal;
   export import ChatCompletionContentPartText = ChatCompletionsAPI.ChatCompletionContentPartText;
   export import ChatCompletionFunctionCallOption = ChatCompletionsAPI.ChatCompletionFunctionCallOption;
@@ -1059,6 +1201,7 @@ export namespace Completions {
   export import ChatCompletionMessage = ChatCompletionsAPI.ChatCompletionMessage;
   export import ChatCompletionMessageParam = ChatCompletionsAPI.ChatCompletionMessageParam;
   export import ChatCompletionMessageToolCall = ChatCompletionsAPI.ChatCompletionMessageToolCall;
+  export import ChatCompletionModality = ChatCompletionsAPI.ChatCompletionModality;
   export import ChatCompletionNamedToolChoice = ChatCompletionsAPI.ChatCompletionNamedToolChoice;
   export import ChatCompletionRole = ChatCompletionsAPI.ChatCompletionRole;
   export import ChatCompletionStreamOptions = ChatCompletionsAPI.ChatCompletionStreamOptions;

package/src/resources/chat/index.ts

@@ -3,9 +3,12 @@
 export {
   ChatCompletion,
   ChatCompletionAssistantMessageParam,
+  ChatCompletionAudio,
+  ChatCompletionAudioParam,
   ChatCompletionChunk,
   ChatCompletionContentPart,
   ChatCompletionContentPartImage,
+  ChatCompletionContentPartInputAudio,
   ChatCompletionContentPartRefusal,
   ChatCompletionContentPartText,
   ChatCompletionFunctionCallOption,
@@ -13,6 +16,7 @@ export {
   ChatCompletionMessage,
   ChatCompletionMessageParam,
   ChatCompletionMessageToolCall,
+  ChatCompletionModality,
   ChatCompletionNamedToolChoice,
   ChatCompletionRole,
   ChatCompletionStreamOptions,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.67.3'; // x-release-please-version
+export const VERSION = '4.68.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.67.3";
+export declare const VERSION = "4.68.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.67.3'; // x-release-please-version
+exports.VERSION = '4.68.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.67.3'; // x-release-please-version
+export const VERSION = '4.68.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map