The Memory Layer for AI Agents - Drop-in memory infrastructure for AI agents and apps. Context that persists. Built for production.
Python agentic-memoryagentic-memory-systemagentsaiai-agentschatgptgenaillmlong-term-memorymemorymemory-managementpythonragstate-management
Add Wildcard Character Support Documentation for v2 Memory APIs (#2919)
Prateek Chhikarafe3f10adb86d
diff --git a/docs/api-reference/memory/v2-get-memories.mdx b/docs/api-reference/memory/v2-get-memories.mdxindex 1da3036bb..26d173113 100644--- a/docs/api-reference/memory/v2-get-memories.mdx+++ b/docs/api-reference/memory/v2-get-memories.mdx@@ -9,6 +9,9 @@ The v2 get memories API is powerful and flexible, allowing for more precise memo- `lte`: Less than or equal to- `gt`: Greater than- `lt`: Less than+- `ne`: Not equal to+- `icontains`: Case-insensitive containment check+- `*`: Wildcard character that matches everything<CodeGroup>```python Code@@ -41,3 +44,22 @@ memories = m.get_all(]```</CodeGroup>++<CodeGroup>+```python Wildcard Example+# Using wildcard to get all memories for a specific user across all run_ids+memories = m.get_all(+ filters={+ "AND": [+ {+ "user_id": "alex"+ },+ {+ "run_id": "*"+ }+ ]+ },+ version="v2"+)+```+</CodeGroup>diff --git a/docs/api-reference/memory/v2-search-memories.mdx b/docs/api-reference/memory/v2-search-memories.mdxindex f0526869c..044d9f722 100644--- a/docs/api-reference/memory/v2-search-memories.mdx+++ b/docs/api-reference/memory/v2-search-memories.mdx@@ -11,6 +11,7 @@ The v2 search API is powerful and flexible, allowing for more precise memory ret- `lt`: Less than- `ne`: Not equal to- `icontains`: Case-insensitive containment check+- `*`: Wildcard character that matches everything<CodeGroup>```python Code@@ -49,3 +50,23 @@ The v2 search API is powerful and flexible, allowing for more precise memory ret}```</CodeGroup>++ <CodeGroup>+ ```python Wildcard Example+ # Using wildcard to match all run_ids for a specific user+ all_memories = m.search(+ query="What are Alice's hobbies?",+ version="v2",+ filters={+ "AND": [+ {+ "user_id": "alice"+ },+ {+ "run_id": "*"+ }+ ]+ },+ )+ ```+ </CodeGroup>diff --git a/docs/platform/quickstart.mdx b/docs/platform/quickstart.mdxindex 81bd0d9b1..925f7fcef 100644--- a/docs/platform/quickstart.mdx+++ b/docs/platform/quickstart.mdx@@ -458,7 +458,7 @@ curl -X POST "https://api.mem0.ai/v1/memories/search/?version=v2" \#### Search using custom filters-Our advanced search allows you to set custom search filters. You can filter by user_id, agent_id, app_id, run_id, created_at, updated_at, categories, and text. The filters support logical operators (AND, OR) and comparison operators (in, gte, lte, gt, lt, ne, contains, icontains). For more details, see [V2 Search Memories](/api-reference/memory/v2-search-memories).+Our advanced search allows you to set custom search filters. You can filter by user_id, agent_id, app_id, run_id, created_at, updated_at, categories, and text. The filters support logical operators (AND, OR) and comparison operators (in, gte, lte, gt, lt, ne, contains, icontains, *). The wildcard character (*) matches everything for a specific field. For more details, see [V2 Search Memories](/api-reference/memory/v2-search-memories).Here you need to define `version` as `v2` in the search method.@@ -765,6 +765,81 @@ curl -X POST "https://api.mem0.ai/v1/memories/search/?version=v2" \</CodeGroup>+Example 5: Search using wildcard filters+<CodeGroup>+```python Python+query = "What do you know about me?"+filters = {+ "AND": [+ {+ "user_id": "alex"+ },+ {+ "run_id": "*" # Matches all run_ids+ }+ ]+}+client.search(query, version="v2", filters=filters)+```++```javascript JavaScript+const query = "What do you know about me?";+const filters = {+ "AND": [+ {+ "user_id": "alex"+ },+ {+ "run_id": "*" // Matches all run_ids+ }+ ]+};++client.search(query, { version: "v2", filters })+ .then(results => console.log(results))+ .catch(error => console.error(error));+```++```bash cURL+curl -X POST "https://api.mem0.ai/v1/memories/search/?version=v2" \+ -H "Authorization: Token your-api-key" \+ -H "Content-Type: application/json" \+ -d '{+ "query": "What do you know about me?",+ "filters": {+ "AND": [+ {+ "user_id": "alex"+ },+ {+ "run_id": "*"+ }+ ]+ }+ }'+```++```json Output+{+ "results": [+ {+ "id": "7f165f7e-b411-4afe-b7e5-35789b72c4a5",+ "memory": "Name: Alex. Vegetarian. Allergic to nuts.",+ "user_id": "alex",+ "run_id": "session-1",+ "metadata": null,+ "categories": ["food_preferences"],+ "immutable": false,+ "expiration_date": null,+ "created_at": "2024-07-20T01:30:36.275141-07:00",+ "updated_at": "2024-07-20T01:30:36.275172-07:00"+ }+ ]+}+```++</CodeGroup>+### 4.3 Get All Users@@ -1138,7 +1213,7 @@ curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex&keywords=to play&page#### Get all memories using custom filters-Our advanced retrieval allows you to set custom filters when fetching memories. You can filter by user_id, agent_id, app_id, run_id, created_at, updated_at, categories, and keywords. The filters support logical operators (AND, OR) and comparison operators (in, gte, lte, gt, lt, ne, contains, icontains). For more details, see [v2 Get Memories](/api-reference/memory/v2-get-memories).+Our advanced retrieval allows you to set custom filters when fetching memories. You can filter by user_id, agent_id, app_id, run_id, created_at, updated_at, categories, and keywords. The filters support logical operators (AND, OR) and comparison operators (in, gte, lte, gt, lt, ne, contains, icontains, *). The wildcard character (*) matches everything for a specific field. For more details, see [v2 Get Memories](/api-reference/memory/v2-get-memories).Here you need to define `version` as `v2` in the get_all method.@@ -1497,6 +1572,119 @@ curl -X GET "https://api.mem0.ai/v1/memories/?version=v2&page=1&page_size=50" \</CodeGroup>+Example 4: Get all memories using wildcard filters+<CodeGroup>+```python Python+filters = {+ "AND": [+ {+ "user_id": "alex"+ },+ {+ "run_id": "*" # Matches all run_ids+ }+ ]+}++# Default (No Pagination)+client.get_all(version="v2", filters=filters)++# Pagination (You can also use the page and page_size parameters)+client.get_all(version="v2", filters=filters, page=1, page_size=50)+```++```javascript JavaScript+const filters = {+ "AND": [+ {+ "user_id": "alex"+ },+ {+ "run_id": "*" // Matches all run_ids+ }+ ]+};++// Default (No Pagination)+client.getAll({ version: "v2", filters })+ .then(memories => console.log(memories))+ .catch(error => console.error(error));++// Pagination (You can also use the page and page_size parameters)+client.getAll({ version: "v2", filters, page: 1, page_size: 50 })+ .then(memories => console.log(memories))+ .catch(error => console.error(error));+```++```bash cURL+# Default (No Pagination)+curl -X GET "https://api.mem0.ai/v1/memories/?version=v2" \+ -H "Authorization: Token your-api-key" \+ -H "Content-Type: application/json" \+ -d '{+ "filters": {+ "AND": [+ {"user_id":"alex"},+ {"run_id": "*"}+ ]+ }+ }'++# Pagination (You can also use the page and page_size parameters)+curl -X GET "https://api.mem0.ai/v1/memories/?version=v2&page=1&page_size=50" \+ -H "Authorization: Token your-api-key" \+ -H "Content-Type: application/json" \+ -d '{+ "filters": {+ "AND": [+ {"user_id":"alex"},+ {"run_id": "*"}+ ]+ }+ }'+```++```json Output (Default)+[+ {+ "id": "f38b689d-6b24-45b7-bced-17fbb4d8bac7",+ "memory": "Name: Alex. Vegetarian. Allergic to nuts.",+ "user_id": "alex",+ "run_id": "session-1",+ "metadata": null,+ "categories": ["food_preferences"],+ "immutable": false,+ "expiration_date": null,+ "created_at": "2024-07-20T01:30:36.275141-07:00",+ "updated_at": "2024-07-20T01:30:36.275172-07:00"+ }+]+```++```json Output (Paginated)+{+ "count": 1,+ "next": null,+ "previous": null,+ "results": [+ {+ "id": "f38b689d-6b24-45b7-bced-17fbb4d8bac7",+ "memory": "Name: Alex. Vegetarian. Allergic to nuts.",+ "user_id": "alex",+ "run_id": "session-1",+ "metadata": null,+ "categories": ["food_preferences"],+ "immutable": false,+ "expiration_date": null,+ "created_at": "2024-07-20T01:30:36.275141-07:00",+ "updated_at": "2024-07-20T01:30:36.275172-07:00"+ }+ ]+}+```++</CodeGroup>+### 4.5 Memory History