Class representing a Cohere Large Language Model (LLM). It interacts with the Cohere API to generate text completions.

Example

const model = new Cohere({
temperature: 0.7,
maxTokens: 20,
maxRetries: 5,
});

const res = await model.call(
"Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
);
console.log({ res });

Hierarchy

  • LLM<CohereCallOptions>
    • Cohere

Implements

Constructors

Properties

CallOptions: CohereCallOptions
ParsedCallOptions: Omit<CohereCallOptions, never>
apiKey: string
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.

client: CohereClient
maxTokens: number = 250

Maximum number of tokens to generate in the completion.

model: string

Model to use

temperature: number = 0

Sampling temperature to use

verbose: boolean

Whether to print out response text.

callbacks?: Callbacks
metadata?: Record<string, unknown>
name?: string
tags?: string[]

Accessors

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

    Returns string[]

Methods

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

    Parameters

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

    Returns RunnableSequence<any, 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.

    • Optional options: Partial<CohereCallOptions> | Partial<CohereCallOptions>[]

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

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<string[]>

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

  • Parameters

    Returns Promise<(string | Error)[]>

  • Parameters

    Returns Promise<(string | Error)[]>

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

    Parameters

    • kwargs: Partial<CohereCallOptions>

    Returns Runnable<BaseLanguageModelInput, string, CohereCallOptions>

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

  • Parameters

    • prompt: string
    • Optional options: string[] | CohereCallOptions
    • Optional callbacks: Callbacks

    Returns Promise<string>

    Deprecated

    Use .invoke() instead. Will be removed in 0.2.0. Convenience wrapper for generate that takes in a single string prompt and returns a single string output.

  • Run the LLM on the given prompts and input, handling caching.

    Parameters

    • prompts: string[]
    • Optional options: string[] | CohereCallOptions
    • Optional callbacks: Callbacks

    Returns Promise<LLMResult>

  • This method takes prompt values, options, and callbacks, and generates a result based on the prompts.

    Parameters

    • promptValues: BasePromptValueInterface[]

      Prompt values for the LLM.

    • Optional options: string[] | CohereCallOptions

      Options for the LLM call.

    • Optional callbacks: Callbacks

      Callbacks for the LLM call.

    Returns Promise<LLMResult>

    An LLMResult based on the prompts.

  • Parameters

    • Optional suffix: string

    Returns string

  • Parameters

    Returns Promise<number>

  • Get the parameters used to invoke the model

    Parameters

    • options: Omit<CohereCallOptions, never>

    Returns {
        [k: string]: T;
    }

    • [k: string]: T
  • This method takes an input and options, and returns a string. It converts the input to a prompt value and generates a result based on the prompt.

    Parameters

    • input: BaseLanguageModelInput

      Input for the LLM.

    • Optional options: CohereCallOptions

      Options for the LLM call.

    Returns Promise<string>

    A string result based on the prompt.

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

    Parameters

    • keys: string | string[]

    Returns RunnableSequence<any, 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<string, NewRunOutput>

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

    Returns RunnableSequence<BaseLanguageModelInput, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Parameters

    • text: string

      Input text for the prediction.

    • Optional options: string[] | CohereCallOptions

      Options for the LLM call.

    • Optional callbacks: Callbacks

      Callbacks for the LLM call.

    Returns Promise<string>

    A prediction based on the input text.

    ⚠️ Deprecated ⚠️

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

    This feature is deprecated and will be removed in the future.

    It is not recommended for use.

    This method is similar to call, but it's used for making predictions based on the input text.

  • Parameters

    • messages: BaseMessage[]

      A list of messages for the prediction.

    • Optional options: string[] | CohereCallOptions

      Options for the LLM call.

    • Optional callbacks: Callbacks

      Callbacks for the LLM call.

    Returns Promise<BaseMessage>

    A predicted message based on the list of messages.

    Deprecated

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

    This method takes a list of messages, options, and callbacks, and returns a predicted message.

  • Returns SerializedLLM

    Deprecated

    Return a json-like object representing this LLM.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<string>>

    A readable stream that is also an iterable.

  • 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
    • Optional options: Partial<CohereCallOptions>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • 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<string, any, unknown>

  • 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, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

    Returns Runnable<BaseLanguageModelInput, string, CohereCallOptions>

Generated using TypeDoc