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

Hierarchy

Implements

Constructors

  • Parameters

    Returns AI21

Properties

CallOptions: BaseLLMCallOptions
ParsedCallOptions: Omit<BaseLLMCallOptions, never>
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.

countPenalty: AI21PenaltyData
frequencyPenalty: AI21PenaltyData
maxTokens: number
minTokens: number
model: string
numResults: number
presencePenalty: AI21PenaltyData
temperature: number
topP: number
verbose: boolean

Whether to print out response text.

ai21ApiKey?: string
baseUrl?: string
callbacks?: Callbacks
logitBias?: Record<string, number>
metadata?: Record<string, unknown>
name?: string
stop?: string[]
tags?: string[]

Accessors

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

    Returns string[]

  • get defaultParams(): {
        countPenalty: AI21PenaltyData;
        frequencyPenalty: AI21PenaltyData;
        logitBias: undefined | Record<string, number>;
        maxTokens: number;
        minTokens: number;
        numResults: number;
        presencePenalty: AI21PenaltyData;
        temperature: number;
        topP: number;
    }
  • Get the default parameters for calling AI21 API.

    Returns {
        countPenalty: AI21PenaltyData;
        frequencyPenalty: AI21PenaltyData;
        logitBias: undefined | Record<string, number>;
        maxTokens: number;
        minTokens: number;
        numResults: number;
        presencePenalty: AI21PenaltyData;
        temperature: number;
        topP: number;
    }

    • countPenalty: AI21PenaltyData
    • frequencyPenalty: AI21PenaltyData
    • logitBias: undefined | Record<string, number>
    • maxTokens: number
    • minTokens: number
    • numResults: number
    • presencePenalty: AI21PenaltyData
    • temperature: number
    • topP: number
  • get identifyingParams(): {
        countPenalty: AI21PenaltyData;
        frequencyPenalty: AI21PenaltyData;
        logitBias: undefined | Record<string, number>;
        maxTokens: number;
        minTokens: number;
        model: string;
        numResults: number;
        presencePenalty: AI21PenaltyData;
        temperature: number;
        topP: number;
    }
  • Get the identifying parameters for this LLM.

    Returns {
        countPenalty: AI21PenaltyData;
        frequencyPenalty: AI21PenaltyData;
        logitBias: undefined | Record<string, number>;
        maxTokens: number;
        minTokens: number;
        model: string;
        numResults: number;
        presencePenalty: AI21PenaltyData;
        temperature: number;
        topP: number;
    }

    • countPenalty: AI21PenaltyData
    • frequencyPenalty: AI21PenaltyData
    • logitBias: undefined | Record<string, number>
    • maxTokens: number
    • minTokens: number
    • model: string
    • numResults: number
    • presencePenalty: AI21PenaltyData
    • temperature: number
    • topP: number

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

    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)[]>

  • Convenience wrapper for generate that takes in a single string prompt and returns a single string output.

    Parameters

    Returns Promise<string>

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

    Parameters

    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[] | BaseLLMCallOptions

      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

    Returns any

  • 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

    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.

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

    Parameters

    • text: string

      Input text for the prediction.

    • Optional options: string[] | BaseLLMCallOptions

      Options for the LLM call.

    • Optional callbacks: Callbacks

      Callbacks for the LLM call.

    Returns Promise<string>

    A prediction based on the input text.

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

    Parameters

    • messages: BaseMessage[]

      A list of messages for the prediction.

    • Optional options: string[] | BaseLLMCallOptions

      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.

  • 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

    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>

  • Method to validate the environment. It checks if the AI21 API key is set. If not, it throws an error.

    Returns void

  • 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, BaseLLMCallOptions>

  • Static method to get the default penalty data for AI21.

    Returns AI21PenaltyData

    AI21PenaltyData

Generated using TypeDoc