Class AlephAlpha

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

Implements

Constructors

constructor

Properties

base_url completion_bias_exclusion_first_token_only completion_bias_inclusion_first_token_only control_log_additive echo maximum_tokens minimum_tokens model raw_completion temperature top_k top_p aleph_alpha_api_key? best_of? completion_bias_exclusion? completion_bias_inclusion? contextual_control_threshold? disable_optimizations? frequency_penalty? log_probs? logit_bias? n? penalty_bias? penalty_exceptions? penalty_exceptions_include_stop_sequences? presence_penalty? repetition_penalties_include_completion? repetition_penalties_include_prompt? sequence_penalty? sequence_penalty_min_length? stop? tokens? use_multiplicative_frequency_penalty? use_multiplicative_presence_penalty? use_multiplicative_sequence_penalty?

Accessors

defaultParams identifyingParams

Methods

validateEnvironment

Constructors

constructor

Properties

base_url

base_url: string = "https://api.aleph-alpha.com/complete"

completion_bias_exclusion_first_token_only

completion_bias_exclusion_first_token_only: boolean

completion_bias_inclusion_first_token_only

completion_bias_inclusion_first_token_only: boolean

control_log_additive

control_log_additive: boolean

echo

echo: boolean

maximum_tokens

maximum_tokens: number = 64

minimum_tokens

minimum_tokens: number = 0

model

model: string = "luminous-base"

raw_completion

raw_completion: boolean

temperature

temperature: number = 0.0

top_k

top_k: number

top_p

top_p: number = 0.0

Optional aleph_alpha_api_key

aleph_alpha_api_key?: any = ...

Optional best_of

best_of?: number

Optional completion_bias_exclusion

completion_bias_exclusion?: string[]

Optional completion_bias_inclusion

completion_bias_inclusion?: string[]

Optional contextual_control_threshold

contextual_control_threshold?: number

Optional disable_optimizations

disable_optimizations?: boolean

Optional frequency_penalty

frequency_penalty?: number

Optional log_probs

log_probs?: number

Optional logit_bias

logit_bias?: object

Optional n

n?: number

Optional penalty_bias

penalty_bias?: string

Optional penalty_exceptions

penalty_exceptions?: string[]

Optional penalty_exceptions_include_stop_sequences

penalty_exceptions_include_stop_sequences?: boolean

Optional presence_penalty

presence_penalty?: number

Optional repetition_penalties_include_completion

repetition_penalties_include_completion?: boolean

Optional repetition_penalties_include_prompt

repetition_penalties_include_prompt?: boolean

Optional sequence_penalty

sequence_penalty?: number

Optional sequence_penalty_min_length

sequence_penalty_min_length?: number

Optional stop

stop?: string[]

Optional tokens

tokens?: boolean

Optional use_multiplicative_frequency_penalty

use_multiplicative_frequency_penalty?: boolean

Optional use_multiplicative_presence_penalty

use_multiplicative_presence_penalty?: boolean

Optional use_multiplicative_sequence_penalty

use_multiplicative_sequence_penalty?: boolean

Accessors

defaultParams

  • 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

identifyingParams

  • 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

validateEnvironment

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc