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
+3 -27
View File
@@ -18,20 +18,9 @@ The `filters` object supports complex logical operations (AND, OR, NOT) and comp
- `icontains`: Case-insensitive containment check
- `*`: Wildcard character that matches everything
## Temporal fields in V3 responses
## Temporal reasoning in V3 responses
When Temporal Reasoning is enabled for a query, search results can include additional **top-level** fields such as:
- `memory_type`
- `event_date`
- `event_start`
- `event_end`
- `plan_status`
- `effective_plan_status`
- `time_precision`
- `temporal_surface`
- `reference_date_used`
- `score_breakdown.temporal_boost`
Temporal Reasoning is applied internally during retrieval. Search responses keep the normal result shape.
### Search parameter defaults
@@ -78,7 +67,7 @@ related_memories = client.search(
```
</CodeGroup>
### Temporal example
### Temporal query example
<CodeGroup>
```python Platform API Example
@@ -97,15 +86,6 @@ results = client.search(
"memory": "Finished the Q1 product review on March 10, 2025.",
"user_id": "alice",
"score": 0.91,
"memory_type": "event",
"event_date": "2025-03-10",
"event_start": "2025-03-10",
"event_end": "2025-03-10",
"plan_status": null,
"effective_plan_status": null,
"time_precision": "day",
"temporal_surface": "Mar 10, 2025",
"reference_date_used": "2025-03-21",
"metadata": {},
"categories": [],
"created_at": "2025-03-10T00:00:00Z",
@@ -116,10 +96,6 @@ results = client.search(
```
</CodeGroup>
<Note>
Temporal fields are most useful on `search`. The paginated `get_all` endpoint remains a broader retrieval surface and does not mirror the full time-aware search result shape.
</Note>
<CodeGroup>
```python Wildcard Example
# Using wildcard to match all run_ids for a specific user