Interface ChatBedrockConverseCallOptions

interface ChatBedrockConverseCallOptions {
    additionalModelRequestFields?: null | string | number | boolean | DocumentType[] | {
        [prop: string]: DocumentType;
    };
    stop?: string[];
    streamUsage?: boolean;
    tool_choice?: string | AnyMember | AutoMember | ToolMember;
    tools?: any[];
}

Hierarchy (view full)

Properties

additionalModelRequestFields? stop? streamUsage? tool_choice? tools?

Properties

Optional additionalModelRequestFields

additionalModelRequestFields?: null | string | number | boolean | DocumentType[] | {
    [prop: string]: 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.

Type declaration

  • [prop: string]: DocumentType

Link

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

Optional stop

stop?: string[]

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

Optional streamUsage

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

Optional tool_choice

tool_choice?: string | AnyMember | AutoMember | ToolMember

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.

Optional tools

tools?: any[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc