/AWS1/CL_BDZAGNTCRETRVMEMCONF¶
Specifies an AgentCore Memory resource and how this retrieval uses it. Set sessionBinding to restore and continue a session. Set retrievalConfigs to let the agent retrieve from long-term memory. You must specify at least one of the two.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_memoryid TYPE /AWS1/BDZAGENTCOREMEMORYID /AWS1/BDZAGENTCOREMEMORYID¶
The identifier of the AgentCore Memory resource to use. The resource must exist in your account and be in the ACTIVE state.
Optional arguments:¶
io_sessionbinding TYPE REF TO /AWS1/CL_BDZAGTCRTVMEMSESSBND /AWS1/CL_BDZAGTCRTVMEMSESSBND¶
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.
it_retrievalconfigs TYPE /AWS1/CL_BDZAGTCRTVMEMRETRCFG=>TT_AGNTCRETRVMEMRETRVLCFGLIST TT_AGNTCRETRVMEMRETRVLCFGLIST¶
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.
iv_persistencemode TYPE /AWS1/BDZAGTCRTVMEMORYPRSTMODE /AWS1/BDZAGTCRTVMEMORYPRSTMODE¶
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.
Queryable Attributes¶
memoryId¶
The identifier of the AgentCore Memory resource to use. The resource must exist in your account and be in the ACTIVE state.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MEMORYID() |
Getter for MEMORYID, with configurable default |
ASK_MEMORYID() |
Getter for MEMORYID w/ exceptions if field has no value |
HAS_MEMORYID() |
Determine if MEMORYID has a value |
sessionBinding¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SESSIONBINDING() |
Getter for SESSIONBINDING |
retrievalConfigs¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RETRIEVALCONFIGS() |
Getter for RETRIEVALCONFIGS, with configurable default |
ASK_RETRIEVALCONFIGS() |
Getter for RETRIEVALCONFIGS w/ exceptions if field has no va |
HAS_RETRIEVALCONFIGS() |
Determine if RETRIEVALCONFIGS has a value |
persistenceMode¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PERSISTENCEMODE() |
Getter for PERSISTENCEMODE, with configurable default |
ASK_PERSISTENCEMODE() |
Getter for PERSISTENCEMODE w/ exceptions if field has no val |
HAS_PERSISTENCEMODE() |
Determine if PERSISTENCEMODE has a value |