68 lines
2.4 KiB
TypeScript
68 lines
2.4 KiB
TypeScript
|
import { Embeddings, EmbeddingsParams } from "@langchain/core/embeddings";
|
||
|
|
/**
|
||
|
|
* Interface that extends EmbeddingsParams and defines additional
|
||
|
|
* parameters specific to the CohereEmbeddings class.
|
||
|
|
* @deprecated Use `CohereEmbeddingsParams` from `@langchain/cohere` instead.
|
||
|
|
*/
|
||
|
|
export interface CohereEmbeddingsParams extends EmbeddingsParams {
|
||
|
|
modelName: string;
|
||
|
|
/**
|
||
|
|
* The maximum number of documents to embed in a single request. This is
|
||
|
|
* limited by the Cohere API to a maximum of 96.
|
||
|
|
*/
|
||
|
|
batchSize?: number;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* A class for generating embeddings using the Cohere API.
|
||
|
|
* @example
|
||
|
|
* ```typescript
|
||
|
|
* // 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 });
|
||
|
|
* ```
|
||
|
|
* @deprecated Use `CohereEmbeddings` from `@langchain/cohere` instead.
|
||
|
|
*/
|
||
|
|
export declare class CohereEmbeddings extends Embeddings implements CohereEmbeddingsParams {
|
||
|
|
modelName: string;
|
||
|
|
batchSize: number;
|
||
|
|
private apiKey;
|
||
|
|
private client;
|
||
|
|
/**
|
||
|
|
* Constructor for the CohereEmbeddings class.
|
||
|
|
* @param fields - An optional object with properties to configure the instance.
|
||
|
|
*/
|
||
|
|
constructor(fields?: Partial<CohereEmbeddingsParams> & {
|
||
|
|
verbose?: boolean;
|
||
|
|
apiKey?: string;
|
||
|
|
});
|
||
|
|
/**
|
||
|
|
* Generates embeddings for an array of texts.
|
||
|
|
* @param texts - An array of strings to generate embeddings for.
|
||
|
|
* @returns A Promise that resolves to an array of embeddings.
|
||
|
|
*/
|
||
|
|
embedDocuments(texts: string[]): Promise<number[][]>;
|
||
|
|
/**
|
||
|
|
* Generates an embedding for a single text.
|
||
|
|
* @param text - A string to generate an embedding for.
|
||
|
|
* @returns A Promise that resolves to an array of numbers representing the embedding.
|
||
|
|
*/
|
||
|
|
embedQuery(text: string): Promise<number[]>;
|
||
|
|
/**
|
||
|
|
* Generates embeddings with retry capabilities.
|
||
|
|
* @param request - An object containing the request parameters for generating embeddings.
|
||
|
|
* @returns A Promise that resolves to the API response.
|
||
|
|
*/
|
||
|
|
private embeddingWithRetry;
|
||
|
|
/**
|
||
|
|
* Initializes the Cohere client if it hasn't been initialized already.
|
||
|
|
*/
|
||
|
|
private maybeInitClient;
|
||
|
|
/** @ignore */
|
||
|
|
static imports(): Promise<{
|
||
|
|
cohere: typeof import("cohere-ai");
|
||
|
|
}>;
|
||
|
|
}
|