Interface WriterInput

Interface for the input parameters specific to the Writer model.

interface WriterInput {
    apiKey?: string;
    bestOf?: number;
    cache?: boolean | BaseCache<Generation[]>;
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    concurrency?: number;
    frequencyPenalty?: number;
    logprobs?: number;
    maxConcurrency?: number;
    maxRetries?: number;
    maxTokens?: number;
    metadata?: Record<string, unknown>;
    minTokens?: number;
    model?: string;
    n?: number;
    onFailedAttempt?: FailedAttemptHandler;
    orgId?: string | number;
    presencePenalty?: number;
    tags?: string[];
    temperature?: number;
    topP?: number;
    verbose?: boolean;
}

Hierarchy

  • BaseLLMParams
    • WriterInput

Implemented by

Properties

apiKey? bestOf? cache? callbackManager? callbacks? concurrency? frequencyPenalty? logprobs? maxConcurrency? maxRetries? maxTokens? metadata? minTokens? model? n? onFailedAttempt? orgId? presencePenalty? tags? temperature? topP? verbose?

Properties

OptionalapiKey

apiKey?: string

Writer API key

OptionalbestOf

bestOf?: number

Generates this many completions server-side and returns the "best"."

Optionalcache

cache?: boolean | BaseCache<Generation[]>

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

Optionalconcurrency

concurrency?: number

Deprecated

Use maxConcurrency instead

OptionalfrequencyPenalty

frequencyPenalty?: number

Penalizes repeated tokens according to frequency.

Optionallogprobs

logprobs?: number

Whether to return log probabilities.

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.

OptionalmaxTokens

maxTokens?: number

Maximum number of tokens to generate in the completion.

Optionalmetadata

metadata?: Record<string, unknown>

OptionalminTokens

minTokens?: number

Minimum number of tokens to generate.

Optionalmodel

model?: string

Model to use

Optionaln

n?: number

Number of completions to generate.

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.

OptionalorgId

orgId?: string | number

Writer organization ID

OptionalpresencePenalty

presencePenalty?: number

Penalizes repeated tokens regardless of frequency.

Optionaltags

tags?: string[]

Optionaltemperature

temperature?: number

Sampling temperature to use

OptionaltopP

topP?: number

Total probability mass of tokens to consider at each step.

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties