BedrockModelOptions

Options for creating a BedrockModel instance.

Extends

BedrockModelConfig

Properties

maxTokens?

optional maxTokens: number;

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

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:126

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:133

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:138

Array of sequences that will stop generation when encountered.

Inherited from

BedrockModelConfig.stopSequences

cachePrompt?

optional cachePrompt: string;

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

Cache point type for the system prompt.

See

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

Inherited from

BedrockModelConfig.cachePrompt

cacheTools?

optional cacheTools: string;

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

Cache point type for tools.

See

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

Inherited from

BedrockModelConfig.cacheTools

additionalRequestFields?

optional additionalRequestFields: JSONValue;

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

Additional fields to include in the Bedrock request.

Inherited from

BedrockModelConfig.additionalRequestFields

additionalResponseFieldPaths?

optional additionalResponseFieldPaths: string[];

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

Additional response field paths to extract from the Bedrock response.

Inherited from

BedrockModelConfig.additionalResponseFieldPaths

additionalArgs?

optional additionalArgs: JSONValue;

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

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:176

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:184

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

region?

optional region: string;

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

AWS region to use for the Bedrock service.

clientConfig?

optional clientConfig: BedrockRuntimeClientConfig;

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

Configuration for the Bedrock Runtime client.

apiKey?

optional apiKey: string;

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

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:35

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

Inherited from

BedrockModelConfig.modelId