langchain.js
    Preparing search index...

    Interface BedrockEmbeddingsParams

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

    interface BedrockEmbeddingsParams {
        client?: BedrockRuntimeClient;
        clientOptions?: BedrockRuntimeClientConfig;
        credentials?: CredentialType;
        dimensions?: number;
        model?: string;
        modelParameters?: Record<string, unknown>;
        region?: string;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    client? clientOptions? credentials? dimensions? model? modelParameters? region?

    Properties

    client?: BedrockRuntimeClient

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

    clientOptions?: BedrockRuntimeClientConfig

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

    credentials?: CredentialType
    dimensions?: number

    The number of dimensions for the output embeddings. Only supported by certain models (e.g., Amazon Titan Embed Text v2, Cohere Embed). If not specified, uses the model's default.

    model?: string

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

    modelParameters?: Record<string, unknown>

    Additional parameters to pass to the model as part of the InvokeModel request body.

    These are merged into the request payload, allowing model-specific options like normalize, embeddingTypes, etc.

    If dimensions is also provided as a top-level parameter, it will take precedence over a dimensions key set in modelParameters.

    region?: string

    Settings

    Member Visibility

    On This Page

    Properties