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

Hierarchy

Implements

Constructors

Properties

ParsedCallOptions: Omit<BaseLanguageModelCallOptions, never>
baseUrl: 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.

model: string = "@cf/meta/llama-2-7b-chat-int8"
streaming: boolean = false
verbose: boolean

Whether to print out response text.

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

Accessors

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

    Returns string[]

  • get identifyingParams(): {
        model: string;
    }
  • Get the identifying parameters for this LLM.

    Returns {
        model: string;
    }

    • model: string

Methods

  • Makes a single call to the chat model.

    Parameters

    Returns Promise<BaseMessage>

    A Promise that resolves to a BaseMessage.

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

    Parameters

    Returns Promise<BaseMessage>

    A Promise that resolves to a BaseMessage.

  • Generates chat based on the input messages.

    Parameters

    Returns Promise<LLMResult>

    A Promise that resolves to an LLMResult.

  • Generates a prompt based on the input prompt values.

    Parameters

    Returns Promise<LLMResult>

    A Promise that resolves to an LLMResult.

  • Parameters

    Returns Promise<number>

  • Get the parameters used to invoke the model

    Parameters

    Returns {
        model: string;
    }

    • model: string
  • 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

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

    A new runnable sequence.

  • Predicts the next message based on a text input.

    Parameters

    • text: string

      The text input.

    • Optional options: string[] | BaseLanguageModelCallOptions

      The call options or an array of stop sequences.

    • Optional callbacks: Callbacks

      The callbacks for the language model.

    Returns Promise<string>

    A Promise that resolves to a string.

  • Predicts the next message based on the input messages.

    Parameters

    Returns Promise<BaseMessage>

    A Promise that resolves to a BaseMessage.

  • 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

    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<BaseMessageChunk, any, unknown>

  • Method to validate the environment.

    Returns void

Generated using TypeDoc