Struct AgentActionGroup

#[non_exhaustive]
pub struct AgentActionGroup {
    pub action_group_name: String,
    pub description: Option<String>,
    pub parent_action_group_signature: Option<ActionGroupSignature>,
    pub action_group_executor: Option<ActionGroupExecutor>,
    pub api_schema: Option<ApiSchema>,
    pub function_schema: Option<FunctionSchema>,
}

Contains details of the inline agent's action group.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

action_group_name: String

The name of the action group.

description: Option<String>

A description of the action group.

parent_action_group_signature: Option<ActionGroupSignature>

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.

action_group_executor: Option<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.

api_schema: Option<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.

function_schema: Option<FunctionSchema>

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

Implementations

impl AgentActionGroup

pub fn action_group_name(&self) -> &str

The name of the action group.

pub fn description(&self) -> Option<&str>

A description of the action group.

pub fn parent_action_group_signature(&self) -> Option<&ActionGroupSignature>

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.

pub fn action_group_executor(&self) -> Option<&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.

pub fn api_schema(&self) -> Option<&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.

pub fn function_schema(&self) -> Option<&FunctionSchema>

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

impl AgentActionGroup

pub fn builder() -> AgentActionGroupBuilder

Creates a new builder-style object to manufacture AgentActionGroup.

Trait Implementations

impl Clone for AgentActionGroup

fn clone(&self) -> AgentActionGroup

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AgentActionGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AgentActionGroup

fn eq(&self, other: &AgentActionGroup) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AgentActionGroup