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

CohereEmbeddingsParams

Index

Constructors

constructor

new CohereEmbeddings(fields?): CohereEmbeddings
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
Overrides Embeddings.constructor
- Defined in libs/langchain-community/src/embeddings/cohere.ts:48

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.

caller

caller: AsyncCaller

The async caller should be used by subclasses to make any async calls, which will thus benefit from the concurrency and retry logic.

modelName

modelName: string = "small"

Methods

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.
Overrides Embeddings.embedDocuments
- Defined in libs/langchain-community/src/embeddings/cohere.ts:75

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.
Overrides Embeddings.embedQuery
- Defined in libs/langchain-community/src/embeddings/cohere.ts:107

Class CohereEmbeddings

Example

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

Returns CohereEmbeddings

Properties

batchSize

caller

modelName

Methods

embedDocuments

Parameters

texts: string[]

Returns Promise<number[][]>

embedQuery

Parameters

text: string

Returns Promise<number[]>

Settings

Member Visibility

Theme

On This Page

Class CohereEmbeddings

Example

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

Returns CohereEmbeddings

Properties

batchSize

caller

modelName

Methods

embedDocuments

Parameters

texts: string[]

Returns Promise<number[][]>

embedQuery

Parameters

text: string

Returns Promise<number[]>

Settings

Member Visibility

Theme

On This Page

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