Interface BedrockChatFields

interface BedrockChatFields {
    credentials?: AwsCredentialIdentity | Provider<AwsCredentialIdentity>;
    endpointHost?: string;
    endpointUrl?: string;
    fetchFn?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    guardrailConfig?: {
        streamProcessingMode: "SYNCHRONOUS" | "ASYNCHRONOUS";
        tagSuffix: string;
    };
    guardrailIdentifier?: string;
    guardrailVersion?: string;
    maxTokens?: number;
    model?: string;
    modelKwargs?: Record<string, unknown>;
    region?: string;
    stopSequences?: string[];
    streaming?: boolean;
    temperature?: number;
    trace?: "ENABLED" | "DISABLED";
}

Hierarchy (view full)

  • Partial<BaseBedrockInput>
  • Toolkit
    • BedrockChatFields

Properties

credentials? endpointHost? endpointUrl? fetchFn? guardrailConfig? guardrailIdentifier? guardrailVersion? maxTokens? model? modelKwargs? region? stopSequences? streaming? temperature? trace?

Properties

Optional credentials

credentials?: AwsCredentialIdentity | Provider<AwsCredentialIdentity>

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

Optional endpointHost

endpointHost?: string

Override the default endpoint hostname.

Optional endpointUrl

endpointUrl?: string

⚠️ Deprecated ⚠️

Use endpointHost instead Override the default endpoint url.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Optional fetchFn

fetchFn?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

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

Type declaration

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

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

      Parameters

      • input: string | URL | Request
      • Optional init: RequestInit

      Returns Promise<Response>

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

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

      Parameters

      • input: RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

Optional guardrailConfig

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

Required when Guardrail is in use.

Type declaration

  • streamProcessingMode: "SYNCHRONOUS" | "ASYNCHRONOUS"
  • tagSuffix: string

Optional guardrailIdentifier

guardrailIdentifier?: string

Identifier for the guardrail configuration.

Optional guardrailVersion

guardrailVersion?: string

Version for the guardrail configuration.

Optional maxTokens

maxTokens?: number

Max tokens.

Optional model

model?: string

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

Optional modelKwargs

modelKwargs?: Record<string, unknown>

Additional kwargs to pass to the model.

Optional region

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.

Optional stopSequences

stopSequences?: string[]

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

Deprecated

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

Optional streaming

streaming?: boolean

Whether or not to stream responses

Optional temperature

temperature?: number

Temperature.

Optional trace

trace?: "ENABLED" | "DISABLED"

Trace settings for the Bedrock Guardrails.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc