docs: make example code fences copy-safe (#5833)
This commit is contained in:
@@ -445,4 +445,3 @@ By integrating ElevenLabs Conversational AI with Mem0, you can create voice agen
|
|||||||
Create voice-first AI applications
|
Create voice-first AI applications
|
||||||
</Card>
|
</Card>
|
||||||
</CardGroup>
|
</CardGroup>
|
||||||
|
|
||||||
|
|||||||
@@ -62,7 +62,8 @@ def add(
|
|||||||
filters: dict = None,
|
filters: dict = None,
|
||||||
output_format: str = None, # ❌ REMOVED
|
output_format: str = None, # ❌ REMOVED
|
||||||
version: str = None # ❌ REMOVED
|
version: str = None # ❌ REMOVED
|
||||||
) -> Union[List[dict], dict]
|
) -> Union[List[dict], dict]:
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
#### v1.0.0 Signature
|
#### v1.0.0 Signature
|
||||||
@@ -76,7 +77,8 @@ def add(
|
|||||||
metadata: dict = None,
|
metadata: dict = None,
|
||||||
filters: dict = None,
|
filters: dict = None,
|
||||||
infer: bool = True # ✅ NEW: Control memory inference
|
infer: bool = True # ✅ NEW: Control memory inference
|
||||||
) -> dict # Always returns dict with "results" key
|
) -> dict: # Always returns dict with "results" key
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Changes Summary
|
#### Changes Summary
|
||||||
@@ -147,7 +149,8 @@ def search(
|
|||||||
filters: dict = None, # Basic key-value only
|
filters: dict = None, # Basic key-value only
|
||||||
output_format: str = None, # ❌ REMOVED
|
output_format: str = None, # ❌ REMOVED
|
||||||
version: str = None # ❌ REMOVED
|
version: str = None # ❌ REMOVED
|
||||||
) -> Union[List[dict], dict]
|
) -> Union[List[dict], dict]:
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
#### v1.0.0 Signature
|
#### v1.0.0 Signature
|
||||||
@@ -161,7 +164,8 @@ def search(
|
|||||||
limit: int = 100,
|
limit: int = 100,
|
||||||
filters: dict = None, # ✅ ENHANCED: Advanced operators
|
filters: dict = None, # ✅ ENHANCED: Advanced operators
|
||||||
rerank: bool = True # ✅ NEW: Reranking support
|
rerank: bool = True # ✅ NEW: Reranking support
|
||||||
) -> dict # Always returns dict with "results" key
|
) -> dict: # Always returns dict with "results" key
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Enhanced Filtering
|
#### Enhanced Filtering
|
||||||
@@ -216,7 +220,8 @@ def get_all(
|
|||||||
filters: dict = None,
|
filters: dict = None,
|
||||||
output_format: str = None, # ❌ REMOVED
|
output_format: str = None, # ❌ REMOVED
|
||||||
version: str = None # ❌ REMOVED
|
version: str = None # ❌ REMOVED
|
||||||
) -> Union[List[dict], dict]
|
) -> Union[List[dict], dict]:
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
#### v1.0.0 Signature
|
#### v1.0.0 Signature
|
||||||
@@ -227,7 +232,8 @@ def get_all(
|
|||||||
agent_id: str = None,
|
agent_id: str = None,
|
||||||
run_id: str = None,
|
run_id: str = None,
|
||||||
filters: dict = None # ✅ ENHANCED: Advanced operators
|
filters: dict = None # ✅ ENHANCED: Advanced operators
|
||||||
) -> dict # Always returns dict with "results" key
|
) -> dict: # Always returns dict with "results" key
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
### update() Method
|
### update() Method
|
||||||
@@ -239,7 +245,8 @@ def update(
|
|||||||
self,
|
self,
|
||||||
memory_id: str,
|
memory_id: str,
|
||||||
data: str
|
data: str
|
||||||
) -> dict
|
) -> dict:
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
### delete() Method
|
### delete() Method
|
||||||
@@ -250,7 +257,8 @@ def update(
|
|||||||
def delete(
|
def delete(
|
||||||
self,
|
self,
|
||||||
memory_id: str
|
memory_id: str
|
||||||
) -> dict
|
) -> dict:
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
### delete_all() Method
|
### delete_all() Method
|
||||||
@@ -344,7 +352,7 @@ config = {
|
|||||||
### New Configuration Options
|
### New Configuration Options
|
||||||
|
|
||||||
#### Reranker Configuration
|
#### Reranker Configuration
|
||||||
```python
|
```text
|
||||||
# Cohere reranker
|
# Cohere reranker
|
||||||
"reranker": {
|
"reranker": {
|
||||||
"provider": "cohere",
|
"provider": "cohere",
|
||||||
|
|||||||
@@ -117,7 +117,7 @@ results_without_criteria = client.search(
|
|||||||
### Compare Results
|
### Compare Results
|
||||||
|
|
||||||
### Search Results (with Criteria)
|
### Search Results (with Criteria)
|
||||||
```python
|
```text
|
||||||
[
|
[
|
||||||
{"memory": "User feels refreshed and ready to take on anything on a beautiful sunny day", "score": 0.666, ...},
|
{"memory": "User feels refreshed and ready to take on anything on a beautiful sunny day", "score": 0.666, ...},
|
||||||
{"memory": "User finally has time to draw something after a long time", "score": 0.616, ...},
|
{"memory": "User finally has time to draw something after a long time", "score": 0.616, ...},
|
||||||
@@ -128,7 +128,7 @@ results_without_criteria = client.search(
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Search Results (without Criteria)
|
### Search Results (without Criteria)
|
||||||
```python
|
```text
|
||||||
[
|
[
|
||||||
{"memory": "User is happy today", "score": 0.607, ...},
|
{"memory": "User is happy today", "score": 0.607, ...},
|
||||||
{"memory": "User feels refreshed and ready to take on anything on a beautiful sunny day", "score": 0.512, ...},
|
{"memory": "User feels refreshed and ready to take on anything on a beautiful sunny day", "score": 0.512, ...},
|
||||||
|
|||||||
@@ -190,7 +190,7 @@ messages = [
|
|||||||
client.add(messages, user_id='alice')
|
client.add(messages, user_id='alice')
|
||||||
```
|
```
|
||||||
|
|
||||||
```python Memories with categories
|
```text Memories with categories
|
||||||
# Following categories will be created for the memories added
|
# Following categories will be created for the memories added
|
||||||
Sometimes draws and sketches in free time (hobbies)
|
Sometimes draws and sketches in free time (hobbies)
|
||||||
Is quite athletic (sports)
|
Is quite athletic (sports)
|
||||||
|
|||||||
@@ -108,10 +108,10 @@ print(response)
|
|||||||
|
|
||||||
```javascript JavaScript
|
```javascript JavaScript
|
||||||
// Basic Export request
|
// Basic Export request
|
||||||
const filters = {"user_id": "alice"};
|
const basicFilters = {"user_id": "alice"};
|
||||||
const response = await client.createMemoryExport({
|
const response = await client.createMemoryExport({
|
||||||
schema: json_schema,
|
schema: json_schema,
|
||||||
filters: filters
|
filters: basicFilters
|
||||||
});
|
});
|
||||||
|
|
||||||
// Export with custom instructions and additional filters
|
// Export with custom instructions and additional filters
|
||||||
@@ -124,16 +124,16 @@ const export_instructions = `
|
|||||||
`;
|
`;
|
||||||
|
|
||||||
// For create operation, using only user_id filter as requested
|
// For create operation, using only user_id filter as requested
|
||||||
const filters = {
|
const exportFilters = {
|
||||||
"AND": [
|
"AND": [
|
||||||
{"user_id": "alex"},
|
{"user_id": "alex"},
|
||||||
{"created_at": {"gte": "2024-01-01"}}
|
{"created_at": {"gte": "2024-01-01"}}
|
||||||
]
|
]
|
||||||
}
|
};
|
||||||
|
|
||||||
const responseWithInstructions = await client.createMemoryExport({
|
const responseWithInstructions = await client.createMemoryExport({
|
||||||
schema: json_schema,
|
schema: json_schema,
|
||||||
filters: filters,
|
filters: exportFilters,
|
||||||
exportInstructions: export_instructions
|
exportInstructions: export_instructions
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user