diff --git a/docs/features/index.mdx b/docs/features/index.mdx index 6a0823e28..a9271addb 100644 --- a/docs/features/index.mdx +++ b/docs/features/index.mdx @@ -232,7 +232,7 @@ import { TopBanners } from "@site/src/components/TopBanners"; - Please note that the `{{USER_LOCATION}}` prompt variable requires a secure connection over HTTPS. To utilize this particular prompt variable, please ensure that `{{USER_LOCATION}}` is toggled on from the `Settings` > `Interface` menu. - Please note that the `{{CLIPBOARD}}` prompt variables requires access to your device's clipboard. -- 🧠 **Memory Feature & Tools (Experimental)**: Manage information you want your LLMs to remember via `Settings` > `Personalization` > `Memory`. Capable models can now use `memory_add` and `memory_query` tools to dynamically store and retrieve facts about you during chat sessions. [Learn more about Memory](/features/memory). +- 🧠 **Memory Feature & Tools (Experimental)**: Manage information you want your LLMs to remember via `Settings` > `Personalization` > `Memory`. Capable models can now use `add_memory`, `search_memories`, and `replace_memory_content` tools to dynamically store, retrieve, and update facts about you during chat sessions. [Learn more about Memory](/features/memory). --- diff --git a/docs/features/memory.mdx b/docs/features/memory.mdx index f09431f6a..bd43f9d35 100644 --- a/docs/features/memory.mdx +++ b/docs/features/memory.mdx @@ -23,15 +23,17 @@ Users can manually add, edit, or delete memories by navigating to: ### 2. Native Memory Tools (Agentic) -When using a model with **Native Function Calling** enabled, the model can manage your memory autonomously using two built-in tools. For a detailed breakdown of how administrators can configure and manage these system-level tools, see the [**Central Tool Calling Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native). +When using a model with **Native Function Calling** enabled, the model can manage your memory autonomously using three built-in tools. For a detailed breakdown of how administrators can configure and manage these system-level tools, see the [**Central Tool Calling Guide**](/features/plugin/tools#tool-calling-modes-default-vs-native). -- **`memory_add`**: Allows the model to proactively save a new fact it learned about you during the conversation. -- **`memory_query`**: Allows the model to search your memory bank for relevant context that might not have been initially injected. +- **`add_memory`**: Allows the model to proactively save a new fact it learned about you during the conversation. +- **`search_memories`**: Allows the model to search your memory bank for relevant context. Results include a unique `id` for each memory snippet. +- **`replace_memory_content`**: Allows the model to update or correct a specific existing memory using its `id`. ## Benefits of the New Memory System -- **Proactive Learning**: Instead of you manually typing preferences, a model can say: *"I'll remember that you prefer dark mode for your UI projects"* and call `memory_add` behind the scenes. -- **Contextual Retrieval**: If a conversation drifts into a topic mentioned months ago, the model can "search its brain" using `memory_query` to find those past details. +- **Proactive Learning**: Instead of you manually typing preferences, a model can say: *"I'll remember that you prefer dark mode for your UI projects"* and call `add_memory` behind the scenes. +- **Contextual Retrieval**: If a conversation drifts into a topic mentioned months ago, the model can "search its brain" using `search_memories` to find those past details. +- **Dynamic Correction**: If the model remembers something incorrectly, it can use `replace_memory_content` to fix the fact rather than creating a duplicate. - **User Control**: Even though models can add memories, users retain full control. Every memory added by a model can be reviewed and deleted in the Personalization settings. ## Enabling Memory Tools diff --git a/docs/features/plugin/tools/development.mdx b/docs/features/plugin/tools/development.mdx index b87a704ae..9a1c485e9 100644 --- a/docs/features/plugin/tools/development.mdx +++ b/docs/features/plugin/tools/development.mdx @@ -160,8 +160,9 @@ When **Native Mode** is enabled, Open WebUI automatically injects built-in syste | `generate_image` | Generates a new image based on a prompt (supports `steps`). | `ENABLE_IMAGE_GENERATION` enabled. | | `edit_image` | Edits an existing image based on a prompt and URL. | `ENABLE_IMAGE_EDIT` enabled.| | **Memory** | | | -| `memory_query` | Searches the user's personal memory/personalization bank. | Memory feature enabled. | -| `memory_add` | Stores a new fact in the user's personalization memory. | Memory feature enabled. | +| `search_memories` | Searches the user's personal memory/personalization bank. | Memory feature enabled. | +| `add_memory` | Stores a new fact in the user's personalization memory. | Memory feature enabled. | +| `replace_memory_content` | Updates an existing memory record by its unique ID. | Memory feature enabled. | | **Notes** | | | | `search_notes` | Search the user's notes by title and content. | `ENABLE_NOTES` enabled. | | `view_note` | Get the full markdown content of a specific note. | `ENABLE_NOTES` enabled. | @@ -182,7 +183,7 @@ When **Native Mode** is enabled, Open WebUI automatically injects built-in syste #### Why Use Built-in Tools? - **Agentic Research**: Models can invoke `web_search` multiple times to refine results, then use `fetch_url` to read specific deep-dive articles. - **Contextual Awareness**: Models can search your previous chat history or notes to find specific details without manual copy-pasting. -- **Dynamic Personalization**: Models can proactively store important facts about the user using `memory_add` during the conversation. +- **Dynamic Personalization**: Models can proactively store important facts about the user using `add_memory` during the conversation. - **Improved Context Selection**: Instead of forcing a search before every prompt, the model decides *when* a search or retrieval is actually necessary. diff --git a/docs/features/plugin/tools/index.mdx b/docs/features/plugin/tools/index.mdx index cf0c797c6..50d421b76 100644 --- a/docs/features/plugin/tools/index.mdx +++ b/docs/features/plugin/tools/index.mdx @@ -141,8 +141,9 @@ Native Mode can be enabled at two levels: | `generate_image` | Generates a new image based on a prompt (supports `steps`). | `ENABLE_IMAGE_GENERATION` enabled. | | `edit_image` | Edits an existing image based on a prompt and URL. | `ENABLE_IMAGE_EDIT` enabled.| | **Memory** | | | -| `memory_query` | Searches the user's personal memory/personalization bank. | Memory feature enabled. | -| `memory_add` | Stores a new fact in the user's personalization memory. | Memory feature enabled. | +| `search_memories` | Searches the user's personal memory/personalization bank. | Memory feature enabled. | +| `add_memory` | Stores a new fact in the user's personalization memory. | Memory feature enabled. | +| `replace_memory_content` | Updates an existing memory record by its unique ID. | Memory feature enabled. | | **Notes** | | | | `search_notes` | Search the user's notes by title and content. | `ENABLE_NOTES` enabled. | | `view_note` | Get the full markdown content of a specific note. | `ENABLE_NOTES` enabled. |