Skip to content

UpdateMemoryInput

Source code in docs_src/capo_opensearchmemory/types/update_memory_input.py
class UpdateMemoryInput(TypedDict, closed=True):
    space_id: "capo_opensearchmemory.types.space_id.SpaceId"
    """<p>The ID of the space that owns the memory, for example <code>sp-02864597b164</code>.</p>"""
    memory_id: "capo_opensearchmemory.types.memory_id.MemoryId"
    """<p>The ID of the memory to update.</p>"""
    content: NotRequired[
        "capo_opensearchmemory.types.memory_update_content.MemoryUpdateContent"
    ]
    """<p>Replacement memory text. Supplying it re-embeds the memory. Omit to leave the text unchanged.</p>"""
    metadata: NotRequired["capo_opensearchmemory.types.metadata_map.MetadataMap"]
    """<p>The metadata tags to apply. By default this map replaces the stored metadata, and any key not present is removed. Set <code>metadataMode</code> to <code>MERGE</code> to keep the keys you don't supply. Limits apply to the resulting metadata, not to the request. Keys that begin with <code>x-amz-</code> and the key <code>documentS3Source</code> are reserved: a request that sets one fails with <code>ValidationException</code>.</p> <p>A space can use at most 50 distinct metadata keys across all of its events and memories. A request that would add a key beyond that fails with <code>ValidationException</code>. Reuse an existing key instead.</p>"""
    metadata_mode: NotRequired["capo_opensearchmemory.types.metadata_mode.MetadataMode"]
    """<p>How <code>metadata</code> combines with what is stored. The default is <code>REPLACE</code>.</p>"""
    actor_id: NotRequired["capo_opensearchmemory.types.actor_id.ActorId"]
    """<p>The ID of the actor that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with <code>ResourceNotFoundException</code>, as if the memory did not exist.</p>"""
    strategy_name: NotRequired["capo_opensearchmemory.types.strategy_name.StrategyName"]
    """<p>The name of the strategy that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with <code>ResourceNotFoundException</code>, as if the memory did not exist.</p>"""

actor_id instance-attribute

actor_id: NotRequired[ActorId]

The ID of the actor that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.

content instance-attribute

content: NotRequired[MemoryUpdateContent]

Replacement memory text. Supplying it re-embeds the memory. Omit to leave the text unchanged.

memory_id instance-attribute

memory_id: MemoryId

The ID of the memory to update.

metadata instance-attribute

metadata: NotRequired[MetadataMap]

The metadata tags to apply. By default this map replaces the stored metadata, and any key not present is removed. Set metadataMode to MERGE to keep the keys you don't supply. Limits apply to the resulting metadata, not to the request. Keys that begin with x-amz- and the key documentS3Source are reserved: a request that sets one fails with ValidationException.

A space can use at most 50 distinct metadata keys across all of its events and memories. A request that would add a key beyond that fails with ValidationException. Reuse an existing key instead.

metadata_mode instance-attribute

metadata_mode: NotRequired[MetadataMode]

How metadata combines with what is stored. The default is REPLACE.

space_id instance-attribute

space_id: SpaceId

The ID of the space that owns the memory, for example sp-02864597b164.

strategy_name instance-attribute

strategy_name: NotRequired[StrategyName]

The name of the strategy that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.