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 override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfiguration
object. For more information, see Advanced prompts. -
If you agent fails to be created, the response returns a list of
failureReasons
alongside a list ofrecommendedActions
for you to troubleshoot.
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 foundation model to be used for orchestration by the agent you create.
sourcepub fn set_foundation_model(self, input: Option<String>) -> Self
pub fn set_foundation_model(self, input: Option<String>) -> Self
The foundation model to be used for orchestration by the agent you create.
sourcepub fn get_foundation_model(&self) -> &Option<String>
pub fn get_foundation_model(&self) -> &Option<String>
The foundation model to be used for orchestration by the agent you create.
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 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.
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> 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 more