Class LLMStream

Hierarchy (view full)

Constructors

constructor

Accessors

chatCtx connOptions toolCtx

Methods

[asyncIterator] close collect next

Constructors

constructor

Accessors

chatCtx

  • get chatCtx(): ChatContext

  • The initial chat context of this stream.

    Returns ChatContext

connOptions

  • get connOptions(): APIConnectOptions

  • The connection options for this stream.

    Returns APIConnectOptions

toolCtx

  • get toolCtx(): undefined | ToolContext<unknown>

  • The function context of this stream.

    Returns undefined | ToolContext<unknown>

Methods

[asyncIterator]

close

  • close(): void

  • Returns void

collect

  • collect(): Promise<CollectedResponse>

  • Collect the entire stream into a single response.

    Returns Promise<CollectedResponse>

    Example

    const response = await myLlm.chat({ chatCtx, toolCtx }).collect();

    for (const tc of response.toolCalls) {
      // execute the tool call...
    }

next

  • next(): Promise<IteratorResult<ChatChunk, any>>

  • Returns Promise<IteratorResult<ChatChunk, any>>

Settings

Member Visibility

Theme

On This Page

constructorchatCtxconnOptionstoolCtx[asyncIterator]closecollectnext