Package software.amazon.awscdk.services.bedrock

Interface CfnPrompt.ToolChoiceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPrompt.ToolChoiceProperty.Jsii$Proxy

Enclosing class:

CfnPrompt

@Stability(Stable)
public static interface CfnPrompt.ToolChoiceProperty
extends software.amazon.jsii.JsiiSerializable

Determines which tools the model should request in a call to Converse or ConverseStream .

For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 Object any;
 Object auto;
 ToolChoiceProperty toolChoiceProperty = ToolChoiceProperty.builder()
         .any(any)
         .auto(auto)
         .tool(SpecificToolChoiceProperty.builder()
                 .name("name")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPrompt.ToolChoiceProperty.Builder	A builder for CfnPrompt.ToolChoiceProperty
static final class	CfnPrompt.ToolChoiceProperty.Jsii$Proxy	An implementation for CfnPrompt.ToolChoiceProperty

Method Summary

Modifier and Type	Method	Description
static CfnPrompt.ToolChoiceProperty.Builder	builder()
default Object	getAny()	The model must request at least one tool (no text is generated).
default Object	getAuto()	(Default).
default Object	getTool()	The Model must request the specified tool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAny

@Stability(Stable)
@Nullable
default Object getAny()

The model must request at least one tool (no text is generated).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-any

getAuto

@Stability(Stable)
@Nullable
default Object getAuto()

(Default).

The Model automatically decides if a tool should be called or whether to generate text instead.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-auto

getTool

@Stability(Stable)
@Nullable
default Object getTool()

The Model must request the specified tool.

Only supported by Anthropic Claude 3 and Amazon Nova models.

Returns union: either IResolvable or CfnPrompt.SpecificToolChoiceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-tool

builder

@Stability(Stable)
static CfnPrompt.ToolChoiceProperty.Builder builder()

Returns:

a CfnPrompt.ToolChoiceProperty.Builder of CfnPrompt.ToolChoiceProperty