updated ai sdk

Author: sreedharsreeram

apps/docs/integrations/ai-sdk.mdx

@@ -32,10 +32,14 @@ Automatically inject user profiles into every LLM call for instant personalizati
 
 ```typescript
 import { generateText } from "ai"
-import { withSupermemory } from "@supermemory/tools/ai-sdk"
+import { withSupermemory } from "@supermemory/tools/vercel"
 import { openai } from "@ai-sdk/openai"
 
-const modelWithMemory = withSupermemory(openai("gpt-5"), "user-123")
+const modelWithMemory = withSupermemory({
+  model: openai("gpt-4"),
+  containerTag: "user-123",
+  customId: "conv-456"
+})
 
 const result = await generateText({
   model: modelWithMemory,
@@ -44,12 +48,14 @@ const result = await generateText({
 ```
 
 <Note>
-  **Memory saving is disabled by default.** The middleware only retrieves existing memories. To automatically save new memories:
+  **Memory saving is enabled by default.** The middleware automatically saves conversations to memory. To disable memory saving:
 
   ```typescript
-  const modelWithMemory = withSupermemory(openai("gpt-5"), "user-123", {
-    conversationId: "conv-1",
-    addMemory: "always"
+  const modelWithMemory = withSupermemory({
+    model: openai("gpt-4"),
+    containerTag: "user-123",
+    customId: "conv-456",
+    addMemory: "never"
   })
   ```
 </Note>
@@ -59,27 +65,42 @@ const result = await generateText({
 **Profile Mode (Default)** - Retrieves the user's complete profile:
 
 ```typescript
-const model = withSupermemory(openai("gpt-4"), "user-123", { mode: "profile" })
+const model = withSupermemory({
+  model: openai("gpt-4"),
+  containerTag: "user-123",
+  customId: "conv-456",
+  mode: "profile"
+})
 ```
 
 **Query Mode** - Searches memories based on the user's message:
 
 ```typescript
-const model = withSupermemory(openai("gpt-4"), "user-123", { mode: "query" })
+const model = withSupermemory({
+  model: openai("gpt-4"),
+  containerTag: "user-123",
+  customId: "conv-456",
+  mode: "query"
+})
 ```
 
 **Full Mode** - Combines profile AND query-based search:
 
 ```typescript
-const model = withSupermemory(openai("gpt-4"), "user-123", { mode: "full" })
+const model = withSupermemory({
+  model: openai("gpt-4"),
+  containerTag: "user-123",
+  customId: "conv-456",
+  mode: "full"
+})
 ```
 
 ### Custom Prompt Templates
 
 Customize how memories are formatted. The template receives `userMemories`, `generalSearchMemories`, and `searchResults` (raw array for filtering by metadata):
 
 ```typescript
-import { withSupermemory, type MemoryPromptData } from "@supermemory/tools/ai-sdk"
+import { withSupermemory, type MemoryPromptData } from "@supermemory/tools/vercel"
 
 const claudePrompt = (data: MemoryPromptData) => `
 <context>
@@ -92,7 +113,10 @@ const claudePrompt = (data: MemoryPromptData) => `
 </context>
 `.trim()
 
-const model = withSupermemory(anthropic("claude-3-sonnet"), "user-123", {
+const model = withSupermemory({
+  model: anthropic("claude-3-sonnet"),
+  containerTag: "user-123",
+  customId: "conv-456",
   mode: "full",
   promptTemplate: claudePrompt
 })
@@ -101,7 +125,10 @@ const model = withSupermemory(anthropic("claude-3-sonnet"), "user-123", {
 ### Verbose Logging
 
 ```typescript
-const model = withSupermemory(openai("gpt-4"), "user-123", {
+const model = withSupermemory({
+  model: openai("gpt-4"),
+  containerTag: "user-123",
+  customId: "conv-456",
   verbose: true
 })
 // Console output shows memory retrieval details

bun.lock

@@ -12,9 +12,13 @@ import {
 } from "./middleware"
 import type { PromptTemplate, MemoryPromptData } from "./memory-prompt"
 
-interface WrapVercelLanguageModelOptions {
-	/** Conversation ID to group messages into a single document (maps to customId in Supermemory). Required when addMemory is "always". */
-	conversationId?: string
+interface WrapVercelLanguageModelOptions<T extends LanguageModel> {
+	/** The language model to wrap with supermemory capabilities */
+	model: T
+	/** The container tag/identifier for memory search (e.g., user ID, project ID) */
+	containerTag: string
+	/** Custom ID to group messages into a single document. Required. */
+	customId: string
 	/** Enable detailed logging of memory search and injection */
 	verbose?: boolean
 	/**
@@ -35,8 +39,8 @@ interface WrapVercelLanguageModelOptions {
 	searchLimit?: number
 	/**
 	 * Memory persistence mode:
-	 * - "always": Automatically save conversations as memories (requires conversationId)
-	 * - "never": Only retrieve memories, don't store new ones (default)
+	 * - "always": Automatically save conversations as memories (default)
+	 * - "never": Only retrieve memories, don't store new ones
 	 */
 	addMemory?: "always" | "never"
 	/** Supermemory API key (falls back to SUPERMEMORY_API_KEY env var) */
@@ -72,35 +76,40 @@ interface WrapVercelLanguageModelOptions {
  * Supports both Vercel AI SDK 5 (LanguageModelV2) and SDK 6 (LanguageModelV3) via runtime
  * detection of `model.specificationVersion`.
  *
- * @param model - The language model to wrap with supermemory capabilities (V2 or V3)
- * @param containerTag - The container tag/identifier for memory search (e.g., user ID, project ID)
- * @param options - Configuration options for the middleware
- * @param options.conversationId - Conversation ID to group messages into a single document (maps to customId in Supermemory)
+ * @param options - Configuration object containing model and Supermemory options
+ * @param options.model - The language model to wrap with supermemory capabilities (V2 or V3)
+ * @param options.containerTag - Required. The container tag/identifier for memory search (e.g., user ID, project ID)
+ * @param options.customId - Required. Custom ID to group messages into a single document
  * @param options.verbose - Optional flag to enable detailed logging of memory search and injection process (default: false)
  * @param options.mode - Optional mode for memory search: "profile", "query", or "full" (default: "profile")
  * @param options.searchMode - Optional search mode: "memories" (default), "hybrid" (memories + chunks), or "documents" (chunks only)
  * @param options.searchLimit - Optional maximum number of search results when using hybrid/documents mode (default: 10)
- * @param options.addMemory - Optional mode for memory persistence: "always" (requires conversationId), "never" (default)
+ * @param options.addMemory - Optional mode for memory persistence: "always" (default - saves conversations), "never" (read-only mode)
  * @param options.apiKey - Optional Supermemory API key to use instead of the environment variable
  * @param options.baseUrl - Optional base URL for the Supermemory API (default: "https://api.supermemory.ai")
  *
  * @returns A wrapped language model that automatically includes relevant memories in prompts
  *
  * @example
  * ```typescript
- * import { withSupermemory } from "@supermemory/tools/ai-sdk"
+ * import { withSupermemory } from "@supermemory/tools/vercel"
  * import { openai } from "@ai-sdk/openai"
+ * import { generateText } from "ai"
  *
  * // Basic usage with profile memories
- * const modelWithMemory = withSupermemory(openai("gpt-4"), "user-123", {
- *   conversationId: "conv-456",
+ * const modelWithMemory = withSupermemory({
+ *   model: openai("gpt-4"),
+ *   containerTag: "user-123",
+ *   customId: "conv-456",
  *   mode: "full",
  *   addMemory: "always"
  * })
  *
  * // RAG usage with hybrid search (memories + document chunks)
- * const ragModel = withSupermemory(openai("gpt-4"), "user-123", {
- *   conversationId: "conv-789",
+ * const ragModel = withSupermemory({
+ *   model: openai("gpt-4"),
+ *   containerTag: "user-123",
+ *   customId: "conv-789",
  *   mode: "full",
  *   searchMode: "hybrid",  // Search both memories and document chunks
  *   searchLimit: 15,
@@ -116,38 +125,28 @@ interface WrapVercelLanguageModelOptions {
  * @throws {Error} When supermemory API request fails
  */
 const wrapVercelLanguageModel = <T extends LanguageModel>(
-	model: T,
-	containerTag: string,
-	options?: WrapVercelLanguageModelOptions,
+	options: WrapVercelLanguageModelOptions<T>,
 ): T => {
-	const providedApiKey = options?.apiKey ?? process.env.SUPERMEMORY_API_KEY
+	const { model, containerTag, customId, ...restOptions } = options
+	const providedApiKey = restOptions.apiKey ?? process.env.SUPERMEMORY_API_KEY
 
 	if (!providedApiKey) {
 		throw new Error(
 			"SUPERMEMORY_API_KEY is not set — provide it via `options.apiKey` or set `process.env.SUPERMEMORY_API_KEY`",
 		)
 	}
 
-	if (
-		(options?.addMemory ?? "never") === "always" &&
-		!options?.conversationId
-	) {
-		throw new Error(
-			'conversationId is required when addMemory is "always" — provide it via options.conversationId to group messages into a single document',
-		)
-	}
-
 	const ctx = createSupermemoryContext({
 		containerTag,
 		apiKey: providedApiKey,
-		conversationId: options?.conversationId,
-		verbose: options?.verbose ?? false,
-		mode: options?.mode ?? "profile",
-		searchMode: options?.searchMode ?? "memories",
-		searchLimit: options?.searchLimit ?? 10,
-		addMemory: options?.addMemory ?? "never",
-		baseUrl: options?.baseUrl,
-		promptTemplate: options?.promptTemplate,
+		customId,
+		verbose: restOptions.verbose ?? false,
+		mode: restOptions.mode ?? "profile",
+		searchMode: restOptions.searchMode ?? "memories",
+		searchLimit: restOptions.searchLimit ?? 10,
+		addMemory: restOptions.addMemory ?? "always",
+		baseUrl: restOptions.baseUrl,
+		promptTemplate: restOptions.promptTemplate,
 	})
 
 	const wrappedModel = {
@@ -163,7 +162,7 @@ const wrapVercelLanguageModel = <T extends LanguageModel>(
 				const userMessage = getLastUserMessage(params)
 				if (
 					ctx.addMemory === "always" &&
-					ctx.conversationId &&
+					ctx.customId &&
 					userMessage &&
 					userMessage.trim()
 				) {
@@ -173,7 +172,7 @@ const wrapVercelLanguageModel = <T extends LanguageModel>(
 					saveMemoryAfterResponse(
 						ctx.client,
 						ctx.containerTag,
-						ctx.conversationId,
+						ctx.customId,
 						assistantResponseText,
 						params,
 						ctx.logger,
@@ -216,14 +215,14 @@ const wrapVercelLanguageModel = <T extends LanguageModel>(
 						const userMessage = getLastUserMessage(params)
 						if (
 							ctx.addMemory === "always" &&
-							ctx.conversationId &&
+							ctx.customId &&
 							userMessage &&
 							userMessage.trim()
 						) {
 							saveMemoryAfterResponse(
 								ctx.client,
 								ctx.containerTag,
-								ctx.conversationId,
+								ctx.customId,
 								generatedText,
 								params,
 								ctx.logger,

packages/tools/src/vercel/index.ts

@@ -102,7 +102,7 @@ const convertToConversationMessages = (
 export const saveMemoryAfterResponse = async (
 	_client: Supermemory,
 	containerTag: string,
-	conversationId: string,
+	customId: string,
 	assistantResponseText: string,
 	params: LanguageModelCallOptions,
 	logger: Logger,
@@ -116,7 +116,7 @@ export const saveMemoryAfterResponse = async (
 		)
 
 		const response = await addConversation({
-			conversationId,
+			conversationId: customId,
 			messages: conversationMessages,
 			containerTags: [containerTag],
 			apiKey,
@@ -125,7 +125,7 @@ export const saveMemoryAfterResponse = async (
 
 		logger.info("Conversation saved successfully via /v4/conversations", {
 			containerTag,
-			conversationId,
+			customId,
 			messageCount: conversationMessages.length,
 			responseId: response.id,
 		})
@@ -144,8 +144,8 @@ interface SupermemoryMiddlewareOptions {
 	containerTag: string
 	/** Supermemory API key */
 	apiKey: string
-	/** Conversation ID to group messages into a single document (maps to customId in Supermemory). Required when addMemory is "always". */
-	conversationId?: string
+	/** Custom ID to group messages into a single document. Required. */
+	customId: string
 	/** Enable detailed logging of memory search and injection */
 	verbose?: boolean
 	/**
@@ -180,7 +180,7 @@ interface SupermemoryMiddlewareContext {
 	client: Supermemory
 	logger: Logger
 	containerTag: string
-	conversationId?: string
+	customId: string
 	mode: MemoryMode
 	searchMode: SearchMode
 	searchLimit: number
@@ -201,7 +201,7 @@ export const createSupermemoryContext = (
 	const {
 		containerTag,
 		apiKey,
-		conversationId,
+		customId,
 		verbose = false,
 		mode = "profile",
 		searchMode = "memories",
@@ -225,7 +225,7 @@ export const createSupermemoryContext = (
 		client,
 		logger,
 		containerTag,
-		conversationId,
+		customId,
 		mode,
 		searchMode,
 		searchLimit,
@@ -247,7 +247,7 @@ const makeTurnKey = (
 ): string => {
 	return MemoryCache.makeTurnKey(
 		ctx.containerTag,
-		ctx.conversationId,
+		ctx.customId,
 		ctx.mode,
 		userMessage,
 	)
@@ -288,7 +288,7 @@ export const transformParamsWithMemory = async (
 
 	ctx.logger.info("Starting memory search", {
 		containerTag: ctx.containerTag,
-		conversationId: ctx.conversationId,
+		customId: ctx.customId,
 		mode: ctx.mode,
 		searchMode: ctx.searchMode,
 		isNewTurn,