Class Model<T>`Abstract`

Base abstract class for model providers. Defines the contract that all model provider implementations must follow.

Model providers handle communication with LLM APIs and implement streaming responses using async iterables.

Type Parameters

T extends BaseModelConfig = BaseModelConfig
Model configuration type extending BaseModelConfig

Hierarchy (View Summary)

Model
- BedrockModel

Index

Constructors

Methods

updateConfig getConfig stream streamAggregated

Constructors

constructor

new Model<T extends BaseModelConfig = BaseModelConfig>(): Model<T>
Type Parameters
- T extends BaseModelConfig = BaseModelConfig
  Model configuration type extending BaseModelConfig
Returns Model<T>

Methods

`Abstract`updateConfig

updateConfig(modelConfig: T): void
Updates the model configuration. Merges the provided configuration with existing settings.
Parameters
- modelConfig: T
  Configuration object with model-specific settings to update
Returns void
- Defined in sdk-typescript/src/models/model.ts:117

`Abstract`getConfig

getConfig(): T
Retrieves the current model configuration.

Returns T
The current configuration object
- Defined in sdk-typescript/src/models/model.ts:124

`Abstract`stream

stream(
messages: Message[],
options?: StreamOptions,
): AsyncIterable<ModelStreamEvent>
Streams a conversation with the model. Returns an async iterable that yields streaming events as they occur.
Parameters
- messages: Message[]
  Array of conversation messages
- Optionaloptions: StreamOptions
  Optional streaming configuration
Returns AsyncIterable<ModelStreamEvent>
Async iterable of streaming events
- Defined in sdk-typescript/src/models/model.ts:134

streamAggregated

streamAggregated(
    messages: Message[],
    options?: StreamOptions,
): AsyncGenerator<
    ModelStreamEvent
    | ContentBlock,
    StreamAggregatedResult,
    undefined,
>
Streams a conversation with aggregated content blocks and messages. Returns an async generator that yields streaming events and content blocks, and returns the final message with stop reason and optional metadata.

This method enhances the basic stream() by collecting streaming events into complete ContentBlock and Message objects, which are needed by the agentic loop for tool execution and conversation management.

The method yields:
- ModelStreamEvent - Original streaming events (passed through)
- ContentBlock - Complete content block (emitted when block completes)
The method returns:
- StreamAggregatedResult containing the complete message, stop reason, and optional metadata
All exceptions thrown from this method are wrapped in ModelError to provide a consistent error type for model-related errors. Specific error subtypes like ContextWindowOverflowError, ModelThrottledError, and MaxTokensError are preserved.
Parameters
- messages: Message[]
  Array of conversation messages
- Optionaloptions: StreamOptions
  Optional streaming configuration
Returns AsyncGenerator<
    ModelStreamEvent
    | ContentBlock,
    StreamAggregatedResult,
    undefined,
>
Async generator yielding ModelStreamEvent | ContentBlock and returning a StreamAggregatedResult

Throws
ModelError - Base class for all model-related errors

Throws
ContextWindowOverflowError - When input exceeds the model's context window

Throws
ModelThrottledError - When the model provider throttles requests

Throws
MaxTokensError - When the model reaches its maximum token limit
- Defined in sdk-typescript/src/models/model.ts:188