#[non_exhaustive]pub struct InlineSessionState {
pub session_attributes: Option<HashMap<String, String>>,
pub prompt_session_attributes: Option<HashMap<String, String>>,
pub return_control_invocation_results: Option<Vec<InvocationResultMember>>,
pub invocation_id: Option<String>,
pub files: Option<Vec<InputFile>>,
pub conversation_history: Option<ConversationHistory>,
}
Expand description
Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent
request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see Control session context
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_attributes: Option<HashMap<String, String>>
Contains attributes that persist across a session and the values of those attributes.
prompt_session_attributes: Option<HashMap<String, String>>
Contains attributes that persist across a session and the values of those attributes.
return_control_invocation_results: Option<Vec<InvocationResultMember>>
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer.
If you include this field in the sessionState
field, the inputText
field will be ignored.
invocation_id: Option<String>
The identifier of the invocation of an action. This value must match the invocationId
returned in the InvokeInlineAgent
response for the action whose results are provided in the returnControlInvocationResults
field. For more information, see Return control to the agent developer.
files: Option<Vec<InputFile>>
Contains information about the files used by code interpreter.
conversation_history: Option<ConversationHistory>
Contains the conversation history that persist across sessions.
Implementations§
Source§impl InlineSessionState
impl InlineSessionState
Sourcepub fn session_attributes(&self) -> Option<&HashMap<String, String>>
pub fn session_attributes(&self) -> Option<&HashMap<String, String>>
Contains attributes that persist across a session and the values of those attributes.
Sourcepub fn prompt_session_attributes(&self) -> Option<&HashMap<String, String>>
pub fn prompt_session_attributes(&self) -> Option<&HashMap<String, String>>
Contains attributes that persist across a session and the values of those attributes.
Sourcepub fn return_control_invocation_results(&self) -> &[InvocationResultMember]
pub fn return_control_invocation_results(&self) -> &[InvocationResultMember]
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer.
If you include this field in the sessionState
field, the inputText
field will be ignored.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .return_control_invocation_results.is_none()
.
Sourcepub fn invocation_id(&self) -> Option<&str>
pub fn invocation_id(&self) -> Option<&str>
The identifier of the invocation of an action. This value must match the invocationId
returned in the InvokeInlineAgent
response for the action whose results are provided in the returnControlInvocationResults
field. For more information, see Return control to the agent developer.
Sourcepub fn files(&self) -> &[InputFile]
pub fn files(&self) -> &[InputFile]
Contains information about the files used by code interpreter.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .files.is_none()
.
Sourcepub fn conversation_history(&self) -> Option<&ConversationHistory>
pub fn conversation_history(&self) -> Option<&ConversationHistory>
Contains the conversation history that persist across sessions.
Source§impl InlineSessionState
impl InlineSessionState
Sourcepub fn builder() -> InlineSessionStateBuilder
pub fn builder() -> InlineSessionStateBuilder
Creates a new builder-style object to manufacture InlineSessionState
.
Trait Implementations§
Source§impl Clone for InlineSessionState
impl Clone for InlineSessionState
Source§fn clone(&self) -> InlineSessionState
fn clone(&self) -> InlineSessionState
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for InlineSessionState
impl Debug for InlineSessionState
Source§impl PartialEq for InlineSessionState
impl PartialEq for InlineSessionState
impl StructuralPartialEq for InlineSessionState
Auto Trait Implementations§
impl Freeze for InlineSessionState
impl RefUnwindSafe for InlineSessionState
impl Send for InlineSessionState
impl Sync for InlineSessionState
impl Unpin for InlineSessionState
impl UnwindSafe for InlineSessionState
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);