Struct AgentActionGroup

#[non_exhaustive]
pub struct AgentActionGroup {

    pub agent_id: String,
    pub agent_version: String,
    pub action_group_id: String,
    pub action_group_name: String,
    pub client_token: Option<String>,
    pub description: Option<String>,
    pub created_at: DateTime,
    pub updated_at: DateTime,
    pub parent_action_signature: Option<ActionGroupSignature>,
    pub action_group_executor: Option<ActionGroupExecutor>,
    pub api_schema: Option<ApiSchema>,
    pub function_schema: Option<FunctionSchema>,
    pub action_group_state: ActionGroupState,
}

Contains details about an 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.

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.

action_group_id: String

The unique identifier of the action group.

action_group_name: String

The name of the action group.

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

description: Option<String>

The description of the action group.

created_at: DateTime

The time at which the action group was created.

updated_at: DateTime

The time at which the action group was last updated.

parent_action_signature: Option<ActionGroupSignature>

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.

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>

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

action_group_state: ActionGroupState

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

Implementations

impl AgentActionGroup

pub fn agent_id(&self) -> &str

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

pub fn agent_version(&self) -> &str

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

pub fn action_group_id(&self) -> &str

The unique identifier of the action group.

pub fn action_group_name(&self) -> &str

The name of the action group.

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

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.

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

The description of the action group.

pub fn created_at(&self) -> &DateTime

The time at which the action group was created.

pub fn updated_at(&self) -> &DateTime

The time at which the action group was last updated.

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

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.

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>

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

pub fn action_group_state(&self) -> &ActionGroupState

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

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