openai 7.12.1 → 7.14.0

package/src/resources/live/api.md

@@ -0,0 +1,87 @@
+# Live
+
+Types:
+
+- <code><a href="./src/resources/live/live.ts">AudioFormat</a></code>
+- <code><a href="./src/resources/live/live.ts">BuiltInVoice</a></code>
+- <code><a href="./src/resources/live/live.ts">ClientConfig</a></code>
+- <code><a href="./src/resources/live/live.ts">ClientDelegation</a></code>
+- <code><a href="./src/resources/live/live.ts">ClientEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">CommentaryAppendEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">CommentaryAppendedEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">CustomVoice</a></code>
+- <code><a href="./src/resources/live/live.ts">DataChannelConfig</a></code>
+- <code><a href="./src/resources/live/live.ts">DelegationCreatedEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">Error</a></code>
+- <code><a href="./src/resources/live/live.ts">ErrorEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">ForkSessionConfig</a></code>
+- <code><a href="./src/resources/live/live.ts">ForkSessionStartEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">FunctionTool</a></code>
+- <code><a href="./src/resources/live/live.ts">InfoEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">InitialItem</a></code>
+- <code><a href="./src/resources/live/live.ts">InputAudioAppendEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">InputAudioMuteEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">InputAudioMutedEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">InputAudioUnmuteEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">InputAudioUnmutedEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">InputTranscriptDeltaEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">InstructionsAppendEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">InstructionsAppendedEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">MediaSessionConfig</a></code>
+- <code><a href="./src/resources/live/live.ts">MediaSessionForkConfig</a></code>
+- <code><a href="./src/resources/live/live.ts">OutputAudioDeltaEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">OutputTranscriptDeltaEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">ResponseCreateEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">ResponseEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">ResponseItemCreateEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">ResponsesDelegationConfig</a></code>
+- <code><a href="./src/resources/live/live.ts">ResponsesDelegationUpdateConfig</a></code>
+- <code><a href="./src/resources/live/live.ts">ServerEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">ServerEventSelector</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionCloseEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionClosedEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionConfig</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionResource</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionStartEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionStartedEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionUpdateConfig</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionUpdateEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionUpdatedEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionUsage</a></code>
+- <code><a href="./src/resources/live/live.ts">SessionUsageUpdatedEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">ThinkingAppendEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">ThinkingAppendedEvent</a></code>
+- <code><a href="./src/resources/live/live.ts">LiveCreateResponse</a></code>
+
+Methods:
+
+- <code title="post /live/sessions">client.live.<a href="./src/resources/live/live.ts">create</a>({ ...params }) -> LiveCreateResponse</code>
+
+## Sideband
+
+Types:
+
+- <code><a href="./src/resources/live/sideband.ts">ConnectClientEvent</a></code>
+- <code><a href="./src/resources/live/sideband.ts">ConnectServerEvent</a></code>
+
+## Forks
+
+Types:
+
+- <code><a href="./src/resources/live/forks.ts">ForkClientEvent</a></code>
+- <code><a href="./src/resources/live/forks.ts">ForkServerEvent</a></code>
+
+## Sessions
+
+Types:
+
+- <code><a href="./src/resources/live/sessions.ts">SessionForkResponse</a></code>
+
+Methods:
+
+- <code title="post /live/sessions/{session_id}/accept">client.live.sessions.<a href="./src/resources/live/sessions.ts">accept</a>(sessionID, { ...params }) -> void</code>
+- <code title="get /live/sessions/{session_id}/content">client.live.sessions.<a href="./src/resources/live/sessions.ts">downloadRecording</a>(sessionID) -> Response</code>
+- <code title="post /live/sessions/{session_id}/fork">client.live.sessions.<a href="./src/resources/live/sessions.ts">fork</a>(sessionID, { ...params }) -> SessionForkResponse</code>
+- <code title="post /live/sessions/{session_id}/hangup">client.live.sessions.<a href="./src/resources/live/sessions.ts">hangup</a>(sessionID) -> void</code>
+- <code title="post /live/sessions/{session_id}/refer">client.live.sessions.<a href="./src/resources/live/sessions.ts">refer</a>(sessionID, { ...params }) -> void</code>
+- <code title="post /live/sessions/{session_id}/reject">client.live.sessions.<a href="./src/resources/live/sessions.ts">reject</a>(sessionID, { ...params }) -> void</code>

package/src/resources/live/forks/forks.ts

@@ -0,0 +1,169 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as LiveAPI from '../live';
+
+export class Forks extends APIResource {}
+
+/**
+ * Client events for a Live fork WebSocket. First send session.start with an
+ * overrides object (which may be empty), then wait for session.started before
+ * sending other commands. The model and conversation are inherited from the stored
+ * session.
+ */
+export type ForkClientEvent =
+  | LiveAPI.ForkSessionStartEvent
+  | LiveAPI.SessionUpdateEvent
+  | LiveAPI.InputAudioAppendEvent
+  | LiveAPI.InputAudioMuteEvent
+  | LiveAPI.InputAudioUnmuteEvent
+  | LiveAPI.InstructionsAppendEvent
+  | LiveAPI.ThinkingAppendEvent
+  | LiveAPI.CommentaryAppendEvent
+  | LiveAPI.ResponseItemCreateEvent
+  | LiveAPI.ResponseCreateEvent
+  | LiveAPI.SessionCloseEvent;
+
+/**
+ * Server events for Live. Response lifecycle events are wrapped inside
+ * response.event; dispatch the nested event by its full type and tolerate new
+ * response event types. Follow the
+ * [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting)
+ * when designing the conversation and delegation policy.
+ */
+export type ForkServerEvent =
+  | LiveAPI.SessionStartedEvent
+  | LiveAPI.SessionUpdatedEvent
+  | LiveAPI.InputAudioMutedEvent
+  | LiveAPI.InputAudioUnmutedEvent
+  | LiveAPI.InstructionsAppendedEvent
+  | LiveAPI.ThinkingAppendedEvent
+  | LiveAPI.CommentaryAppendedEvent
+  | ForkServerEvent.SessionInputAudioAppend
+  | LiveAPI.OutputAudioDeltaEvent
+  | LiveAPI.InputTranscriptDeltaEvent
+  | LiveAPI.OutputTranscriptDeltaEvent
+  | LiveAPI.DelegationCreatedEvent
+  | LiveAPI.ResponseEvent
+  | LiveAPI.SessionUsageUpdatedEvent
+  | LiveAPI.SessionClosedEvent
+  | LiveAPI.ErrorEvent
+  | LiveAPI.InfoEvent
+  | ForkServerEvent.TransportDtmfReceived
+  | ForkServerEvent.TransportDtmfSend
+  | ForkServerEvent.TransportRinging
+  | ForkServerEvent.TransportAnswered
+  | ForkServerEvent.TransportFailed;
+
+export namespace ForkServerEvent {
+  /**
+   * Input audio received from the primary transport and reflected to a Live sideband
+   * connection before model-input muting.
+   */
+  export interface SessionInputAudioAppend {
+    /**
+     * Base64-encoded raw mono PCM16LE at 24 kHz received from the primary transport,
+     * reflected to the sideband before model-input muting. This server event uses the
+     * same audio key as the client command, but is not an acknowledgment of it.
+     */
+    audio: string;
+
+    /**
+     * The event type, always `session.input_audio.append`.
+     */
+    type: 'session.input_audio.append';
+  }
+
+  /**
+   * A SIP DTMF keypress received from the caller. Delivered only to sideband
+   * observers.
+   */
+  export interface TransportDtmfReceived {
+    event: string;
+
+    event_id: string;
+
+    type: 'transport.dtmf.received';
+  }
+
+  /**
+   * A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to
+   * sideband observers; this is not a client command.
+   */
+  export interface TransportDtmfSend {
+    event: string;
+
+    event_id: string;
+
+    type: 'transport.dtmf.send';
+  }
+
+  /**
+   * The outbound SIP provider leg is ringing or providing early media. Delivered
+   * only to sideband observers.
+   */
+  export interface TransportRinging {
+    event_id: string;
+
+    /**
+     * The canonical Live session ID.
+     */
+    session_id: string;
+
+    type: 'transport.ringing';
+  }
+
+  /**
+   * The outbound SIP provider leg answered and media is established. Delivered only
+   * to sideband observers.
+   */
+  export interface TransportAnswered {
+    event_id: string;
+
+    /**
+     * The canonical Live session ID.
+     */
+    session_id: string;
+
+    type: 'transport.answered';
+  }
+
+  /**
+   * An asynchronous outbound SIP setup failure. Delivered only to sideband
+   * observers.
+   */
+  export interface TransportFailed {
+    error: TransportFailed.Error;
+
+    event_id: string;
+
+    /**
+     * The canonical Live session ID.
+     */
+    session_id: string;
+
+    type: 'transport.failed';
+  }
+
+  export namespace TransportFailed {
+    export interface Error {
+      /**
+       * The call setup failure code.
+       */
+      code: string;
+
+      message: string;
+
+      type: 'call_error';
+
+      /**
+       * The parameter related to the error, if any. Empty when no parameter applies.
+       */
+      param?: string;
+    }
+  }
+}
+
+export declare namespace Forks {
+  export { type ForkClientEvent as ForkClientEvent, type ForkServerEvent as ForkServerEvent };
+}

package/src/resources/live/forks/index.ts

@@ -0,0 +1,5 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+export { Forks, type ForkClientEvent, type ForkServerEvent } from './forks';
+export { type ForksWSClientOptions } from './ws';
+export { type ForksWSReconnectOptions } from './ws-base';

package/src/resources/live/forks/internal-base.ts

@@ -0,0 +1,107 @@
+// File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
+
+import * as ForksAPI from './forks';
+import * as LiveAPI from '../live';
+import { OpenAI } from '../../../client';
+import { EventEmitter } from '../../../core/EventEmitter';
+import { OpenAIError } from '../../../core/error';
+import { path } from '../../../internal/utils/path';
+
+import type { RawWebSocketData, ReconnectingEvent, UnsentMessage } from '../../../internal/ws';
+import { ForksWSParameters } from './ws-base';
+
+export type ForksStreamMessage =
+  | { type: 'connecting' | 'open' | 'closing' }
+  | { type: 'close'; code: number; reason: string; unsent: UnsentMessage<ForksAPI.ForkClientEvent>[] }
+  | { type: 'reconnecting'; reconnect: ReconnectingEvent<ForksWSParameters> }
+  | { type: 'reconnected' }
+  | { type: 'message'; message: ForksAPI.ForkServerEvent }
+  | { type: 'raw'; data: RawWebSocketData }
+  | { type: 'error'; error: WebSocketError };
+
+export class WebSocketError extends OpenAIError {
+  /**
+   * The error data that the API sent back in an error event.
+   */
+  error?: LiveAPI.ErrorEvent | undefined;
+
+  constructor(message: string, event: LiveAPI.ErrorEvent | null) {
+    super(message);
+
+    this.error = event ?? undefined;
+  }
+}
+
+type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
+
+type WebSocketEvents = Simplify<
+  {
+    event: (event: ForksAPI.ForkServerEvent) => void;
+    raw: (data: RawWebSocketData) => void;
+    error: (error: WebSocketError) => void;
+    close: (code: number, reason: string, unsent: UnsentMessage<ForksAPI.ForkClientEvent>[]) => void;
+    reconnecting: (event: ReconnectingEvent<ForksWSParameters>) => void;
+    reconnected: () => void;
+  } & {
+    [EventType in Exclude<NonNullable<ForksAPI.ForkServerEvent['type']>, 'error'>]: (
+      event: Extract<ForksAPI.ForkServerEvent, { type?: EventType }>,
+    ) => unknown;
+  }
+>;
+
+export abstract class ForksEmitter extends EventEmitter<WebSocketEvents> {
+  /**
+   * Send an event to the API.
+   */
+  abstract send(event: ForksAPI.ForkClientEvent): void;
+
+  /**
+   * Send raw data over the WebSocket without JSON serialization.
+   */
+  abstract sendRaw(data: RawWebSocketData): void;
+
+  /**
+   * Close the WebSocket connection.
+   */
+  abstract close(props?: { code: number; reason: string }): void;
+
+  protected _onError(event: null, message: string, cause: any): void;
+  protected _onError(event: LiveAPI.ErrorEvent, message?: string | undefined): void;
+  protected _onError(event: LiveAPI.ErrorEvent | null, message?: string | undefined, cause?: any): void {
+    message = message ?? safeJSONStringify(event) ?? 'unknown error';
+
+    if (!this._hasListener('error')) {
+      const error = new WebSocketError(
+        message +
+          `\n\nTo resolve these unhandled rejection errors you should bind an \`error\` callback, e.g. \`ws.on('error', (error) => ...)\` `,
+        event,
+      );
+      // @ts-ignore
+      error.cause = cause;
+      Promise.reject(error);
+      return;
+    }
+
+    const error = new WebSocketError(message, event);
+    // @ts-ignore
+    error.cause = cause;
+
+    this._emit('error', error);
+  }
+}
+
+export function buildURL(client: OpenAI, parameters: Record<string, unknown>): URL {
+  const { session_id: path0, ...query } = parameters;
+  const endpoint = path`/live/sessions/${path0}/fork`;
+  const url = new URL(client.buildURL(endpoint, query, undefined));
+  url.protocol = url.protocol === 'http:' || url.protocol === 'ws:' ? 'ws:' : 'wss:';
+  return url;
+}
+
+function safeJSONStringify(value: unknown): string | null {
+  try {
+    return JSON.stringify(value);
+  } catch {
+    return null;
+  }
+}