mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-08-14 19:14:01 +00:00
docs: add entity context documentation and fix MDX parsing (#723)
Add entity context documentation to customization and add-memories pages, remove nav icons from Developer Platform, fix install.md parsing error Changes: - Remove icons from Developer Platform subheadings (Getting Started, Concepts, Using supermemory, Connectors and sync, Migration Guides) - Add Entity Context section to customization page with usage example and accordion for advanced API - Add entityContext parameter to add-memories Parameters table and examples accordion - Fix MDX parsing error in install.md (wrap curly braces in backticks)
This commit is contained in:
parent
16da766fde
commit
9a0f366ff6
4 changed files with 46 additions and 7 deletions
|
|
@ -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">
|
||||
|
|
@ -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 john@acme.com 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>
|
||||
|
||||
|
|
|
|||
|
|
@ -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 john@acme.com 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 john@acme.com 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.
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
|
|
@ -88,7 +86,6 @@
|
|||
},
|
||||
{
|
||||
"group": "Using supermemory",
|
||||
"icon": "brain",
|
||||
"pages": [
|
||||
"add-memories",
|
||||
"search",
|
||||
|
|
@ -103,7 +100,6 @@
|
|||
},
|
||||
{
|
||||
"group": "Connectors and sync",
|
||||
"icon": "plug",
|
||||
"pages": [
|
||||
"connectors/overview",
|
||||
{
|
||||
|
|
@ -125,7 +121,6 @@
|
|||
},
|
||||
{
|
||||
"group": "Migration Guides",
|
||||
"icon": "arrow-right-left",
|
||||
"pages": [
|
||||
{
|
||||
"group": "From another provider",
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue