77 lines
2.4 KiB
TypeScript
77 lines
2.4 KiB
TypeScript
|
import { Embeddings, type EmbeddingsParams } from "@langchain/core/embeddings";
|
||
|
|
/**
|
||
|
|
* Interface that extends EmbeddingsParams and defines additional
|
||
|
|
* parameters specific to the VoyageEmbeddings class.
|
||
|
|
*/
|
||
|
|
export interface VoyageEmbeddingsParams extends EmbeddingsParams {
|
||
|
|
modelName: string;
|
||
|
|
/**
|
||
|
|
* The maximum number of documents to embed in a single request. This is
|
||
|
|
* limited by the Voyage AI API to a maximum of 8.
|
||
|
|
*/
|
||
|
|
batchSize?: number;
|
||
|
|
/**
|
||
|
|
* Input type for the embeddings request.
|
||
|
|
*/
|
||
|
|
inputType?: string;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Interface for the request body to generate embeddings.
|
||
|
|
*/
|
||
|
|
export interface CreateVoyageEmbeddingRequest {
|
||
|
|
/**
|
||
|
|
* @type {string}
|
||
|
|
* @memberof CreateVoyageEmbeddingRequest
|
||
|
|
*/
|
||
|
|
model: string;
|
||
|
|
/**
|
||
|
|
* Text to generate vector expectation
|
||
|
|
* @type {CreateEmbeddingRequestInput}
|
||
|
|
* @memberof CreateVoyageEmbeddingRequest
|
||
|
|
*/
|
||
|
|
input: string | string[];
|
||
|
|
/**
|
||
|
|
* Input type for the embeddings request.
|
||
|
|
*/
|
||
|
|
input_type?: string;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* A class for generating embeddings using the Voyage AI API.
|
||
|
|
*/
|
||
|
|
export declare class VoyageEmbeddings extends Embeddings implements VoyageEmbeddingsParams {
|
||
|
|
modelName: string;
|
||
|
|
batchSize: number;
|
||
|
|
private apiKey;
|
||
|
|
basePath?: string;
|
||
|
|
apiUrl: string;
|
||
|
|
headers?: Record<string, string>;
|
||
|
|
inputType?: string;
|
||
|
|
/**
|
||
|
|
* Constructor for the VoyageEmbeddings class.
|
||
|
|
* @param fields - An optional object with properties to configure the instance.
|
||
|
|
*/
|
||
|
|
constructor(fields?: Partial<VoyageEmbeddingsParams> & {
|
||
|
|
verbose?: boolean;
|
||
|
|
apiKey?: string;
|
||
|
|
inputType?: 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[]>;
|
||
|
|
/**
|
||
|
|
* Makes a request to the Voyage AI API to generate embeddings for an array of texts.
|
||
|
|
* @param request - An object with properties to configure the request.
|
||
|
|
* @returns A Promise that resolves to the response from the Voyage AI API.
|
||
|
|
*/
|
||
|
|
private embeddingWithRetry;
|
||
|
|
}
|