Class RealtimeSession

Hierarchy

  • RealtimeSession
    • RealtimeSession

Constructors

constructor

Accessors

chatCtx conversation expiration fncCtx inputAudioBuffer response

Methods

close queueMsg recoverFromTextResponse sessionUpdate

Constructors

constructor

Accessors

chatCtx

conversation

expiration

fncCtx

inputAudioBuffer

response

Methods

close

queueMsg

recoverFromTextResponse

  • recoverFromTextResponse(itemId): void

  • Try to recover from a text response to audio mode.

    Parameters

    • itemId: string

    Returns void

    Remarks

    Sometimes the OpenAI Realtime API returns text instead of audio responses. This method tries to recover from this by requesting a new response after deleting the text response and creating an empty user audio message.

sessionUpdate

  • sessionUpdate(__namedParameters): void

  • Parameters

    • __namedParameters: {
          inputAudioFormat?: "pcm16";
          inputAudioTranscription?: null | InputAudioTranscription;
          instructions?: string;
          maxResponseOutputTokens?: number;
          modalities: ["text", "audio"] | ["text"];
          outputAudioFormat?: "pcm16";
          selectedTools?: string[];
          temperature?: number;
          toolChoice?: string;
          turnDetection?: null | TurnDetectionType;
          voice?: string;
      }
      • Optional inputAudioFormat?: "pcm16"
      • Optional inputAudioTranscription?: null | InputAudioTranscription
      • Optional instructions?: string
      • Optional maxResponseOutputTokens?: number
      • modalities: ["text", "audio"] | ["text"]
      • Optional outputAudioFormat?: "pcm16"
      • Optional selectedTools?: string[]
      • Optional temperature?: number
      • Optional toolChoice?: string
      • Optional turnDetection?: null | TurnDetectionType
      • Optional voice?: string

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorchatCtxconversationexpirationfncCtxinputAudioBufferresponseclosequeueMsgrecoverFromTextResponsesessionUpdate