pub struct CreateAgentFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateAgent
.
Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
-
Specify the following fields for security purposes.
-
agentResourceRoleArn
– The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. -
(Optional)
customerEncryptionKeyArn
– The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. -
(Optional)
idleSessionTTLinSeconds
– Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequentInvokeAgent
request begins a new session.
-
-
To enable your agent to retain conversational context across multiple sessions, include a
memoryConfiguration
object. For more information, see Configure memory. -
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfiguration
object. For more information, see Advanced prompts. -
If your agent fails to be created, the response returns a list of
failureReasons
alongside a list ofrecommendedActions
for you to troubleshoot. -
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
Implementations§
Source§impl CreateAgentFluentBuilder
impl CreateAgentFluentBuilder
Sourcepub fn as_input(&self) -> &CreateAgentInputBuilder
pub fn as_input(&self) -> &CreateAgentInputBuilder
Access the CreateAgent as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateAgentOutput, SdkError<CreateAgentError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateAgentOutput, SdkError<CreateAgentError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateAgentOutput, CreateAgentError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateAgentOutput, CreateAgentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn agent_name(self, input: impl Into<String>) -> Self
pub fn agent_name(self, input: impl Into<String>) -> Self
A name for the agent that you create.
Sourcepub fn set_agent_name(self, input: Option<String>) -> Self
pub fn set_agent_name(self, input: Option<String>) -> Self
A name for the agent that you create.
Sourcepub fn get_agent_name(&self) -> &Option<String>
pub fn get_agent_name(&self) -> &Option<String>
A name for the agent that you create.
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 foundation_model(self, input: impl Into<String>) -> Self
pub fn foundation_model(self, input: impl Into<String>) -> Self
The identifier for the model that you want to be used for orchestration by the agent you create.
The modelId
to provide depends on the type of model or throughput that you use:
-
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
-
If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.
-
If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
-
If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
-
If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.
Sourcepub fn set_foundation_model(self, input: Option<String>) -> Self
pub fn set_foundation_model(self, input: Option<String>) -> Self
The identifier for the model that you want to be used for orchestration by the agent you create.
The modelId
to provide depends on the type of model or throughput that you use:
-
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
-
If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.
-
If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
-
If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
-
If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.
Sourcepub fn get_foundation_model(&self) -> &Option<String>
pub fn get_foundation_model(&self) -> &Option<String>
The identifier for the model that you want to be used for orchestration by the agent you create.
The modelId
to provide depends on the type of model or throughput that you use:
-
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
-
If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.
-
If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
-
If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
-
If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the agent.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the agent.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the agent.
Sourcepub fn orchestration_type(self, input: OrchestrationType) -> Self
pub fn orchestration_type(self, input: OrchestrationType) -> Self
Specifies the type of orchestration strategy for the agent. This is set to DEFAULT
orchestration type, by default.
Sourcepub fn set_orchestration_type(self, input: Option<OrchestrationType>) -> Self
pub fn set_orchestration_type(self, input: Option<OrchestrationType>) -> Self
Specifies the type of orchestration strategy for the agent. This is set to DEFAULT
orchestration type, by default.
Sourcepub fn get_orchestration_type(&self) -> &Option<OrchestrationType>
pub fn get_orchestration_type(&self) -> &Option<OrchestrationType>
Specifies the type of orchestration strategy for the agent. This is set to DEFAULT
orchestration type, by default.
Sourcepub fn custom_orchestration(self, input: CustomOrchestration) -> Self
pub fn custom_orchestration(self, input: CustomOrchestration) -> Self
Contains details of the custom orchestration configured for the agent.
Sourcepub fn set_custom_orchestration(
self,
input: Option<CustomOrchestration>,
) -> Self
pub fn set_custom_orchestration( self, input: Option<CustomOrchestration>, ) -> Self
Contains details of the custom orchestration configured for the agent.
Sourcepub fn get_custom_orchestration(&self) -> &Option<CustomOrchestration>
pub fn get_custom_orchestration(&self) -> &Option<CustomOrchestration>
Contains details of the custom orchestration configured 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.
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.
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 with which to encrypt 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 with which to encrypt 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 with which to encrypt the agent.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
Any tags that you want to attach to the agent.
Any tags that you want to attach to the agent.
Any tags that you want to attach to the agent.
Sourcepub fn prompt_override_configuration(
self,
input: PromptOverrideConfiguration,
) -> Self
pub fn prompt_override_configuration( self, input: PromptOverrideConfiguration, ) -> Self
Contains configurations to override prompts 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 prompts 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 prompts 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
The unique Guardrail configuration assigned to the agent when it is created.
Sourcepub fn set_guardrail_configuration(
self,
input: Option<GuardrailConfiguration>,
) -> Self
pub fn set_guardrail_configuration( self, input: Option<GuardrailConfiguration>, ) -> Self
The unique Guardrail configuration assigned to the agent when it is created.
Sourcepub fn get_guardrail_configuration(&self) -> &Option<GuardrailConfiguration>
pub fn get_guardrail_configuration(&self) -> &Option<GuardrailConfiguration>
The unique Guardrail configuration assigned to the agent when it is created.
Sourcepub fn memory_configuration(self, input: MemoryConfiguration) -> Self
pub fn memory_configuration(self, input: MemoryConfiguration) -> Self
Contains the details of the memory configured for the agent.
Sourcepub fn set_memory_configuration(
self,
input: Option<MemoryConfiguration>,
) -> Self
pub fn set_memory_configuration( self, input: Option<MemoryConfiguration>, ) -> Self
Contains the details of the memory configured for the agent.
Sourcepub fn get_memory_configuration(&self) -> &Option<MemoryConfiguration>
pub fn get_memory_configuration(&self) -> &Option<MemoryConfiguration>
Contains the details of the memory configured for the agent.
Sourcepub fn agent_collaboration(self, input: AgentCollaboration) -> Self
pub fn agent_collaboration(self, input: AgentCollaboration) -> Self
The agent's collaboration role.
Sourcepub fn set_agent_collaboration(self, input: Option<AgentCollaboration>) -> Self
pub fn set_agent_collaboration(self, input: Option<AgentCollaboration>) -> Self
The agent's collaboration role.
Sourcepub fn get_agent_collaboration(&self) -> &Option<AgentCollaboration>
pub fn get_agent_collaboration(&self) -> &Option<AgentCollaboration>
The agent's collaboration role.
Trait Implementations§
Source§impl Clone for CreateAgentFluentBuilder
impl Clone for CreateAgentFluentBuilder
Source§fn clone(&self) -> CreateAgentFluentBuilder
fn clone(&self) -> CreateAgentFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateAgentFluentBuilder
impl !RefUnwindSafe for CreateAgentFluentBuilder
impl Send for CreateAgentFluentBuilder
impl Sync for CreateAgentFluentBuilder
impl Unpin for CreateAgentFluentBuilder
impl !UnwindSafe for CreateAgentFluentBuilder
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);