create_agent_action_group¶
Operation¶
async
¶
create_agent_action_group(input: CreateAgentActionGroupInput, plugins: list[Plugin] | None = None) -> CreateAgentActionGroupOutput
Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
To allow your agent to request the user for additional information when
trying to complete a task, add an action group with the
parentActionGroupSignature field set to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying
to complete a task, add an action group with the
parentActionGroupSignature field set 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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateAgentActionGroupInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateAgentActionGroupOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateAgentActionGroupInput structure.
Attributes¶
class-attribute
instance-attribute
¶
action_group_executor: ActionGroupExecutor | None = None
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.
class-attribute
instance-attribute
¶
action_group_name: str | None = None
The name to give the action group.
class-attribute
instance-attribute
¶
action_group_state: ActionGroupState | None = None
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
class-attribute
instance-attribute
¶
agent_id: str | None = None
The unique identifier of the agent for which to create the action group.
class-attribute
instance-attribute
¶
agent_version: str | None = None
The version of the agent for which to create the action group.
class-attribute
instance-attribute
¶
api_schema: APISchema | None = None
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.
class-attribute
instance-attribute
¶
client_token: str | None = None
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.
class-attribute
instance-attribute
¶
description: str | None = None
A description of the action group.
class-attribute
instance-attribute
¶
function_schema: FunctionSchema | None = None
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
class-attribute
instance-attribute
¶
parent_action_group_signature: ActionGroupSignature | None = None
Specify a built-in or computer use action for this action group. If you
specify a value, you must leave the description, apiSchema, and
actionGroupExecutor fields empty for this action group.
-
To allow your agent to request the user for additional information when trying to complete a task, set this field to
AMAZON.UserInput. -
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to
AMAZON.CodeInterpreter. -
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Warning: Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
-
ANTHROPIC.Computer- Gives the agent permission to use the mouse and keyboard and take screenshots. -
ANTHROPIC.TextEditor- Gives the agent permission to view, create and edit files. -
ANTHROPIC.Bash- Gives the agent permission to run commands in a bash shell.
class-attribute
instance-attribute
¶
parent_action_group_signature_params: dict[str, str] | None = None
The configuration settings for a computer use action.
Warning
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Output¶
dataclass
¶
Dataclass for CreateAgentActionGroupOutput structure.
Attributes¶
instance-attribute
¶
agent_action_group: AgentActionGroup
Contains details about the action group that was created.