langchain.js
    Preparing search index...

    Class Ollama

    Class that represents the Ollama language model. It extends the base LLM class and implements the OllamaInput interface.

    const ollama = new Ollama({
      baseUrl: "http://api.example.com",
      model: "llama3",
    });

    // Streaming translation from English to German
    const stream = await ollama.stream(
      `Translate "I love programming" into German.`
    );

    const chunks = [];
    for await (const chunk of stream) {
      chunks.push(chunk);
    }

    console.log(chunks.join(""));

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    baseUrl client embeddingOnly? f16KV? format? frequencyPenalty? keepAlive? lc_serializable logitsAll? lowVram? mainGpu? mirostat? mirostatEta? mirostatTau? model numBatch? numCtx? numGpu? numKeep? numPredict? numThread? penalizeNewline? presencePenalty? repeatLastN? repeatPenalty? stop? temperature? tfsZ? topK? topP? typicalP? useMLock? useMMap? vocabOnly?

    Methods

    _llmType _streamResponseChunks invocationParams lc_name

    Constructors

    • Parameters

      • Optionalfields: any

      Returns Ollama

    Properties

    baseUrl: string = "http://localhost:11434"

    Optionally override the base URL to make request to. This should only be set if your Ollama instance is being server from a non-standard location.

    "http://localhost:11434"
    client: Ollama
    embeddingOnly?: boolean
    f16KV?: boolean
    format?: any
    frequencyPenalty?: number
    keepAlive?: string | number
    "5m"
    lc_serializable: boolean = true
    logitsAll?: boolean
    lowVram?: boolean
    mainGpu?: number
    mirostat?: number
    mirostatEta?: number
    mirostatTau?: number
    model: string = "llama3"

    The model to use when making requests.

    "llama3"
    numBatch?: number
    numCtx?: number
    numGpu?: number
    numKeep?: number
    numPredict?: number
    numThread?: number
    penalizeNewline?: boolean
    presencePenalty?: number
    repeatLastN?: number
    repeatPenalty?: number
    stop?: string[]
    temperature?: number
    tfsZ?: number
    topK?: number
    topP?: number
    typicalP?: number
    useMLock?: boolean
    useMMap?: boolean
    vocabOnly?: boolean

    Methods

    _llmType

    • _llmType(): string

      Returns string

    _streamResponseChunks

    • _streamResponseChunks(
          prompt: string,
          options: unknown,
          runManager?: any,
      ): AsyncGenerator<GenerationChunk>

      Parameters

      • prompt: string
      • options: unknown
      • OptionalrunManager: any

      Returns AsyncGenerator<GenerationChunk>

    • Parameters

      • Optionaloptions: unknown

      Returns {
          format: any;
          images: any;
          keep_alive: undefined | string | number;
          model: string;
          options: {
              embedding_only: undefined | boolean;
              f16_kv: undefined | boolean;
              frequency_penalty: undefined | number;
              logits_all: undefined | boolean;
              low_vram: undefined | boolean;
              main_gpu: undefined | number;
              mirostat: undefined | number;
              mirostat_eta: undefined | number;
              mirostat_tau: undefined | number;
              num_batch: undefined | number;
              num_ctx: undefined | number;
              num_gpu: undefined | number;
              num_keep: undefined | number;
              num_predict: undefined | number;
              num_thread: undefined | number;
              penalize_newline: undefined | boolean;
              presence_penalty: undefined | number;
              repeat_last_n: undefined | number;
              repeat_penalty: undefined | number;
              stop: any;
              temperature: undefined | number;
              tfs_z: undefined | number;
              top_k: undefined | number;
              top_p: undefined | number;
              typical_p: undefined | number;
              use_mlock: undefined | boolean;
              use_mmap: undefined | boolean;
              vocab_only: undefined | boolean;
          };
      }

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods