Class CohereEmbeddings

A class for generating embeddings using the Cohere API.

Example

// Embed a query using the CohereEmbeddings class
const model = new ChatOpenAI();
const res = await model.embedQuery(
  "What would be a good company name for a company that makes colorful socks?",
);
console.log({ res });

Hierarchy

  • Embeddings
    • CohereEmbeddings

Implements

Constructors

constructor

Properties

batchSize modelName

Methods

embedDocuments embedQuery

Constructors

constructor

  • Constructor for the CohereEmbeddings class.

    Parameters

    • Optional fields: Partial<CohereEmbeddingsParams> & {
          apiKey?: string;
          verbose?: boolean;
      }

      An optional object with properties to configure the instance.

    Returns CohereEmbeddings

Properties

batchSize

batchSize: number = 48

The maximum number of documents to embed in a single request. This is limited by the Cohere API to a maximum of 96.

modelName

modelName: string = "small"

Methods

embedDocuments

  • Generates embeddings for an array of texts.

    Parameters

    • texts: string[]

      An array of strings to generate embeddings for.

    Returns Promise<number[][]>

    A Promise that resolves to an array of embeddings.

embedQuery

  • Generates an embedding for a single text.

    Parameters

    • text: string

      A string to generate an embedding for.

    Returns Promise<number[]>

    A Promise that resolves to an array of numbers representing the embedding.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc