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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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:

  • CreateAgentActionGroup request][1
  • CreateAgentActionGroup response][2
  • UpdateAgentActionGroup request][3
  • UpdateAgentActionGroup response][4
  • GetAgentActionGroup response][5

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax [2]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax [3]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax [4]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax [5]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax

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) 


3460
3461
3462
3463
3464
3465
3466
3467
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3460

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

#name ⇒ String

A name for the function.

Returns:

  • (String) 


3460
3461
3462
3463
3464
3465
3466
3467
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3460

class Function < Struct.new(
  :description,
  :name,
  :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:



3460
3461
3462
3463
3464
3465
3466
3467
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3460

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

#require_confirmation ⇒ String

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

Returns:

  • (String) 


3460
3461
3462
3463
3464
3465
3466
3467
 
# File 'lib/aws-sdk-bedrockagent/types.rb', line 3460

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