Class ChatAnthropic

Wrapper around Anthropic large language models.

To use this package, you should have an Anthropic API key set as an environment variable named ANTHROPIC_API_KEY or passed into the constructor.

Remarks

Any parameters that are valid to be passed to anthropic.messages can be passed through invocationKwargs, even if not explicitly available on this class.

Example

import { ChatAnthropic } from "@langchain/anthropic";

const model = new ChatAnthropic({
  temperature: 0.9,
  apiKey: 'YOUR-API-KEY',
});
const res = await model.invoke({ input: 'Hello!' });
console.log(res);

Hierarchy (view full)

ChatAnthropicMessages
- ChatAnthropic

Constructors

constructor

new ChatAnthropic(fields?): ChatAnthropic
Parameters
- Optionalfields: any
Returns ChatAnthropic
Inherited from ChatAnthropicMessages.constructor
- Defined in libs/langchain-anthropic/src/chat_models.ts:261

Properties

clientOptions

clientOptions: ClientOptions

Overridable Anthropic ClientOptions

maxTokens

maxTokens: number = 2048

A maximum number of tokens to generate before stopping.

model

model: string = "claude-2.1"

Model name to use

modelName

modelName: string = "claude-2.1"

Model name to use

streamUsage

streamUsage: boolean = true

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

Default

true

streaming

streaming: boolean = false

Whether to stream the results or not

temperature

temperature: number = 1

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.

topK

topK: number = -1

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.

topP

topP: number = -1

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.

`Optional`anthropicApiKey

anthropicApiKey?: string

Anthropic API key

`Optional`apiKey

apiKey?: string

Anthropic API key

`Optional`apiUrl

apiUrl?: string

`Optional`invocationKwargs

invocationKwargs?: Kwargs

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

`Optional`stopSequences

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.

`Protected`batchClient

batchClient: Anthropic

`Protected`streamingClient

streamingClient: Anthropic

Methods

bindTools

bindTools(tools, kwargs?): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>
Parameters
- tools: any[]
- Optionalkwargs: Partial<ChatAnthropicCallOptions>
Returns Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>
Inherited from ChatAnthropicMessages.bindTools
- Defined in libs/langchain-anthropic/src/chat_models.ts:354

formatStructuredToolToAnthropic

formatStructuredToolToAnthropic(tools): undefined | Tool[]
Formats LangChain StructuredTools to AnthropicTools.
Parameters
- tools: undefined | any[]
  The tools to format
Returns undefined | Tool[]
The formatted tools, or undefined if none are passed.

Throws
If a mix of AnthropicTools and StructuredTools are passed.
Inherited from ChatAnthropicMessages.formatStructuredToolToAnthropic
- Defined in libs/langchain-anthropic/src/chat_models.ts:315

getLsParams

getLsParams(options): LangSmithParams
Parameters
- options: unknown
Returns LangSmithParams
Inherited from ChatAnthropicMessages.getLsParams
- Defined in libs/langchain-anthropic/src/chat_models.ts:296

identifyingParams

identifyingParams(): {
model_name: string;
}
Get the identifying parameters for the model

Returns {
model_name: string;
}
- model_name: string
Inherited from ChatAnthropicMessages.identifyingParams
- Defined in libs/langchain-anthropic/src/chat_models.ts:405

invocationParams

invocationParams(options?): Omit<MessageCreateParamsNonStreaming | MessageCreateParamsStreaming, "messages"> & Kwargs
Get the parameters used to invoke the model
Parameters
- Optionaloptions: unknown
Returns Omit<MessageCreateParamsNonStreaming | MessageCreateParamsStreaming, "messages"> & Kwargs
Inherited from ChatAnthropicMessages.invocationParams
- Defined in libs/langchain-anthropic/src/chat_models.ts:367

withStructuredOutput

withStructuredOutput<RunOutput>(outputSchema, config?): Runnable<BaseLanguageModelInput, RunOutput>
Type Parameters
- RunOutput extends Record<string, any> = Record<string, any>
Parameters
- outputSchema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>
- Optionalconfig: any
Returns Runnable<BaseLanguageModelInput, RunOutput>
Inherited from ChatAnthropicMessages.withStructuredOutput
- Defined in libs/langchain-anthropic/src/chat_models.ts:623
withStructuredOutput<RunOutput>(outputSchema, config?): Runnable<BaseLanguageModelInput, {
parsed: RunOutput;
raw: BaseMessage;
}>
Type Parameters
- RunOutput extends Record<string, any> = Record<string, any>
Parameters
- outputSchema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>
- Optionalconfig: any
Returns Runnable<BaseLanguageModelInput, {
parsed: RunOutput;
raw: BaseMessage;
}>
Inherited from ChatAnthropicMessages.withStructuredOutput
- Defined in libs/langchain-anthropic/src/chat_models.ts:634

`Protected`createStreamWithRetry

createStreamWithRetry(request, options?): Promise<Stream<RawMessageStreamEvent>>
Creates a streaming request with retry.
Parameters
- request: MessageCreateParamsStreaming & Kwargs
  The parameters for creating a completion.
- Optionaloptions: AnthropicRequestOptions
Returns Promise<Stream<RawMessageStreamEvent>>
A streaming request.
Inherited from ChatAnthropicMessages.createStreamWithRetry
- Defined in libs/langchain-anthropic/src/chat_models.ts:562

Class ChatAnthropic

Remarks

Example

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ChatAnthropic

Properties

clientOptions

maxTokens

model

modelName

streamUsage

Default

streaming

temperature

topK

topP

OptionalanthropicApiKey

OptionalapiKey

OptionalapiUrl

OptionalinvocationKwargs

OptionalstopSequences

ProtectedbatchClient

ProtectedstreamingClient

Methods

bindTools

Parameters

Returns Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>

formatStructuredToolToAnthropic

Parameters

Returns undefined | Tool[]

Throws

getLsParams

Parameters

Returns LangSmithParams

identifyingParams

Returns { model_name: string; }

model_name: string

invocationParams

Parameters

Returns Omit<MessageCreateParamsNonStreaming | MessageCreateParamsStreaming, "messages"> & Kwargs

withStructuredOutput

Type Parameters

Parameters

Returns Runnable<BaseLanguageModelInput, RunOutput>

Type Parameters

Parameters

Returns Runnable<BaseLanguageModelInput, { parsed: RunOutput; raw: BaseMessage; }>

ProtectedcreateStreamWithRetry

Parameters

Returns Promise<Stream<RawMessageStreamEvent>>

Settings

On This Page

`Optional`anthropicApiKey

`Optional`apiKey

`Optional`apiUrl

`Optional`invocationKwargs

`Optional`stopSequences

`Protected`batchClient

`Protected`streamingClient

Returns {
model_name: string;
}

Returns Runnable<BaseLanguageModelInput, {
parsed: RunOutput;
raw: BaseMessage;
}>

`Protected`createStreamWithRetry