get_agent_memory¶
Operation¶
get_agent_memory
async
¶
get_agent_memory(input: GetAgentMemoryInput, plugins: list[Plugin] | None = None) -> GetAgentMemoryOutput
Gets the sessions stored in the memory of the agent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetAgentMemoryInput
|
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 |
|---|---|
GetAgentMemoryOutput
|
An instance of |
Input¶
GetAgentMemoryInput
dataclass
¶
Dataclass for GetAgentMemoryInput structure.
Attributes¶
agent_alias_id
class-attribute
instance-attribute
¶
agent_alias_id: str | None = None
The unique identifier of an alias of an agent.
agent_id
class-attribute
instance-attribute
¶
agent_id: str | None = None
The unique identifier of the agent to which the alias belongs.
max_items
class-attribute
instance-attribute
¶
max_items: int | None = None
The maximum number of items to return in the response. If the total
number of results is greater than this value, use the token returned in
the response in the nextToken field when making another request to
return the next batch of results.
memory_id
class-attribute
instance-attribute
¶
memory_id: str | None = None
The unique identifier of the memory.
memory_type
class-attribute
instance-attribute
¶
memory_type: MemoryType | None = None
The type of memory.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxItems value
provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
Output¶
GetAgentMemoryOutput
dataclass
¶
Dataclass for GetAgentMemoryOutput structure.
Attributes¶
memory_contents
class-attribute
instance-attribute
¶
memory_contents: list[Memory] | None = None
Contains details of the sessions stored in the memory
next_token
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxItems value
provided in the request, use this token when making another request in
the nextToken field to return the next batch of results.