Interface ChatAnthropicCallOptions

interface ChatAnthropicCallOptions {
    callbacks?: Callbacks;
    configurable?: Record<string, any>;
    headers?: Record<string, string>;
    ls_structured_output_format?: {
        kwargs: {
            method: string;
        };
        schema?: JsonSchema7Type;
    };
    maxConcurrency?: number;
    metadata?: Record<string, unknown>;
    recursionLimit?: number;
    runId?: string;
    runName?: string;
    signal?: AbortSignal;
    stop?: string[];
    streamUsage?: boolean;
    tags?: string[];
    timeout?: number;
    tool_choice?: AnthropicToolChoice;
    tools?: ChatAnthropicToolType[];
}

Hierarchy

  • BaseChatModelCallOptions
  • Pick<AnthropicInput, "streamUsage">
    • ChatAnthropicCallOptions

Properties

callbacks? configurable? headers? ls_structured_output_format? maxConcurrency? metadata? recursionLimit? runId? runName? signal? stop? streamUsage? tags? timeout? tool_choice? tools?

Properties

Optionalcallbacks

callbacks?: Callbacks

Callbacks for this call and any sub-calls (eg. a Chain calling an LLM). Tags are passed to all callbacks, metadata is passed to handle*Start callbacks.

Optionalconfigurable

configurable?: Record<string, any>

Runtime values for attributes previously made configurable on this Runnable, or sub-Runnables.

Optionalheaders

headers?: Record<string, string>

Custom headers to pass to the Anthropic API when making a request.

Optionalls_structured_output_format

ls_structured_output_format?: {
    kwargs: {
        method: string;
    };
    schema?: JsonSchema7Type;
}

Describes the format of structured outputs. This should be provided if an output is considered to be structured

Type declaration

  • kwargs: {
        method: string;
    }

    An object containing the method used for structured output (e.g., "jsonMode").

    • method: string
  • Optionalschema?: JsonSchema7Type

    The JSON schema describing the expected output structure.

OptionalmaxConcurrency

maxConcurrency?: number

Maximum number of parallel calls to make.

Optionalmetadata

metadata?: Record<string, unknown>

Metadata for this call and any sub-calls (eg. a Chain calling an LLM). Keys should be strings, values should be JSON-serializable.

OptionalrecursionLimit

recursionLimit?: number

Maximum number of times a call can recurse. If not provided, defaults to 25.

OptionalrunId

runId?: string

Unique identifier for the tracer run for this call. If not provided, a new UUID will be generated.

OptionalrunName

runName?: string

Name for the tracer run for this call. Defaults to the name of the class.

Optionalsignal

signal?: AbortSignal

Abort signal for this call. If provided, the call will be aborted when the signal is aborted.

See

https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal

Optionalstop

stop?: string[]

Stop tokens to use for this call. If not provided, the default stop tokens for the model will be used.

OptionalstreamUsage

streamUsage?: boolean

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

Default

true

Optionaltags

tags?: string[]

Tags for this call and any sub-calls (eg. a Chain calling an LLM). You can use these to filter calls.

Optionaltimeout

timeout?: number

Timeout for this call in milliseconds.

Optionaltool_choice

tool_choice?: AnthropicToolChoice

Whether or not to specify what tool the model should use

Default

"auto"

Optionaltools

tools?: ChatAnthropicToolType[]

Settings

Member Visibility

On This Page

Properties