klas/t6_mem0
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: add example for filtering through categories and metadata (#2031)

Browse Source
This commit is contained in:
Dev Khant
2024-11-15 13:45:46 +05:30
committed by GitHub
parent e909e3e76c
commit fd7fab4e08
1 changed files with 61 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/platform/quickstart.mdx
View File

@@ -77,7 +77,7 @@ messages = [
client.add(messages, user_id="alex", output_format="v1.0") client.add(messages, user_id="alex", output_format="v1.0")
# To use the latest output_format, set the output_format parameter to "v1.1" # To use the latest output_format, set the output_format parameter to "v1.1"
client.add(messages, user_id="alex", output_format="v1.1") client.add(messages, user_id="alex", output_format="v1.1", metadata={"food": "vegan"})
``` ```
```javascript JavaScript ```javascript JavaScript
@@ -85,7 +85,7 @@ const messages = [
{"role": "user", "content": "Hi, I'm Alex. I'm a vegetarian and I'm allergic to nuts."}, {"role": "user", "content": "Hi, I'm Alex. I'm a vegetarian and I'm allergic to nuts."},
{"role": "assistant", "content": "Hello Alex! I've noted that you're a vegetarian and have a nut allergy. I'll keep this in mind for any food-related recommendations or discussions."} {"role": "assistant", "content": "Hello Alex! I've noted that you're a vegetarian and have a nut allergy. I'll keep this in mind for any food-related recommendations or discussions."}
]; ];
client.add(messages, { user_id: "alex", output_format: "v1.1" }) client.add(messages, { user_id: "alex", output_format: "v1.1", metadata: { food: "vegan" } })
.then(response => console.log(response)) .then(response => console.log(response))
.catch(error => console.error(error)); .catch(error => console.error(error));
``` ```
@@ -100,7 +100,10 @@ curl -X POST "https://api.mem0.ai/v1/memories/" \
{"role": "assistant", "content": "Hello Alex! I've noted that you're a vegetarian and have a nut allergy. I'll keep this in mind for any food-related recommendations or discussions."} {"role": "assistant", "content": "Hello Alex! I've noted that you're a vegetarian and have a nut allergy. I'll keep this in mind for any food-related recommendations or discussions."}
], ],
"user_id": "alex", "user_id": "alex",
"output_format": "v1.1" "output_format": "v1.1",
"metadata": {
"food": "vegan"
}
}' }'
``` ```
@@ -331,7 +334,7 @@ curl -X POST "https://api.mem0.ai/v1/memories/search/" \
], ],
"user_id": "alex", "user_id": "alex",
"hash": "9ee7e1455e84d1dab700ed8749aed75a", "hash": "9ee7e1455e84d1dab700ed8749aed75a",
"metadata": null, "metadata": {"food": "vegan"},
"categories": ["food_preferences"], "categories": ["food_preferences"],
"created_at": "2024-07-20T01:30:36.275141-07:00", "created_at": "2024-07-20T01:30:36.275141-07:00",
"updated_at": "2024-07-20T01:30:36.275172-07:00" "updated_at": "2024-07-20T01:30:36.275172-07:00"
@@ -357,7 +360,7 @@ curl -X POST "https://api.mem0.ai/v1/memories/search/" \
], ],
"user_id": "alex", "user_id": "alex",
"hash": "9ee7e1455e84d1dab700ed8749aed75a", "hash": "9ee7e1455e84d1dab700ed8749aed75a",
"metadata": null, "metadata": {"food": "vegan"},
"categories": ["food_preferences"], "categories": ["food_preferences"],
"created_at": "2024-07-20T01:30:36.275141-07:00", "created_at": "2024-07-20T01:30:36.275141-07:00",
"updated_at": "2024-07-20T01:30:36.275172-07:00" "updated_at": "2024-07-20T01:30:36.275172-07:00"
@@ -367,6 +370,59 @@ curl -X POST "https://api.mem0.ai/v1/memories/search/" \
``` ```
</CodeGroup> </CodeGroup>
Use category and metadata filters:
<CodeGroup>
```python Python
query = "What do you know about me?"
client.search(query, categories=["food_preferences"], metadata={"food": "vegan"})
```
```javascript JavaScript
const query = "What do you know about me?";
client.search(query, categories=["food_preferences"], metadata={"food": "vegan"})
.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?",
"categories": ["food_preferences"],
"metadata": {"food": "vegan"}
}'
```
```json Output
[
{
"id": "7f165f7e-b411-4afe-b7e5-35789b72c4a5",
"memory": "Name: Alex. Vegetarian. Allergic to nuts.",
"input": [
{
"role": "user",
"content": "Hi, I'm Alex. I'm a vegetarian and I'm allergic to nuts."
},
{
"role": "assistant",
"content": "Hello Alex! I've noted that you're a vegetarian and have a nut allergy. I'll keep this in mind for any food-related recommendations or discussions."
}
],
"user_id": "alex",
"hash": "9ee7e1455e84d1dab700ed8749aed75a",
"metadata": {"food": "vegan"},
"categories": ["food_preferences"],
"created_at": "2024-07-20T01:30:36.275141-07:00",
"updated_at": "2024-07-20T01:30:36.275172-07:00"
}
]
```
</CodeGroup>
#### Search using custom filters #### Search using custom filters