langchain.js
    Preparing search index...

    Class CloudflareWorkersAI

    Install and import from "@langchain/cloudflare" instead.

    Class representing the CloudflareWorkersAI language model. It extends the LLM (Large Language Model) class, providing a standard interface for interacting with the CloudflareWorkersAI language model.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    baseUrl cloudflareAccountId? cloudflareApiToken? lc_serializable model streaming

    Accessors

    identifyingParams

    Methods

    _call _llmType _request _streamResponseChunks invocationParams validateEnvironment lc_name

    Constructors

    • Parameters

      • Optionalfields: any

      Returns CloudflareWorkersAI

    Properties

    baseUrl: string
    cloudflareAccountId?: string
    cloudflareApiToken?: string
    lc_serializable: boolean = true
    model: string = "@cf/meta/llama-2-7b-chat-int8"
    streaming: boolean = false

    Accessors

    • get identifyingParams(): { model: string }

      Get the identifying parameters for this LLM.

      Returns { model: string }

    Methods

    _call

    • _call(prompt: string, options: unknown, runManager?: any): Promise<string>

      Call out to CloudflareWorkersAI's complete endpoint. Args: prompt: The prompt to pass into the model. Returns: The string generated by the model. Example: let response = CloudflareWorkersAI.call("Tell me a joke.");

      Parameters

      • prompt: string
      • options: unknown
      • OptionalrunManager: any

      Returns Promise<string>

    _llmType

    • _llmType(): string

      Get the type of LLM.

      Returns string

    _request

    • _request(prompt: string, options: unknown, stream?: boolean): Promise<any>

      Parameters

      • prompt: string
      • options: unknown
      • Optionalstream: boolean

      Returns Promise<any>

    _streamResponseChunks

    • _streamResponseChunks(
          prompt: string,
          options: unknown,
          runManager?: any,
      ): AsyncGenerator<GenerationChunk>

      Parameters

      • prompt: string
      • options: unknown
      • OptionalrunManager: any

      Returns AsyncGenerator<GenerationChunk>

    • Get the parameters used to invoke the model

      Returns { model: string }

    • Method to validate the environment.

      Returns void

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods