Class: Aws::BedrockAgentRuntime::Types::FunctionDefinition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/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.

See Also:

Constant Summary collapse

SENSITIVE = 
[:name]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description of the function and its purpose.

Returns:

  • (String) 


2607
2608
2609
2610
2611
2612
2613
2614
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2607

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

#name ⇒ String

A name for the function.

Returns:

  • (String) 


2607
2608
2609
2610
2611
2612
2613
2614
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2607

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

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

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

Returns:



2607
2608
2609
2610
2611
2612
2613
2614
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2607

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

#require_confirmation ⇒ String

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

Returns:

  • (String) 


2607
2608
2609
2610
2611
2612
2613
2614
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2607

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