BedrockModelOptions

Options for creating a BedrockModel instance.

Extends

BedrockModelConfig

Properties

maxTokens?

optional maxTokens?: number;

Defined in: src/models/bedrock.ts:245

Maximum number of tokens to generate in the response.

See

https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InferenceConfiguration.html

Inherited from

BedrockModelConfig.maxTokens

temperature?

optional temperature?: number;

Defined in: src/models/bedrock.ts:252

Controls randomness in generation.

See

https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InferenceConfiguration.html

Inherited from

BedrockModelConfig.temperature

topP?

optional topP?: number;

Defined in: src/models/bedrock.ts:259

Controls diversity via nucleus sampling.

See

https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InferenceConfiguration.html

Inherited from

BedrockModelConfig.topP

stopSequences?

optional stopSequences?: string[];

Defined in: src/models/bedrock.ts:264

Array of sequences that will stop generation when encountered.

Inherited from

BedrockModelConfig.stopSequences

cacheConfig?

optional cacheConfig?: BedrockCacheConfig;

Defined in: src/models/bedrock.ts:271

Configuration for prompt caching.

See

https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-caching.html

Inherited from

BedrockModelConfig.cacheConfig

additionalRequestFields?

optional additionalRequestFields?: JSONValue;

Defined in: src/models/bedrock.ts:276

Additional fields to include in the Bedrock request.

Inherited from

BedrockModelConfig.additionalRequestFields

additionalResponseFieldPaths?

optional additionalResponseFieldPaths?: string[];

Defined in: src/models/bedrock.ts:281

Additional response field paths to extract from the Bedrock response.

Inherited from

BedrockModelConfig.additionalResponseFieldPaths

additionalArgs?

optional additionalArgs?: JSONValue;

Defined in: src/models/bedrock.ts:287

Additional arguments to pass through to the Bedrock Converse API.

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-runtime/command/ConverseStreamCommand/

Inherited from

BedrockModelConfig.additionalArgs

stream?

optional stream?: boolean;

Defined in: src/models/bedrock.ts:297

Whether or not to stream responses from the model.

This will use the ConverseStream API instead of the Converse API.

See

Inherited from

BedrockModelConfig.stream

includeToolResultStatus?

optional includeToolResultStatus?: boolean | "auto";

Defined in: src/models/bedrock.ts:305

Flag to include status field in tool results.

true: Always include status field
false: Never include status field
'auto': Automatically determine based on model ID (default)

Inherited from

BedrockModelConfig.includeToolResultStatus

guardrailConfig?

optional guardrailConfig?: BedrockGuardrailConfig;

Defined in: src/models/bedrock.ts:311

Guardrail configuration for content filtering and safety controls.

See

https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html

Inherited from

BedrockModelConfig.guardrailConfig

useNativeTokenCount?

optional useNativeTokenCount?: boolean;

Defined in: src/models/bedrock.ts:322

Whether to use the native Bedrock CountTokens API.

When true, countTokens() calls the Bedrock CountTokens API for accurate counts. When false or not set (default), skips the API call and uses the character-based heuristic estimator.

Default Value

false

Inherited from

BedrockModelConfig.useNativeTokenCount

region?

optional region?: string;

Defined in: src/models/bedrock.ts:332

AWS region to use for the Bedrock service.

clientConfig?

optional clientConfig?: BedrockRuntimeClientConfig;

Defined in: src/models/bedrock.ts:337

Configuration for the Bedrock Runtime client.

apiKey?

optional apiKey?: string;

Defined in: src/models/bedrock.ts:344

Amazon Bedrock API key for bearer token authentication. When provided, requests use the API key instead of SigV4 signing.

See

https://docs.aws.amazon.com/bedrock/latest/userguide/api-keys.html

modelId?

optional modelId?: string;

Defined in: src/models/model.ts:91

The model identifier. This typically specifies which model to use from the provider’s catalog.

Inherited from

BedrockModelConfig.modelId

contextWindowLimit?

optional contextWindowLimit?: number;

Defined in: src/models/model.ts:124

Maximum context window size in tokens for the model.

This value represents the total token capacity shared between input and output. When not provided, it is automatically resolved from a built-in lookup table based on the configured model ID. An explicit value always takes precedence.

When modelId is changed via updateConfig(), this value is automatically re-resolved if it was initially auto-populated. Explicitly set values are preserved.

Inherited from

BedrockModelConfig.contextWindowLimit