Memory APIs

Introduced 0.5.0

warning

Deprecated as of 0.12.0. This /_plugins/_ml/memory/* conversation-CRUD API is deprecated in favor of the org-tenant-scoped Conversation management API (/_plugins/_memory/conversations), which adds organization-tenant scoping (versus user-owner-only) and compliance/ABAC enforcement. These routes still work for backward compatibility but emit a deprecation warning; new integrations should use the replacement.

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

important

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.