Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions apps/docs/add-memories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ Upload PDFs, images, and documents directly.
| `customId` | string | **Recommended.** Your ID for the content (conversation ID, doc ID). Enables updates and deduplication |
| `containerTag` | string | Group by user/project. Required for user profiles |
| `metadata` | object | Key-value pairs for filtering (strings, numbers, booleans) |
| `entityContext` | string | Context for memory extraction on this container tag. Max 1500 chars. See [Customization](/concepts/customization#entity-context) |

<AccordionGroup>
<Accordion title="Parameter Details & Examples">
Expand Down Expand Up @@ -257,6 +258,19 @@ Upload PDFs, images, and documents directly.
```
- No nested objects or arrays
- Values: string, number, or boolean only

**Entity Context:**
```typescript
// Guide memory extraction for this container tag
{
containerTag: "session_abc123",
entityContext: `Design exploration conversation between [email protected] and Brand.ai assistant.
Focus on John's design preferences and brand requirements.`
}
```
- Max 1500 characters
- Persists on the container tag
- Combines with org-level filter prompts
</Accordion>
</AccordionGroup>

Expand Down
30 changes: 30 additions & 0 deletions apps/docs/concepts/customization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,36 @@ await client.settings.update({

---

## Entity Context

Guide memory extraction for a specific container tag. Filter prompts are org-wide; entity context is per container.

```typescript
await client.add({
content: "User asked about logo variations for dark backgrounds...",
containerTag: "session_abc123",
entityContext: `Design exploration conversation between [email protected] and Brand.ai assistant.
Focus on John's design preferences and brand requirements.`
});
```

<Accordion title="Update entity context only">
Update entity context for a container tag without uploading content.

```typescript
await client.containerTags.update("session_abc123", {
entityContext: `Design exploration conversation between [email protected] and Brand.ai assistant.
Focus on John's design preferences and brand requirements.`
});
```
</Accordion>

<Note>
Entity context persists on the container tag and combines with org-level filter prompts.
</Note>

---

## Chunk Size

Control how documents are split into searchable pieces. Smaller chunks = more precise retrieval but less context per result.
Expand Down
5 changes: 0 additions & 5 deletions apps/docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,10 @@
"pages": [
{
"group": "Getting Started",
"icon": "rocket",
"pages": ["intro", "quickstart", "vibe-coding"]
},
{
"group": "Concepts",
"icon": "lightbulb",
"pages": [
"concepts/how-it-works",
"concepts/graph-memory",
Expand All @@ -88,7 +86,6 @@
},
{
"group": "Using supermemory",
"icon": "brain",
"pages": [
"add-memories",
"search",
Expand All @@ -103,7 +100,6 @@
},
{
"group": "Connectors and sync",
"icon": "plug",
"pages": [
"connectors/overview",
{
Expand All @@ -125,7 +121,6 @@
},
{
"group": "Migration Guides",
"icon": "arrow-right-left",
"pages": [
{
"group": "From another provider",
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ You can always reference the documentation by using the **SearchSupermemoryDocs
- No → Just use search

5. How should I retrieve context?
- OPTION A: One call with search included → profile({ containerTag, q: userMessage })
- OPTION B: Separate calls → profile() for facts, search() for memories
- OPTION A: One call with search included → `profile({ containerTag, q: userMessage })`
- OPTION B: Separate calls → `profile()` for facts, `search()` for memories

## STEP 2: INSTALL

Expand Down
Loading