Class: Aws::BedrockAgent::Types::ParameterDetail

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb

Overview

Contains details about a parameter in a function for an action group.

This data type is used in the following API operations:

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

Returns:

  • (String) 


3128
3129
3130
3131
3132
3133
3134
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3128

class ParameterDetail < Struct.new(
  :description,
  :required,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#required ⇒ Boolean

Whether the parameter is required for the agent to complete the function for action group invocation.

Returns:

  • (Boolean) 


3128
3129
3130
3131
3132
3133
3134
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3128

class ParameterDetail < Struct.new(
  :description,
  :required,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The data type of the parameter.

Returns:

  • (String) 


3128
3129
3130
3131
3132
3133
3134
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 3128

class ParameterDetail < Struct.new(
  :description,
  :required,
  :type)
  SENSITIVE = []
  include Aws::Structure
end