Create Agent Action Group

bedrockagent_create_agent_action_group

R Documentation

Creates an action group for an agent

Description

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.

Usage

bedrockagent_create_agent_action_group(actionGroupExecutor,
  actionGroupName, actionGroupState, agentId, agentVersion, apiSchema,
  clientToken, description, functionSchema, parentActionGroupSignature)

Arguments

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.

actionGroupName

[required] The name to give the action group.

actionGroupState

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

agentId

[required] The unique identifier of the agent for which to create the action group.

agentVersion

[required] The version of the agent for which to create the action group.

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.

clientToken

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.

description

A description of the action group.

functionSchema

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

parentActionGroupSignature

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.

Value

A list with the following syntax:

list(
  agentActionGroup = list(
    actionGroupExecutor = list(
      customControl = "RETURN_CONTROL",
      lambda = "string"
    ),
    actionGroupId = "string",
    actionGroupName = "string",
    actionGroupState = "ENABLED"|"DISABLED",
    agentId = "string",
    agentVersion = "string",
    apiSchema = list(
      payload = "string",
      s3 = list(
        s3BucketName = "string",
        s3ObjectKey = "string"
      )
    ),
    clientToken = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    description = "string",
    functionSchema = list(
      functions = list(
        list(
          description = "string",
          name = "string",
          parameters = list(
            list(
              description = "string",
              required = TRUE|FALSE,
              type = "string"|"number"|"integer"|"boolean"|"array"
            )
          ),
          requireConfirmation = "ENABLED"|"DISABLED"
        )
      )
    ),
    parentActionSignature = "AMAZON.UserInput"|"AMAZON.CodeInterpreter",
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$create_agent_action_group(
  actionGroupExecutor = list(
    customControl = "RETURN_CONTROL",
    lambda = "string"
  ),
  actionGroupName = "string",
  actionGroupState = "ENABLED"|"DISABLED",
  agentId = "string",
  agentVersion = "string",
  apiSchema = list(
    payload = "string",
    s3 = list(
      s3BucketName = "string",
      s3ObjectKey = "string"
    )
  ),
  clientToken = "string",
  description = "string",
  functionSchema = list(
    functions = list(
      list(
        description = "string",
        name = "string",
        parameters = list(
          list(
            description = "string",
            required = TRUE|FALSE,
            type = "string"|"number"|"integer"|"boolean"|"array"
          )
        ),
        requireConfirmation = "ENABLED"|"DISABLED"
      )
    )
  ),
  parentActionGroupSignature = "AMAZON.UserInput"|"AMAZON.CodeInterpreter"
)