Interface ChatBedrockConverseCallOptions

interface ChatBedrockConverseCallOptions {
    additionalModelRequestFields?: DocumentType;
    callbacks?: Callbacks;
    configurable?: Record<string, any>;
    guardrailConfig?: GuardrailConfiguration;
    ls_structured_output_format?: {
        kwargs: {
            method: string;
        };
        schema?: JsonSchema7Type;
    };
    maxConcurrency?: number;
    metadata?: Record<string, unknown>;
    performanceConfig?: PerformanceConfiguration;
    recursionLimit?: number;
    requestMetadata?: Record<string, string>;
    runId?: string;
    runName?: string;
    signal?: AbortSignal;
    stop?: string[];
    streamUsage?: boolean;
    tags?: string[];
    timeout?: number;
    tool_choice?: BedrockConverseToolChoice;
    tools?: ChatBedrockConverseToolType[];
}

Hierarchy

  • BaseChatModelCallOptions
  • Pick<ChatBedrockConverseInput,
        | "additionalModelRequestFields"
        | "streamUsage"
        | "guardrailConfig"
        | "performanceConfig">
    • ChatBedrockConverseCallOptions

Properties

additionalModelRequestFields? callbacks? configurable? guardrailConfig? ls_structured_output_format? maxConcurrency? metadata? performanceConfig? recursionLimit? requestMetadata? runId? runName? signal? stop? streamUsage? tags? timeout? tool_choice? tools?

Properties

OptionaladditionalModelRequestFields

additionalModelRequestFields?: DocumentType

Additional inference parameters that the model supports, beyond the base set of inference parameters that the Converse API supports in the inferenceConfig field. For more information, see the model parameters link below.

Link

https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html

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.

OptionalguardrailConfig

guardrailConfig?: GuardrailConfiguration

Configuration information for a guardrail that you want to use in the 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.

OptionalperformanceConfig

performanceConfig?: PerformanceConfiguration

Model performance configuration. See https://docs.aws.amazon.com/bedrock/latest/userguide/latency-optimized-inference.html

OptionalrecursionLimit

recursionLimit?: number

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

OptionalrequestMetadata

requestMetadata?: Record<string, string>

Key-value pairs that you can use to filter invocation logs.

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

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

OptionalstreamUsage

streamUsage?: boolean

Whether or not to include usage data, like token counts in the streamed response chunks. Passing as a call option will take precedence over the class-level setting.

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?: BedrockConverseToolChoice

Tool choice for the model. If passing a string, it must be "any", "auto" or the name of the tool to use. Or, pass a BedrockToolChoice object.

If "any" is passed, the model must request at least one tool. If "auto" is passed, the model automatically decides if a tool should be called or whether to generate text instead. If a tool name is passed, it will force the model to call that specific tool.

Optionaltools

tools?: ChatBedrockConverseToolType[]

Settings

Member Visibility

On This Page

Properties