SessionState
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.
Contents
- conversationHistory
-
The state's conversation history.
Type: ConversationHistory object
Required: No
- files
-
Contains information about the files used by code interpreter.
Type: Array of InputFile objects
Required: No
- invocationId
-
The identifier of the invocation of an action. This value must match the
invocationIdreturned in theInvokeAgentresponse for the action whose results are provided in thereturnControlInvocationResultsfield. For more information, see Return control to the agent developer and Control session context.Type: String
Required: No
- knowledgeBaseConfigurations
-
An array of configurations, each of which applies to a knowledge base attached to the agent.
Type: Array of KnowledgeBaseConfiguration objects
Array Members: Minimum number of 1 item.
Required: No
- promptSessionAttributes
-
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.
Type: String to string map
Required: No
-
- returnControlInvocationResults
-
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
Note
If you include this field, the
inputTextfield will be ignored.Type: Array of InvocationResultMember objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: No
- sessionAttributes
-
Contains attributes that persist across a session and the values of those attributes. If
sessionAttributesare passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.Type: String to string map
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
