#[non_exhaustive]pub struct InvokeAgentInputBuilder { /* private fields */ }Expand description
A builder for InvokeAgentInput.
Implementations§
Source§impl InvokeAgentInputBuilder
impl InvokeAgentInputBuilder
Sourcepub fn session_state(self, input: SessionState) -> Self
pub fn session_state(self, input: SessionState) -> Self
Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Sourcepub fn set_session_state(self, input: Option<SessionState>) -> Self
pub fn set_session_state(self, input: Option<SessionState>) -> Self
Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Sourcepub fn get_session_state(&self) -> &Option<SessionState>
pub fn get_session_state(&self) -> &Option<SessionState>
Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
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 to use.
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 to use.
Sourcepub fn get_agent_id(&self) -> &Option<String>
pub fn get_agent_id(&self) -> &Option<String>
The unique identifier of the agent to use.
Sourcepub fn agent_alias_id(self, input: impl Into<String>) -> Self
pub fn agent_alias_id(self, input: impl Into<String>) -> Self
The alias of the agent to use.
This field is required.Sourcepub fn set_agent_alias_id(self, input: Option<String>) -> Self
pub fn set_agent_alias_id(self, input: Option<String>) -> Self
The alias of the agent to use.
Sourcepub fn get_agent_alias_id(&self) -> &Option<String>
pub fn get_agent_alias_id(&self) -> &Option<String>
The alias of the agent to use.
Sourcepub fn session_id(self, input: impl Into<String>) -> Self
pub fn session_id(self, input: impl Into<String>) -> Self
The unique identifier of the session. Use the same value across requests to continue the same conversation.
This field is required.Sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
The unique identifier of the session. Use the same value across requests to continue the same conversation.
Sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
The unique identifier of the session. Use the same value across requests to continue the same conversation.
Sourcepub fn end_session(self, input: bool) -> Self
pub fn end_session(self, input: bool) -> Self
Specifies whether to end the session with the agent or not.
Sourcepub fn set_end_session(self, input: Option<bool>) -> Self
pub fn set_end_session(self, input: Option<bool>) -> Self
Specifies whether to end the session with the agent or not.
Sourcepub fn get_end_session(&self) -> &Option<bool>
pub fn get_end_session(&self) -> &Option<bool>
Specifies whether to end the session with the agent or not.
Sourcepub fn enable_trace(self, input: bool) -> Self
pub fn enable_trace(self, input: bool) -> Self
Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
Sourcepub fn set_enable_trace(self, input: Option<bool>) -> Self
pub fn set_enable_trace(self, input: Option<bool>) -> Self
Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
Sourcepub fn get_enable_trace(&self) -> &Option<bool>
pub fn get_enable_trace(&self) -> &Option<bool>
Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
Sourcepub fn input_text(self, input: impl Into<String>) -> Self
pub fn input_text(self, input: impl Into<String>) -> Self
The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Sourcepub fn set_input_text(self, input: Option<String>) -> Self
pub fn set_input_text(self, input: Option<String>) -> Self
The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Sourcepub fn get_input_text(&self) -> &Option<String>
pub fn get_input_text(&self) -> &Option<String>
The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Sourcepub fn memory_id(self, input: impl Into<String>) -> Self
pub fn memory_id(self, input: impl Into<String>) -> Self
The unique identifier of the agent memory.
Sourcepub fn set_memory_id(self, input: Option<String>) -> Self
pub fn set_memory_id(self, input: Option<String>) -> Self
The unique identifier of the agent memory.
Sourcepub fn get_memory_id(&self) -> &Option<String>
pub fn get_memory_id(&self) -> &Option<String>
The unique identifier of the agent memory.
Sourcepub fn bedrock_model_configurations(
self,
input: BedrockModelConfigurations,
) -> Self
pub fn bedrock_model_configurations( self, input: BedrockModelConfigurations, ) -> Self
Model performance settings for the request.
Sourcepub fn set_bedrock_model_configurations(
self,
input: Option<BedrockModelConfigurations>,
) -> Self
pub fn set_bedrock_model_configurations( self, input: Option<BedrockModelConfigurations>, ) -> Self
Model performance settings for the request.
Sourcepub fn get_bedrock_model_configurations(
&self,
) -> &Option<BedrockModelConfigurations>
pub fn get_bedrock_model_configurations( &self, ) -> &Option<BedrockModelConfigurations>
Model performance settings for the request.
Sourcepub fn streaming_configurations(self, input: StreamingConfigurations) -> Self
pub fn streaming_configurations(self, input: StreamingConfigurations) -> Self
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
Sourcepub fn set_streaming_configurations(
self,
input: Option<StreamingConfigurations>,
) -> Self
pub fn set_streaming_configurations( self, input: Option<StreamingConfigurations>, ) -> Self
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
Sourcepub fn get_streaming_configurations(&self) -> &Option<StreamingConfigurations>
pub fn get_streaming_configurations(&self) -> &Option<StreamingConfigurations>
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
Sourcepub fn prompt_creation_configurations(
self,
input: PromptCreationConfigurations,
) -> Self
pub fn prompt_creation_configurations( self, input: PromptCreationConfigurations, ) -> Self
Specifies parameters that control how the service populates the agent prompt for an InvokeAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
Sourcepub fn set_prompt_creation_configurations(
self,
input: Option<PromptCreationConfigurations>,
) -> Self
pub fn set_prompt_creation_configurations( self, input: Option<PromptCreationConfigurations>, ) -> Self
Specifies parameters that control how the service populates the agent prompt for an InvokeAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
Sourcepub fn get_prompt_creation_configurations(
&self,
) -> &Option<PromptCreationConfigurations>
pub fn get_prompt_creation_configurations( &self, ) -> &Option<PromptCreationConfigurations>
Specifies parameters that control how the service populates the agent prompt for an InvokeAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
Sourcepub fn source_arn(self, input: impl Into<String>) -> Self
pub fn source_arn(self, input: impl Into<String>) -> Self
The ARN of the resource making the request.
Sourcepub fn set_source_arn(self, input: Option<String>) -> Self
pub fn set_source_arn(self, input: Option<String>) -> Self
The ARN of the resource making the request.
Sourcepub fn get_source_arn(&self) -> &Option<String>
pub fn get_source_arn(&self) -> &Option<String>
The ARN of the resource making the request.
Sourcepub fn build(self) -> Result<InvokeAgentInput, BuildError>
pub fn build(self) -> Result<InvokeAgentInput, BuildError>
Consumes the builder and constructs a InvokeAgentInput.
Source§impl InvokeAgentInputBuilder
impl InvokeAgentInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<InvokeAgentOutput, SdkError<InvokeAgentError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<InvokeAgentOutput, SdkError<InvokeAgentError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for InvokeAgentInputBuilder
impl Clone for InvokeAgentInputBuilder
Source§fn clone(&self) -> InvokeAgentInputBuilder
fn clone(&self) -> InvokeAgentInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for InvokeAgentInputBuilder
impl Debug for InvokeAgentInputBuilder
Source§impl Default for InvokeAgentInputBuilder
impl Default for InvokeAgentInputBuilder
Source§fn default() -> InvokeAgentInputBuilder
fn default() -> InvokeAgentInputBuilder
Source§impl PartialEq for InvokeAgentInputBuilder
impl PartialEq for InvokeAgentInputBuilder
impl StructuralPartialEq for InvokeAgentInputBuilder
Auto Trait Implementations§
impl Freeze for InvokeAgentInputBuilder
impl RefUnwindSafe for InvokeAgentInputBuilder
impl Send for InvokeAgentInputBuilder
impl Sync for InvokeAgentInputBuilder
impl Unpin for InvokeAgentInputBuilder
impl UnwindSafe for InvokeAgentInputBuilder
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);