Interface ChatPremInput

Input to chat model class.

interface ChatPremInput {
    apiKey?: string;
    cache?: boolean | BaseCache<Generation[]>;
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    disableStreaming?: boolean;
    frequency_penalty?: number;
    logit_bias?: {
        [k: string]: unknown;
    };
    maxConcurrency?: number;
    maxRetries?: number;
    max_tokens?: number;
    messages?: {
        content: string;
        role: "user" | "assistant";
        [k: string]: unknown;
    }[];
    metadata?: Record<string, unknown>;
    model?: string;
    n?: number;
    onFailedAttempt?: FailedAttemptHandler;
    presence_penalty?: number;
    project_id?: string | number;
    response_format?: {
        [k: string]: unknown;
    };
    seed?: number;
    session_id?: string;
    stop?: string;
    streaming?: boolean;
    system_prompt?: string;
    tags?: string[];
    temperature?: number;
    tools?: {
        [k: string]: unknown;
    }[];
    top_p?: number;
    user?: string;
    verbose?: boolean;
}

Hierarchy

  • BaseChatModelParams
    • ChatPremInput

Implemented by

Properties

apiKey? cache? callbackManager? callbacks? disableStreaming? frequency_penalty? logit_bias? maxConcurrency? maxRetries? max_tokens? messages? metadata? model? n? onFailedAttempt? presence_penalty? project_id? response_format? seed? session_id? stop? streaming? system_prompt? tags? temperature? tools? top_p? user? verbose?

Properties

OptionalapiKey

apiKey?: string

The Prem API key to use for requests.

Default

process.env.PREM_API_KEY

Optionalcache

cache?: boolean | BaseCache<Generation[]>

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

OptionaldisableStreaming

disableStreaming?: boolean

Whether to disable streaming.

If streaming is bypassed, then stream() will defer to invoke().

  • If true, will always bypass streaming case.
  • If false (default), will always use streaming case if available.

Optionalfrequency_penalty

frequency_penalty?: number

Optionallogit_bias

logit_bias?: {
    [k: string]: unknown;
}

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

Optionalmax_tokens

max_tokens?: number

Optionalmessages

messages?: {
    content: string;
    role: "user" | "assistant";
    [k: string]: unknown;
}[]

Optionalmetadata

metadata?: Record<string, unknown>

Optionalmodel

model?: string

Optionaln

n?: number

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

Optionalpresence_penalty

presence_penalty?: number

Optionalproject_id

project_id?: string | number

Optionalresponse_format

response_format?: {
    [k: string]: unknown;
}

Optionalseed

seed?: number

Optionalsession_id

session_id?: string

Optionalstop

stop?: string

Optionalstreaming

streaming?: boolean

Optionalsystem_prompt

system_prompt?: string

Optionaltags

tags?: string[]

Optionaltemperature

temperature?: number

Optionaltools

tools?: {
    [k: string]: unknown;
}[]

Optionaltop_p

top_p?: number

Optionaluser

user?: string

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties