langchain.js
    Preparing search index...

    Class OllamaEmbeddings

    OllamaEmbeddings have been moved to the @langchain/ollama package. Install it with npm install @langchain/ollama.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    baseUrl headers? keepAlive model requestOptions?

    Methods

    _convertOptions _embed _request embedDocuments embedQuery

    Constructors

    • Parameters

      • Optionalparams: OllamaEmbeddingsParams

      Returns OllamaEmbeddings

    Properties

    baseUrl: string = "http://localhost:11434"
    headers?: Record<string, string>
    keepAlive: string = "5m"
    model: string = "llama2"
    requestOptions?: {
        embedding_only?: boolean;
        f16_kv?: boolean;
        frequency_penalty?: number;
        logits_all?: boolean;
        low_vram?: boolean;
        main_gpu?: number;
        mirostat?: number;
        mirostat_eta?: number;
        mirostat_tau?: number;
        num_batch?: number;
        num_ctx?: number;
        num_gpu?: number;
        num_gqa?: number;
        num_keep?: number;
        num_predict?: number;
        num_thread?: number;
        penalize_newline?: boolean;
        presence_penalty?: number;
        repeat_last_n?: number;
        repeat_penalty?: number;
        rope_frequency_base?: number;
        rope_frequency_scale?: number;
        stop?: string[];
        temperature?: number;
        tfs_z?: number;
        top_k?: number;
        top_p?: number;
        typical_p?: number;
        use_mlock?: boolean;
        use_mmap?: boolean;
        vocab_only?: boolean;
    }

    Methods

    _convertOptions

    • _convertOptions(
          requestOptions: CamelCasedRequestOptions,
      ): Record<string, unknown>

      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

      Parameters

      • requestOptions: CamelCasedRequestOptions

      Returns Record<string, unknown>

    _embed

    • _embed(texts: string[]): Promise<number[][]>

      Parameters

      • texts: string[]

      Returns Promise<number[][]>

    _request

    • _request(prompt: string): Promise<number[]>

      Parameters

      • prompt: string

      Returns Promise<number[]>

    • Parameters

      • documents: string[]

      Returns Promise<number[][]>

    • Parameters

      • document: string

      Returns Promise<number[]>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods