add the addMemory option docs (#616)

This commit is contained in:
nexxeln 2025-12-14 01:19:52 +00:00
parent f7fcb40a8c
commit c42248ff35
2 changed files with 24 additions and 1 deletions

View file

@ -26,7 +26,7 @@ import { withSupermemory } from "@supermemory/tools/ai-sdk"
import { openai } from "@ai-sdk/openai"
// Wrap your model with Supermemory - profiles are automatically injected
const modelWithMemory = withSupermemory(openai("gpt-4"), "user-123")
const modelWithMemory = withSupermemory(openai("gpt-5"), "user-123")
const result = await generateText({
model: modelWithMemory,
@ -35,6 +35,19 @@ const result = await generateText({
// The model automatically has the user's profile context!
```
<Note>
**Memory saving is disabled by default.** The middleware only retrieves existing memories. To automatically save new memories from conversations, enable it explicitly:
```typescript
const modelWithMemory = withSupermemory(openai("gpt-5"), "user-123", {
addMemory: "always"
})
```
</Note>
```typescript
```
## Memory Tools
Add memory capabilities to AI agents with search, add, and fetch operations.

View file

@ -45,6 +45,16 @@ The `withSupermemory` middleware:
All of this happens transparently - you write code as if using a normal model, but get personalized responses.
<Note>
**Memory saving is disabled by default.** The middleware only retrieves existing memories. To automatically save new memories from conversations, set `addMemory: "always"`:
```typescript
const model = withSupermemory(openai("gpt-5"), "user-123", {
addMemory: "always"
})
```
</Note>
## Memory Search Modes
Configure how the middleware retrieves and uses memory: