aboutsummaryrefslogtreecommitdiff
path: root/apps/docs/concepts/customization.mdx
diff options
context:
space:
mode:
Diffstat (limited to 'apps/docs/concepts/customization.mdx')
-rw-r--r--apps/docs/concepts/customization.mdx172
1 files changed, 172 insertions, 0 deletions
diff --git a/apps/docs/concepts/customization.mdx b/apps/docs/concepts/customization.mdx
new file mode 100644
index 00000000..6107dd60
--- /dev/null
+++ b/apps/docs/concepts/customization.mdx
@@ -0,0 +1,172 @@
+---
+title: "Customizing for Your Use Case"
+sidebarTitle: "Customization"
+description: "Configure Supermemory's behavior for your specific application"
+icon: "settings-2"
+---
+
+Configure how Supermemory processes and retrieves content for your specific use case.
+
+## Filter Prompts
+
+Tell Supermemory what content matters during ingestion. This helps filter and prioritize what gets indexed.
+
+```typescript
+// Example: Brand guidelines assistant
+await client.settings.update({
+ shouldLLMFilter: true,
+ filterPrompt: `You are ingesting content for Brand.ai's brand guidelines system.
+
+ Index:
+ - Official brand values and mission statements
+ - Approved tone of voice guidelines
+ - Logo usage and visual identity docs
+ - Approved messaging and taglines
+
+ Skip:
+ - Draft documents and work-in-progress
+ - Outdated brand materials (pre-2024)
+ - Internal discussions about brand changes
+ - Competitor analysis docs`
+});
+```
+
+<AccordionGroup>
+ <Accordion title="Personal Assistant">
+ ```typescript
+ filterPrompt: `Personal AI assistant. Prioritize recent content, action items,
+ and personal context. Exclude spam and duplicates.`
+ ```
+ </Accordion>
+ <Accordion title="Customer Support">
+ ```typescript
+ filterPrompt: `Customer support agent. Prioritize verified solutions, official docs,
+ and resolved tickets. Exclude internal discussions and PII.`
+ ```
+ </Accordion>
+ <Accordion title="Legal Assistant">
+ ```typescript
+ filterPrompt: `Legal research assistant. Prioritize precedents, current regulations,
+ and approved contract language. Exclude privileged communications.`
+ ```
+ </Accordion>
+ <Accordion title="Finance Agent">
+ ```typescript
+ filterPrompt: `Financial analysis assistant. Prioritize latest reports, verified data,
+ and regulatory filings. Exclude speculative data and MNPI.`
+ ```
+ </Accordion>
+ <Accordion title="Healthcare">
+ ```typescript
+ filterPrompt: `Healthcare information assistant. Prioritize evidence-based guidelines
+ and FDA-approved info. Exclude PHI and outdated recommendations.`
+ ```
+ </Accordion>
+ <Accordion title="Developer Docs">
+ ```typescript
+ filterPrompt: `Developer documentation assistant. Prioritize current APIs, working
+ examples, and best practices. Exclude deprecated APIs and test fixtures.`
+ ```
+ </Accordion>
+</AccordionGroup>
+
+---
+
+## Chunk Size
+
+Control how documents are split into searchable pieces. Smaller chunks = more precise retrieval but less context per result.
+
+```typescript
+await client.settings.update({
+ chunkSize: 512 // -1 for default
+});
+```
+
+| Use Case | Chunk Size | Why |
+|----------|------------|-----|
+| Citations & references | `256-512` | Precise source attribution |
+| Q&A / Support | `512-1024` | Balanced context |
+| Long-form analysis | `1024-2048` | More context per chunk |
+| Default | `-1` | Supermemory's optimized default |
+
+<Note>
+Smaller chunks generate more memories per document. Larger chunks provide more context but may reduce precision.
+</Note>
+
+---
+
+## Connector Branding
+
+Show "Log in to **YourApp**" instead of "Log in to Supermemory" when users connect external services. See [Connectors Overview](/connectors/overview) for the full list of supported integrations.
+
+<AccordionGroup>
+ <Accordion title="Google Drive">
+ 1. Create OAuth credentials in [Google Cloud Console](https://console.cloud.google.com/)
+ 2. Redirect URI: `https://api.supermemory.ai/v3/connections/google-drive/callback`
+
+ ```typescript
+ await client.settings.update({
+ googleDriveCustomKeyEnabled: true,
+ googleDriveClientId: "your-client-id.apps.googleusercontent.com",
+ googleDriveClientSecret: "your-client-secret"
+ });
+ ```
+ </Accordion>
+ <Accordion title="Notion">
+ 1. Create integration at [Notion Developers](https://developers.notion.com/)
+ 2. Redirect URI: `https://api.supermemory.ai/v3/connections/notion/callback`
+
+ ```typescript
+ await client.settings.update({
+ notionCustomKeyEnabled: true,
+ notionClientId: "your-notion-client-id",
+ notionClientSecret: "your-notion-client-secret"
+ });
+ ```
+ </Accordion>
+ <Accordion title="OneDrive">
+ 1. Register app in [Azure Portal](https://portal.azure.com/)
+ 2. Redirect URI: `https://api.supermemory.ai/v3/connections/onedrive/callback`
+
+ ```typescript
+ await client.settings.update({
+ onedriveCustomKeyEnabled: true,
+ onedriveClientId: "your-azure-app-id",
+ onedriveClientSecret: "your-azure-client-secret"
+ });
+ ```
+ </Accordion>
+</AccordionGroup>
+
+---
+
+## API Reference
+
+```typescript
+// Get current settings
+const settings = await client.settings.get();
+
+// Update settings
+await client.settings.update({
+ shouldLLMFilter: true,
+ filterPrompt: "...",
+ chunkSize: 512
+});
+```
+
+<Note>
+Settings are organization-wide. Changes apply to new content only—existing memories aren't reprocessed.
+</Note>
+
+---
+
+## Next Steps
+
+<CardGroup cols={2}>
+ <Card title="Add Memories" icon="plus" href="/add-memories">
+ See your custom settings in action
+ </Card>
+ <Card title="Connectors" icon="plug" href="/connectors/overview">
+ Set up automatic syncing from external platforms
+ </Card>
+</CardGroup>