Struct SessionState 

#[non_exhaustive]
pub struct SessionState {
    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 knowledge_base_configurations: Option<Vec<KnowledgeBaseConfiguration>>,
    pub conversation_history: Option<ConversationHistory>,
}

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 InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.

prompt_session_attributes: 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 promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.

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 and Control session context.

If you include this 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 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.

files: Option<Vec<InputFile>>

Contains information about the files used by code interpreter.

knowledge_base_configurations: Option<Vec<KnowledgeBaseConfiguration>>

An array of configurations, each of which applies to a knowledge base attached to the agent.

conversation_history: Option<ConversationHistory>

The state's conversation history.

Implementations

impl SessionState

pub fn 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.

pub fn 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 promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.

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 and Control session context.

If you include this 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().

pub fn invocation_id(&self) -> Option<&str>

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.

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().

pub fn knowledge_base_configurations(&self) -> &[KnowledgeBaseConfiguration]

An array of configurations, each of which applies to a knowledge base attached to the agent.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .knowledge_base_configurations.is_none().

pub fn conversation_history(&self) -> Option<&ConversationHistory>

The state's conversation history.

impl SessionState

pub fn builder() -> SessionStateBuilder

Creates a new builder-style object to manufacture SessionState.

Trait Implementations

impl Clone for SessionState

fn clone(&self) -> SessionState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SessionState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SessionState

fn eq(&self, other: &SessionState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SessionState