/AWS1/CL_BDA=>CREATEAGENTACTIONGROUP()¶
About CreateAgentActionGroup¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_AGENTID TYPE /AWS1/BDAID /AWS1/BDAID¶
The unique identifier of the agent for which to create the action group.
IV_AGENTVERSION TYPE /AWS1/BDADRAFTVERSION /AWS1/BDADRAFTVERSION¶
The version of the agent for which to create the action group.
IV_ACTIONGROUPNAME TYPE /AWS1/BDANAME /AWS1/BDANAME¶
The name to give the action group.
Optional arguments:¶
IV_CLIENTTOKEN TYPE /AWS1/BDACLIENTTOKEN /AWS1/BDACLIENTTOKEN¶
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.
IV_DESCRIPTION TYPE /AWS1/BDADESCRIPTION /AWS1/BDADESCRIPTION¶
A description of the action group.
IV_PARENTACTIONGROUPSIG TYPE /AWS1/BDAACTIONGROUPSIGNATURE /AWS1/BDAACTIONGROUPSIGNATURE¶
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 thedescription,apiSchema, andactionGroupExecutorfields 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 thedescription,apiSchema, andactionGroupExecutorfields 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.
IO_ACTIONGROUPEXECUTOR TYPE REF TO /AWS1/CL_BDAACTGROUPEXECUTOR /AWS1/CL_BDAACTGROUPEXECUTOR¶
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.
IO_APISCHEMA TYPE REF TO /AWS1/CL_BDAAPISCHEMA /AWS1/CL_BDAAPISCHEMA¶
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.
IV_ACTIONGROUPSTATE TYPE /AWS1/BDAACTIONGROUPSTATE /AWS1/BDAACTIONGROUPSTATE¶
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
IO_FUNCTIONSCHEMA TYPE REF TO /AWS1/CL_BDAFUNCTIONSCHEMA /AWS1/CL_BDAFUNCTIONSCHEMA¶
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.