Strands Agents Typescript SDK
    Preparing search index...

    Interface BedrockModelOptions

    Options for creating a BedrockModel instance.

    interface BedrockModelOptions {
        maxTokens?: number;
        temperature?: number;
        topP?: number;
        stopSequences?: string[];
        cachePrompt?: string;
        cacheTools?: string;
        additionalRequestFields?: JSONValue;
        additionalResponseFieldPaths?: string[];
        additionalArgs?: JSONValue;
        stream?: boolean;
        includeToolResultStatus?: boolean | "auto";
        region?: string;
        clientConfig?: BedrockRuntimeClientConfig;
        modelId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    maxTokens? temperature? topP? stopSequences? cachePrompt? cacheTools? additionalRequestFields? additionalResponseFieldPaths? additionalArgs? stream? includeToolResultStatus? region? clientConfig? modelId?

    Properties

    maxTokens?: number

    Maximum number of tokens to generate in the response.

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

    temperature?: number

    Controls randomness in generation.

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

    topP?: number

    Controls diversity via nucleus sampling.

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

    stopSequences?: string[]

    Array of sequences that will stop generation when encountered.

    cachePrompt?: string

    Cache point type for the system prompt.

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

    cacheTools?: string

    Cache point type for tools.

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

    additionalRequestFields?: JSONValue

    Additional fields to include in the Bedrock request.

    additionalResponseFieldPaths?: string[]

    Additional response field paths to extract from the Bedrock response.

    additionalArgs?: JSONValue

    Additional arguments to pass through to the Bedrock Converse API.

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

    stream?: boolean

    Whether or not to stream responses from the model.

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

    includeToolResultStatus?: boolean | "auto"

    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)
    region?: string

    AWS region to use for the Bedrock service.

    clientConfig?: BedrockRuntimeClientConfig

    Configuration for the Bedrock Runtime client.

    modelId?: string

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

    Settings

    Member Visibility

    On This Page

    Properties