Class: Aws::BedrockAgentRuntime::Types::AgentActionGroup

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

Overview

Contains details of the inline agent's action group.

See Also:

Constant Summary collapse

SENSITIVE = 
[:action_group_name, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#action_group_executor ⇒ Types::ActionGroupExecutor

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Returns:



232
233
234
235
236
237
238
239
240
241
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 232

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_name,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = [:action_group_name, :description]
  include Aws::Structure
end

#action_group_name ⇒ String

The name of the action group.

Returns:

  • (String) 


232
233
234
235
236
237
238
239
240
241
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 232

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_name,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = [:action_group_name, :description]
  include Aws::Structure
end

#api_schema ⇒ Types::APISchema

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

Returns:



232
233
234
235
236
237
238
239
240
241
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 232

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_name,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = [:action_group_name, :description]
  include Aws::Structure
end

#description ⇒ String

A description of the action group.

Returns:

  • (String) 


232
233
234
235
236
237
238
239
240
241
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 232

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_name,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = [:action_group_name, :description]
  include Aws::Structure
end

#function_schema ⇒ Types::FunctionSchema

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

Returns:



232
233
234
235
236
237
238
239
240
241
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 232

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_name,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = [:action_group_name, :description]
  include Aws::Structure
end

#parent_action_group_signature ⇒ String

To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

Returns:

  • (String) 


232
233
234
235
236
237
238
239
240
241
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 232

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_name,
  :api_schema,
  :description,
  :function_schema,
  :parent_action_group_signature)
  SENSITIVE = [:action_group_name, :description]
  include Aws::Structure
end