#[non_exhaustive]pub struct AgentActionGroup {Show 14 fields
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 parent_action_group_signature_params: Option<HashMap<String, String>>,
pub action_group_executor: Option<ActionGroupExecutor>,
pub api_schema: Option<ApiSchema>,
pub function_schema: Option<FunctionSchema>,
pub action_group_state: ActionGroupState,
}
Expand description
Contains details about an action group.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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.
parent_action_group_signature_params: Option<HashMap<String, String>>
The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with 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.
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§
Source§impl AgentActionGroup
impl AgentActionGroup
Sourcepub fn agent_id(&self) -> &str
pub fn agent_id(&self) -> &str
The unique identifier of the agent to which the action group belongs.
Sourcepub fn agent_version(&self) -> &str
pub fn agent_version(&self) -> &str
The version of the agent to which the action group belongs.
Sourcepub fn action_group_id(&self) -> &str
pub fn action_group_id(&self) -> &str
The unique identifier of the action group.
Sourcepub fn action_group_name(&self) -> &str
pub fn action_group_name(&self) -> &str
The name of the action group.
Sourcepub fn client_token(&self) -> Option<&str>
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.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the action group.
Sourcepub fn created_at(&self) -> &DateTime
pub fn created_at(&self) -> &DateTime
The time at which the action group was created.
Sourcepub fn updated_at(&self) -> &DateTime
pub fn updated_at(&self) -> &DateTime
The time at which the action group was last updated.
Sourcepub fn parent_action_signature(&self) -> Option<&ActionGroupSignature>
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.
Sourcepub fn parent_action_group_signature_params(
&self,
) -> Option<&HashMap<String, String>>
pub fn parent_action_group_signature_params( &self, ) -> Option<&HashMap<String, String>>
The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with 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.
Sourcepub fn action_group_executor(&self) -> Option<&ActionGroupExecutor>
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.
Sourcepub fn api_schema(&self) -> Option<&ApiSchema>
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.
Sourcepub fn function_schema(&self) -> Option<&FunctionSchema>
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.
Sourcepub fn action_group_state(&self) -> &ActionGroupState
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.
Source§impl AgentActionGroup
impl AgentActionGroup
Sourcepub fn builder() -> AgentActionGroupBuilder
pub fn builder() -> AgentActionGroupBuilder
Creates a new builder-style object to manufacture AgentActionGroup
.
Trait Implementations§
Source§impl Clone for AgentActionGroup
impl Clone for AgentActionGroup
Source§fn clone(&self) -> AgentActionGroup
fn clone(&self) -> AgentActionGroup
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AgentActionGroup
impl Debug for AgentActionGroup
Source§impl PartialEq for AgentActionGroup
impl PartialEq for AgentActionGroup
impl StructuralPartialEq for AgentActionGroup
Auto Trait Implementations§
impl Freeze for AgentActionGroup
impl RefUnwindSafe for AgentActionGroup
impl Send for AgentActionGroup
impl Sync for AgentActionGroup
impl Unpin for AgentActionGroup
impl UnwindSafe for AgentActionGroup
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);