Interface AnthropicInput

Input to AnthropicChat class.

interface AnthropicInput {
    anthropicApiKey?: string;
    anthropicApiUrl?: string;
    apiKey?: string;
    clientOptions?: ClientOptions;
    createClient?: ((options: ClientOptions) => any);
    invocationKwargs?: Kwargs;
    maxTokens?: number;
    maxTokensToSample?: number;
    model?: string;
    modelName?: string;
    stopSequences?: string[];
    streamUsage?: boolean;
    streaming?: boolean;
    temperature?: number;
    topK?: number;
    topP?: number;
}

Implemented by

Properties

anthropicApiKey? anthropicApiUrl? apiKey? clientOptions? createClient? invocationKwargs? maxTokens? maxTokensToSample? model? modelName? stopSequences? streamUsage? streaming? temperature? topK? topP?

Properties

OptionalanthropicApiKey

anthropicApiKey?: string

Anthropic API key

OptionalanthropicApiUrl

anthropicApiUrl?: string

Anthropic API URL

OptionalapiKey

apiKey?: string

Anthropic API key

OptionalclientOptions

clientOptions?: ClientOptions

Overridable Anthropic ClientOptions

OptionalcreateClient

createClient?: ((options: ClientOptions) => any)

Optional method that returns an initialized underlying Anthropic client. Useful for accessing Anthropic models hosted on other cloud services such as Google Vertex.

OptionalinvocationKwargs

invocationKwargs?: Kwargs

Holds any additional parameters that are valid to pass to anthropic.messages that are not explicitly specified on this class.

OptionalmaxTokens

maxTokens?: number

A maximum number of tokens to generate before stopping.

OptionalmaxTokensToSample

maxTokensToSample?: number

A maximum number of tokens to generate before stopping.

Deprecated

Use "maxTokens" instead.

Optionalmodel

model?: string

Model name to use

OptionalmodelName

modelName?: string

Deprecated

Use "model" instead

OptionalstopSequences

stopSequences?: string[]

A list of strings upon which to stop generating. You probably want ["\n\nHuman:"], as that's the cue for the next turn in the dialog agent.

OptionalstreamUsage

streamUsage?: boolean

Whether or not to include token usage data in streamed chunks.

Default

true

Optionalstreaming

streaming?: boolean

Whether to stream the results or not

Optionaltemperature

temperature?: number

Amount of randomness injected into the response. Ranges from 0 to 1. Use temp closer to 0 for analytical / multiple choice, and temp closer to 1 for creative and generative tasks.

OptionaltopK

topK?: number

Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. Defaults to -1, which disables it.

OptionaltopP

topP?: number

Does nucleus sampling, in which we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. Defaults to -1, which disables it. Note that you should either alter temperature or top_p, but not both.

Settings

Member Visibility

On This Page

Properties