langchain.js
    Preparing search index...

    Class AI21

    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 (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    ai21ApiKey? baseUrl? countPenalty frequencyPenalty lc_serializable logitBias? maxTokens minTokens model numResults presencePenalty stop? temperature topP

    Accessors

    defaultParams identifyingParams

    Methods

    _call _llmType validateEnvironment getDefaultAI21PenaltyData

    Constructors

    • Parameters

      Returns AI21

    Properties

    ai21ApiKey?: string
    baseUrl?: string
    countPenalty: AI21PenaltyData = ...
    frequencyPenalty: AI21PenaltyData = ...
    lc_serializable: boolean = true
    logitBias?: Record<string, number>
    maxTokens: number = 1024
    minTokens: number = 0
    model: string = "j2-jumbo-instruct"
    numResults: number = 1
    presencePenalty: AI21PenaltyData = ...
    stop?: string[]
    temperature: number = 0.7
    topP: number = 1

    Accessors

    • 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;
      }

    • 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;
      }

    Methods

    _call

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

      Call out to AI21's complete endpoint. Args: prompt: The prompt to pass into the model. stop: Optional list of stop words to use when generating.

      Returns:

      The string generated by the model.

      Example: let response = ai21._call("Tell me a joke.");

      Parameters

      • prompt: string
      • options: unknown

      Returns Promise<string>

    _llmType

    • _llmType(): string

      Get the type of LLM.

      Returns string

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

      Returns void

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

      Returns AI21PenaltyData

      AI21PenaltyData

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods