Interface ChatStreamCapability<TChatInput, TChatOutput>

Provider-agnostic streaming chat capability interface.

Allows streaming partial responses for chat.

interface ChatStreamCapability<TChatInput = unknown, TChatOutput = unknown> {
    chatStream(
        request: AIRequest<TChatInput>,
        ctx: MultiModalExecutionContext,
        signal?: AbortSignal,
    ): AsyncGenerator<AIResponseChunk<TChatOutput>>;
}

Type Parameters

TChatInput = unknown
Input type for chat messages
TChatOutput = unknown
Output type for chat responses

Hierarchy (View Summary)

ProviderCapability
- ChatStreamCapability

Implemented by

Index

Methods

Methods

chatStream

chatStream(
    request: AIRequest<TChatInput>,
    ctx: MultiModalExecutionContext,
    signal?: AbortSignal,
): AsyncGenerator<AIResponseChunk<TChatOutput>>
Execute a streaming chat request. Yields partial responses as they are generated.
Parameters
- request: AIRequest<TChatInput>
  AIRequest containing chat input
- ctx: MultiModalExecutionContext
  Execution context
- Optionalsignal: AbortSignal
  Optional abort signal
Returns AsyncGenerator<AIResponseChunk<TChatOutput>>
AsyncGenerator yielding AIResponseChunk objects
- Defined in src/core/provider/capabilities/ChatCapability.ts:49