InlineSessionState
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
Contents
- conversationHistory
-
Contains the conversation history that persist across sessions.
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 theInvokeInlineAgentresponse for the action whose results are provided in thereturnControlInvocationResultsfield. For more information, see Return control to the agent developer.Type: String
Required: No
- promptSessionAttributes
-
Contains attributes that persist across a session and the values of those attributes.
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.
Note
If you include this field in the
sessionStatefield, theinputTextfield 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.
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:
