Specific implementation of a Large Language Model (LLM) designed to interact with the Aleph Alpha API. It extends the base LLM class and includes a variety of parameters for customizing the behavior of the Aleph Alpha model.

Hierarchy

  • LLM
    • AlephAlpha

Implements

Constructors

Properties

CallOptions: BaseLLMCallOptions
ParsedCallOptions: Omit<BaseLLMCallOptions, never>
base_url: string = "https://api.aleph-alpha.com/complete"
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.

completion_bias_exclusion_first_token_only: boolean
completion_bias_inclusion_first_token_only: boolean
control_log_additive: boolean
echo: boolean
maximum_tokens: number = 64
minimum_tokens: number = 0
model: string = "luminous-base"
raw_completion: boolean
temperature: number = 0.0
top_k: number
top_p: number = 0.0
verbose: boolean

Whether to print out response text.

aleph_alpha_api_key?: string = ...
best_of?: number
callbacks?: Callbacks
completion_bias_exclusion?: string[]
completion_bias_inclusion?: string[]
contextual_control_threshold?: number
disable_optimizations?: boolean
frequency_penalty?: number
log_probs?: number
logit_bias?: object
metadata?: Record<string, unknown>
n?: number
penalty_bias?: string
penalty_exceptions?: string[]
penalty_exceptions_include_stop_sequences?: boolean
presence_penalty?: number
repetition_penalties_include_completion?: boolean
repetition_penalties_include_prompt?: boolean
sequence_penalty?: number
sequence_penalty_min_length?: number
stop?: string[]
tags?: string[]
tokens?: boolean
use_multiplicative_frequency_penalty?: boolean
use_multiplicative_presence_penalty?: boolean
use_multiplicative_sequence_penalty?: boolean

Accessors

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

    Returns string[]

  • get defaultParams(): {
        best_of: undefined | number;
        completion_bias_exclusion: undefined | string[];
        completion_bias_exclusion_first_token_only: boolean;
        completion_bias_inclusion: undefined | string[];
        completion_bias_inclusion_first_token_only: boolean;
        contextual_control_threshold: undefined | number;
        control_log_additive: boolean;
        disable_optimizations: undefined | boolean;
        frequency_penalty: undefined | number;
        log_probs: undefined | number;
        logit_bias: undefined | object;
        maximum_tokens: number;
        minimum_tokens: number;
        model: string;
        n: undefined | number;
        penalty_bias: undefined | string;
        penalty_exceptions: undefined | string[];
        penalty_exceptions_include_stop_sequences: undefined | boolean;
        presence_penalty: undefined | number;
        raw_completion: boolean;
        repetition_penalties_include_completion: undefined | boolean;
        repetition_penalties_include_prompt: undefined | boolean;
        sequence_penalty: undefined | number;
        sequence_penalty_min_length: undefined | number;
        temperature: number;
        tokens: undefined | boolean;
        top_k: number;
        top_p: number;
        use_multiplicative_frequency_penalty: undefined | boolean;
        use_multiplicative_presence_penalty: undefined | boolean;
        use_multiplicative_sequence_penalty: undefined | boolean;
    }
  • Get the default parameters for calling Aleph Alpha API.

    Returns {
        best_of: undefined | number;
        completion_bias_exclusion: undefined | string[];
        completion_bias_exclusion_first_token_only: boolean;
        completion_bias_inclusion: undefined | string[];
        completion_bias_inclusion_first_token_only: boolean;
        contextual_control_threshold: undefined | number;
        control_log_additive: boolean;
        disable_optimizations: undefined | boolean;
        frequency_penalty: undefined | number;
        log_probs: undefined | number;
        logit_bias: undefined | object;
        maximum_tokens: number;
        minimum_tokens: number;
        model: string;
        n: undefined | number;
        penalty_bias: undefined | string;
        penalty_exceptions: undefined | string[];
        penalty_exceptions_include_stop_sequences: undefined | boolean;
        presence_penalty: undefined | number;
        raw_completion: boolean;
        repetition_penalties_include_completion: undefined | boolean;
        repetition_penalties_include_prompt: undefined | boolean;
        sequence_penalty: undefined | number;
        sequence_penalty_min_length: undefined | number;
        temperature: number;
        tokens: undefined | boolean;
        top_k: number;
        top_p: number;
        use_multiplicative_frequency_penalty: undefined | boolean;
        use_multiplicative_presence_penalty: undefined | boolean;
        use_multiplicative_sequence_penalty: undefined | boolean;
    }

    • best_of: undefined | number
    • completion_bias_exclusion: undefined | string[]
    • completion_bias_exclusion_first_token_only: boolean
    • completion_bias_inclusion: undefined | string[]
    • completion_bias_inclusion_first_token_only: boolean
    • contextual_control_threshold: undefined | number
    • control_log_additive: boolean
    • disable_optimizations: undefined | boolean
    • frequency_penalty: undefined | number
    • log_probs: undefined | number
    • logit_bias: undefined | object
    • maximum_tokens: number
    • minimum_tokens: number
    • model: string
    • n: undefined | number
    • penalty_bias: undefined | string
    • penalty_exceptions: undefined | string[]
    • penalty_exceptions_include_stop_sequences: undefined | boolean
    • presence_penalty: undefined | number
    • raw_completion: boolean
    • repetition_penalties_include_completion: undefined | boolean
    • repetition_penalties_include_prompt: undefined | boolean
    • sequence_penalty: undefined | number
    • sequence_penalty_min_length: undefined | number
    • temperature: number
    • tokens: undefined | boolean
    • top_k: number
    • top_p: number
    • use_multiplicative_frequency_penalty: undefined | boolean
    • use_multiplicative_presence_penalty: undefined | boolean
    • use_multiplicative_sequence_penalty: undefined | boolean
  • get identifyingParams(): {
        best_of: undefined | number;
        completion_bias_exclusion: undefined | string[];
        completion_bias_exclusion_first_token_only: boolean;
        completion_bias_inclusion: undefined | string[];
        completion_bias_inclusion_first_token_only: boolean;
        contextual_control_threshold: undefined | number;
        control_log_additive: boolean;
        disable_optimizations: undefined | boolean;
        frequency_penalty: undefined | number;
        log_probs: undefined | number;
        logit_bias: undefined | object;
        maximum_tokens: number;
        minimum_tokens: number;
        model: string;
        n: undefined | number;
        penalty_bias: undefined | string;
        penalty_exceptions: undefined | string[];
        penalty_exceptions_include_stop_sequences: undefined | boolean;
        presence_penalty: undefined | number;
        raw_completion: boolean;
        repetition_penalties_include_completion: undefined | boolean;
        repetition_penalties_include_prompt: undefined | boolean;
        sequence_penalty: undefined | number;
        sequence_penalty_min_length: undefined | number;
        temperature: number;
        tokens: undefined | boolean;
        top_k: number;
        top_p: number;
        use_multiplicative_frequency_penalty: undefined | boolean;
        use_multiplicative_presence_penalty: undefined | boolean;
        use_multiplicative_sequence_penalty: undefined | boolean;
    }
  • Get the identifying parameters for this LLM.

    Returns {
        best_of: undefined | number;
        completion_bias_exclusion: undefined | string[];
        completion_bias_exclusion_first_token_only: boolean;
        completion_bias_inclusion: undefined | string[];
        completion_bias_inclusion_first_token_only: boolean;
        contextual_control_threshold: undefined | number;
        control_log_additive: boolean;
        disable_optimizations: undefined | boolean;
        frequency_penalty: undefined | number;
        log_probs: undefined | number;
        logit_bias: undefined | object;
        maximum_tokens: number;
        minimum_tokens: number;
        model: string;
        n: undefined | number;
        penalty_bias: undefined | string;
        penalty_exceptions: undefined | string[];
        penalty_exceptions_include_stop_sequences: undefined | boolean;
        presence_penalty: undefined | number;
        raw_completion: boolean;
        repetition_penalties_include_completion: undefined | boolean;
        repetition_penalties_include_prompt: undefined | boolean;
        sequence_penalty: undefined | number;
        sequence_penalty_min_length: undefined | number;
        temperature: number;
        tokens: undefined | boolean;
        top_k: number;
        top_p: number;
        use_multiplicative_frequency_penalty: undefined | boolean;
        use_multiplicative_presence_penalty: undefined | boolean;
        use_multiplicative_sequence_penalty: undefined | boolean;
    }

    • best_of: undefined | number
    • completion_bias_exclusion: undefined | string[]
    • completion_bias_exclusion_first_token_only: boolean
    • completion_bias_inclusion: undefined | string[]
    • completion_bias_inclusion_first_token_only: boolean
    • contextual_control_threshold: undefined | number
    • control_log_additive: boolean
    • disable_optimizations: undefined | boolean
    • frequency_penalty: undefined | number
    • log_probs: undefined | number
    • logit_bias: undefined | object
    • maximum_tokens: number
    • minimum_tokens: number
    • model: string
    • n: undefined | number
    • penalty_bias: undefined | string
    • penalty_exceptions: undefined | string[]
    • penalty_exceptions_include_stop_sequences: undefined | boolean
    • presence_penalty: undefined | number
    • raw_completion: boolean
    • repetition_penalties_include_completion: undefined | boolean
    • repetition_penalties_include_prompt: undefined | boolean
    • sequence_penalty: undefined | number
    • sequence_penalty_min_length: undefined | number
    • temperature: number
    • tokens: undefined | boolean
    • top_k: number
    • top_p: number
    • use_multiplicative_frequency_penalty: undefined | boolean
    • use_multiplicative_presence_penalty: undefined | boolean
    • use_multiplicative_sequence_penalty: undefined | boolean

Methods

  • 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

    Returns Promise<LLMResult>

    An LLMResult based on the prompts.

  • 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.

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

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

Generated using TypeDoc