Class Ollama

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

Example

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 full)

Implements

Constructors

constructor

Properties

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

Methods

invocationParams

Constructors

constructor

Properties

baseUrl

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.

Default

"http://localhost:11434"

client

client: Ollama

keepAlive

keepAlive: string | number = "5m"

Default

"5m"

model

model: string = "llama3"

The model to use when making requests.

Default

"llama3"

OptionalembeddingOnly

embeddingOnly?: boolean

Optionalf16KV

f16KV?: boolean

Optionalformat

format?: any

OptionalfrequencyPenalty

frequencyPenalty?: number

OptionallogitsAll

logitsAll?: boolean

OptionallowVram

lowVram?: boolean

OptionalmainGpu

mainGpu?: number

Optionalmirostat

mirostat?: number

OptionalmirostatEta

mirostatEta?: number

OptionalmirostatTau

mirostatTau?: number

OptionalnumBatch

numBatch?: number

OptionalnumCtx

numCtx?: number

OptionalnumGpu

numGpu?: number

OptionalnumKeep

numKeep?: number

OptionalnumPredict

numPredict?: number

OptionalnumThread

numThread?: number

OptionalpenalizeNewline

penalizeNewline?: boolean

OptionalpresencePenalty

presencePenalty?: number

OptionalrepeatLastN

repeatLastN?: number

OptionalrepeatPenalty

repeatPenalty?: number

Optionalstop

stop?: string[]

Optionaltemperature

temperature?: number

OptionaltfsZ

tfsZ?: number

OptionaltopK

topK?: number

OptionaltopP

topP?: number

OptionaltypicalP

typicalP?: number

OptionaluseMLock

useMLock?: boolean

OptionaluseMMap

useMMap?: boolean

OptionalvocabOnly

vocabOnly?: boolean

Methods

invocationParams

  • invocationParams(options?): {
        format: any;
        images: any;
        keep_alive: 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;
        };
    }

  • Parameters

    • Optionaloptions: unknown

    Returns {
        format: any;
        images: any;
        keep_alive: 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;
        };
    }

    • format: any
    • images: any
    • keep_alive: 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;
      }
      • 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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods