Skip to content

Memory

Source code in docs_src/capo_opensearchmemory/types/memory.py
class Memory(TypedDict, closed=True):
    memory_id: "capo_opensearchmemory.types.memory_id.MemoryId"
    """<p>The memory's ID, assigned by the service.</p>"""
    memory_type: "capo_opensearchmemory.types.memory_type.MemoryType"
    """<p>The memory type.</p>"""
    strategy_name: NotRequired["capo_opensearchmemory.types.strategy_name.StrategyName"]
    """<p>The name of the strategy the memory belongs to, for example <code>user-facts</code>. A space can hold several strategies of the same type, so this tells them apart. Absent when the memory's strategy is no longer declared on the space, for example right after the strategy is deleted.</p>"""
    content: "capo_opensearchmemory.types.sensitive_content.SensitiveContent"
    """<p>The memory text.</p>"""
    system_metadata: "capo_opensearchmemory.types.system_metadata.SystemMetadata"
    """<p>Provenance for the memory: the owning actor and session, and when it was created and last updated. Always present. <code>updatedAt</code> equals <code>createdAt</code> for a memory that has never been updated.</p>"""
    metadata: NotRequired["capo_opensearchmemory.types.metadata_map.MetadataMap"]
    """<p>The memory's metadata tags. All values are strings. May be empty.</p>"""

content instance-attribute

The memory text.

memory_id instance-attribute

memory_id: MemoryId

The memory's ID, assigned by the service.

memory_type instance-attribute

memory_type: MemoryType

The memory type.

metadata instance-attribute

metadata: NotRequired[MetadataMap]

The memory's metadata tags. All values are strings. May be empty.

strategy_name instance-attribute

strategy_name: NotRequired[StrategyName]

The name of the strategy the memory belongs to, for example user-facts. A space can hold several strategies of the same type, so this tells them apart. Absent when the memory's strategy is no longer declared on the space, for example right after the strategy is deleted.

system_metadata instance-attribute

system_metadata: SystemMetadata

Provenance for the memory: the owning actor and session, and when it was created and last updated. Always present. updatedAt equals createdAt for a memory that has never been updated.