@convex-dev/agent 0.1.16-alpha.0 → 0.1.16-alpha.2

package/src/client/search.ts

@@ -16,9 +16,8 @@ import {
 const DEFAULT_VECTOR_SCORE_THRESHOLD = 0.0;
 
 export type GetEmbedding = (text: string) => Promise<{
-  vector: number[];
-  vectorModel: string;
-  vectorScoreThreshold?: number;
+  embedding: number[];
+  embeddingModel: string;
 }>;
 
 /**
@@ -44,7 +43,7 @@ export async function fetchContextMessages(
     upToAndIncludingMessageId?: string;
     contextOptions: ContextOptions;
     getEmbedding?: GetEmbedding;
-  }
+  },
 ): Promise<MessageDoc[]> {
   assert(args.userId || args.threadId, "Specify userId or threadId");
   const opts = args.contextOptions;
@@ -67,17 +66,17 @@ export async function fetchContextMessages(
         upToAndIncludingMessageId: args.upToAndIncludingMessageId,
         order: "desc",
         statuses: ["success"],
-      }
+      },
     );
     included = new Set(page.map((m) => m._id));
     contextMessages.push(
       // Reverse since we fetched in descending order
-      ...page.reverse()
+      ...page.reverse(),
     );
   }
   if (opts.searchOptions?.textSearch || opts.searchOptions?.vectorSearch) {
     const targetMessage = contextMessages.find(
-      (m) => m._id === args.upToAndIncludingMessageId
+      (m) => m._id === args.upToAndIncludingMessageId,
     )?.message;
     const messagesToSearch = targetMessage ? [targetMessage] : args.messages;
     if (!("runAction" in ctx)) {
@@ -89,11 +88,11 @@ export async function fetchContextMessages(
     assert(text, `No text to search in message ${JSON.stringify(lastMessage)}`);
     assert(
       !args.contextOptions?.searchOptions?.vectorSearch || "runAction" in ctx,
-      "You must do vector search from an action"
+      "You must do vector search from an action",
     );
     if (opts.searchOptions?.vectorSearch && !args.getEmbedding) {
       throw new Error(
-        "You must provide an embedding and embeddingModel to use vector search"
+        "You must provide an embedding and embeddingModel to use vector search",
       );
     }
     const embeddingFields = opts.searchOptions?.vectorSearch
@@ -122,20 +121,21 @@ export async function fetchContextMessages(
         vectorScoreThreshold:
           opts.searchOptions?.vectorScoreThreshold ??
           DEFAULT_VECTOR_SCORE_THRESHOLD,
-        ...embeddingFields,
-      }
+        embedding: embeddingFields?.embedding,
+        embeddingModel: embeddingFields?.embeddingModel,
+      },
     );
     // TODO: track what messages we used for context
     contextMessages.unshift(
-      ...searchMessages.filter((m) => !included?.has(m._id))
+      ...searchMessages.filter((m) => !included?.has(m._id)),
     );
   }
   // Ensure we don't include tool messages without a corresponding tool call
   return filterOutOrphanedToolMessages(
     contextMessages.sort((a, b) =>
       // Sort the raw MessageDocs by order and stepOrder
-      a.order === b.order ? a.stepOrder - b.stepOrder : a.order - b.order
-    )
+      a.order === b.order ? a.stepOrder - b.stepOrder : a.order - b.order,
+    ),
   );
 }
 

package/src/client/streaming.ts

@@ -38,7 +38,7 @@ export async function syncStreams(
     streamArgs: StreamArgs | undefined;
     // By default, only streaming messages are included.
     includeStatuses?: ("streaming" | "finished" | "aborted")[];
-  }
+  },
 ): Promise<SyncStreamsReturnValue | undefined> {
   if (!args.streamArgs) return undefined;
   if (args.streamArgs.kind === "list") {
@@ -66,7 +66,7 @@ export async function abortStream(
   component: AgentComponent,
   args: {
     reason: string;
-  } & ({ streamId: string } | { threadId: string; order: number })
+  } & ({ streamId: string } | { threadId: string; order: number }),
 ): Promise<boolean> {
   if ("streamId" in args) {
     return await ctx.runMutation(component.streams.abort, {
@@ -102,7 +102,7 @@ export async function listStreams(
     threadId: string;
     startOrder?: number;
     includeStatuses?: ("streaming" | "finished" | "aborted")[];
-  }
+  },
 ): Promise<StreamMessage[]> {
   return ctx.runQuery(component.streams.list, {
     threadId,
@@ -137,7 +137,7 @@ export function mergeTransforms<TOOLS extends ToolSet>(
   existing:
     | StreamTextTransform<TOOLS>
     | Array<StreamTextTransform<TOOLS>>
-    | undefined
+    | undefined,
 ) {
   if (!options) {
     return existing;
@@ -180,7 +180,7 @@ export class DeltaStreamer {
       order: number | undefined;
       stepOrder: number | undefined;
       abortSignal: AbortSignal | undefined;
-    }
+    },
   ) {
     this.options =
       typeof options === "boolean"
@@ -216,7 +216,7 @@ export class DeltaStreamer {
           ...omit(this.metadata, ["abortSignal"]),
           order: this.#nextOrder,
           stepOrder: this.#nextStepOrder,
-        }
+        },
       );
     }
     this.#nextParts.push(...parts);
@@ -237,7 +237,7 @@ export class DeltaStreamer {
     try {
       const success = await this.ctx.runMutation(
         this.component.streams.addDelta,
-        delta
+        delta,
       );
       if (!success) {
         this.abortController.abort();

package/src/client/types.ts

@@ -22,13 +22,14 @@ import type {
   Auth,
   Expand,
   FunctionReference,
-  GenericActionCtx,
-  GenericDataModel,
-  GenericMutationCtx,
-  GenericQueryCtx,
   StorageActionWriter,
   StorageReader,
   WithoutSystemFields,
+  FunctionArgs,
+  FunctionReturnType,
+  GenericActionCtx,
+  GenericDataModel,
+  OptionalRestArgs,
 } from "convex/server";
 import type { GenericId } from "convex/values";
 import type { Schema } from "zod";
@@ -127,7 +128,7 @@ export type UsageHandler = (
     providerMetadata: ProviderMetadata | undefined;
     model: string;
     provider: string;
-  }
+  },
 ) => void | Promise<void>;
 
 export type RawRequestResponseHandler = (
@@ -138,7 +139,7 @@ export type RawRequestResponseHandler = (
     agentName: string | undefined;
     request: LanguageModelRequestMetadata;
     response: LanguageModelResponseMetadata;
-  }
+  },
 ) => void | Promise<void>;
 
 export type AgentComponent = UseApi<Mounts>;
@@ -335,7 +336,7 @@ export interface Thread<DefaultTools extends ToolSet> {
    * Update the metadata for the thread.
    */
   updateMetadata: (
-    patch: Partial<WithoutSystemFields<ThreadDoc>>
+    patch: Partial<WithoutSystemFields<ThreadDoc>>,
   ) => Promise<ThreadDoc>;
   /**
    * This behaves like {@link generateText} from the "ai" package except that
@@ -358,7 +359,7 @@ export interface Thread<DefaultTools extends ToolSet> {
       OUTPUT,
       OUTPUT_PARTIAL
     >,
-    options?: Options
+    options?: Options,
   ): Promise<
     GenerateTextResult<TOOLS extends undefined ? DefaultTools : TOOLS, OUTPUT> &
       ThreadOutputMetadata
@@ -397,7 +398,7 @@ export interface Thread<DefaultTools extends ToolSet> {
        * iterating over the text, streaming it over HTTP, etc.
        */
       saveStreamDeltas?: boolean | StreamingOptions;
-    }
+    },
   ): Promise<
     StreamTextResult<
       TOOLS extends undefined ? DefaultTools : TOOLS,
@@ -417,7 +418,7 @@ export interface Thread<DefaultTools extends ToolSet> {
    */
   generateObject<T>(
     args: OurObjectArgs<T>,
-    options?: Options
+    options?: Options,
   ): Promise<GenerateObjectResult<T> & ThreadOutputMetadata>;
   /**
    * This behaves like {@link generateObject} from the "ai" package except that
@@ -431,7 +432,7 @@ export interface Thread<DefaultTools extends ToolSet> {
    */
   generateObject(
     args: GenerateObjectNoSchemaOptions,
-    options?: Options
+    options?: Options,
   ): Promise<GenerateObjectResult<JSONValue> & ThreadOutputMetadata>;
   /**
    * This behaves like {@link streamObject} from the "ai" package except that
@@ -445,7 +446,7 @@ export interface Thread<DefaultTools extends ToolSet> {
    */
   streamObject<T>(
     args: OurStreamObjectArgs<T>,
-    options?: Options
+    options?: Options,
   ): Promise<
     StreamObjectResult<DeepPartial<T>, T, never> & ThreadOutputMetadata
   >;
@@ -469,17 +470,24 @@ export type SyncStreamsReturnValue =
 
 /* Type utils follow */
 export type RunQueryCtx = {
-  runQuery: GenericQueryCtx<GenericDataModel>["runQuery"];
+  runQuery: <Query extends FunctionReference<"query", "internal">>(
+    query: Query,
+    args: FunctionArgs<Query>,
+  ) => Promise<FunctionReturnType<Query>>;
 };
-export type RunMutationCtx = {
-  runQuery: GenericMutationCtx<GenericDataModel>["runQuery"];
-  runMutation: GenericMutationCtx<GenericDataModel>["runMutation"];
+export type RunMutationCtx = RunQueryCtx & {
+  runMutation: <Mutation extends FunctionReference<"mutation", "internal">>(
+    mutation: Mutation,
+    args: FunctionArgs<Mutation>,
+  ) => Promise<FunctionReturnType<Mutation>>;
 };
-export type RunActionCtx = {
-  runQuery: GenericActionCtx<GenericDataModel>["runQuery"];
-  runMutation: GenericActionCtx<GenericDataModel>["runMutation"];
-  runAction: GenericActionCtx<GenericDataModel>["runAction"];
+export type RunActionCtx = RunMutationCtx & {
+  runAction<Action extends FunctionReference<"action", "internal">>(
+    action: Action,
+    args: FunctionArgs<Action>,
+  ): Promise<FunctionReturnType<Action>>;
 };
+export type UserActionCtx = GenericActionCtx<GenericDataModel>;
 export type ActionCtx = RunActionCtx & {
   auth: Auth;
   storage: StorageActionWriter;
@@ -496,9 +504,7 @@ export type OpaqueIds<T> =
       : T extends ArrayBuffer
         ? ArrayBuffer
         : T extends object
-          ? {
-              [K in keyof T]: OpaqueIds<T[K]>;
-            }
+          ? { [K in keyof T]: OpaqueIds<T[K]> }
           : T;
 
 export type UseApi<API> = Expand<{

package/src/component/apiKeys.ts

@@ -69,6 +69,6 @@ export const destroy = mutation({
     v.literal("missing"),
     v.literal("deleted"),
     v.literal("name mismatch"),
-    v.literal("must provide either apiKey or name")
+    v.literal("must provide either apiKey or name"),
   ),
 });

package/src/component/files.test.ts

@@ -22,7 +22,7 @@ describe("files", () => {
         hash,
         filename,
         mimeType: "text/plain",
-      }
+      },
     );
     expect(fileId).toBeTruthy();
     expect(returnedStorageId).toBe(storageId);

package/src/component/files.ts

@@ -23,7 +23,7 @@ export const addFile = mutation({
 
 export async function addFileHandler(
   ctx: MutationCtx,
-  args: Infer<typeof addFileArgs>
+  args: Infer<typeof addFileArgs>,
 ) {
   const existingFile = await ctx.db
     .query("files")
@@ -93,14 +93,14 @@ export const useExistingFile = mutation({
     v.object({
       fileId: v.id("files"),
       storageId: v.string(),
-    })
+    }),
   ),
 });
 
 export async function changeRefcount(
   ctx: MutationCtx,
   prev: Id<"files">[],
-  next: Id<"files">[]
+  next: Id<"files">[],
 ) {
   const prevSet = new Set(prev);
   const nextSet = new Set(next);
@@ -140,7 +140,7 @@ export const copyFile = mutation({
 
 export async function copyFileHandler(
   ctx: MutationCtx,
-  args: { fileId: Id<"files"> }
+  args: { fileId: Id<"files"> },
 ) {
   const file = await ctx.db.get(args.fileId);
   if (!file) {
@@ -194,14 +194,14 @@ export const deleteFiles = mutation({
         if (file.refcount && file.refcount > 0) {
           if (!args.force) {
             console.error(
-              `File ${fileId} has refcount ${file.refcount} > 0, skipping...`
+              `File ${fileId} has refcount ${file.refcount} > 0, skipping...`,
             );
             return null;
           }
         }
         await ctx.db.delete(fileId);
         return fileId;
-      })
+      }),
     );
     return deletedFileIds.filter((fileId) => fileId !== null);
   },

package/src/component/messages.test.ts

@@ -280,7 +280,7 @@ describe("agent", () => {
         patch: {
           message: { role: "user", content: "test" },
         },
-      })
+      }),
     ).rejects.toThrow();
   });
 
@@ -311,7 +311,7 @@ describe("agent", () => {
       {
         threadId: thread._id as Id<"threads">,
         order: "asc",
-      }
+      },
     );
     expect(remainingMessages.page).toHaveLength(1);
     expect(remainingMessages.page[0]._id).toBe(messageIds[1]);
@@ -346,7 +346,7 @@ describe("agent", () => {
       {
         threadId: thread._id as Id<"threads">,
         order: "asc",
-      }
+      },
     );
     expect(remainingMessages.page).toHaveLength(0);
   });
@@ -398,7 +398,7 @@ describe("agent", () => {
       {
         threadId: thread._id as Id<"threads">,
         order: "asc",
-      }
+      },
     );
 
     expect(remainingMessages.page).toHaveLength(3); // Should have messages from order 1 and 2
@@ -441,7 +441,7 @@ describe("agent", () => {
       {
         threadId: thread._id as Id<"threads">,
         order: "asc",
-      }
+      },
     );
 
     expect(remainingMessages.page).toHaveLength(2);
@@ -504,7 +504,7 @@ describe("agent", () => {
       {
         threadId: thread._id as Id<"threads">,
         order: "asc",
-      }
+      },
     );
     expect(remainingMessages.page).toHaveLength(1);
   });

package/src/component/messages.ts

@@ -46,7 +46,7 @@ function publicMessage(message: Doc<"messages">): MessageDoc {
 
 export async function deleteMessage(
   ctx: MutationCtx,
-  messageDoc: Doc<"messages">
+  messageDoc: Doc<"messages">,
 ) {
   await ctx.db.delete(messageDoc._id);
   if (messageDoc.embeddingId) {
@@ -71,14 +71,14 @@ export const deleteByIds = mutation({
           return id;
         }
         return null;
-      })
+      }),
     );
     return deletedMessageIds.filter((id) => id !== null);
   },
 });
 
 export const messageStatuses = vMessageDoc.fields.status.members.map(
-  (m) => m.value
+  (m) => m.value,
 );
 
 export const deleteByOrder = mutation({
@@ -99,7 +99,7 @@ export const deleteByOrder = mutation({
       ctx,
       args.threadId,
       "asc",
-      args.startOrder
+      args.startOrder,
     )
       .narrow({
         lowerBound: args.startStepOrder
@@ -140,7 +140,7 @@ export const addMessages = mutation({
 });
 async function addMessagesHandler(
   ctx: MutationCtx,
-  args: ObjectType<typeof addMessagesArgs>
+  args: ObjectType<typeof addMessagesArgs>,
 ) {
   let userId = args.userId;
   const threadId = args.threadId;
@@ -163,15 +163,15 @@ async function addMessagesHandler(
     const pendingMessages = await ctx.db
       .query("messages")
       .withIndex("threadId_status_tool_order_stepOrder", (q) =>
-        q.eq("threadId", threadId).eq("status", "pending")
+        q.eq("threadId", threadId).eq("status", "pending"),
       )
       .collect();
     await Promise.all(
       pendingMessages
         .filter((m) => !parentMessage || m.order === parentMessage.order)
         .map((m) =>
-          ctx.db.patch(m._id, { status: "failed", error: "Restarting" })
-        )
+          ctx.db.patch(m._id, { status: "failed", error: "Restarting" }),
+        ),
     );
   }
   let order, stepOrder;
@@ -194,7 +194,7 @@ async function addMessagesHandler(
   if (embeddings) {
     assert(
       embeddings.vectors.length === messages.length,
-      "embeddings.vectors.length must match messages.length"
+      "embeddings.vectors.length must match messages.length",
     );
   }
   for (let i = 0; i < messages.length; i++) {
@@ -242,7 +242,7 @@ async function addMessagesHandler(
 export async function getMaxMessage(
   ctx: QueryCtx,
   threadId: Id<"threads">,
-  order?: number
+  order?: number,
 ) {
   return orderedMessagesStream(ctx, threadId, "desc", order).first();
 }
@@ -251,7 +251,7 @@ function orderedMessagesStream(
   ctx: QueryCtx,
   threadId: Id<"threads">,
   sortOrder: "asc" | "desc",
-  order?: number
+  order?: number,
 ) {
   return mergedStream(
     [true, false].flatMap((tool) =>
@@ -268,10 +268,10 @@ function orderedMessagesStream(
             }
             return qq;
           })
-          .order(sortOrder)
-      )
+          .order(sortOrder),
+      ),
     ),
-    ["order", "stepOrder"]
+    ["order", "stepOrder"],
   );
 }
 
@@ -288,7 +288,7 @@ export const rollbackMessage = mutation({
       ctx,
       message.threadId,
       "asc",
-      message.order
+      message.order,
     ).collect();
     for (const m of messages) {
       if (m.status === "pending") {
@@ -347,7 +347,7 @@ export const updateMessage = mutation({
 
 async function commitMessageHandler(
   ctx: MutationCtx,
-  { messageId }: { messageId: Id<"messages"> }
+  { messageId }: { messageId: Id<"messages"> },
 ) {
   const message = await ctx.db.get(messageId);
   assert(message, `Message ${messageId} not found`);
@@ -362,10 +362,10 @@ async function commitMessageHandler(
             .eq("threadId", message.threadId)
             .eq("status", "pending")
             .eq("tool", tool)
-            .eq("order", order)
-        )
+            .eq("order", order),
+        ),
     ),
-    ["order", "stepOrder"]
+    ["order", "stepOrder"],
   ).collect();
   for (const message of messages) {
     await ctx.db.patch(message._id, { status: "success" });
@@ -390,7 +390,7 @@ export const listMessagesByThreadId = query({
       (await ctx.db.get(args.upToAndIncludingMessageId));
     assert(
       !last || last.threadId === args.threadId,
-      "upToAndIncludingMessageId must be a message in the thread"
+      "upToAndIncludingMessageId must be a message in the thread",
     );
     const toolOptions = args.excludeToolMessages ? [false] : [true, false];
     const order = args.order ?? "desc";
@@ -411,9 +411,10 @@ export const listMessagesByThreadId = query({
           .order(order)
           .filterWith(
             // We allow all messages on the same order.
-            async (m) => !last || m.order < last.order || m.order === last.order
-          )
-      )
+            async (m) =>
+              !last || m.order < last.order || m.order === last.order,
+          ),
+      ),
     );
     const messages = await mergedStream(streams, [
       "order",
@@ -422,7 +423,7 @@ export const listMessagesByThreadId = query({
       args.paginationOpts ?? {
         numItems: DEFAULT_RECENT_MESSAGES,
         cursor: null,
-      }
+      },
     );
     return { ...messages, page: messages.page.map(publicMessage) };
   },
@@ -450,14 +451,14 @@ export const searchMessages = action({
     limit: v.number(),
     vectorScoreThreshold: v.optional(v.number()),
     messageRange: v.optional(
-      v.object({ before: v.number(), after: v.number() })
+      v.object({ before: v.number(), after: v.number() }),
     ),
   },
   returns: v.array(vMessageDoc),
   handler: async (ctx, args): Promise<MessageDoc[]> => {
     assert(
       args.searchAllMessagesForUserId || args.threadId,
-      "Specify userId or threadId"
+      "Specify userId or threadId",
     );
     const limit = args.limit;
     let textSearchMessages: MessageDoc[] | undefined;
@@ -496,20 +497,20 @@ export const searchMessages = action({
             1 / ((textEmbeddingIds?.indexOf(v._id) ?? Infinity) + k),
         }))
         .sort((a, b) => b.score - a.score);
-      const vectorIds = vectorScores.slice(0, limit).map((v) => v.id);
+      const embeddingIds = vectorScores.slice(0, limit).map((v) => v.id);
       const messages: MessageDoc[] = await ctx.runQuery(
         internal.messages._fetchSearchMessages,
         {
           searchAllMessagesForUserId: args.searchAllMessagesForUserId,
           threadId: args.threadId,
-          vectorIds,
+          embeddingIds,
           textSearchMessages: textSearchMessages?.filter(
-            (m) => !vectorIds.includes(m.embeddingId! as VectorTableId)
+            (m) => !embeddingIds.includes(m.embeddingId! as VectorTableId),
           ),
           messageRange: args.messageRange ?? DEFAULT_MESSAGE_RANGE,
           beforeMessageId: args.beforeMessageId,
           limit,
-        }
+        },
       );
       return messages;
     }
@@ -520,7 +521,7 @@ export const searchMessages = action({
 export const _fetchSearchMessages = internalQuery({
   args: {
     threadId: v.optional(v.id("threads")),
-    vectorIds: v.array(vVectorId),
+    embeddingIds: v.array(vVectorId),
     searchAllMessagesForUserId: v.optional(v.string()),
     textSearchMessages: v.optional(v.array(vMessageDoc)),
     messageRange: v.object({ before: v.number(), after: v.number() }),
@@ -534,28 +535,28 @@ export const _fetchSearchMessages = internalQuery({
     const { searchAllMessagesForUserId, threadId } = args;
     assert(
       searchAllMessagesForUserId || threadId,
-      "Specify searchAllMessagesForUserId or threadId to search"
+      "Specify searchAllMessagesForUserId or threadId to search",
     );
     let messages: MessageDoc[] = (
       await Promise.all(
-        args.vectorIds.map((embeddingId) =>
+        args.embeddingIds.map((embeddingId) =>
           ctx.db
             .query("messages")
             .withIndex("embeddingId_threadId", (q) =>
               searchAllMessagesForUserId
                 ? q.eq("embeddingId", embeddingId)
-                : q.eq("embeddingId", embeddingId).eq("threadId", threadId!)
+                : q.eq("embeddingId", embeddingId).eq("threadId", threadId!),
             )
             .filter((q) =>
               q.and(
                 q.eq(q.field("status"), "success"),
                 searchAllMessagesForUserId
                   ? q.eq(q.field("userId"), searchAllMessagesForUserId)
-                  : q.eq(q.field("threadId"), threadId)
-              )
+                  : q.eq(q.field("threadId"), threadId),
+              ),
             )
-            .first()
-        )
+            .first(),
+        ),
       )
     )
       .filter(
@@ -566,7 +567,7 @@ export const _fetchSearchMessages = internalQuery({
           (!beforeMessage ||
             m.order < beforeMessage.order ||
             (m.order === beforeMessage.order &&
-              m.stepOrder < beforeMessage.stepOrder))
+              m.stepOrder < beforeMessage.stepOrder)),
       )
       .map(publicMessage);
     messages.push(...(args.textSearchMessages ?? []));
@@ -614,7 +615,7 @@ export const _fetchSearchMessages = internalQuery({
               .eq("status", "success")
               .eq("tool", false)
               .gte("order", earliest)
-              .lte("order", latest)
+              .lte("order", latest),
           )
           .collect();
         if (!ranges[searchId]) {
@@ -645,7 +646,7 @@ export const textSearch = query({
   handler: async (ctx, args) => {
     assert(
       args.searchAllMessagesForUserId || args.threadId,
-      "Specify userId or threadId"
+      "Specify userId or threadId",
     );
     const beforeMessage =
       args.beforeMessageId && (await ctx.db.get(args.beforeMessageId));
@@ -657,7 +658,7 @@ export const textSearch = query({
           ? q
               .search("text", args.text)
               .eq("userId", args.searchAllMessagesForUserId)
-          : q.search("text", args.text).eq("threadId", args.threadId!)
+          : q.search("text", args.text).eq("threadId", args.threadId!),
       )
       // Just in case tool messages slip through
       .filter((q) => {
@@ -674,7 +675,7 @@ export const textSearch = query({
           !beforeMessage ||
           m.order < beforeMessage.order ||
           (m.order === beforeMessage.order &&
-            m.stepOrder < beforeMessage.stepOrder)
+            m.stepOrder < beforeMessage.stepOrder),
       )
       .map(publicMessage);
   },