#[non_exhaustive]pub struct Agent {Show 23 fields
pub agent_id: String,
pub agent_name: String,
pub agent_arn: String,
pub agent_version: String,
pub client_token: Option<String>,
pub instruction: Option<String>,
pub agent_status: AgentStatus,
pub foundation_model: Option<String>,
pub description: Option<String>,
pub orchestration_type: Option<OrchestrationType>,
pub custom_orchestration: Option<CustomOrchestration>,
pub idle_session_ttl_in_seconds: i32,
pub agent_resource_role_arn: String,
pub customer_encryption_key_arn: Option<String>,
pub created_at: DateTime,
pub updated_at: DateTime,
pub prepared_at: Option<DateTime>,
pub failure_reasons: Option<Vec<String>>,
pub recommended_actions: Option<Vec<String>>,
pub prompt_override_configuration: Option<PromptOverrideConfiguration>,
pub guardrail_configuration: Option<GuardrailConfiguration>,
pub memory_configuration: Option<MemoryConfiguration>,
pub agent_collaboration: Option<AgentCollaboration>,
}Expand description
Contains details about an agent.
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: StringThe unique identifier of the agent.
agent_name: StringThe name of the agent.
agent_arn: StringThe Amazon Resource Name (ARN) of the agent.
agent_version: StringThe version of the agent.
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.
instruction: Option<String>Instructions that tell the agent what it should do and how it should interact with users.
agent_status: AgentStatusThe status of the agent and whether it is ready for use. The following statuses are possible:
-
CREATING – The agent is being created.
-
PREPARING – The agent is being prepared.
-
PREPARED – The agent is prepared and ready to be invoked.
-
NOT_PREPARED – The agent has been created but not yet prepared.
-
FAILED – The agent API operation failed.
-
UPDATING – The agent is being updated.
-
DELETING – The agent is being deleted.
foundation_model: Option<String>The foundation model used for orchestration by the agent.
description: Option<String>The description of the agent.
orchestration_type: Option<OrchestrationType>Specifies the orchestration strategy for the agent.
custom_orchestration: Option<CustomOrchestration>Contains custom orchestration configurations for the agent.
idle_session_ttl_in_seconds: i32The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
agent_resource_role_arn: StringThe Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
customer_encryption_key_arn: Option<String>The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
created_at: DateTimeThe time at which the agent was created.
updated_at: DateTimeThe time at which the agent was last updated.
prepared_at: Option<DateTime>The time at which the agent was last prepared.
failure_reasons: Option<Vec<String>>Contains reasons that the agent-related API that you invoked failed.
recommended_actions: Option<Vec<String>>Contains recommended actions to take for the agent-related API that you invoked to succeed.
prompt_override_configuration: Option<PromptOverrideConfiguration>Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
guardrail_configuration: Option<GuardrailConfiguration>Details about the guardrail associated with the agent.
memory_configuration: Option<MemoryConfiguration>Contains memory configuration for the agent.
agent_collaboration: Option<AgentCollaboration>The agent's collaboration settings.
Implementations§
Source§impl Agent
impl Agent
Sourcepub fn agent_name(&self) -> &str
pub fn agent_name(&self) -> &str
The name of the agent.
Sourcepub fn agent_version(&self) -> &str
pub fn agent_version(&self) -> &str
The version of the agent.
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 instruction(&self) -> Option<&str>
pub fn instruction(&self) -> Option<&str>
Instructions that tell the agent what it should do and how it should interact with users.
Sourcepub fn agent_status(&self) -> &AgentStatus
pub fn agent_status(&self) -> &AgentStatus
The status of the agent and whether it is ready for use. The following statuses are possible:
-
CREATING – The agent is being created.
-
PREPARING – The agent is being prepared.
-
PREPARED – The agent is prepared and ready to be invoked.
-
NOT_PREPARED – The agent has been created but not yet prepared.
-
FAILED – The agent API operation failed.
-
UPDATING – The agent is being updated.
-
DELETING – The agent is being deleted.
Sourcepub fn foundation_model(&self) -> Option<&str>
pub fn foundation_model(&self) -> Option<&str>
The foundation model used for orchestration by the agent.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the agent.
Sourcepub fn orchestration_type(&self) -> Option<&OrchestrationType>
pub fn orchestration_type(&self) -> Option<&OrchestrationType>
Specifies the orchestration strategy for the agent.
Sourcepub fn custom_orchestration(&self) -> Option<&CustomOrchestration>
pub fn custom_orchestration(&self) -> Option<&CustomOrchestration>
Contains custom orchestration configurations for the agent.
Sourcepub fn idle_session_ttl_in_seconds(&self) -> i32
pub fn idle_session_ttl_in_seconds(&self) -> i32
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
Sourcepub fn agent_resource_role_arn(&self) -> &str
pub fn agent_resource_role_arn(&self) -> &str
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
Sourcepub fn customer_encryption_key_arn(&self) -> Option<&str>
pub fn customer_encryption_key_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
Sourcepub fn created_at(&self) -> &DateTime
pub fn created_at(&self) -> &DateTime
The time at which the agent was created.
Sourcepub fn updated_at(&self) -> &DateTime
pub fn updated_at(&self) -> &DateTime
The time at which the agent was last updated.
Sourcepub fn prepared_at(&self) -> Option<&DateTime>
pub fn prepared_at(&self) -> Option<&DateTime>
The time at which the agent was last prepared.
Sourcepub fn failure_reasons(&self) -> &[String]
pub fn failure_reasons(&self) -> &[String]
Contains reasons that the agent-related API that you invoked failed.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .failure_reasons.is_none().
Sourcepub fn recommended_actions(&self) -> &[String]
pub fn recommended_actions(&self) -> &[String]
Contains recommended actions to take for the agent-related API that you invoked to succeed.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .recommended_actions.is_none().
Sourcepub fn prompt_override_configuration(
&self,
) -> Option<&PromptOverrideConfiguration>
pub fn prompt_override_configuration( &self, ) -> Option<&PromptOverrideConfiguration>
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
Sourcepub fn guardrail_configuration(&self) -> Option<&GuardrailConfiguration>
pub fn guardrail_configuration(&self) -> Option<&GuardrailConfiguration>
Details about the guardrail associated with the agent.
Sourcepub fn memory_configuration(&self) -> Option<&MemoryConfiguration>
pub fn memory_configuration(&self) -> Option<&MemoryConfiguration>
Contains memory configuration for the agent.
Sourcepub fn agent_collaboration(&self) -> Option<&AgentCollaboration>
pub fn agent_collaboration(&self) -> Option<&AgentCollaboration>
The agent's collaboration settings.
Trait Implementations§
impl StructuralPartialEq for Agent
Auto Trait Implementations§
impl Freeze for Agent
impl RefUnwindSafe for Agent
impl Send for Agent
impl Sync for Agent
impl Unpin for Agent
impl UnwindSafe for Agent
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);