Class CohereEmbeddings

A class for generating embeddings using the Cohere API.

Hierarchy (view full)

Toolkit
- CohereEmbeddings

Implements

CohereEmbeddingsParams

Index

Constructors

Properties

batchSize embeddingTypes model

Methods

embed embedDocuments embedQuery

Constructors

constructor

new CohereEmbeddings(fields?): CohereEmbeddings
Constructor for the CohereEmbeddings class.
Parameters
- Optionalfields: Partial<CohereEmbeddingsParams> & {
  apiKey?: string;
  verbose?: boolean;
  }
  An optional object with properties to configure the instance.
Returns CohereEmbeddings
Overrides Embeddings.constructor
- Defined in libs/langchain-cohere/src/embeddings.ts:57

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.

embeddingTypes

embeddingTypes: string[] = ...

Specifies the type of embeddings you want to generate.

model

model: undefined | string

Methods

embed

embed(request): Promise<number[]>
Parameters
- request: EmbedRequest
Returns Promise<number[]>
- Defined in libs/langchain-cohere/src/embeddings.ts:157

embedDocuments

embedDocuments(texts): Promise<number[][]>
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.
- Defined in libs/langchain-cohere/src/embeddings.ts:95

embedQuery

embedQuery(text): Promise<number[]>
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.
- Defined in libs/langchain-cohere/src/embeddings.ts:133