Class: Aws::BedrockAgent::Types::AgentActionGroup

Inherits:

Struct

Object
Struct
Aws::BedrockAgent::Types::AgentActionGroup

show all

Includes:: Structure

Defined in:: lib/aws-sdk-bedrockagent/types.rb

Overview

Contains details about an action group.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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.
#action_group_id ⇒ String

The unique identifier of the action group.
#action_group_name ⇒ String

The name of the action group.
#action_group_state ⇒ String

Specifies whether the action group is available for the agent to invoke or not when sending an [InvokeAgent] request.
#agent_id ⇒ String

The unique identifier of the agent to which the action group belongs.
#agent_version ⇒ String

The version of the agent to which the action group belongs.
#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.
#client_token ⇒ String

A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
#created_at ⇒ Time

The time at which the action group was created.
#description ⇒ String

The description of the action group.
#function_schema ⇒ Types::FunctionSchema

Defines functions that each define parameters that the agent needs to invoke from the user.
#parent_action_signature ⇒ String

If this field is set as ‘AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task.
#updated_at ⇒ Time

The time at which the action group was last updated.

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:

(Types::ActionGroupExecutor)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#action_group_id ⇒ `String`

The unique identifier of the action group.

Returns:

(String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#action_group_name ⇒ `String`

The name of the action group.

Returns:

(String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#action_group_state ⇒ `String`

Specifies whether the action group is available for the agent to invoke or not when sending an [InvokeAgent] request.

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html

Returns:

(String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#agent_id ⇒ `String`

The unique identifier of the agent to which the action group belongs.

Returns:

(String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#agent_version ⇒ `String`

The version of the agent to which the action group belongs.

Returns:

(String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  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].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html

Returns:

(Types::APISchema)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

(String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

The time at which the action group was created.

Returns:

(Time)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The description of the action group.

Returns:

(String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#function_schema ⇒ `Types::FunctionSchema`

Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

Returns:

(Types::FunctionSchema)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#parent_action_signature ⇒ `String`

If this field is set as ‘AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task. The `description`, `apiSchema`, and `actionGroupExecutor` fields must be blank for this action group.

During orchestration, if the 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.

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html

Returns:

(String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ `Time`

The time at which the action group was last updated.

Returns:

(Time)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 387

class AgentActionGroup < Struct.new(
  :action_group_executor,
  :action_group_id,
  :action_group_name,
  :action_group_state,
  :agent_id,
  :agent_version,
  :api_schema,
  :client_token,
  :created_at,
  :description,
  :function_schema,
  :parent_action_signature,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::BedrockAgent::Types::AgentActionGroup

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#action_group_executor ⇒ Types::ActionGroupExecutor

#action_group_id ⇒ String

#action_group_name ⇒ String

#action_group_state ⇒ String

#agent_id ⇒ String

#agent_version ⇒ String

#api_schema ⇒ Types::APISchema

#client_token ⇒ String

#created_at ⇒ Time

#description ⇒ String

#function_schema ⇒ Types::FunctionSchema

#parent_action_signature ⇒ String

#updated_at ⇒ Time

#action_group_executor ⇒ `Types::ActionGroupExecutor`

#action_group_id ⇒ `String`

#action_group_name ⇒ `String`

#action_group_state ⇒ `String`

#agent_id ⇒ `String`

#agent_version ⇒ `String`

#api_schema ⇒ `Types::APISchema`

#client_token ⇒ `String`

#created_at ⇒ `Time`

#description ⇒ `String`

#function_schema ⇒ `Types::FunctionSchema`

#parent_action_signature ⇒ `String`

#updated_at ⇒ `Time`