Skip to content

AgenticRetrieveMemoryConfiguration

Source code in docs_src/capo_bedrock_agent_runtime/types/agentic_retrieve_memory_configuration.py
class AgenticRetrieveMemoryConfiguration(TypedDict, closed=True):
    memory_id: "capo_bedrock_agent_runtime.types.agent_core_memory_id.AgentCoreMemoryId"
    """<p>The identifier of the AgentCore Memory resource to use. The resource must exist in your account and be in the ACTIVE state.</p>"""
    session_binding: NotRequired[
        "capo_bedrock_agent_runtime.types.agentic_retrieve_memory_session_binding.AgenticRetrieveMemorySessionBinding"
    ]
    """<p>The short-term memory session whose history is restored for this retrieval. To persist the agent-generated answer to the session, omit persistenceMode or set it to DEFAULT. To leave the session unchanged, set persistenceMode to NONE. Supply session history through the existing messages parameter or through short-term memory, but not both.</p>"""
    retrieval_configs: NotRequired[
        "capo_bedrock_agent_runtime.types.agentic_retrieve_memory_retrieval_config_list.AgenticRetrieveMemoryRetrievalConfigList"
    ]
    """<p>Specifies the long-term memory configuration the agent can retrieve from. The agent decides whether to retrieve and composes its own query. This field currently accepts at most one entry.</p>"""
    persistence_mode: NotRequired[
        "capo_bedrock_agent_runtime.types.agentic_retrieve_memory_persistence_mode.AgenticRetrieveMemoryPersistenceMode"
    ]
    """<p>Specifies whether the agent-generated answer is written back to the given short-term memory session, and applies only when sessionBinding is set. Valid values:</p> <ul> <li> <p> <code>DEFAULT</code> (default) – Specifies that the question and the agent-generated answer are persisted to the session as a single event. This value requires generateResponse to be true.</p> </li> <li> <p> <code>NONE</code> – Specifies that the session is left unchanged.</p> </li> </ul>"""

memory_id instance-attribute

memory_id: AgentCoreMemoryId

The identifier of the AgentCore Memory resource to use. The resource must exist in your account and be in the ACTIVE state.

persistence_mode instance-attribute

persistence_mode: NotRequired[AgenticRetrieveMemoryPersistenceMode]

Specifies whether the agent-generated answer is written back to the given short-term memory session, and applies only when sessionBinding is set. Valid values:

  • DEFAULT (default) – Specifies that the question and the agent-generated answer are persisted to the session as a single event. This value requires generateResponse to be true.

  • NONE – Specifies that the session is left unchanged.

retrieval_configs instance-attribute

retrieval_configs: NotRequired[AgenticRetrieveMemoryRetrievalConfigList]

Specifies the long-term memory configuration the agent can retrieve from. The agent decides whether to retrieve and composes its own query. This field currently accepts at most one entry.

session_binding instance-attribute

session_binding: NotRequired[AgenticRetrieveMemorySessionBinding]

The short-term memory session whose history is restored for this retrieval. To persist the agent-generated answer to the session, omit persistenceMode or set it to DEFAULT. To leave the session unchanged, set persistenceMode to NONE. Supply session history through the existing messages parameter or through short-term memory, but not both.