BedrockModelOptions

Options for creating a BedrockModel instance.

Extends

BedrockModelConfig

Properties

maxTokens?

maxTokens?: number;

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

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?

temperature?: number;

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

Controls randomness in generation.

See

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

Inherited from

BedrockModelConfig.temperature

topP?

topP?: number;

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

Controls diversity via nucleus sampling.

See

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

Inherited from

BedrockModelConfig.topP

stopSequences?

stopSequences?: string[];

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

Array of sequences that will stop generation when encountered.

Inherited from

BedrockModelConfig.stopSequences

cacheConfig?

cacheConfig?: CacheConfig;

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

Configuration for prompt caching.

See

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

Inherited from

BedrockModelConfig.cacheConfig

additionalRequestFields?

additionalRequestFields?: JSONValue;

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

Additional fields to include in the Bedrock request.

Inherited from

BedrockModelConfig.additionalRequestFields

additionalResponseFieldPaths?

additionalResponseFieldPaths?: string[];

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

Additional response field paths to extract from the Bedrock response.

Inherited from

BedrockModelConfig.additionalResponseFieldPaths

additionalArgs?

additionalArgs?: JSONValue;

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

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?

stream?: boolean;

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

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?

includeToolResultStatus?: boolean | "auto";

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

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?

guardrailConfig?: BedrockGuardrailConfig;

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

Guardrail configuration for content filtering and safety controls.

See

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

Inherited from

BedrockModelConfig.guardrailConfig

useNativeTokenCount?

useNativeTokenCount?: boolean;

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

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

strictTools?

strictTools?: boolean;

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

Constrain the model to emit tool names and inputs that conform to each tool’s schema.

When true, every tool is sent with strict: true and a copy of its inputSchema with additionalProperties: false added to each object type, so a free-form { type: 'object' } parameter becomes one the model can only fill with {}. Bedrock rejects schemas that use features outside its strict subset (recursive or external $ref, minimum/maximum/ multipleOf, minLength/maxLength, additionalProperties other than false) with a 400 at request time, and compiles each new schema on first use, which can take minutes. Incompatible with citations for Anthropic models.

See

Default Value

false

Inherited from

BedrockModelConfig.strictTools

region?

region?: string;

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

AWS region to use for the Bedrock service.

clientConfig?

clientConfig?: BedrockRuntimeClientConfig;

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

Configuration for the Bedrock Runtime client.

requestTimeout?

requestTimeout?: number;

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

Milliseconds of stream inactivity before a Bedrock request is aborted.

Applies to the default request handler and takes precedence over clientConfig.requestHandler.requestTimeout. Ignored when clientConfig.requestHandler is a constructed handler instance, whose own timeouts apply.

Default Value

apiKey?

apiKey?: string;

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

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?

modelId?: string;

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

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

Inherited from

BedrockModelConfig.modelId

contextWindowLimit?

contextWindowLimit?: number;

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

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