fix(api/types): correct audio duration & role types (#1300)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 69
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-6204952a29973265b9c0d66fc67ffaf53c6a90ae4d75cdacf9d147676f5274c9.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-fc5dbc19505b0035f9e7f88868619f4fb519b048bde011f6154f3132d4be71fb.yml

api.md

@@ -229,6 +229,7 @@ Types:
 - <code><a href="./src/resources/beta/realtime/realtime.ts">ConversationItemInputAudioTranscriptionFailedEvent</a></code>
 - <code><a href="./src/resources/beta/realtime/realtime.ts">ConversationItemTruncateEvent</a></code>
 - <code><a href="./src/resources/beta/realtime/realtime.ts">ConversationItemTruncatedEvent</a></code>
+- <code><a href="./src/resources/beta/realtime/realtime.ts">ConversationItemWithReference</a></code>
 - <code><a href="./src/resources/beta/realtime/realtime.ts">ErrorEvent</a></code>
 - <code><a href="./src/resources/beta/realtime/realtime.ts">InputAudioBufferAppendEvent</a></code>
 - <code><a href="./src/resources/beta/realtime/realtime.ts">InputAudioBufferClearEvent</a></code>

src/lib/ChatCompletionStream.ts

@@ -12,6 +12,7 @@ import {
   type ChatCompletionCreateParams,
   type ChatCompletionCreateParamsStreaming,
   type ChatCompletionCreateParamsBase,
+  type ChatCompletionRole,
 } from '../resources/chat/completions';
 import {
   AbstractChatCompletionRunner,
@@ -797,7 +798,7 @@ export namespace ChatCompletionSnapshot {
       /**
        * The role of the author of this message.
        */
-      role?: 'system' | 'user' | 'assistant' | 'function' | 'tool';
+      role?: ChatCompletionRole;
     }
 
     export namespace Message {

src/resources/audio/transcriptions.ts

@@ -106,7 +106,7 @@ export interface TranscriptionVerbose {
   /**
    * The duration of the input audio.
    */
-  duration: string;
+  duration: number;
 
   /**
    * The language of the input audio.

src/resources/audio/translations.ts

@@ -41,7 +41,7 @@ export interface TranslationVerbose {
   /**
    * The duration of the input audio.
    */
-  duration: string;
+  duration: number;
 
   /**
    * The language of the output translation (always `english`).

src/resources/beta/realtime/realtime.ts

@@ -439,6 +439,76 @@ export interface ConversationItemTruncatedEvent {
   type: 'conversation.item.truncated';
 }
 
+/**
+ * The item to add to the conversation.
+ */
+export interface ConversationItemWithReference {
+  /**
+   * For an item of type (`message` | `function_call` | `function_call_output`) this
+   * field allows the client to assign the unique ID of the item. It is not required
+   * because the server will generate one if not provided.
+   *
+   * For an item of type `item_reference`, this field is required and is a reference
+   * to any item that has previously existed in the conversation.
+   */
+  id?: string;
+
+  /**
+   * The arguments of the function call (for `function_call` items).
+   */
+  arguments?: string;
+
+  /**
+   * The ID of the function call (for `function_call` and `function_call_output`
+   * items). If passed on a `function_call_output` item, the server will check that a
+   * `function_call` item with the same ID exists in the conversation history.
+   */
+  call_id?: string;
+
+  /**
+   * The content of the message, applicable for `message` items.
+   *
+   * - Message items of role `system` support only `input_text` content
+   * - Message items of role `user` support `input_text` and `input_audio` content
+   * - Message items of role `assistant` support `text` content.
+   */
+  content?: Array<ConversationItemContent>;
+
+  /**
+   * The name of the function being called (for `function_call` items).
+   */
+  name?: string;
+
+  /**
+   * Identifier for the API object being returned - always `realtime.item`.
+   */
+  object?: 'realtime.item';
+
+  /**
+   * The output of the function call (for `function_call_output` items).
+   */
+  output?: string;
+
+  /**
+   * The role of the message sender (`user`, `assistant`, `system`), only applicable
+   * for `message` items.
+   */
+  role?: 'user' | 'assistant' | 'system';
+
+  /**
+   * The status of the item (`completed`, `incomplete`). These have no effect on the
+   * conversation, but are accepted for consistency with the
+   * `conversation.item.created` event.
+   */
+  status?: 'completed' | 'incomplete';
+
+  /**
+   * The type of the item (`message`, `function_call`, `function_call_output`,
+   * `item_reference`).
+   */
+  type?: 'message' | 'function_call' | 'function_call_output' | 'item_reference';
+}
+
 /**
  * Returned when an error occurs, which could be a client problem or a server
  * problem. Most errors are recoverable and the session will stay open, we
@@ -1336,11 +1406,12 @@ export namespace ResponseCreateEvent {
     conversation?: (string & {}) | 'auto' | 'none';
 
     /**
-     * Input items to include in the prompt for the model. Creates a new context for
-     * this response, without including the default conversation. Can include
-     * references to items from the default conversation.
+     * Input items to include in the prompt for the model. Using this field creates a
+     * new context for this Response instead of using the default conversation. An
+     * empty array `[]` will clear the context for this Response. Note that this can
+     * include references to items from the default conversation.
      */
-    input?: Array<RealtimeAPI.ConversationItem>;
+    input?: Array<RealtimeAPI.ConversationItemWithReference>;
 
     /**
      * The default system instructions (i.e. system message) prepended to model calls.

src/resources/chat/completions.ts

@@ -371,7 +371,7 @@ export namespace ChatCompletionChunk {
       /**
        * The role of the author of this message.
        */
-      role?: 'system' | 'user' | 'assistant' | 'tool';
+      role?: 'developer' | 'system' | 'user' | 'assistant' | 'tool';
 
       tool_calls?: Array<Delta.ToolCall>;
     }
@@ -756,7 +756,7 @@ export type ChatCompletionReasoningEffort = 'low' | 'medium' | 'high';
 /**
  * The role of the author of a message
  */
-export type ChatCompletionRole = 'system' | 'user' | 'assistant' | 'tool' | 'function';
+export type ChatCompletionRole = 'developer' | 'system' | 'user' | 'assistant' | 'tool' | 'function';
 
 /**
  * Options for streaming response. Only set this when you set `stream: true`.