@convex-dev/agent 0.1.5-alpha.2 → 0.1.5

package/src/client/index.ts

@@ -16,6 +16,7 @@ import {
   internalMutationGeneric,
   type PaginationOptions,
   type PaginationResult,
+  type WithoutSystemFields,
 } from "convex/server";
 import { v } from "convex/values";
 import type { MessageDoc, ThreadDoc } from "../component/schema.js";
@@ -323,6 +324,14 @@ export class Agent<AgentTools extends ToolSet> {
     return {
       thread: {
         threadId: args.threadId,
+        getMetadata: this.getThreadMetadata.bind(this, ctx, {
+          threadId: args.threadId,
+        }),
+        updateMetadata: (patch: Partial<WithoutSystemFields<ThreadDoc>>) =>
+          ctx.runMutation(this.component.threads.updateThread, {
+            threadId: args.threadId,
+            patch,
+          }),
         generateText: this.generateText.bind(this, ctx, args),
         streamText: this.streamText.bind(this, ctx, args),
         generateObject: this.generateObject.bind(this, ctx, args),
@@ -331,6 +340,43 @@ export class Agent<AgentTools extends ToolSet> {
     };
   }
 
+  /**
+   * Get the metadata for a thread.
+   * @param ctx A ctx object from a query, mutation, or action.
+   * @param args.threadId The thread to get the metadata for.
+   * @returns The metadata for the thread.
+   */
+  async getThreadMetadata(
+    ctx: RunQueryCtx,
+    args: { threadId: string }
+  ): Promise<ThreadDoc> {
+    const thread = await ctx.runQuery(this.component.threads.getThread, {
+      threadId: args.threadId,
+    });
+    if (!thread) {
+      throw new Error("Thread not found");
+    }
+    return thread;
+  }
+
+  /**
+   * Update the metadata for a thread.
+   * @param ctx A ctx object from a mutation or action.
+   * @param args.threadId The thread to update the metadata for.
+   * @param args.patch The patch to apply to the thread.
+   * @returns The updated thread metadata.
+   */
+  async updateThreadMetadata(
+    ctx: RunMutationCtx,
+    args: { threadId: string; patch: Partial<WithoutSystemFields<ThreadDoc>> }
+  ): Promise<ThreadDoc> {
+    const thread = await ctx.runMutation(
+      this.component.threads.updateThread,
+      args
+    );
+    return thread;
+  }
+
   /**
    * List messages from a thread.
    * @param ctx A ctx object from a query, mutation, or action.
@@ -711,9 +757,11 @@ export class Agent<AgentTools extends ToolSet> {
     if (args.skipEmbeddings || !("runAction" in ctx)) {
       embeddings = undefined;
       if (!args.skipEmbeddings && this.options.textEmbedding) {
-        throw new Error(
-          "You're trying to save messages and generate embeddings, but you're in a mutation. Pass `skipEmbeddings: true` to skip generating embeddings in the mutation. " +
-            "You can generate them asynchronously by using the scheduler to run an action later that calls `agent.generateAndSaveEmbeddings`."
+        console.warn(
+          "You're trying to save messages and generate embeddings, but you're in a mutation. " +
+            "Pass `skipEmbeddings: true` to skip generating embeddings in the mutation and skip this warning. " +
+            "They will be generated lazily when you generate or stream text / objects. " +
+            "You can explicitly generate them asynchronously by using the scheduler to run an action later that calls `agent.generateAndSaveEmbeddings`."
         );
       }
     } else {
@@ -1110,7 +1158,7 @@ export class Agent<AgentTools extends ToolSet> {
       maxRetries?: number;
     },
   >(
-    ctx: RunActionCtx | RunMutationCtx,
+    ctx: RunActionCtx,
     args: T,
     {
       userId: argsUserId,
@@ -1151,6 +1199,18 @@ export class Agent<AgentTools extends ToolSet> {
       messages,
       contextOptions,
     });
+    // Lazily generate embeddings for the prompt message, if it doesn't have
+    // embeddings yet. This can happen if the message was saved in a mutation
+    // where the LLM is not available.
+    if (
+      args.promptMessageId &&
+      !contextMessages.at(-1)?.embeddingId &&
+      this.options.textEmbedding
+    ) {
+      await this.generateAndSaveEmbeddings(ctx, {
+        messageIds: [args.promptMessageId],
+      });
+    }
     let messageId = args.promptMessageId;
     let order = args.promptMessageId
       ? contextMessages.at(-1)?.order

package/src/client/types.ts

@@ -1,23 +1,21 @@
 import type {
   CoreMessage,
   DeepPartial,
+  generateObject,
   GenerateObjectResult,
+  generateText,
   GenerateTextResult,
   JSONValue,
+  LanguageModelV1,
   RepairTextFunction,
+  streamObject,
   StreamObjectResult,
+  streamText,
   StreamTextResult,
   TelemetrySettings,
   ToolChoice,
   ToolSet,
 } from "ai";
-import type {
-  generateObject,
-  generateText,
-  LanguageModelV1,
-  streamObject,
-  streamText,
-} from "ai";
 import type {
   Expand,
   FunctionReference,
@@ -25,8 +23,12 @@ import type {
   GenericDataModel,
   GenericMutationCtx,
   GenericQueryCtx,
+  WithoutSystemFields,
 } from "convex/server";
 import type { GenericId } from "convex/values";
+import type { Schema } from "zod";
+import type { Mounts } from "../component/_generated/api.js";
+import type { ThreadDoc } from "../component/schema.js";
 import type {
   CallSettings,
   ProviderMetadata,
@@ -35,8 +37,6 @@ import type {
   StreamMessage,
   Usage,
 } from "../validators.js";
-import type { Mounts } from "../component/_generated/api.js";
-import type { Schema } from "zod";
 import type { StreamingOptions } from "./streaming.js";
 
 /**
@@ -311,6 +311,16 @@ export interface Thread<DefaultTools extends ToolSet> {
    * The target threadId, from the startThread or continueThread initializers.
    */
   threadId: string;
+  /**
+   * Get the metadata for the thread.
+   */
+  getMetadata: () => Promise<ThreadDoc>;
+  /**
+   * Update the metadata for the thread.
+   */
+  updateMetadata: (
+    patch: Partial<WithoutSystemFields<ThreadDoc>>
+  ) => Promise<ThreadDoc>;
   /**
    * This behaves like {@link generateText} from the "ai" package except that
    * it add context based on the userId and threadId and saves the input and

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

@@ -143,6 +143,7 @@ export type Mounts = {
                         }
                       | {
                           data: string | ArrayBuffer;
+                          filename?: string;
                           mimeType: string;
                           providerOptions?: Record<string, Record<string, any>>;
                           type: "file";
@@ -162,6 +163,7 @@ export type Mounts = {
                         }
                       | {
                           data: string | ArrayBuffer;
+                          filename?: string;
                           mimeType: string;
                           providerOptions?: Record<string, Record<string, any>>;
                           type: "file";
@@ -283,6 +285,7 @@ export type Mounts = {
                         }
                       | {
                           data: string | ArrayBuffer;
+                          filename?: string;
                           mimeType: string;
                           providerOptions?: Record<string, Record<string, any>>;
                           type: "file";
@@ -302,6 +305,7 @@ export type Mounts = {
                         }
                       | {
                           data: string | ArrayBuffer;
+                          filename?: string;
                           mimeType: string;
                           providerOptions?: Record<string, Record<string, any>>;
                           type: "file";
@@ -423,6 +427,7 @@ export type Mounts = {
                         }
                       | {
                           data: string | ArrayBuffer;
+                          filename?: string;
                           mimeType: string;
                           providerOptions?: Record<string, Record<string, any>>;
                           type: "file";
@@ -442,6 +447,7 @@ export type Mounts = {
                         }
                       | {
                           data: string | ArrayBuffer;
+                          filename?: string;
                           mimeType: string;
                           providerOptions?: Record<string, Record<string, any>>;
                           type: "file";
@@ -589,6 +595,7 @@ export type Mounts = {
                           }
                         | {
                             data: string | ArrayBuffer;
+                            filename?: string;
                             mimeType: string;
                             providerOptions?: Record<
                               string,
@@ -614,6 +621,7 @@ export type Mounts = {
                           }
                         | {
                             data: string | ArrayBuffer;
+                            filename?: string;
                             mimeType: string;
                             providerOptions?: Record<
                               string,
@@ -761,6 +769,7 @@ export type Mounts = {
                               }
                             | {
                                 data: string | ArrayBuffer;
+                                filename?: string;
                                 mimeType: string;
                                 providerOptions?: Record<
                                   string,
@@ -786,6 +795,7 @@ export type Mounts = {
                               }
                             | {
                                 data: string | ArrayBuffer;
+                                filename?: string;
                                 mimeType: string;
                                 providerOptions?: Record<
                                   string,
@@ -937,6 +947,7 @@ export type Mounts = {
                       }
                     | {
                         data: string | ArrayBuffer;
+                        filename?: string;
                         mimeType: string;
                         providerOptions?: Record<string, Record<string, any>>;
                         type: "file";
@@ -956,6 +967,7 @@ export type Mounts = {
                       }
                     | {
                         data: string | ArrayBuffer;
+                        filename?: string;
                         mimeType: string;
                         providerOptions?: Record<string, Record<string, any>>;
                         type: "file";
@@ -1088,6 +1100,7 @@ export type Mounts = {
                       }
                     | {
                         data: string | ArrayBuffer;
+                        filename?: string;
                         mimeType: string;
                         providerOptions?: Record<string, Record<string, any>>;
                         type: "file";
@@ -1107,6 +1120,7 @@ export type Mounts = {
                       }
                     | {
                         data: string | ArrayBuffer;
+                        filename?: string;
                         mimeType: string;
                         providerOptions?: Record<string, Record<string, any>>;
                         type: "file";
@@ -1236,6 +1250,7 @@ export type Mounts = {
                         }
                       | {
                           data: string | ArrayBuffer;
+                          filename?: string;
                           mimeType: string;
                           providerOptions?: Record<string, Record<string, any>>;
                           type: "file";
@@ -1255,6 +1270,7 @@ export type Mounts = {
                         }
                       | {
                           data: string | ArrayBuffer;
+                          filename?: string;
                           mimeType: string;
                           providerOptions?: Record<string, Record<string, any>>;
                           type: "file";
@@ -1402,6 +1418,7 @@ export type Mounts = {
                         }
                       | {
                           data: string | ArrayBuffer;
+                          filename?: string;
                           mimeType: string;
                           providerOptions?: Record<string, Record<string, any>>;
                           type: "file";
@@ -1421,6 +1438,7 @@ export type Mounts = {
                         }
                       | {
                           data: string | ArrayBuffer;
+                          filename?: string;
                           mimeType: string;
                           providerOptions?: Record<string, Record<string, any>>;
                           type: "file";
@@ -1566,6 +1584,7 @@ export type Mounts = {
                       }
                     | {
                         data: string | ArrayBuffer;
+                        filename?: string;
                         mimeType: string;
                         providerOptions?: Record<string, Record<string, any>>;
                         type: "file";
@@ -1585,6 +1604,7 @@ export type Mounts = {
                       }
                     | {
                         data: string | ArrayBuffer;
+                        filename?: string;
                         mimeType: string;
                         providerOptions?: Record<string, Record<string, any>>;
                         type: "file";
@@ -1717,6 +1737,7 @@ export type Mounts = {
                       }
                     | {
                         data: string | ArrayBuffer;
+                        filename?: string;
                         mimeType: string;
                         providerOptions?: Record<string, Record<string, any>>;
                         type: "file";
@@ -1736,6 +1757,7 @@ export type Mounts = {
                       }
                     | {
                         data: string | ArrayBuffer;
+                        filename?: string;
                         mimeType: string;
                         providerOptions?: Record<string, Record<string, any>>;
                         type: "file";

package/src/react/types.ts

@@ -5,9 +5,9 @@ import type {
   PaginationOptions,
   PaginationResult,
 } from "convex/server";
-import type { MessageDoc } from "../client";
-import type { SyncStreamsReturnValue } from "../client/types";
-import type { StreamArgs } from "../validators";
+import type { MessageDoc } from "../client/index.js";
+import type { SyncStreamsReturnValue } from "../client/types.js";
+import type { StreamArgs } from "../validators.js";
 
 export type ThreadQuery<
   Args = unknown,

package/src/react/useSmoothText.ts

@@ -47,6 +47,10 @@ export function useSmoothText(
       (2 * latestCharsPerMs + smoothState.current.charsPerMs) / 3,
       smoothState.current.charsPerMs * 2
     );
+    smoothState.current.tick = Math.max(
+      smoothState.current.tick,
+      Date.now() - 2 * MS_PER_FRAME
+    );
 
     function update() {
       if (smoothState.current.cursor >= text.length) {

package/src/validators.ts

@@ -54,6 +54,7 @@ export const vImagePart = v.object({
 export const vFilePart = v.object({
   type: v.literal("file"),
   data: v.union(v.string(), v.bytes()),
+  filename: v.optional(v.string()),
   mimeType: v.string(),
   providerOptions,
 });