docs: hide temporal internals from API docs

This commit is contained in:
agumpandey
2026-05-12 23:49:06 +05:30
parent 9532d08cdd
commit 14237e3252
9 changed files with 14 additions and 488 deletions
+2 -45
View File
@@ -19,31 +19,6 @@ The `filters` object supports complex logical operations (AND, OR, NOT) and comp
Pass `page` and `page_size` as query parameters to paginate through results.
## Temporal fields on `get_all`
`get_all` returns the **stored** memory record. For temporally enriched memories, that can include top-level fields such as:
- `event_date`
- `event_start`
- `event_end`
- `time_precision`
- `timezone`
- `polarity`
- `temporal_relation`
- `state_key`
- `plan_status`
These are stored memory attributes, not search-time interpretation fields.
`get_all` does **not** add search-only fields such as:
- `effective_plan_status`
- `temporal_surface`
- `reference_date_used`
- `score_breakdown`
Those fields belong to `search`, where Mem0 interprets a query in context.
<CodeGroup>
```python Code
memories = client.get_all(
@@ -75,16 +50,7 @@ memories = client.get_all(
"metadata": {},
"categories": [],
"created_at": "2024-07-01T12:00:00Z",
"updated_at": "2024-07-01T12:00:00Z",
"event_date": "2024-07-01",
"event_start": "2024-07-01",
"event_end": "2024-07-10",
"time_precision": "interval",
"timezone": "UTC",
"polarity": "positive",
"temporal_relation": "during",
"state_key": null,
"plan_status": "pending"
"updated_at": "2024-07-01T12:00:00Z"
},
{
"id": "a2b8c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
@@ -93,16 +59,7 @@ memories = client.get_all(
"metadata": {},
"categories": [],
"created_at": "2024-07-05T15:30:00Z",
"updated_at": "2024-07-05T15:30:00Z",
"event_date": null,
"event_start": null,
"event_end": null,
"time_precision": null,
"timezone": null,
"polarity": null,
"temporal_relation": null,
"state_key": null,
"plan_status": null
"updated_at": "2024-07-05T15:30:00Z"
}
]
}