Class ChatOllama

Integration with a chat model.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

model embeddingOnly? f16Kv? format? frequencyPenalty? keepAlive? logitsAll? lowVram? mainGpu? mirostat? mirostatEta? mirostatTau? numBatch? numCtx? numGpu? numKeep? numPredict? numThread? numa? penalizeNewline? presencePenalty? repeatLastN? repeatPenalty? seed? streaming? temperature? tfsZ? topK? topP? typicalP? useMlock? useMmap? vocabOnly?

Methods

invocationParams pull

Constructors

constructor

Properties

model

model: string = "llama3"

The model to invoke. If the model does not exist, it will be pulled.

Default

"llama3"

OptionalembeddingOnly

embeddingOnly?: boolean

Optionalf16Kv

f16Kv?: boolean

Optionalformat

format?: string

OptionalfrequencyPenalty

frequencyPenalty?: number

OptionalkeepAlive

keepAlive?: string | 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

Optionalnuma

numa?: boolean

OptionalpenalizeNewline

penalizeNewline?: boolean

OptionalpresencePenalty

presencePenalty?: number

OptionalrepeatLastN

repeatLastN?: number

OptionalrepeatPenalty

repeatPenalty?: number

Optionalseed

seed?: number

Optionalstreaming

streaming?: boolean

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: undefined | string;
        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;
            numa: undefined | boolean;
            penalize_newline: undefined | boolean;
            presence_penalty: undefined | number;
            repeat_last_n: undefined | number;
            repeat_penalty: undefined | number;
            seed: undefined | number;
            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

    • Optional_options: unknown

    Returns {
        format: undefined | string;
        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;
            numa: undefined | boolean;
            penalize_newline: undefined | boolean;
            presence_penalty: undefined | number;
            repeat_last_n: undefined | number;
            repeat_penalty: undefined | number;
            seed: undefined | number;
            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: undefined | string
    • 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;
          numa: undefined | boolean;
          penalize_newline: undefined | boolean;
          presence_penalty: undefined | number;
          repeat_last_n: undefined | number;
          repeat_penalty: undefined | number;
          seed: undefined | number;
          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
      • numa: undefined | boolean
      • penalize_newline: undefined | boolean
      • presence_penalty: undefined | number
      • repeat_last_n: undefined | number
      • repeat_penalty: undefined | number
      • seed: undefined | number
      • 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

pull

Settings

Member Visibility

On This Page

Constructors
Properties
Methods