langchain.js
    Preparing search index...

    Class BedrockEmbeddings

    Class that extends the Embeddings class and provides methods for generating embeddings using the Bedrock API.

    const embeddings = new BedrockEmbeddings({
      region: "your-aws-region",
      credentials: {
        accessKeyId: "your-access-key-id",
        secretAccessKey: "your-secret-access-key",
      },
      model: "amazon.titan-embed-text-v1",
      // Configure client options (e.g., custom request handler)
      // clientOptions: {
      //   requestHandler: myCustomRequestHandler,
      // },
    });

    // Embed a query and log the result
    const res = await embeddings.embedQuery(
      "What would be a good company name for a company that makes colorful socks?"
    );
    console.log({ res });

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    batchSize client clientOptions? model

    Methods

    _embedText embedDocuments embedQuery

    Constructors

    Properties

    batchSize: number = 512
    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.

    model: string

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

    Methods

    Protected_embedText

    • _embedText(text: string): Promise<number[]>

      Protected method to make a request to the Bedrock API to generate embeddings. Handles the retry logic and returns the response from the API.

      Parameters

      • text: string

      Returns Promise<number[]>

      Promise that resolves to the response from the API.

    • Method to generate embeddings for an array of texts. Calls _embedText method which batches and handles retry logic when calling the AWS Bedrock API.

      Parameters

      • documents: string[]

        Array of texts for which to generate embeddings.

      Returns Promise<number[][]>

      Promise that resolves to a 2D array of embeddings for each input document.

    • Method that takes a document as input and returns a promise that resolves to an embedding for the document. It calls the _embedText method with the document as the input.

      Parameters

      • document: string

        Document for which to generate an embedding.

      Returns Promise<number[]>

      Promise that resolves to an embedding for the input document.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods