#[non_exhaustive]pub struct SessionStateBuilder { /* private fields */ }Expand description
A builder for SessionState.
Implementations§
Source§impl SessionStateBuilder
impl SessionStateBuilder
Sourcepub fn session_attributes(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn session_attributes( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to session_attributes.
To override the contents of this collection use set_session_attributes.
Contains attributes that persist across a session and the values of those attributes. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.
Sourcepub fn set_session_attributes(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_session_attributes( self, input: Option<HashMap<String, String>>, ) -> Self
Contains attributes that persist across a session and the values of those attributes. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.
Sourcepub fn get_session_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_session_attributes(&self) -> &Option<HashMap<String, String>>
Contains attributes that persist across a session and the values of those attributes. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.
Sourcepub fn prompt_session_attributes(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn prompt_session_attributes( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to prompt_session_attributes.
To override the contents of this collection use set_prompt_session_attributes.
Contains attributes that persist across a prompt and the values of those attributes.
-
In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.
-
In multi-agent collaboration, the
promptSessionAttributeswill only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.
Sourcepub fn set_prompt_session_attributes(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_prompt_session_attributes( self, input: Option<HashMap<String, String>>, ) -> Self
Contains attributes that persist across a prompt and the values of those attributes.
-
In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.
-
In multi-agent collaboration, the
promptSessionAttributeswill only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.
Sourcepub fn get_prompt_session_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_prompt_session_attributes(&self) -> &Option<HashMap<String, String>>
Contains attributes that persist across a prompt and the values of those attributes.
-
In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.
-
In multi-agent collaboration, the
promptSessionAttributeswill only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.
Sourcepub fn return_control_invocation_results(
self,
input: InvocationResultMember,
) -> Self
pub fn return_control_invocation_results( self, input: InvocationResultMember, ) -> Self
Appends an item to return_control_invocation_results.
To override the contents of this collection use set_return_control_invocation_results.
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
If you include this field, the inputText field will be ignored.
Sourcepub fn set_return_control_invocation_results(
self,
input: Option<Vec<InvocationResultMember>>,
) -> Self
pub fn set_return_control_invocation_results( self, input: Option<Vec<InvocationResultMember>>, ) -> Self
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
If you include this field, the inputText field will be ignored.
Sourcepub fn get_return_control_invocation_results(
&self,
) -> &Option<Vec<InvocationResultMember>>
pub fn get_return_control_invocation_results( &self, ) -> &Option<Vec<InvocationResultMember>>
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
If you include this field, the inputText field will be ignored.
Sourcepub fn invocation_id(self, input: impl Into<String>) -> Self
pub fn invocation_id(self, input: impl Into<String>) -> Self
The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
Sourcepub fn set_invocation_id(self, input: Option<String>) -> Self
pub fn set_invocation_id(self, input: Option<String>) -> Self
The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
Sourcepub fn get_invocation_id(&self) -> &Option<String>
pub fn get_invocation_id(&self) -> &Option<String>
The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
Sourcepub fn files(self, input: InputFile) -> Self
pub fn files(self, input: InputFile) -> Self
Appends an item to files.
To override the contents of this collection use set_files.
Contains information about the files used by code interpreter.
Sourcepub fn set_files(self, input: Option<Vec<InputFile>>) -> Self
pub fn set_files(self, input: Option<Vec<InputFile>>) -> Self
Contains information about the files used by code interpreter.
Sourcepub fn get_files(&self) -> &Option<Vec<InputFile>>
pub fn get_files(&self) -> &Option<Vec<InputFile>>
Contains information about the files used by code interpreter.
Sourcepub fn knowledge_base_configurations(
self,
input: KnowledgeBaseConfiguration,
) -> Self
pub fn knowledge_base_configurations( self, input: KnowledgeBaseConfiguration, ) -> Self
Appends an item to knowledge_base_configurations.
To override the contents of this collection use set_knowledge_base_configurations.
An array of configurations, each of which applies to a knowledge base attached to the agent.
Sourcepub fn set_knowledge_base_configurations(
self,
input: Option<Vec<KnowledgeBaseConfiguration>>,
) -> Self
pub fn set_knowledge_base_configurations( self, input: Option<Vec<KnowledgeBaseConfiguration>>, ) -> Self
An array of configurations, each of which applies to a knowledge base attached to the agent.
Sourcepub fn get_knowledge_base_configurations(
&self,
) -> &Option<Vec<KnowledgeBaseConfiguration>>
pub fn get_knowledge_base_configurations( &self, ) -> &Option<Vec<KnowledgeBaseConfiguration>>
An array of configurations, each of which applies to a knowledge base attached to the agent.
Sourcepub fn conversation_history(self, input: ConversationHistory) -> Self
pub fn conversation_history(self, input: ConversationHistory) -> Self
The state's conversation history.
Sourcepub fn set_conversation_history(
self,
input: Option<ConversationHistory>,
) -> Self
pub fn set_conversation_history( self, input: Option<ConversationHistory>, ) -> Self
The state's conversation history.
Sourcepub fn get_conversation_history(&self) -> &Option<ConversationHistory>
pub fn get_conversation_history(&self) -> &Option<ConversationHistory>
The state's conversation history.
Sourcepub fn build(self) -> SessionState
pub fn build(self) -> SessionState
Consumes the builder and constructs a SessionState.
Trait Implementations§
Source§impl Clone for SessionStateBuilder
impl Clone for SessionStateBuilder
Source§fn clone(&self) -> SessionStateBuilder
fn clone(&self) -> SessionStateBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for SessionStateBuilder
impl Debug for SessionStateBuilder
Source§impl Default for SessionStateBuilder
impl Default for SessionStateBuilder
Source§fn default() -> SessionStateBuilder
fn default() -> SessionStateBuilder
Source§impl PartialEq for SessionStateBuilder
impl PartialEq for SessionStateBuilder
impl StructuralPartialEq for SessionStateBuilder
Auto Trait Implementations§
impl Freeze for SessionStateBuilder
impl RefUnwindSafe for SessionStateBuilder
impl Send for SessionStateBuilder
impl Sync for SessionStateBuilder
impl Unpin for SessionStateBuilder
impl UnwindSafe for SessionStateBuilder
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);