Class DuplexSession<Events>Abstract

constructor

• new DuplexSession<Events>(duplexModel): DuplexSession<Events>

• Create a provider session owned by the given model.

  Type Parameters

  • Events extends EventMap = Record<never, never>

  Parameters

  • duplexModel: DuplexModel

    Model that created this session.

  Returns DuplexSession<Events>

Readonly duplexModel

Abstract audioStream

• get audioStream(): ReadableStream<DuplexAudioFrame>

• Continuous output audio, including silence, delivered at playback pace.

  Returns ReadableStream<DuplexAudioFrame>

capabilities

• get capabilities(): DuplexCapabilities

• Provider features declared by the owning model.

  Returns DuplexCapabilities

Abstract tools

• get tools(): ToolContext<unknown>

• Tools currently available to the provider.

  Returns ToolContext<unknown>

Abstract _appendItems

• _appendItems(items): Promise<void>

• Append chat items to the provider's context.

  Parameters

  • items: ChatItem[]

  Returns Promise<void>

_generateReply

• _generateReply(_instructions?, _options?): void

• Ask the model to speak; its next speech is the reply. Providers may override this.

  Parameters

  • Optional _instructions: string
  • Optional _options: {
        toolChoice?: llm.ToolChoice;
        tools?: ToolContext<unknown>;
    }

    • Optional toolChoice?: llm.ToolChoice

    • Optional tools?: ToolContext<unknown>

  Returns void

Abstract _updateInstructions

• _updateInstructions(instructions): Promise<void>

• Apply instructions, or reject changes the provider cannot accept.

  Parameters

  • instructions: string

  Returns Promise<void>

Abstract _updateOptions

• _updateOptions(options): void

• Apply provider options used for subsequent replies.

  Parameters

  • options: {
        toolChoice?: null | llm.ToolChoice;
    }

    • Optional toolChoice?: null | llm.ToolChoice

  Returns void

_updateSession

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

• Apply the complete startup configuration before releasing a waiting provider connection.

  Parameters

  • Optional instructions: string
  • Optional chatCtx: ChatContext
  • Optional tools: ToolContext<unknown>

  Returns Promise<void>

Abstract _updateTools

• _updateTools(tools): Promise<void>

• Replace the tools available to the provider.

  Parameters

  • tools: ToolContext<unknown>

  Returns Promise<void>

close

• close(): Promise<void>

• Mark the session closing, release configuration waits, and close provider resources.

  Returns Promise<void>

Abstract pushAudio

• pushAudio(frame): void

• Feed an input audio frame to the provider.

  Parameters

  • frame: AudioFrame

  Returns void

pushVideo

• pushVideo(_frame): void

• Feed an input video frame. Providers without video input can ignore it.

  Parameters

  • _frame: VideoFrame

  Returns void