Class: CohereEmbeddings
embeddings/cohere.CohereEmbeddings
A class for generating embeddings using the Cohere API.
Hierarchy
↳
CohereEmbeddings
Implements
ModelParams
Constructors
constructor
• new CohereEmbeddings(fields?)
Constructor for the CohereEmbeddings class.
Parameters
| Name | Type | Description |
|---|---|---|
fields? | AsyncCallerParams & Partial<ModelParams> & { apiKey?: string ; batchSize?: number ; verbose?: boolean } | An optional object with properties to configure the instance. |
Overrides
Defined in
langchain/src/embeddings/cohere.ts:28
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.
Defined in
langchain/src/embeddings/cohere.ts:18
caller
• Protected 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.
Inherited from
Defined in
langchain/src/embeddings/base.ts:10
modelName
• modelName: string = "small"
Implementation of
ModelParams.modelName
Defined in
langchain/src/embeddings/cohere.ts:12
Methods
embedDocuments
▸ embedDocuments(texts): Promise<number[][]>
Generates embeddings for an array of texts.
Parameters
| Name | Type | Description |
|---|---|---|
texts | string[] | An array of strings to generate embeddings for. |
Returns
Promise<number[][]>
A Promise that resolves to an array of embeddings.
Overrides
Defined in
langchain/src/embeddings/cohere.ts:57
embedQuery
▸ embedQuery(text): Promise<number[]>
Generates an embedding for a single text.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
langchain/src/embeddings/cohere.ts:83
imports
▸ Static imports(): Promise<{ cohere: Cohere }>
Dynamically imports the required dependencies for the CohereEmbeddings class.
Throws
An error if the cohere-ai dependency is not installed.
Returns
Promise<{ cohere: Cohere }>
An object containing the imported cohere-ai module.
Defined in
langchain/src/embeddings/cohere.ts:123