Deprecated in favor of the @langchain/ollama package. Import ChatOllama from @langchain/ollama instead.

Hierarchy

Constructors

Properties

ParsedCallOptions: Omit<ChatOllamaFunctionsCallOptions,
    | "tags"
    | "configurable"
    | "recursionLimit"
    | "runName"
    | "metadata"
    | "callbacks"
    | "runId">
cache?: BaseCache<Generation[]>
callbacks?: Callbacks
caller: AsyncCaller

The async caller should be used by subclasses to make any async calls, which will thus benefit from the concurrency and retry logic.

defaultResponseFunction: {
    description: string;
    name: string;
    parameters: {
        properties: {
            response: {
                description: string;
                type: string;
            };
        };
        required: string[];
        type: string;
    };
} = ...
metadata?: Record<string, unknown>
name?: string
tags?: string[]
toolSystemPromptTemplate: string = DEFAULT_TOOL_SYSTEM_TEMPLATE
verbose: boolean

Whether to print out response text.

Accessors

  • get callKeys(): string[]
  • Keys that the language model accepts as call options.

    Returns string[]

Methods

  • Convert a runnable to a tool. Return a new instance of RunnableToolLike which contains the runnable, name, description and schema.

    Type Parameters

    • T extends BaseLanguageModelInput = BaseLanguageModelInput

    Parameters

    • fields: {
          description?: string;
          name?: string;
          schema: ZodType<T, ZodTypeDef, T>;
      }
      • Optionaldescription?: string

        The description of the tool. Falls back to the description on the Zod schema if not provided, or undefined if neither are provided.

      • Optionalname?: string

        The name of the tool. If not provided, it will default to the name of the runnable.

      • schema: ZodType<T, ZodTypeDef, T>

        The Zod schema for the input of the tool. Infers the Zod type from the input type of the runnable.

    Returns RunnableToolLike<ZodType<ToolCall | T, ZodTypeDef, ToolCall | T>, BaseMessageChunk>

    An instance of RunnableToolLike which is a runnable that can be used as a tool.

  • Assigns new fields to the dict output of this runnable. Returns a new runnable.

    Parameters

    • mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

    Returns Runnable<any, any, RunnableConfig<Record<string, any>>>

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    • inputs: BaseLanguageModelInput[]

      Array of inputs to each batch call.

    • Optionaloptions: Partial<ChatOllamaFunctionsCallOptions> | Partial<ChatOllamaFunctionsCallOptions>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • OptionalbatchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<BaseMessageChunk[]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<(Error | BaseMessageChunk)[]>

  • Parameters

    Returns Promise<(Error | BaseMessageChunk)[]>

  • Bind arguments to a Runnable, returning a new Runnable.

    Parameters

    Returns Runnable<BaseLanguageModelInput, BaseMessageChunk, ChatOllamaFunctionsCallOptions>

    A new RunnableBinding that, when invoked, will apply the bound args.

  • Bind tool-like objects to this chat model.

    Parameters

    • tools: BindToolsInput[]

      A list of tool definitions to bind to this chat model. Can be a structured tool, an OpenAI formatted tool, or an object matching the provider's specific tool schema.

    • Optionalkwargs: Partial<ChatOllamaFunctionsCallOptions>

      Any additional parameters to bind.

    Returns Runnable<BaseLanguageModelInput, BaseMessageChunk, ChatOllamaFunctionsCallOptions>

  • Parameters

    • messages: BaseMessageLike[]

      An array of BaseMessage instances.

    • Optionaloptions: string[] | ChatOllamaFunctionsCallOptions

      The call options or an array of stop sequences.

    • Optionalcallbacks: Callbacks

      The callbacks for the language model.

    Returns Promise<BaseMessage>

    A Promise that resolves to a BaseMessage.

    Use .invoke() instead. Will be removed in 0.2.0.

    Makes a single call to the chat model.

  • Parameters

    • promptValue: BasePromptValueInterface

      The value of the prompt.

    • Optionaloptions: string[] | ChatOllamaFunctionsCallOptions

      The call options or an array of stop sequences.

    • Optionalcallbacks: Callbacks

      The callbacks for the language model.

    Returns Promise<BaseMessage>

    A Promise that resolves to a BaseMessage.

    Use .invoke() instead. Will be removed in 0.2.0.

    Makes a single call to the chat model with a prompt value.

  • Generates chat based on the input messages.

    Parameters

    • messages: BaseMessageLike[][]

      An array of arrays of BaseMessage instances.

    • Optionaloptions: string[] | ChatOllamaFunctionsCallOptions

      The call options or an array of stop sequences.

    • Optionalcallbacks: Callbacks

      The callbacks for the language model.

    Returns Promise<LLMResult>

    A Promise that resolves to an LLMResult.

  • Generates a prompt based on the input prompt values.

    Parameters

    • promptValues: BasePromptValueInterface[]

      An array of BasePromptValue instances.

    • Optionaloptions: string[] | ChatOllamaFunctionsCallOptions

      The call options or an array of stop sequences.

    • Optionalcallbacks: Callbacks

      The callbacks for the language model.

    Returns Promise<LLMResult>

    A Promise that resolves to an LLMResult.

  • Parameters

    • Optional_: RunnableConfig<Record<string, any>>

    Returns Graph

  • Parameters

    • options: Omit<ChatOllamaFunctionsCallOptions,
          | "tags"
          | "configurable"
          | "recursionLimit"
          | "runName"
          | "metadata"
          | "callbacks"
          | "runId">

    Returns LangSmithParams

  • Parameters

    • Optionalsuffix: string

    Returns string

  • Parameters

    • content: MessageContent

    Returns Promise<number>

  • Get the parameters used to invoke the model

    Returns {
        format: undefined | StringWithAutocomplete<"json">;
        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: undefined | string[];
            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 | StringWithAutocomplete<"json">
    • 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: undefined | string[];
          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: undefined | string[]
      • 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
  • Invokes the chat model with a single input.

    Parameters

    Returns Promise<BaseMessageChunk>

    A Promise that resolves to a BaseMessageChunk.

  • Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

    Returns Runnable<BaseLanguageModelInput[], BaseMessageChunk[], ChatOllamaFunctionsCallOptions>

  • Pick keys from the dict output of this runnable. Returns a new runnable.

    Parameters

    • keys: string | string[]

    Returns Runnable<any, any, RunnableConfig<Record<string, any>>>

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<BaseMessageChunk, NewRunOutput, RunnableConfig<Record<string, any>>>

      A runnable, function, or object whose values are functions or runnables.

    Returns Runnable<BaseLanguageModelInput, Exclude<NewRunOutput, Error>, RunnableConfig<Record<string, any>>>

    A new runnable sequence.

  • Parameters

    • text: string

      The text input.

    • Optionaloptions: string[] | ChatOllamaFunctionsCallOptions

      The call options or an array of stop sequences.

    • Optionalcallbacks: Callbacks

      The callbacks for the language model.

    Returns Promise<string>

    A Promise that resolves to a string.

    Use .invoke() instead. Will be removed in 0.2.0.

    Predicts the next message based on a text input.

  • Parameters

    • messages: BaseMessage[]

      An array of BaseMessage instances.

    • Optionaloptions: string[] | ChatOllamaFunctionsCallOptions

      The call options or an array of stop sequences.

    • Optionalcallbacks: Callbacks

      The callbacks for the language model.

    Returns Promise<BaseMessage>

    A Promise that resolves to a BaseMessage.

    Use .invoke() instead. Will be removed in 0.2.0.

    Predicts the next message based on the input messages.

  • Returns SerializedLLM

    Return a json-like object representing this LLM.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<BaseMessageChunk>>

    A readable stream that is also an iterable.

  • Generate a stream of events emitted by the internal steps of the runnable.

    Use to create an iterator over StreamEvents that provide real-time information about the progress of the runnable, including StreamEvents from intermediate results.

    A StreamEvent is a dictionary with the following schema:

    • event: string - Event names are of the format: on_[runnable_type]_(start|stream|end).
    • name: string - The name of the runnable that generated the event.
    • run_id: string - Randomly generated ID associated with the given execution of the runnable that emitted the event. A child runnable that gets invoked as part of the execution of a parent runnable is assigned its own unique ID.
    • tags: string[] - The tags of the runnable that generated the event.
    • metadata: Record<string, any> - The metadata of the runnable that generated the event.
    • data: Record<string, any>

    Below is a table that illustrates some events that might be emitted by various chains. Metadata fields have been omitted from the table for brevity. Chain definitions have been included after the table.

    ATTENTION This reference table is for the V2 version of the schema.

    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | event                | name             | chunk                           | input                                         | output                                          |
    +======================+==================+=================================+===============================================+=================================================+
    | on_chat_model_start  | [model name]     |                                 | {"messages": [[SystemMessage, HumanMessage]]} |                                                 |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_chat_model_stream | [model name]     | AIMessageChunk(content="hello") |                                               |                                                 |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_chat_model_end    | [model name]     |                                 | {"messages": [[SystemMessage, HumanMessage]]} | AIMessageChunk(content="hello world")           |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_llm_start         | [model name]     |                                 | {'input': 'hello'}                            |                                                 |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_llm_stream        | [model name]     | 'Hello'                         |                                               |                                                 |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_llm_end           | [model name]     |                                 | 'Hello human!'                                |                                                 |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_chain_start       | some_runnable    |                                 |                                               |                                                 |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_chain_stream      | some_runnable    | "hello world!, goodbye world!"  |                                               |                                                 |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_chain_end         | some_runnable    |                                 | [Document(...)]                               | "hello world!, goodbye world!"                  |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_tool_start        | some_tool        |                                 | {"x": 1, "y": "2"}                            |                                                 |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_tool_end          | some_tool        |                                 |                                               | {"x": 1, "y": "2"}                              |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_retriever_start   | [retriever name] |                                 | {"query": "hello"}                            |                                                 |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_retriever_end     | [retriever name] |                                 | {"query": "hello"}                            | [Document(...), ..]                             |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_prompt_start      | [template_name]  |                                 | {"question": "hello"}                         |                                                 |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    | on_prompt_end        | [template_name]  |                                 | {"question": "hello"}                         | ChatPromptValue(messages: [SystemMessage, ...]) |
    +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
    

    The "on_chain_*" events are the default for Runnables that don't fit one of the above categories.

    In addition to the standard events above, users can also dispatch custom events.

    Custom events will be only be surfaced with in the v2 version of the API!

    A custom event has following format:

    +-----------+------+-----------------------------------------------------------------------------------------------------------+
    | Attribute | Type | Description                                                                                               |
    +===========+======+===========================================================================================================+
    | name      | str  | A user defined name for the event.                                                                        |
    +-----------+------+-----------------------------------------------------------------------------------------------------------+
    | data      | Any  | The data associated with the event. This can be anything, though we suggest making it JSON serializable.  |
    +-----------+------+-----------------------------------------------------------------------------------------------------------+
    

    Here's an example:

    import { RunnableLambda } from "@langchain/core/runnables";
    import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch";
    // Use this import for web environments that don't support "async_hooks"
    // and manually pass config to child runs.
    // import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch/web";

    const slowThing = RunnableLambda.from(async (someInput: string) => {
    // Placeholder for some slow operation
    await new Promise((resolve) => setTimeout(resolve, 100));
    await dispatchCustomEvent("progress_event", {
    message: "Finished step 1 of 2",
    });
    await new Promise((resolve) => setTimeout(resolve, 100));
    return "Done";
    });

    const eventStream = await slowThing.streamEvents("hello world", {
    version: "v2",
    });

    for await (const event of eventStream) {
    if (event.event === "on_custom_event") {
    console.log(event);
    }
    }

    Parameters

    • input: BaseLanguageModelInput
    • options: Partial<ChatOllamaFunctionsCallOptions> & {
          version: "v1" | "v2";
      }
    • OptionalstreamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">

    Returns IterableReadableStream<StreamEvent>

  • Parameters

    • input: BaseLanguageModelInput
    • options: Partial<ChatOllamaFunctionsCallOptions> & {
          encoding: "text/event-stream";
          version: "v1" | "v2";
      }
    • OptionalstreamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">

    Returns IterableReadableStream<Uint8Array>

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    • input: BaseLanguageModelInput
    • Optionaloptions: Partial<ChatOllamaFunctionsCallOptions>
    • OptionalstreamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Returns Serialized

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    Returns AsyncGenerator<BaseMessageChunk, any, unknown>

  • Bind config to a Runnable, returning a new Runnable.

    Parameters

    • config: RunnableConfig<Record<string, any>>

      New configuration parameters to attach to the new runnable.

    Returns RunnableBinding<BaseLanguageModelInput, BaseMessageChunk, ChatOllamaFunctionsCallOptions>

    A new RunnableBinding with a config matching what's passed.

  • Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.

    Parameters

    • fields: {
          fallbacks: Runnable<BaseLanguageModelInput, BaseMessageChunk, RunnableConfig<Record<string, any>>>[];
      } | Runnable<BaseLanguageModelInput, BaseMessageChunk, RunnableConfig<Record<string, any>>>[]

    Returns RunnableWithFallbacks<BaseLanguageModelInput, BaseMessageChunk>

    A new RunnableWithFallbacks.

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>);
          onError?: ((run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>);
          onStart?: ((run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>);
      }

      The object containing the callback functions.

      • OptionalonEnd?: ((run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>)

        Called after the runnable finishes running, with the Run object.

          • (run, config?): void | Promise<void>
          • Parameters

            • run: Run
            • Optionalconfig: RunnableConfig<Record<string, any>>

            Returns void | Promise<void>

      • OptionalonError?: ((run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>)

        Called if the runnable throws an error, with the Run object.

          • (run, config?): void | Promise<void>
          • Parameters

            • run: Run
            • Optionalconfig: RunnableConfig<Record<string, any>>

            Returns void | Promise<void>

      • OptionalonStart?: ((run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>)

        Called before the runnable starts running, with the Run object.

          • (run, config?): void | Promise<void>
          • Parameters

            • run: Run
            • Optionalconfig: RunnableConfig<Record<string, any>>

            Returns void | Promise<void>

    Returns Runnable<BaseLanguageModelInput, BaseMessageChunk, ChatOllamaFunctionsCallOptions>

  • Add retry logic to an existing runnable.

    Parameters

    • Optionalfields: {
          onFailedAttempt?: RunnableRetryFailedAttemptHandler;
          stopAfterAttempt?: number;
      }
      • OptionalonFailedAttempt?: RunnableRetryFailedAttemptHandler
      • OptionalstopAfterAttempt?: number

    Returns RunnableRetry<BaseLanguageModelInput, BaseMessageChunk, ChatOllamaFunctionsCallOptions>

    A new RunnableRetry that, when invoked, will retry according to the parameters.

  • Model wrapper that returns outputs formatted to match the given schema.

    Type Parameters

    • RunOutput extends Record<string, any> = Record<string, any>

      The output type for the Runnable, expected to be a Zod schema object for structured output validation.

    Parameters

    • outputSchema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>
    • Optionalconfig: StructuredOutputMethodOptions<false>

    Returns Runnable<BaseLanguageModelInput, RunOutput, RunnableConfig<Record<string, any>>>

    A new runnable that calls the LLM with structured output.

  • Model wrapper that returns outputs formatted to match the given schema.

    Type Parameters

    • RunOutput extends Record<string, any> = Record<string, any>

      The output type for the Runnable, expected to be a Zod schema object for structured output validation.

    Parameters

    • outputSchema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>
    • Optionalconfig: StructuredOutputMethodOptions<true>

    Returns Runnable<BaseLanguageModelInput, {
        parsed: RunOutput;
        raw: BaseMessage;
    }, RunnableConfig<Record<string, any>>>

    A new runnable that calls the LLM with structured output.

  • Parameters

    • _data: SerializedLLM

    Returns Promise<BaseLanguageModel<any, BaseLanguageModelCallOptions>>

    Load an LLM from a json-like object describing it.

  • Parameters

    • thing: any

    Returns thing is Runnable<any, any, RunnableConfig<Record<string, any>>>