#[non_exhaustive]pub struct InvokeAgentInput {
pub session_state: Option<SessionState>,
pub agent_id: Option<String>,
pub agent_alias_id: Option<String>,
pub session_id: Option<String>,
pub end_session: Option<bool>,
pub enable_trace: Option<bool>,
pub input_text: Option<String>,
pub memory_id: Option<String>,
pub bedrock_model_configurations: Option<BedrockModelConfigurations>,
pub streaming_configurations: Option<StreamingConfigurations>,
pub prompt_creation_configurations: Option<PromptCreationConfigurations>,
pub source_arn: Option<String>,
}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.session_state: 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.
agent_id: Option<String>The unique identifier of the agent to use.
agent_alias_id: Option<String>The alias of the agent to use.
session_id: Option<String>The unique identifier of the session. Use the same value across requests to continue the same conversation.
end_session: Option<bool>Specifies whether to end the session with the agent or not.
enable_trace: Option<bool>Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
input_text: Option<String>The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
memory_id: Option<String>The unique identifier of the agent memory.
bedrock_model_configurations: Option<BedrockModelConfigurations>Model performance settings for the request.
streaming_configurations: Option<StreamingConfigurations>Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
prompt_creation_configurations: 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.
source_arn: Option<String>The ARN of the resource making the request.
Implementations§
Source§impl InvokeAgentInput
impl InvokeAgentInput
Sourcepub fn session_state(&self) -> Option<&SessionState>
pub fn 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_alias_id(&self) -> Option<&str>
pub fn agent_alias_id(&self) -> Option<&str>
The alias of the agent to use.
Sourcepub fn session_id(&self) -> Option<&str>
pub fn session_id(&self) -> Option<&str>
The unique identifier of the session. Use the same value across requests to continue the same conversation.
Sourcepub fn end_session(&self) -> Option<bool>
pub fn end_session(&self) -> Option<bool>
Specifies whether to end the session with the agent or not.
Sourcepub fn enable_trace(&self) -> Option<bool>
pub fn 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) -> Option<&str>
pub fn input_text(&self) -> Option<&str>
The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Sourcepub fn bedrock_model_configurations(
&self,
) -> Option<&BedrockModelConfigurations>
pub fn bedrock_model_configurations( &self, ) -> Option<&BedrockModelConfigurations>
Model performance settings for the request.
Sourcepub fn streaming_configurations(&self) -> Option<&StreamingConfigurations>
pub fn 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,
) -> Option<&PromptCreationConfigurations>
pub fn 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) -> Option<&str>
pub fn source_arn(&self) -> Option<&str>
The ARN of the resource making the request.
Source§impl InvokeAgentInput
impl InvokeAgentInput
Sourcepub fn builder() -> InvokeAgentInputBuilder
pub fn builder() -> InvokeAgentInputBuilder
Creates a new builder-style object to manufacture InvokeAgentInput.
Trait Implementations§
Source§impl Clone for InvokeAgentInput
impl Clone for InvokeAgentInput
Source§fn clone(&self) -> InvokeAgentInput
fn clone(&self) -> InvokeAgentInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for InvokeAgentInput
impl Debug for InvokeAgentInput
Source§impl PartialEq for InvokeAgentInput
impl PartialEq for InvokeAgentInput
impl StructuralPartialEq for InvokeAgentInput
Auto Trait Implementations§
impl Freeze for InvokeAgentInput
impl RefUnwindSafe for InvokeAgentInput
impl Send for InvokeAgentInput
impl Sync for InvokeAgentInput
impl Unpin for InvokeAgentInput
impl UnwindSafe for InvokeAgentInput
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);