Optional
fields: anyOptional
anthropicAnthropic API key
Optional
apiAnthropic API key
Optional
apiProtected
batchOverridable Anthropic ClientOptions
Optional method that returns an initialized underlying Anthropic client. Useful for accessing Anthropic models hosted on other cloud services such as Google Vertex.
Optional
invocationHolds any additional parameters that are valid to pass to anthropic.messages
that are not explicitly specified on this class.
A maximum number of tokens to generate before stopping.
Model name to use
Optional
stopA 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.
Whether to stream the results or not
Protected
streamingWhether or not to include token usage data in streamed chunks.
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.
To not set this field, pass null
. If undefined
is passed,
the default (1) will be used.
Options for extended thinking.
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.
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.
To not set this field, pass null
. If undefined
is passed,
the default (-1) will be used.
For Opus 4.1, this defaults to null
.
Optional
kwargs: Partial<ChatAnthropicCallOptions>Protected
createCreates a streaming request with retry.
The parameters for creating a completion.
Optional
options: RequestOptionsA streaming request.
Formats LangChain StructuredTools to AnthropicTools.
The tools to format
The formatted tools, or undefined if none are passed.
Get the identifying parameters for the model
Get the parameters used to invoke the model
Optional
options: unknownOptional
config: anyOptional
config: anyStatic
lc_
Anthropic chat model integration.
Setup: Install
@langchain/anthropic
and set an environment variable namedANTHROPIC_API_KEY
.Constructor args
Runtime args
Runtime args can be passed as the second argument to any of the base runnable methods
.invoke
..stream
,.batch
, etc. They can also be passed via.bind
, or the second arg in.bindTools
, like shown in the examples below:Examples
Instantiate
Invoking
Streaming Chunks
Aggregate Streamed Chunks
Bind tools
Structured Output
Multimodal
Usage Metadata
Stream Usage Metadata
Response Metadata