#[non_exhaustive]pub struct AgentBuilder { /* private fields */ }
Expand description
A builder for Agent
.
Implementations§
Source§impl AgentBuilder
impl AgentBuilder
Sourcepub fn agent_id(self, input: impl Into<String>) -> Self
pub fn agent_id(self, input: impl Into<String>) -> Self
The unique identifier of the agent.
This field is required.Sourcepub fn set_agent_id(self, input: Option<String>) -> Self
pub fn set_agent_id(self, input: Option<String>) -> Self
The unique identifier of the agent.
Sourcepub fn get_agent_id(&self) -> &Option<String>
pub fn get_agent_id(&self) -> &Option<String>
The unique identifier of the agent.
Sourcepub fn agent_name(self, input: impl Into<String>) -> Self
pub fn agent_name(self, input: impl Into<String>) -> Self
The name of the agent.
This field is required.Sourcepub fn set_agent_name(self, input: Option<String>) -> Self
pub fn set_agent_name(self, input: Option<String>) -> Self
The name of the agent.
Sourcepub fn get_agent_name(&self) -> &Option<String>
pub fn get_agent_name(&self) -> &Option<String>
The name of the agent.
Sourcepub fn agent_arn(self, input: impl Into<String>) -> Self
pub fn agent_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the agent.
This field is required.Sourcepub fn set_agent_arn(self, input: Option<String>) -> Self
pub fn set_agent_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the agent.
Sourcepub fn get_agent_arn(&self) -> &Option<String>
pub fn get_agent_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the agent.
Sourcepub fn agent_version(self, input: impl Into<String>) -> Self
pub fn agent_version(self, input: impl Into<String>) -> Self
The version of the agent.
This field is required.Sourcepub fn set_agent_version(self, input: Option<String>) -> Self
pub fn set_agent_version(self, input: Option<String>) -> Self
The version of the agent.
Sourcepub fn get_agent_version(&self) -> &Option<String>
pub fn get_agent_version(&self) -> &Option<String>
The version of the agent.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
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 set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
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 get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &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.
Sourcepub fn instruction(self, input: impl Into<String>) -> Self
pub fn instruction(self, input: impl Into<String>) -> Self
Instructions that tell the agent what it should do and how it should interact with users.
Sourcepub fn set_instruction(self, input: Option<String>) -> Self
pub fn set_instruction(self, input: Option<String>) -> Self
Instructions that tell the agent what it should do and how it should interact with users.
Sourcepub fn get_instruction(&self) -> &Option<String>
pub fn get_instruction(&self) -> &Option<String>
Instructions that tell the agent what it should do and how it should interact with users.
Sourcepub fn agent_status(self, input: AgentStatus) -> Self
pub fn agent_status(self, input: AgentStatus) -> Self
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 set_agent_status(self, input: Option<AgentStatus>) -> Self
pub fn set_agent_status(self, input: Option<AgentStatus>) -> Self
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 get_agent_status(&self) -> &Option<AgentStatus>
pub fn get_agent_status(&self) -> &Option<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, input: impl Into<String>) -> Self
pub fn foundation_model(self, input: impl Into<String>) -> Self
The foundation model used for orchestration by the agent.
Sourcepub fn set_foundation_model(self, input: Option<String>) -> Self
pub fn set_foundation_model(self, input: Option<String>) -> Self
The foundation model used for orchestration by the agent.
Sourcepub fn get_foundation_model(&self) -> &Option<String>
pub fn get_foundation_model(&self) -> &Option<String>
The foundation model used for orchestration by the agent.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the agent.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the agent.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the agent.
Sourcepub fn orchestration_type(self, input: OrchestrationType) -> Self
pub fn orchestration_type(self, input: OrchestrationType) -> Self
Specifies the orchestration strategy for the agent.
Sourcepub fn set_orchestration_type(self, input: Option<OrchestrationType>) -> Self
pub fn set_orchestration_type(self, input: Option<OrchestrationType>) -> Self
Specifies the orchestration strategy for the agent.
Sourcepub fn get_orchestration_type(&self) -> &Option<OrchestrationType>
pub fn get_orchestration_type(&self) -> &Option<OrchestrationType>
Specifies the orchestration strategy for the agent.
Sourcepub fn custom_orchestration(self, input: CustomOrchestration) -> Self
pub fn custom_orchestration(self, input: CustomOrchestration) -> Self
Contains custom orchestration configurations for the agent.
Sourcepub fn set_custom_orchestration(
self,
input: Option<CustomOrchestration>,
) -> Self
pub fn set_custom_orchestration( self, input: Option<CustomOrchestration>, ) -> Self
Contains custom orchestration configurations for the agent.
Sourcepub fn get_custom_orchestration(&self) -> &Option<CustomOrchestration>
pub fn get_custom_orchestration(&self) -> &Option<CustomOrchestration>
Contains custom orchestration configurations for the agent.
Sourcepub fn idle_session_ttl_in_seconds(self, input: i32) -> Self
pub fn idle_session_ttl_in_seconds(self, input: i32) -> Self
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.
This field is required.Sourcepub fn set_idle_session_ttl_in_seconds(self, input: Option<i32>) -> Self
pub fn set_idle_session_ttl_in_seconds(self, input: Option<i32>) -> Self
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 get_idle_session_ttl_in_seconds(&self) -> &Option<i32>
pub fn get_idle_session_ttl_in_seconds(&self) -> &Option<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, input: impl Into<String>) -> Self
pub fn agent_resource_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
This field is required.Sourcepub fn set_agent_resource_role_arn(self, input: Option<String>) -> Self
pub fn set_agent_resource_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
Sourcepub fn get_agent_resource_role_arn(&self) -> &Option<String>
pub fn get_agent_resource_role_arn(&self) -> &Option<String>
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, input: impl Into<String>) -> Self
pub fn customer_encryption_key_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
Sourcepub fn set_customer_encryption_key_arn(self, input: Option<String>) -> Self
pub fn set_customer_encryption_key_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
Sourcepub fn get_customer_encryption_key_arn(&self) -> &Option<String>
pub fn get_customer_encryption_key_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The time at which the agent was created.
This field is required.Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The time at which the agent was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The time at which the agent was created.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The time at which the agent was last updated.
This field is required.Sourcepub fn set_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_updated_at(self, input: Option<DateTime>) -> Self
The time at which the agent was last updated.
Sourcepub fn get_updated_at(&self) -> &Option<DateTime>
pub fn get_updated_at(&self) -> &Option<DateTime>
The time at which the agent was last updated.
Sourcepub fn prepared_at(self, input: DateTime) -> Self
pub fn prepared_at(self, input: DateTime) -> Self
The time at which the agent was last prepared.
Sourcepub fn set_prepared_at(self, input: Option<DateTime>) -> Self
pub fn set_prepared_at(self, input: Option<DateTime>) -> Self
The time at which the agent was last prepared.
Sourcepub fn get_prepared_at(&self) -> &Option<DateTime>
pub fn get_prepared_at(&self) -> &Option<DateTime>
The time at which the agent was last prepared.
Sourcepub fn failure_reasons(self, input: impl Into<String>) -> Self
pub fn failure_reasons(self, input: impl Into<String>) -> Self
Appends an item to failure_reasons
.
To override the contents of this collection use set_failure_reasons
.
Contains reasons that the agent-related API that you invoked failed.
Sourcepub fn set_failure_reasons(self, input: Option<Vec<String>>) -> Self
pub fn set_failure_reasons(self, input: Option<Vec<String>>) -> Self
Contains reasons that the agent-related API that you invoked failed.
Sourcepub fn get_failure_reasons(&self) -> &Option<Vec<String>>
pub fn get_failure_reasons(&self) -> &Option<Vec<String>>
Contains reasons that the agent-related API that you invoked failed.
Sourcepub fn recommended_actions(self, input: impl Into<String>) -> Self
pub fn recommended_actions(self, input: impl Into<String>) -> Self
Appends an item to recommended_actions
.
To override the contents of this collection use set_recommended_actions
.
Contains recommended actions to take for the agent-related API that you invoked to succeed.
Sourcepub fn set_recommended_actions(self, input: Option<Vec<String>>) -> Self
pub fn set_recommended_actions(self, input: Option<Vec<String>>) -> Self
Contains recommended actions to take for the agent-related API that you invoked to succeed.
Sourcepub fn get_recommended_actions(&self) -> &Option<Vec<String>>
pub fn get_recommended_actions(&self) -> &Option<Vec<String>>
Contains recommended actions to take for the agent-related API that you invoked to succeed.
Sourcepub fn prompt_override_configuration(
self,
input: PromptOverrideConfiguration,
) -> Self
pub fn prompt_override_configuration( self, input: PromptOverrideConfiguration, ) -> Self
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
Sourcepub fn set_prompt_override_configuration(
self,
input: Option<PromptOverrideConfiguration>,
) -> Self
pub fn set_prompt_override_configuration( self, input: Option<PromptOverrideConfiguration>, ) -> Self
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
Sourcepub fn get_prompt_override_configuration(
&self,
) -> &Option<PromptOverrideConfiguration>
pub fn get_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, input: GuardrailConfiguration) -> Self
pub fn guardrail_configuration(self, input: GuardrailConfiguration) -> Self
Details about the guardrail associated with the agent.
Sourcepub fn set_guardrail_configuration(
self,
input: Option<GuardrailConfiguration>,
) -> Self
pub fn set_guardrail_configuration( self, input: Option<GuardrailConfiguration>, ) -> Self
Details about the guardrail associated with the agent.
Sourcepub fn get_guardrail_configuration(&self) -> &Option<GuardrailConfiguration>
pub fn get_guardrail_configuration(&self) -> &Option<GuardrailConfiguration>
Details about the guardrail associated with the agent.
Sourcepub fn memory_configuration(self, input: MemoryConfiguration) -> Self
pub fn memory_configuration(self, input: MemoryConfiguration) -> Self
Contains memory configuration for the agent.
Sourcepub fn set_memory_configuration(
self,
input: Option<MemoryConfiguration>,
) -> Self
pub fn set_memory_configuration( self, input: Option<MemoryConfiguration>, ) -> Self
Contains memory configuration for the agent.
Sourcepub fn get_memory_configuration(&self) -> &Option<MemoryConfiguration>
pub fn get_memory_configuration(&self) -> &Option<MemoryConfiguration>
Contains memory configuration for the agent.
Sourcepub fn agent_collaboration(self, input: AgentCollaboration) -> Self
pub fn agent_collaboration(self, input: AgentCollaboration) -> Self
The agent's collaboration settings.
Sourcepub fn set_agent_collaboration(self, input: Option<AgentCollaboration>) -> Self
pub fn set_agent_collaboration(self, input: Option<AgentCollaboration>) -> Self
The agent's collaboration settings.
Sourcepub fn get_agent_collaboration(&self) -> &Option<AgentCollaboration>
pub fn get_agent_collaboration(&self) -> &Option<AgentCollaboration>
The agent's collaboration settings.
Trait Implementations§
Source§impl Clone for AgentBuilder
impl Clone for AgentBuilder
Source§fn clone(&self) -> AgentBuilder
fn clone(&self) -> AgentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AgentBuilder
impl Debug for AgentBuilder
Source§impl Default for AgentBuilder
impl Default for AgentBuilder
Source§fn default() -> AgentBuilder
fn default() -> AgentBuilder
Source§impl PartialEq for AgentBuilder
impl PartialEq for AgentBuilder
impl StructuralPartialEq for AgentBuilder
Auto Trait Implementations§
impl Freeze for AgentBuilder
impl RefUnwindSafe for AgentBuilder
impl Send for AgentBuilder
impl Sync for AgentBuilder
impl Unpin for AgentBuilder
impl UnwindSafe for AgentBuilder
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);