44 lines
2 KiB
TypeScript
44 lines
2 KiB
TypeScript
|
import { Embeddings, EmbeddingsParams } from "@langchain/core/embeddings";
|
||
|
|
import { OllamaInput, OllamaRequestParams } from "../utils/ollama.js";
|
||
|
|
type CamelCasedRequestOptions = Omit<OllamaInput, "baseUrl" | "model" | "format" | "headers">;
|
||
|
|
/**
|
||
|
|
* Interface for OllamaEmbeddings parameters. Extends EmbeddingsParams and
|
||
|
|
* defines additional parameters specific to the OllamaEmbeddings class.
|
||
|
|
*/
|
||
|
|
interface OllamaEmbeddingsParams extends EmbeddingsParams {
|
||
|
|
/** The Ollama model to use, e.g: "llama2:13b" */
|
||
|
|
model?: string;
|
||
|
|
/** Base URL of the Ollama server, defaults to "http://localhost:11434" */
|
||
|
|
baseUrl?: string;
|
||
|
|
/** Extra headers to include in the Ollama API request */
|
||
|
|
headers?: Record<string, string>;
|
||
|
|
/** Defaults to "5m" */
|
||
|
|
keepAlive?: string;
|
||
|
|
/** Advanced Ollama API request parameters in camelCase, see
|
||
|
|
* https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md#valid-parameters-and-values
|
||
|
|
* for details of the available parameters.
|
||
|
|
*/
|
||
|
|
requestOptions?: CamelCasedRequestOptions;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* @deprecated OllamaEmbeddings have been moved to the `@langchain/ollama` package. Install it with `npm install @langchain/ollama`.
|
||
|
|
*/
|
||
|
|
export declare class OllamaEmbeddings extends Embeddings {
|
||
|
|
model: string;
|
||
|
|
baseUrl: string;
|
||
|
|
headers?: Record<string, string>;
|
||
|
|
keepAlive: string;
|
||
|
|
requestOptions?: OllamaRequestParams["options"];
|
||
|
|
constructor(params?: OllamaEmbeddingsParams);
|
||
|
|
/** convert camelCased Ollama request options like "useMMap" to
|
||
|
|
* the snake_cased equivalent which the ollama API actually uses.
|
||
|
|
* Used only for consistency with the llms/Ollama and chatModels/Ollama classes
|
||
|
|
*/
|
||
|
|
_convertOptions(requestOptions: CamelCasedRequestOptions): Record<string, unknown>;
|
||
|
|
_request(prompt: string): Promise<number[]>;
|
||
|
|
_embed(texts: string[]): Promise<number[][]>;
|
||
|
|
embedDocuments(documents: string[]): Promise<number[][]>;
|
||
|
|
embedQuery(document: string): Promise<number[]>;
|
||
|
|
}
|
||
|
|
export {};
|