delete_session¶
Operation¶
async
¶
delete_session(input: DeleteSessionInput, plugins: list[Plugin] | None = None) -> DeleteSessionOutput
Removes session information for a specified bot, alias, and user ID.
You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.
You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.
If you specify a bot or alias ID that doesn't exist, you receive a
BadRequestException.
If the locale doesn't exist in the bot, or if the locale hasn't been
enables for the alias, you receive a BadRequestException.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeleteSessionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DeleteSessionOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for DeleteSessionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
bot_alias_id: str | None = None
The alias identifier in use for the bot that contains the session data.
class-attribute
instance-attribute
¶
bot_id: str | None = None
The identifier of the bot that contains the session data.
class-attribute
instance-attribute
¶
locale_id: str | None = None
The locale where the session is in use.
class-attribute
instance-attribute
¶
session_id: str | None = None
The identifier of the session to delete.
Output¶
dataclass
¶
Dataclass for DeleteSessionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
bot_alias_id: str | None = None
The alias identifier in use for the bot that contained the session data.
class-attribute
instance-attribute
¶
bot_id: str | None = None
The identifier of the bot that contained the session data.
class-attribute
instance-attribute
¶
locale_id: str | None = None
The locale where the session was used.
class-attribute
instance-attribute
¶
session_id: str | None = None
The identifier of the deleted session.