This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Memory APIs

Introduced 2.12

Memory APIs provide operations needed to implement conversational search. A memory stores conversation history for the current conversation. A message represents one question/answer interaction between the user and a large language model. Messages are organized into memories.

ML Commons supports the following memory-level APIs:

• Create or update memory
• Get memory
• Search memory
• Delete memory

ML Commons supports the following message-level APIs:

• Create or update message
• Get message
• Search message
• Get message traces

When the Security plugin is enabled, all memories exist in a private security mode. Only the user who created a memory can interact with that memory and its messages.