@convex-dev/agent 0.1.1 → 0.1.2-alpha.0

package/src/component/_generated/api.d.ts

@@ -11,6 +11,7 @@
 import type * as apiKeys from "../apiKeys.js";
 import type * as files from "../files.js";
 import type * as messages from "../messages.js";
+import type * as streams from "../streams.js";
 import type * as threads from "../threads.js";
 import type * as users from "../users.js";
 import type * as vector_index from "../vector/index.js";
@@ -34,6 +35,7 @@ declare const fullApi: ApiFromModules<{
   apiKeys: typeof apiKeys;
   files: typeof files;
   messages: typeof messages;
+  streams: typeof streams;
   threads: typeof threads;
   users: typeof users;
   "vector/index": typeof vector_index;
@@ -899,196 +901,142 @@ export type Mounts = {
       Array<{
         _creationTime: number;
         _id: string;
+        agentName?: string;
+        embeddingId?: string;
+        error?: string;
+        files?: Array<{
+          data?: ArrayBuffer | string;
+          fileId?: string;
+          mimeType: string;
+          url?: string;
+        }>;
+        finishReason?:
+          | "stop"
+          | "length"
+          | "content-filter"
+          | "tool-calls"
+          | "error"
+          | "other"
+          | "unknown";
+        id?: string;
+        message?:
+          | {
+              content:
+                | string
+                | Array<
+                    | {
+                        providerOptions?: Record<string, Record<string, any>>;
+                        text: string;
+                        type: "text";
+                      }
+                    | {
+                        image: string | ArrayBuffer;
+                        mimeType?: string;
+                        providerOptions?: Record<string, Record<string, any>>;
+                        type: "image";
+                      }
+                    | {
+                        data: string | ArrayBuffer;
+                        mimeType: string;
+                        providerOptions?: Record<string, Record<string, any>>;
+                        type: "file";
+                      }
+                  >;
+              providerOptions?: Record<string, Record<string, any>>;
+              role: "user";
+            }
+          | {
+              content:
+                | string
+                | Array<
+                    | {
+                        providerOptions?: Record<string, Record<string, any>>;
+                        text: string;
+                        type: "text";
+                      }
+                    | {
+                        data: string | ArrayBuffer;
+                        mimeType: string;
+                        providerOptions?: Record<string, Record<string, any>>;
+                        type: "file";
+                      }
+                    | {
+                        providerOptions?: Record<string, Record<string, any>>;
+                        signature?: string;
+                        text: string;
+                        type: "reasoning";
+                      }
+                    | {
+                        data: string;
+                        providerOptions?: Record<string, Record<string, any>>;
+                        type: "redacted-reasoning";
+                      }
+                    | {
+                        args: any;
+                        providerOptions?: Record<string, Record<string, any>>;
+                        toolCallId: string;
+                        toolName: string;
+                        type: "tool-call";
+                      }
+                  >;
+              providerOptions?: Record<string, Record<string, any>>;
+              role: "assistant";
+            }
+          | {
+              content: Array<{
+                args?: any;
+                experimental_content?: Array<
+                  | { text: string; type: "text" }
+                  | { data: string; mimeType?: string; type: "image" }
+                >;
+                isError?: boolean;
+                providerOptions?: Record<string, Record<string, any>>;
+                result: any;
+                toolCallId: string;
+                toolName: string;
+                type: "tool-result";
+              }>;
+              providerOptions?: Record<string, Record<string, any>>;
+              role: "tool";
+            }
+          | {
+              content: string;
+              providerOptions?: Record<string, Record<string, any>>;
+              role: "system";
+            };
+        model?: string;
         order: number;
-        parentMessageId: string;
+        provider?: string;
+        providerMetadata?: Record<string, Record<string, any>>;
+        providerOptions?: Record<string, Record<string, any>>;
+        reasoning?: string;
+        reasoningDetails?: Array<
+          | { signature?: string; text: string; type: "text" }
+          | { data: string; type: "redacted" }
+        >;
+        sources?: Array<{
+          id: string;
+          providerOptions?: Record<string, Record<string, any>>;
+          sourceType: "url";
+          title?: string;
+          url: string;
+        }>;
         status: "pending" | "success" | "failed";
-        step: {
-          experimental_providerMetadata?: Record<string, Record<string, any>>;
-          files?: Array<any>;
-          finishReason:
-            | "stop"
-            | "length"
-            | "content-filter"
-            | "tool-calls"
-            | "error"
-            | "other"
-            | "unknown";
-          isContinued: boolean;
-          logprobs?: any;
-          providerMetadata?: Record<string, Record<string, any>>;
-          reasoning?: string;
-          reasoningDetails?: Array<
-            | { signature?: string; text: string; type: "text" }
-            | { data: string; type: "redacted" }
-          >;
-          request?: {
-            body?: any;
-            headers?: Record<string, string>;
-            method?: string;
-            url?: string;
-          };
-          response?: {
-            body?: any;
-            headers?: Record<string, string>;
-            id: string;
-            messages: Array<{
-              fileId?: string;
-              id?: string;
-              message:
-                | {
-                    content:
-                      | string
-                      | Array<
-                          | {
-                              providerOptions?: Record<
-                                string,
-                                Record<string, any>
-                              >;
-                              text: string;
-                              type: "text";
-                            }
-                          | {
-                              image: string | ArrayBuffer;
-                              mimeType?: string;
-                              providerOptions?: Record<
-                                string,
-                                Record<string, any>
-                              >;
-                              type: "image";
-                            }
-                          | {
-                              data: string | ArrayBuffer;
-                              mimeType: string;
-                              providerOptions?: Record<
-                                string,
-                                Record<string, any>
-                              >;
-                              type: "file";
-                            }
-                        >;
-                    providerOptions?: Record<string, Record<string, any>>;
-                    role: "user";
-                  }
-                | {
-                    content:
-                      | string
-                      | Array<
-                          | {
-                              providerOptions?: Record<
-                                string,
-                                Record<string, any>
-                              >;
-                              text: string;
-                              type: "text";
-                            }
-                          | {
-                              data: string | ArrayBuffer;
-                              mimeType: string;
-                              providerOptions?: Record<
-                                string,
-                                Record<string, any>
-                              >;
-                              type: "file";
-                            }
-                          | {
-                              providerOptions?: Record<
-                                string,
-                                Record<string, any>
-                              >;
-                              signature?: string;
-                              text: string;
-                              type: "reasoning";
-                            }
-                          | {
-                              data: string;
-                              providerOptions?: Record<
-                                string,
-                                Record<string, any>
-                              >;
-                              type: "redacted-reasoning";
-                            }
-                          | {
-                              args: any;
-                              providerOptions?: Record<
-                                string,
-                                Record<string, any>
-                              >;
-                              toolCallId: string;
-                              toolName: string;
-                              type: "tool-call";
-                            }
-                        >;
-                    providerOptions?: Record<string, Record<string, any>>;
-                    role: "assistant";
-                  }
-                | {
-                    content: Array<{
-                      args?: any;
-                      experimental_content?: Array<
-                        | { text: string; type: "text" }
-                        | { data: string; mimeType?: string; type: "image" }
-                      >;
-                      isError?: boolean;
-                      providerOptions?: Record<string, Record<string, any>>;
-                      result: any;
-                      toolCallId: string;
-                      toolName: string;
-                      type: "tool-result";
-                    }>;
-                    providerOptions?: Record<string, Record<string, any>>;
-                    role: "tool";
-                  }
-                | {
-                    content: string;
-                    providerOptions?: Record<string, Record<string, any>>;
-                    role: "system";
-                  };
-            }>;
-            modelId: string;
-            timestamp: number;
-          };
-          sources?: Array<{
-            id: string;
-            providerOptions?: Record<string, Record<string, any>>;
-            sourceType: "url";
-            title?: string;
-            url: string;
-          }>;
-          stepType: "initial" | "continue" | "tool-result";
-          text: string;
-          toolCalls: Array<{
-            args: any;
-            providerOptions?: Record<string, Record<string, any>>;
-            toolCallId: string;
-            toolName: string;
-            type: "tool-call";
-          }>;
-          toolResults: Array<{
-            args?: any;
-            experimental_content?: Array<
-              | { text: string; type: "text" }
-              | { data: string; mimeType?: string; type: "image" }
-            >;
-            isError?: boolean;
-            providerOptions?: Record<string, Record<string, any>>;
-            result: any;
-            toolCallId: string;
-            toolName: string;
-            type: "tool-result";
-          }>;
-          usage?: {
-            completionTokens: number;
-            promptTokens: number;
-            totalTokens: number;
-          };
-          warnings?: Array<
-            | { details?: string; setting: string; type: "unsupported-setting" }
-            | { details?: string; tool: any; type: "unsupported-tool" }
-            | { message: string; type: "other" }
-          >;
-        };
         stepOrder: number;
+        text?: string;
         threadId: string;
+        tool: boolean;
+        usage?: {
+          completionTokens: number;
+          promptTokens: number;
+          totalTokens: number;
+        };
+        userId?: string;
+        warnings?: Array<
+          | { details?: string; setting: string; type: "unsupported-setting" }
+          | { details?: string; tool: any; type: "unsupported-tool" }
+          | { message: string; type: "other" }
+        >;
       }>
     >;
     commitMessage: FunctionReference<
@@ -1254,7 +1202,7 @@ export type Mounts = {
       {
         excludeToolMessages?: boolean;
         isTool?: "use excludeToolMessages instead of this";
-        order?: "asc" | "desc";
+        order: "asc" | "desc";
         paginationOpts?: {
           cursor: string | null;
           endCursor?: string | null;
@@ -1727,6 +1675,209 @@ export type Mounts = {
       }>
     >;
   };
+  streams: {
+    addDelta: FunctionReference<
+      "mutation",
+      "public",
+      {
+        end: number;
+        parts: Array<
+          | { textDelta: string; type: "text-delta" }
+          | { textDelta: string; type: "reasoning" }
+          | {
+              source: {
+                id: string;
+                providerOptions?: Record<string, Record<string, any>>;
+                sourceType: "url";
+                title?: string;
+                url: string;
+              };
+              type: "source";
+            }
+          | {
+              args: any;
+              providerOptions?: Record<string, Record<string, any>>;
+              toolCallId: string;
+              toolName: string;
+              type: "tool-call";
+            }
+          | {
+              toolCallId: string;
+              toolName: string;
+              type: "tool-call-streaming-start";
+            }
+          | {
+              argsTextDelta: string;
+              toolCallId: string;
+              toolName: string;
+              type: "tool-call-delta";
+            }
+          | {
+              args?: any;
+              experimental_content?: Array<
+                | { text: string; type: "text" }
+                | { data: string; mimeType?: string; type: "image" }
+              >;
+              isError?: boolean;
+              providerOptions?: Record<string, Record<string, any>>;
+              result: any;
+              toolCallId: string;
+              toolName: string;
+              type: "tool-result";
+            }
+        >;
+        start: number;
+        streamId: string;
+      },
+      null
+    >;
+    create: FunctionReference<
+      "mutation",
+      "public",
+      {
+        agentName?: string;
+        model?: string;
+        order: number;
+        provider?: string;
+        providerOptions?: Record<string, Record<string, any>>;
+        stepOrder: number;
+        threadId: string;
+        userId?: string;
+      },
+      string
+    >;
+    finish: FunctionReference<
+      "mutation",
+      "public",
+      {
+        finalDelta?: {
+          end: number;
+          parts: Array<
+            | { textDelta: string; type: "text-delta" }
+            | { textDelta: string; type: "reasoning" }
+            | {
+                source: {
+                  id: string;
+                  providerOptions?: Record<string, Record<string, any>>;
+                  sourceType: "url";
+                  title?: string;
+                  url: string;
+                };
+                type: "source";
+              }
+            | {
+                args: any;
+                providerOptions?: Record<string, Record<string, any>>;
+                toolCallId: string;
+                toolName: string;
+                type: "tool-call";
+              }
+            | {
+                toolCallId: string;
+                toolName: string;
+                type: "tool-call-streaming-start";
+              }
+            | {
+                argsTextDelta: string;
+                toolCallId: string;
+                toolName: string;
+                type: "tool-call-delta";
+              }
+            | {
+                args?: any;
+                experimental_content?: Array<
+                  | { text: string; type: "text" }
+                  | { data: string; mimeType?: string; type: "image" }
+                >;
+                isError?: boolean;
+                providerOptions?: Record<string, Record<string, any>>;
+                result: any;
+                toolCallId: string;
+                toolName: string;
+                type: "tool-result";
+              }
+          >;
+          start: number;
+          streamId: string;
+        };
+        streamId: string;
+      },
+      null
+    >;
+    list: FunctionReference<
+      "query",
+      "public",
+      { threadId: string },
+      Array<{
+        agentName?: string;
+        model?: string;
+        order: number;
+        provider?: string;
+        providerOptions?: Record<string, Record<string, any>>;
+        stepOrder: number;
+        streamId: string;
+        userId?: string;
+      }>
+    >;
+    listDeltas: FunctionReference<
+      "query",
+      "public",
+      {
+        cursors: Array<{ cursor: number; streamId: string }>;
+        threadId: string;
+      },
+      Array<{
+        end: number;
+        parts: Array<
+          | { textDelta: string; type: "text-delta" }
+          | { textDelta: string; type: "reasoning" }
+          | {
+              source: {
+                id: string;
+                providerOptions?: Record<string, Record<string, any>>;
+                sourceType: "url";
+                title?: string;
+                url: string;
+              };
+              type: "source";
+            }
+          | {
+              args: any;
+              providerOptions?: Record<string, Record<string, any>>;
+              toolCallId: string;
+              toolName: string;
+              type: "tool-call";
+            }
+          | {
+              toolCallId: string;
+              toolName: string;
+              type: "tool-call-streaming-start";
+            }
+          | {
+              argsTextDelta: string;
+              toolCallId: string;
+              toolName: string;
+              type: "tool-call-delta";
+            }
+          | {
+              args?: any;
+              experimental_content?: Array<
+                | { text: string; type: "text" }
+                | { data: string; mimeType?: string; type: "image" }
+              >;
+              isError?: boolean;
+              providerOptions?: Record<string, Record<string, any>>;
+              result: any;
+              toolCallId: string;
+              toolName: string;
+              type: "tool-result";
+            }
+        >;
+        start: number;
+        streamId: string;
+      }>
+    >;
+  };
   threads: {
     createThread: FunctionReference<
       "mutation",
@@ -1785,7 +1936,7 @@ export type Mounts = {
           maximumRowsRead?: number;
           numItems: number;
         };
-        userId: string;
+        userId?: string;
       },
       {
         continueCursor: string;

package/src/component/messages.ts

@@ -8,7 +8,7 @@ import {
   isTool,
 } from "../shared.js";
 import {
-  paginationResultValidator,
+  vPaginationResult,
   vMessageEmbeddings,
   vMessageStatus,
   vMessageWithMetadata,
@@ -180,11 +180,12 @@ async function addMessagesHandler(
         error: fail ? "Parent message failed" : undefined,
         stepOrder,
       });
-      if (!message.id) {
-        await ctx.db.patch(messageId, {
-          id: messageId,
-        });
-      }
+      // Let's just not set the id field and have it set only in explicit cases.
+      // if (!message.id) {
+      //   await ctx.db.patch(messageId, {
+      //     id: messageId,
+      //   });
+      // }
       for (const { fileId } of message.files ?? []) {
         if (!fileId) continue;
         await ctx.db.patch(fileId, {
@@ -214,7 +215,7 @@ function orderedMessagesStream(
 ) {
   return mergedStream(
     [true, false].flatMap((tool) =>
-      ["success" as const, "pending" as const].map((status) =>
+      messageStatuses.map((status) =>
         stream(ctx.db, schema)
           .query("messages")
           .withIndex("threadId_status_tool_order_stepOrder", (q) => {
@@ -244,7 +245,7 @@ const addStepArgs = {
 
 export const addStep = mutation({
   args: addStepArgs,
-  returns: v.array(v.doc("steps")),
+  returns: v.array(vMessageDoc),
   handler: addStepHandler,
 });
 async function addStepHandler(
@@ -279,7 +280,7 @@ async function addStepHandler(
     status: step.finishReason === "stop" ? "success" : "pending",
     step,
   });
-  await addMessagesHandler(ctx, {
+  const added = await addMessagesHandler(ctx, {
     userId: args.userId,
     threadId: args.threadId,
     stepId,
@@ -293,8 +294,7 @@ async function addStepHandler(
   if (step.finishReason === "stop") {
     await commitMessageHandler(ctx, { messageId: args.promptMessageId });
   }
-  steps.push((await ctx.db.get(stepId))!);
-  return steps;
+  return added.messages.map(publicMessage);
 }
 
 export const rollbackMessage = mutation({
@@ -388,7 +388,8 @@ export const listMessagesByThreadId = query({
     excludeToolMessages: v.optional(v.boolean()),
     /** @deprecated Use excludeToolMessages instead. */
     isTool: v.optional(v.literal("use excludeToolMessages instead of this")),
-    order: v.optional(v.union(v.literal("asc"), v.literal("desc"))),
+    /** What order to sort the messages in. To get the latest, use "desc". */
+    order: v.union(v.literal("asc"), v.literal("desc")),
     paginationOpts: v.optional(paginationOptsValidator),
     statuses: v.optional(v.array(vMessageStatus)),
     upToAndIncludingMessageId: v.optional(v.id("messages")),
@@ -439,7 +440,7 @@ export const listMessagesByThreadId = query({
     );
     return { ...messages, page: messages.page.map(publicMessage) };
   },
-  returns: paginationResultValidator(vMessageDoc),
+  returns: vPaginationResult(vMessageDoc),
 });
 
 /** @deprecated Use listMessagesByThreadId instead. */
@@ -448,7 +449,7 @@ export const getThreadMessages = query({
   handler: async () => {
     throw new Error("Use listMessagesByThreadId instead of getThreadMessages");
   },
-  returns: paginationResultValidator(vMessageDoc),
+  returns: vPaginationResult(vMessageDoc),
 });
 
 export const searchMessages = action({