Class ChatAnthropicMessages<CallOptions>

Wrapper around Anthropic large language models.

To use you should have the @anthropic-ai/sdk package installed, with the ANTHROPIC_API_KEY environment variable set.

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,
  anthropicApiKey: 'YOUR-API-KEY',
});
const res = await model.invoke({ input: 'Hello!' });
console.log(res);

Type Parameters

  • CallOptions extends ChatAnthropicCallOptions = ChatAnthropicCallOptions

Hierarchy (view full)

Implements

Constructors

constructor

Properties

clientOptions maxTokens modelName streaming temperature topK topP anthropicApiKey? apiUrl? invocationKwargs? stopSequences? batchClient streamingClient

Methods

formatStructuredToolToAnthropic identifyingParams invocationOptions invocationParams withStructuredOutput createStreamWithRetry formatMessagesForAnthropic

Constructors

constructor

Properties

clientOptions

clientOptions: ClientOptions

Overridable Anthropic ClientOptions

maxTokens

maxTokens: number = 2048

A maximum number of tokens to generate before stopping.

modelName

modelName: string = "claude-2.1"

Model name to use

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 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

formatStructuredToolToAnthropic

  • formatStructuredToolToAnthropic(tools): undefined | AnthropicTool[]

  • Formats LangChain StructuredTools to AnthropicTools.

    Parameters

    • tools: undefined | StructuredToolInterface[] | AnthropicTool[]

      The tools to format

    Returns undefined | AnthropicTool[]

    The formatted tools, or undefined if none are passed.

    Throws

    If a mix of AnthropicTools and StructuredTools are passed.

identifyingParams

invocationOptions

  • invocationOptions(request, options): AnthropicRequestOptions

  • Parameters

    • request: Omit<MessageCreateParamsNonStreaming | MessageCreateParamsStreaming, "messages"> & Kwargs
    • options: unknown

    Returns AnthropicRequestOptions

invocationParams

  • invocationParams(options?): Omit<MessageCreateParamsNonStreaming | MessageCreateParamsStreaming, "messages"> & Kwargs

  • Get the parameters used to invoke the model

    Parameters

    • Optional options: unknown

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

withStructuredOutput

Protected createStreamWithRetry

  • createStreamWithRetry(request, options?): Promise<Stream<MessageStreamEvent>>

  • Creates a streaming request with retry.

    Parameters

    • request: MessageCreateParamsStreaming & Kwargs

      The parameters for creating a completion.

    • Optional options: AnthropicRequestOptions

    Returns Promise<Stream<MessageStreamEvent>>

    A streaming request.

Protected formatMessagesForAnthropic

  • formatMessagesForAnthropic(messages): {
        messages: MessageParam[];
        system?: string;
    }

  • Formats messages as a prompt for the model.

    Parameters

    • messages: BaseMessage[]

      The base messages to format as a prompt.

    Returns {
        messages: MessageParam[];
        system?: string;
    }

    The formatted prompt.

    • messages: MessageParam[]
    • Optional system?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc