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

Modify docs to update response format (#2002)

Browse Source
This commit is contained in:
Dev Khant
2024-11-01 13:22:20 +05:30
committed by GitHub
parent 6668be3d5b
commit f6290a0e48
1 changed files with 22 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/platform/quickstart.mdx
View File

@@ -129,7 +129,7 @@ curl -X POST "https://api.mem0.ai/v1/memories/" \
</CodeGroup>
<Note> The `add` method supports two output formats: `v1.0` (default) and `v1.1`. To use the latest format, which provides more detailed information about each memory operation, set the `output_format` parameter to `v1.1`: </Note>
<Note> The `add` method offers support for two output formats: `v1.0` (default) and `v1.1`. To enable the latest format, which provides enhanced detail for each memory operation, set the `output_format` parameter to `v1.1`. Note that `v1.0` will be deprecated in version `0.1.30`. </Note>
#### Short-term memory for a user session
@@ -332,6 +332,7 @@ curl -X POST "https://api.mem0.ai/v1/memories/search/" \
"user_id": "alex",
"hash": "9ee7e1455e84d1dab700ed8749aed75a",
"metadata": null,
"categories": ["food_preferences"],
"created_at": "2024-07-20T01:30:36.275141-07:00",
"updated_at": "2024-07-20T01:30:36.275172-07:00"
}
@@ -357,6 +358,7 @@ curl -X POST "https://api.mem0.ai/v1/memories/search/" \
"user_id": "alex",
"hash": "9ee7e1455e84d1dab700ed8749aed75a",
"metadata": null,
"categories": ["food_preferences"],
"created_at": "2024-07-20T01:30:36.275141-07:00",
"updated_at": "2024-07-20T01:30:36.275172-07:00"
}
@@ -457,6 +459,7 @@ curl -X POST "https://api.mem0.ai/v1/memories/search/?version=v2" \
"user_id": "alex",
"hash": "9ee7e1455e84d1dab700ed8749aed75a",
"metadata": null,
"categories": ["food_preferences"],
"created_at": "2024-07-20T01:30:36.275141-07:00",
"updated_at": "2024-07-20T01:30:36.275172-07:00"
}
@@ -531,6 +534,7 @@ curl -X POST "https://api.mem0.ai/v1/memories/search/?version=v2" \
"user_id": "alex",
"hash": "9ee7e1455e84d1dab700ed8749aed75a",
"metadata": null,
"categories": ["food_preferences"],
"created_at": "2024-07-20T01:30:36.275141-07:00",
"updated_at": "2024-07-20T01:30:36.275172-07:00"
}
@@ -570,7 +574,6 @@ curl -X GET "https://api.mem0.ai/v1/entities/" \
"updated_at": "2024-07-17T16:47:23.899918-07:00",
"total_memories": 5,
"owner": "alex",
"organization": "alex-org",
"metadata": {"foo": "bar"},
"type": "user"
},
@@ -581,7 +584,6 @@ curl -X GET "https://api.mem0.ai/v1/entities/" \
"updated_at": "2024-07-01T17:59:08.187266-07:00",
"total_memories": 10,
"owner": "alex",
"organization": "alex-org",
"metadata": {"agent_id": "123"},
"type": "agent"
}
@@ -631,7 +633,7 @@ curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex&output_format=v1.1" \
"metadata":None,
"created_at":"2024-07-25T23:57:00.108347-07:00",
"updated_at":"2024-07-25T23:57:00.108367-07:00",
"custom_categories":None
"categories":None
},
{
"id":"0a14d8f0-e364-4f5c-b305-10da1f0d0878",
@@ -641,7 +643,7 @@ curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex&output_format=v1.1" \
"metadata":"None",
"created_at":"2024-07-26T00:31:03.543759-07:00",
"updated_at":"2024-07-26T00:31:03.543778-07:00",
"custom_categories":None
"categories":None
}
]
```
@@ -706,7 +708,7 @@ curl -X GET "https://api.mem0.ai/v1/memories/?agent_id=travel-assistant&output_f
"metadata":None,
"created_at":"2024-07-25T23:57:00.108347-07:00",
"updated_at":"2024-07-25T23:57:00.108367-07:00",
"custom_categories":None
"categories":None
},
{
"id":"0a14d8f0-e364-4f5c-b305-10da1f0d0878",
@@ -716,7 +718,7 @@ curl -X GET "https://api.mem0.ai/v1/memories/?agent_id=travel-assistant&output_f
"metadata":None,
"created_at":"2024-07-26T00:31:03.543759-07:00",
"updated_at":"2024-07-26T00:31:03.543778-07:00",
"custom_categories":None
"categories":None
}
]
```
@@ -780,7 +782,7 @@ curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex123&run_id=trip-planni
"metadata":None,
"created_at":"2024-07-26T00:25:16.566471-07:00",
"updated_at":"2024-07-26T00:25:16.566492-07:00",
"custom_categories":None
"categories":None
},
{
"id":"b4229775-d860-4ccb-983f-0f628ca112f5",
@@ -790,7 +792,7 @@ curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex123&run_id=trip-planni
"metadata":None,
"created_at":"2024-07-26T00:33:20.350542-07:00",
"updated_at":"2024-07-26T00:33:20.350560-07:00",
"custom_categories":None
"categories":None
},
{
"id":"df1aca24-76cf-4b92-9f58-d03857efcb64",
@@ -800,7 +802,7 @@ curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex123&run_id=trip-planni
"metadata":None,
"created_at":"2024-07-26T00:51:09.642275-07:00",
"updated_at":"2024-07-26T00:51:09.642295-07:00",
"custom_categories":None
"categories":None
}
]
```
@@ -815,7 +817,8 @@ curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex123&run_id=trip-planni
"hash": "d2088c936e259f2f5d2d75543d31401c",
"metadata":None,
"created_at": "2024-07-26T00:25:16.566471-07:00",
"updated_at": "2024-07-26T00:25:16.566492-07:00"
"updated_at": "2024-07-26T00:25:16.566492-07:00",
"categories": ["food_preferences"]
},
{
"id": "b4229775-d860-4ccb-983f-0f628ca112f5",
@@ -824,7 +827,8 @@ curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex123&run_id=trip-planni
"hash": "d2088c936e259f2f5d2d75543d31401c",
"metadata":None,
"created_at": "2024-07-26T00:33:20.350542-07:00",
"updated_at": "2024-07-26T00:33:20.350560-07:00"
"updated_at": "2024-07-26T00:33:20.350560-07:00",
"categories": ["food_preferences"]
},
{
"id": "df1aca24-76cf-4b92-9f58-d03857efcb64",
@@ -833,7 +837,8 @@ curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex123&run_id=trip-planni
"hash": "d2088c936e259f2f5d2d75543d31401c",
"metadata":None,
"created_at": "2024-07-26T00:51:09.642275-07:00",
"updated_at": "2024-07-26T00:51:09.642295-07:00"
"updated_at": "2024-07-26T00:51:09.642295-07:00",
"categories": None
}
]
}
@@ -868,7 +873,8 @@ curl -X GET "https://api.mem0.ai/v1/memories/582bbe6d-506b-48c6-a4c6-5df3b1e6342
"hash":"d2088c936e259f2f5d2d75543d31401c",
"metadata":"None",
"created_at":"2024-07-26T00:25:16.566471-07:00",
"updated_at":"2024-07-26T00:25:16.566492-07:00"
"updated_at":"2024-07-26T00:25:16.566492-07:00",
"categories": ["travel"]
}
```
</CodeGroup>
@@ -949,7 +955,8 @@ curl -X GET "https://api.mem0.ai/v1/memories/?version=v2" \
"hash":"62bc074f56d1f909f1b4c2b639f56f6a",
"metadata":null,
"created_at":"2024-07-25T23:57:00.108347-07:00",
"updated_at":"2024-07-25T23:57:00.108367-07:00"
"updated_at":"2024-07-25T23:57:00.108367-07:00",
"categories": ["food_preferences"]
}
]
```