-
Notifications
You must be signed in to change notification settings - Fork 2.4k
docs update for profile buckets and inferred memory review #1158
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sohamd22
wants to merge
1
commit into
main
Choose a base branch
from
06-24-docs_update_for_profile_buckets_and_inferred_memory_review
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+436
−3
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,288 @@ | ||
| --- | ||
| title: "Review Inferred Memories" | ||
| sidebarTitle: "Memory Review" | ||
| description: "List and act on low-confidence inferred memories — approve, decline, or undo" | ||
| icon: "list-checks" | ||
| --- | ||
|
|
||
| Supermemory's graph automatically **derives** new facts from patterns across your | ||
| existing memories (see [Graph Memory](/concepts/graph-memory)). These derived facts | ||
| are guesses — the engine wasn't told them directly — so they are flagged as | ||
| **inferred** (`isInference: true`) and **down-weighted in search** until confirmed. | ||
|
|
||
| These two endpoints let you build a review experience on top of that queue: list the | ||
| inferred memories awaiting review, then **approve**, **decline**, or **undo** a | ||
| decision on each one. | ||
|
|
||
| <Info> | ||
| These endpoints are scoped to a single [container tag](/concepts/container-tags) | ||
| (space), under `/v3/container-tags/{containerTag}`. | ||
| </Info> | ||
|
|
||
| ## How review affects ranking | ||
|
|
||
| While a memory is unreviewed and inferred it is down-weighted in search, so the | ||
| engine's guesses rank below facts you stated explicitly. Reviewing it resolves that | ||
| either way: | ||
|
|
||
| | Action | Result | Effect on search | | ||
| |--------|--------|------------------| | ||
| | **Approve** | `isInference` cleared | Ranks like a stated fact — no longer down-weighted | | ||
| | **Decline** | `isForgotten` set | Removed from search entirely — a rejected guess is forgotten | | ||
| | **Undo** | back to unreviewed | Returns to the queue; inferred and down-weighted again | | ||
|
|
||
| A reviewed memory is stamped with `reviewStatus` in its metadata so it drops out of the | ||
| review queue (declined memories also leave search, since they're forgotten). **Undo** | ||
| clears that stamp — and un-forgets a declined memory — bringing it back. | ||
|
|
||
| --- | ||
|
|
||
| ## List Inferred Memories | ||
|
|
||
| Return the inferred memories for a container tag that are still awaiting review (the | ||
| review queue). Reviewed memories are excluded. | ||
|
|
||
| ``` | ||
| GET /v3/container-tags/{containerTag}/inferred | ||
| ``` | ||
|
|
||
| <Tabs> | ||
| <Tab title="fetch"> | ||
| ```typescript | ||
| const res = await fetch( | ||
| "https://api.supermemory.ai/v3/container-tags/user_123/inferred", | ||
| { headers: { "Authorization": `Bearer ${API_KEY}` } } | ||
| ); | ||
|
|
||
| const { memories, total } = await res.json(); | ||
| ``` | ||
| </Tab> | ||
| <Tab title="cURL"> | ||
| ```bash | ||
| curl "https://api.supermemory.ai/v3/container-tags/user_123/inferred" \ | ||
| -H "Authorization: Bearer $SUPERMEMORY_API_KEY" | ||
| ``` | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Path parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| |-----------|------|-------------| | ||
| | `containerTag` | string | The container tag / space to read the review queue for | | ||
|
|
||
| ### Response | ||
|
|
||
| ```json | ||
| { | ||
| "memories": [ | ||
| { | ||
| "id": "mem_abc123", | ||
| "memory": "Alex likely works on Stripe's core payments product", | ||
| "parentCount": 3, | ||
| "createdAt": "2025-01-15T10:30:00.000Z", | ||
| "updatedAt": "2025-01-15T10:30:00.000Z", | ||
| "metadata": { "source": "derive" } | ||
| } | ||
| ], | ||
| "total": 1 | ||
| } | ||
| ``` | ||
|
|
||
| | Field | Type | Description | | ||
| |-------|------|-------------| | ||
| | `memories[].id` | string | Memory entry ID — pass to the review endpoint | | ||
| | `memories[].memory` | string | The inferred memory text | | ||
| | `memories[].parentCount` | number | How many source memories this was derived from. Higher = stronger signal | | ||
| | `memories[].createdAt` | string | ISO 8601 timestamp | | ||
| | `memories[].updatedAt` | string | ISO 8601 timestamp | | ||
| | `memories[].metadata` | object \| null | Arbitrary metadata stored on the memory | | ||
| | `total` | number | Count of unreviewed inferred memories returned | | ||
|
|
||
| <Note> | ||
| The queue returns up to **50** memories, ordered by `parentCount` descending (most | ||
| strongly supported first), then by `createdAt` descending. It excludes anything that | ||
| is forgotten, expired, or already reviewed. An unknown or empty container tag returns | ||
| `{ "memories": [], "total": 0 }`. | ||
| </Note> | ||
|
|
||
| --- | ||
|
|
||
| ## Review an Inferred Memory | ||
|
|
||
| Record a decision on a single inferred memory. | ||
|
|
||
| ``` | ||
| POST /v3/container-tags/{containerTag}/inferred/{memoryId}/review | ||
| ``` | ||
|
|
||
| <Tabs> | ||
| <Tab title="fetch"> | ||
| ```typescript | ||
| const res = await fetch( | ||
| "https://api.supermemory.ai/v3/container-tags/user_123/inferred/mem_abc123/review", | ||
| { | ||
| method: "POST", | ||
| headers: { | ||
| "Authorization": `Bearer ${API_KEY}`, | ||
| "Content-Type": "application/json" | ||
| }, | ||
| body: JSON.stringify({ action: "approve" }) | ||
| } | ||
| ); | ||
|
|
||
| const result = await res.json(); | ||
| // { id: "mem_abc123", isInference: false, isForgotten: false, reviewStatus: "approved" } | ||
| ``` | ||
| </Tab> | ||
| <Tab title="cURL"> | ||
| ```bash | ||
| curl -X POST \ | ||
| "https://api.supermemory.ai/v3/container-tags/user_123/inferred/mem_abc123/review" \ | ||
| -H "Authorization: Bearer $SUPERMEMORY_API_KEY" \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{"action": "approve"}' | ||
| ``` | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ### Path parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| |-----------|------|-------------| | ||
| | `containerTag` | string | The container tag / space the memory belongs to | | ||
| | `memoryId` | string | The memory entry ID from the list endpoint | | ||
|
|
||
| ### Body parameters | ||
|
|
||
| | Parameter | Type | Required | Description | | ||
| |-----------|------|----------|-------------| | ||
| | `action` | string | yes | One of `approve`, `decline`, or `undo` | | ||
|
|
||
| <Warning> | ||
| The reject action is named **`decline`**. There is no `reject` value. | ||
| </Warning> | ||
|
|
||
| **Action semantics:** | ||
|
|
||
| - **`approve`** — Promote the memory: clears `isInference`, so it ranks like a stated | ||
| fact instead of a down-weighted guess. Stamps `reviewStatus: "approved"`. | ||
| - **`decline`** — Reject the suggestion: the memory is **forgotten** | ||
| (`isForgotten: true`) and stamped `reviewStatus: "declined"`, so it leaves both | ||
| search and the review queue. | ||
| - **`undo`** — Revert a prior `approve`/`decline` back to the unreviewed inferred | ||
| state: restores `isInference: true`, un-forgets the memory (`isForgotten: false`), | ||
| and clears the review stamp, so it returns to the queue. | ||
|
|
||
| ### Response | ||
|
|
||
| ```json | ||
| { | ||
| "id": "mem_abc123", | ||
| "isInference": false, | ||
| "isForgotten": false, | ||
| "reviewStatus": "approved" | ||
| } | ||
| ``` | ||
|
|
||
| | Field | Type | Description | | ||
| |-------|------|-------------| | ||
| | `id` | string | The reviewed memory ID | | ||
| | `isInference` | boolean | `false` after approve; `true` after decline or undo | | ||
| | `isForgotten` | boolean | `true` after decline (the memory is forgotten); `false` otherwise | | ||
| | `reviewStatus` | `"approved"` \| `"declined"` \| `null` | The new status; `null` after an undo | | ||
|
|
||
| ### Errors | ||
|
|
||
| | Status | When | | ||
| |--------|------| | ||
| | `401` | Missing or invalid authentication | | ||
| | `404` | The container tag or memory was not found in your organization | | ||
| | `409` | The memory isn't reviewable for this action — it's not an inferred memory, or there's no prior review to undo | | ||
|
|
||
| --- | ||
|
|
||
| ## Building a review experience | ||
|
|
||
| The endpoints are designed for an optimistic, one-at-a-time review UI (swipe to keep / | ||
| decline, with undo). A typical client fetches the queue once, then pops each card off | ||
| locally as the user decides — `undo` re-adds it. | ||
|
|
||
| <Accordion title="React Query hooks (TypeScript)"> | ||
| ```typescript | ||
| import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query"; | ||
|
|
||
| const BASE = "https://api.supermemory.ai/v3"; | ||
| const key = (tag: string) => ["inferred-memories", tag] as const; | ||
|
|
||
| export type InferredMemory = { | ||
| id: string; | ||
| memory: string; | ||
| parentCount: number; | ||
| createdAt: string; | ||
| updatedAt: string; | ||
| metadata: Record<string, unknown> | null; | ||
| }; | ||
|
|
||
| export type ReviewAction = "approve" | "decline" | "undo"; | ||
|
|
||
| export function useInferredMemories(containerTag: string) { | ||
| return useQuery({ | ||
| queryKey: key(containerTag), | ||
| queryFn: async (): Promise<InferredMemory[]> => { | ||
| const res = await fetch(`${BASE}/container-tags/${containerTag}/inferred`, { | ||
| headers: { Authorization: `Bearer ${API_KEY}` }, | ||
| }); | ||
| if (!res.ok) throw new Error("Failed to load review queue"); | ||
| const data = await res.json(); | ||
| return data.memories ?? []; | ||
| }, | ||
| staleTime: 60_000, | ||
| }); | ||
| } | ||
|
|
||
| export function useReviewInferredMemory(containerTag: string) { | ||
| const queryClient = useQueryClient(); | ||
| return useMutation({ | ||
| mutationFn: async (vars: { memoryId: string; action: ReviewAction }) => { | ||
| const res = await fetch( | ||
| `${BASE}/container-tags/${containerTag}/inferred/${vars.memoryId}/review`, | ||
| { | ||
| method: "POST", | ||
| headers: { | ||
| Authorization: `Bearer ${API_KEY}`, | ||
| "Content-Type": "application/json", | ||
| }, | ||
| body: JSON.stringify({ action: vars.action }), | ||
| }, | ||
| ); | ||
| if (!res.ok) throw new Error("Review failed"); | ||
| return res.json(); | ||
| }, | ||
| onSuccess: (_data, { memoryId, action }) => { | ||
| // approve/decline remove the card; undo brings it back, so refetch. | ||
| if (action === "undo") { | ||
| queryClient.invalidateQueries({ queryKey: key(containerTag) }); | ||
| return; | ||
| } | ||
| queryClient.setQueryData<InferredMemory[]>(key(containerTag), (prev) => | ||
| prev?.filter((m) => m.id !== memoryId), | ||
| ); | ||
| }, | ||
| }); | ||
| } | ||
| ``` | ||
| </Accordion> | ||
|
|
||
| <Note> | ||
| There is no separate "skip" action. A swipe-to-skip is purely client-side — don't send | ||
| a request and the memory simply stays in the queue for a later session. | ||
| </Note> | ||
|
|
||
| --- | ||
|
|
||
| ## Next Steps | ||
|
|
||
| - [Graph Memory](/concepts/graph-memory) — How inferred (`derive`) memories are created | ||
| - [Memory Operations](/memory-operations) — Create, forget, and update memories | ||
| - [Search](/search) — How inferred memories are ranked in results | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
declineaction description doesn't specify what happens toisInference, but line 191 claims it becomestrueafter decline. This is inconsistent.The description states:
But line 191 says
isInferenceistrueafter decline. The decline action description should explicitly state what happens toisInference(e.g.,isInferenceremainstrueor is set tofalse) to match the behavior documented in the response table.Spotted by Graphite

Is this helpful? React 👍 or 👎 to let us know.