Interface BedrockEmbeddingsParams

Interface that extends EmbeddingsParams and defines additional parameters specific to the BedrockEmbeddings class.

interface BedrockEmbeddingsParams {
    client?: BedrockRuntimeClient;
    clientOptions?: BedrockRuntimeClientConfig;
    credentials?: CredentialType;
    maxConcurrency?: number;
    maxRetries?: number;
    model?: string;
    onFailedAttempt?: FailedAttemptHandler;
    region?: string;
}

Hierarchy

  • EmbeddingsParams
    • BedrockEmbeddingsParams

Implemented by

Properties

client? clientOptions? credentials? maxConcurrency? maxRetries? model? onFailedAttempt? region?

Properties

Optionalclient

client?: BedrockRuntimeClient

A client provided by the user that allows them to customze any SDK configuration options.

OptionalclientOptions

clientOptions?: BedrockRuntimeClientConfig

Overrideable configuration options for the BedrockRuntimeClient. Allows customization of client configuration such as requestHandler, etc. Will be ignored if 'client' is provided.

Optionalcredentials

credentials?: CredentialType

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.

Optionalmodel

model?: string

Model Name to use. Defaults to amazon.titan-embed-text-v1 if not provided

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

Settings

Member Visibility

On This Page

Properties