Class RealtimeSession

Hierarchy

  • OpenAIRealtimeSession
    • RealtimeSession

Constructors

constructor

Accessors

chatCtx realtimeModel tools

Methods

_updateSession clearAudio close commitAudio generateReply interrupt pushAudio sendEvent setInputAudioStream startUserActivity truncate updateChatCtx updateInstructions updateOptions updateTools

Constructors

constructor

Accessors

chatCtx

  • get chatCtx(): ChatContext

  • Returns ChatContext

realtimeModel

tools

  • get tools(): ToolContext<unknown>

  • Returns ToolContext<unknown>

Methods

_updateSession

  • _updateSession(instructions?, chatCtx?, tools?): Promise<void>

  • Parameters

    Returns Promise<void>

clearAudio

  • clearAudio(): Promise<void>

  • Returns Promise<void>

close

commitAudio

  • commitAudio(): Promise<void>

  • Returns Promise<void>

generateReply

  • generateReply(instructions?, options?): Promise<GenerationCreatedEvent>

  • Parameters

    • Optional instructions: string
    • Optional options: {
          signal?: AbortSignal;
      }
      • Optional signal?: AbortSignal

    Returns Promise<GenerationCreatedEvent>

interrupt

pushAudio

  • pushAudio(frame): void

  • Parameters

    • frame: AudioFrame

    Returns void

sendEvent

  • sendEvent(command): void

  • Parameters

    Returns void

setInputAudioStream

  • setInputAudioStream(audioStream): void

  • Parameters

    • audioStream: ReadableStream<AudioFrame>

    Returns void

startUserActivity

  • startUserActivity(): void

  • Notifies the model that user activity has started

    Returns void

truncate

  • truncate(_options): Promise<void>

  • Parameters

    • _options: {
          audioEndMs: number;
          audioTranscript?: string;
          messageId: string;
          modalities?: Modality[];
      }
      • audioEndMs: number
      • Optional audioTranscript?: string
      • messageId: string
      • Optional modalities?: Modality[]

    Returns Promise<void>

updateChatCtx

  • updateChatCtx(_chatCtx): Promise<void>

  • Parameters

    Returns Promise<void>

updateInstructions

  • updateInstructions(_instructions): Promise<void>

  • Parameters

    • _instructions: string

    Returns Promise<void>

updateOptions

  • updateOptions(__namedParameters): void

  • Parameters

    Returns void

updateTools

  • updateTools(_tools): Promise<void>

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorchatCtxrealtimeModeltools_updateSessionclearAudioclosecommitAudiogenerateReplyinterruptpushAudiosendEventsetInputAudioStreamstartUserActivitytruncateupdateChatCtxupdateInstructionsupdateOptionsupdateTools