Interface BedrockChatFields

interface BedrockChatFields {
    awsAccessKeyId?: string;
    awsSecretAccessKey?: string;
    awsSessionToken?: string;
    cache?: boolean | BaseCache<Generation[]>;
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    credentials?: CredentialType;
    endpointHost?: string;
    endpointUrl?: string;
    fetchFn?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>);
    guardrailConfig?: {
        streamProcessingMode: "SYNCHRONOUS" | "ASYNCHRONOUS";
        tagSuffix: string;
    };
    guardrailIdentifier?: string;
    guardrailVersion?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    maxTokens?: number;
    metadata?: Record<string, unknown>;
    model?: string;
    modelKwargs?: Record<string, unknown>;
    onFailedAttempt?: FailedAttemptHandler;
    region?: string;
    stopSequences?: string[];
    streaming?: boolean;
    tags?: string[];
    temperature?: number;
    trace?: "ENABLED" | "DISABLED";
    verbose?: boolean;
}

Hierarchy

  • Partial<BaseBedrockInput>
  • BaseChatModelParams
    • BedrockChatFields

Properties

awsAccessKeyId? awsSecretAccessKey? awsSessionToken? cache? callbackManager? callbacks? credentials? endpointHost? endpointUrl? fetchFn? guardrailConfig? guardrailIdentifier? guardrailVersion? maxConcurrency? maxRetries? maxTokens? metadata? model? modelKwargs? onFailedAttempt? region? stopSequences? streaming? tags? temperature? trace? verbose?

Properties

OptionalawsAccessKeyId

awsAccessKeyId?: string

OptionalawsSecretAccessKey

awsSecretAccessKey?: string

OptionalawsSessionToken

awsSessionToken?: string

Optionalcache

cache?: boolean | BaseCache<Generation[]>

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

Optionalcredentials

credentials?: CredentialType

AWS Credentials. If no credentials are provided, the default credentials from @aws-sdk/credential-provider-node will be used.

OptionalendpointHost

endpointHost?: string

Override the default endpoint hostname.

OptionalendpointUrl

endpointUrl?: string

Deprecated

Use endpointHost instead Override the default endpoint url.

OptionalfetchFn

fetchFn?: ((input: RequestInfo | URL, init?: RequestInit) => Promise<Response>)

A custom fetch function for low-level access to AWS API. Defaults to fetch().

Type declaration

    • (input, init?): Promise<Response>

    • MDN Reference

      Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

OptionalguardrailConfig

guardrailConfig?: {
    streamProcessingMode: "SYNCHRONOUS" | "ASYNCHRONOUS";
    tagSuffix: string;
}

Required when Guardrail is in use.

OptionalguardrailIdentifier

guardrailIdentifier?: string

Identifier for the guardrail configuration.

OptionalguardrailVersion

guardrailVersion?: string

Version for the guardrail configuration.

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

OptionalmaxTokens

maxTokens?: number

Max tokens.

Optionalmetadata

metadata?: Record<string, unknown>

Optionalmodel

model?: string

Model to use. For example, "amazon.titan-tg1-large", this is equivalent to the modelId property in the list-foundation-models api.

OptionalmodelKwargs

modelKwargs?: Record<string, unknown>

Additional kwargs to pass to the model.

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

Optionalregion

region?: string

The AWS region e.g. us-west-2. Fallback to AWS_DEFAULT_REGION env variable or region specified in ~/.aws/config in case it is not provided here.

OptionalstopSequences

stopSequences?: string[]

Optional additional stop sequences to pass to the model. Currently only supported for Anthropic and AI21.

Deprecated

Use .bind({ "stop": [...] }) instead

Optionalstreaming

streaming?: boolean

Whether or not to stream responses

Optionaltags

tags?: string[]

Optionaltemperature

temperature?: number

Temperature.

Optionaltrace

trace?: "ENABLED" | "DISABLED"

Trace settings for the Bedrock Guardrails.

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties