Class ChatOllama

A class that enables calls to the Ollama API to access large language models in a chat-like fashion. It extends the SimpleChatModel class and implements the OllamaInput interface.

Example

const prompt = ChatPromptTemplate.fromMessages([
  [
    "system",
    `You are an expert translator. Format all responses as JSON objects with two keys: "original" and "translated".`,
  ],
  ["human", `Translate "{input}" into {language}.`],
]);

const model = new ChatOllama({
  baseUrl: "http://api.example.com",
  model: "llama2",
  format: "json",
});

const chain = prompt.pipe(model);

const result = await chain.invoke({
  input: "I love programming",
  language: "German",
});

Hierarchy (view full)

Implements

Constructors

constructor

Properties

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

Methods

invocationParams

Constructors

constructor

Properties

baseUrl

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

keepAlive

keepAlive: string = "5m"

model

model: string = "llama2"

Optional embeddingOnly

embeddingOnly?: boolean

Optional f16KV

f16KV?: boolean

Optional format

format?: any

Optional frequencyPenalty

frequencyPenalty?: number

Optional headers

headers?: Record<string, string>

Optional logitsAll

logitsAll?: boolean

Optional lowVram

lowVram?: boolean

Optional mainGpu

mainGpu?: number

Optional mirostat

mirostat?: number

Optional mirostatEta

mirostatEta?: number

Optional mirostatTau

mirostatTau?: number

Optional numBatch

numBatch?: number

Optional numCtx

numCtx?: number

Optional numGpu

numGpu?: number

Optional numGqa

numGqa?: number

Optional numKeep

numKeep?: number

Optional numPredict

numPredict?: number

Optional numThread

numThread?: number

Optional penalizeNewline

penalizeNewline?: boolean

Optional presencePenalty

presencePenalty?: number

Optional repeatLastN

repeatLastN?: number

Optional repeatPenalty

repeatPenalty?: number

Optional ropeFrequencyBase

ropeFrequencyBase?: number

Optional ropeFrequencyScale

ropeFrequencyScale?: number

Optional stop

stop?: string[]

Optional temperature

temperature?: number

Optional tfsZ

tfsZ?: number

Optional topK

topK?: number

Optional topP

topP?: number

Optional typicalP

typicalP?: number

Optional useMLock

useMLock?: boolean

Optional useMMap

useMMap?: boolean

Optional vocabOnly

vocabOnly?: boolean

Methods

invocationParams

  • invocationParams(options?): {
        format: any;
        keep_alive: string;
        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_gqa: 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;
            rope_frequency_base: undefined | number;
            rope_frequency_scale: 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;
        };
    }

  • A method that returns the parameters for an Ollama API call. It includes model and options parameters.

    Parameters

    • Optional options: unknown

      Optional parsed call options.

    Returns {
        format: any;
        keep_alive: string;
        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_gqa: 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;
            rope_frequency_base: undefined | number;
            rope_frequency_scale: 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;
        };
    }

    An object containing the parameters for an Ollama API call.

    • format: any
    • keep_alive: string
    • 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_gqa: 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;
          rope_frequency_base: undefined | number;
          rope_frequency_scale: 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;
      }
      • 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_gqa: 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
      • rope_frequency_base: undefined | number
      • rope_frequency_scale: 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc