Class: AWSCDK::Bedrock::CfnPrompt::SpecificToolChoiceProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Bedrock::CfnPrompt::SpecificToolChoiceProperty

Defined in:

bedrock/cfn_prompt.rb

Overview

The model must request a specific tool.

For example, {"tool" : {"name" : "Your tool name"}} . For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide

This field is only supported by Anthropic Claude 3 models.

See Also:

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

Instance Attribute Summary

• #name ⇒ String readonly

  The name of the tool that the model must request.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:) ⇒ SpecificToolChoiceProperty constructor

  A new instance of SpecificToolChoiceProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:) ⇒ SpecificToolChoiceProperty

Returns a new instance of SpecificToolChoiceProperty.

Parameters:

• name (String) —

  The name of the tool that the model must request.

# File 'bedrock/cfn_prompt.rb', line 1208

def initialize(name:)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
end

Instance Attribute Details

#name ⇒ String (readonly)

The name of the tool that the model must request.

Returns:

• (String)

See Also:

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

# File 'bedrock/cfn_prompt.rb', line 1217

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock/cfn_prompt.rb', line 1219

def self.jsii_properties
  {
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock/cfn_prompt.rb', line 1225

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
  })
  result.compact
end