Class: Aws::BedrockAgent::Types::Function

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

Overview

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in 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 function and its purpose.

Returns:

  • (String) 


5130
5131
5132
5133
5134
5135
5136
5137
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 5130

class Function < Struct.new(
  :name,
  :description,
  :parameters,
  :require_confirmation)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the function.

Returns:

  • (String) 


5130
5131
5132
5133
5134
5135
5136
5137
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 5130

class Function < Struct.new(
  :name,
  :description,
  :parameters,
  :require_confirmation)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,Types::ParameterDetail>

The parameters that the agent elicits from the user to fulfill the function.

Returns:



5130
5131
5132
5133
5134
5135
5136
5137
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 5130

class Function < Struct.new(
  :name,
  :description,
  :parameters,
  :require_confirmation)
  SENSITIVE = []
  include Aws::Structure
end

#require_confirmation ⇒ String

Contains information if user confirmation is required to invoke the function.

Returns:

  • (String) 


5130
5131
5132
5133
5134
5135
5136
5137
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 5130

class Function < Struct.new(
  :name,
  :description,
  :parameters,
  :require_confirmation)
  SENSITIVE = []
  include Aws::Structure
end