@convex-dev/agent 0.1.18-alpha.0 → 0.5.0-alpha.1

package/src/client/streaming.ts

@@ -9,7 +9,7 @@ import type {
   StreamArgs,
   StreamDelta,
   StreamMessage,
-  TextStreamPart,
+  vTextStreamPartV5,
 } from "../validators.js";
 import type { MessageDoc } from "../component/schema.js";
 import type {
@@ -20,6 +20,7 @@ import type {
   SyncStreamsReturnValue,
 } from "./types.js";
 import { omit } from "convex-helpers";
+import type { Infer } from "convex/values";
 
 /**
  * A function that handles fetching stream deltas, used with the React hooks
@@ -158,7 +159,7 @@ export function mergeTransforms<TOOLS extends ToolSet>(
 export class DeltaStreamer {
   public streamId: string | undefined;
   public readonly options: Required<StreamingOptions>;
-  #nextParts: TextStreamPart[] = [];
+  #nextParts: Infer<typeof vTextStreamPartV5>[] = [];
   #nextOrder: number;
   #nextStepOrder: number;
   #latestWrite: number = 0;
@@ -205,7 +206,7 @@ export class DeltaStreamer {
       });
     }
   }
-  public async addParts(parts: TextStreamPart[]) {
+  public async addParts(parts: Infer<typeof vTextStreamPartV5>[]) {
     if (this.abortController.signal.aborted) {
       return;
     }

package/src/client/types.ts

@@ -1,5 +1,6 @@
+import type { LanguageModelV2 } from "@ai-sdk/provider";
 import type {
-  CoreMessage,
+  ModelMessage,
   DeepPartial,
   generateObject,
   GenerateObjectResult,
@@ -8,7 +9,6 @@ import type {
   JSONValue,
   LanguageModelRequestMetadata,
   LanguageModelResponseMetadata,
-  LanguageModelV1,
   RepairTextFunction,
   streamObject,
   StreamObjectResult,
@@ -17,6 +17,8 @@ import type {
   TelemetrySettings,
   ToolChoice,
   ToolSet,
+  Schema,
+  LanguageModelUsage,
 } from "ai";
 import type {
   Auth,
@@ -31,7 +33,7 @@ import type {
   GenericDataModel,
 } from "convex/server";
 import type { GenericId } from "convex/values";
-import type { Schema } from "zod";
+import type { z } from "zod";
 import type { Mounts } from "../component/_generated/api.js";
 import type { ThreadDoc } from "../component/schema.js";
 import type {
@@ -40,7 +42,6 @@ import type {
   ProviderOptions,
   StreamDelta,
   StreamMessage,
-  Usage,
 } from "../validators.js";
 import type { StreamingOptions } from "./streaming.js";
 
@@ -122,7 +123,7 @@ export type UsageHandler = (
     userId: string | undefined;
     threadId: string | undefined;
     agentName: string | undefined;
-    usage: Usage;
+    usage: LanguageModelUsage;
     // Often has more information, like cached token usage in the case of openai.
     providerMetadata: ProviderMetadata | undefined;
     model: string;
@@ -169,7 +170,7 @@ export type TextArgs<
    * The model to use for the LLM calls. This will override the model specified
    * in the Agent constructor.
    */
-  model?: LanguageModelV1;
+  model?: LanguageModelV2;
   /**
    * The tools to use for the tool calls. This will override tools specified
    * in the Agent constructor or createThread / continueThread.
@@ -208,7 +209,7 @@ export type StreamingTextArgs<
    * The model to use for the tool calls. This will override the model specified
    * in the Agent constructor.
    */
-  model?: LanguageModelV1;
+  model?: LanguageModelV2;
   /**
    * The tools to use for the tool calls. This will override tools specified
    * in the Agent constructor or createThread / continueThread.
@@ -226,7 +227,7 @@ type BaseGenerateObjectOptions = CallSettings & {
    * The model to use for the object generation. This will override the model
    * specified in the Agent constructor.
    */
-  model?: LanguageModelV1;
+  model?: LanguageModelV2;
   /**
    * The system prompt to use for the object generation. This will override the
    * system prompt specified in the Agent constructor.
@@ -236,13 +237,13 @@ type BaseGenerateObjectOptions = CallSettings & {
    * The prompt to the LLM to use for the object generation.
    * Specify this or messages, but not both.
    */
-  prompt?: string;
+  prompt?: string | Array<ModelMessage>;
   /**
    * The messages to use for the object generation.
    * Note: recent messages are automatically added based on the thread it's
    * associated with and your contextOptions.
    */
-  messages?: CoreMessage[];
+  messages?: Array<ModelMessage>;
   /**
    * The message to use as the "prompt" for the object generation.
    * If this is provided, it will be used instead of the prompt or messages.
@@ -256,52 +257,28 @@ type BaseGenerateObjectOptions = CallSettings & {
   experimental_providerMetadata?: ProviderMetadata;
 };
 
-type GenerateObjectObjectOptions<T extends Record<string, unknown>> =
-  BaseGenerateObjectOptions & {
-    output?: "object";
-    mode?: "auto" | "json" | "tool";
-    schema: Schema<T>;
-    schemaName?: string;
-    schemaDescription?: string;
-  };
-
-type GenerateObjectArrayOptions<T> = BaseGenerateObjectOptions & {
-  output: "array";
-  mode?: "auto" | "json" | "tool";
-  schema: Schema<T>;
+type StandardGenerateObjectOptions<T> = {
+  schema: z.Schema<T>;
   schemaName?: string;
   schemaDescription?: string;
-};
-
-type GenerateObjectWithEnumOptions<T extends string> =
-  BaseGenerateObjectOptions & {
-    output: "enum";
-    enum: Array<T>;
-    mode?: "auto" | "json" | "tool";
-  };
-
-type GenerateObjectNoSchemaOptions = BaseGenerateObjectOptions & {
-  schema?: undefined;
-  mode?: "json";
+  output?: "object" | "array";
+  mode?: "auto" | "json" | "tool";
 };
 
 // TODO: simplify this to just use the generateObject args, with an optional
 // model and tool/toolChoice types
-type GenerateObjectArgs<T> =
-  T extends Record<string, unknown>
-    ? GenerateObjectObjectOptions<T>
-    : T extends Array<unknown>
-      ? GenerateObjectArrayOptions<T>
-      : T extends string
-        ? GenerateObjectWithEnumOptions<T>
-        : GenerateObjectNoSchemaOptions;
+type GenerateObjectArgs<T> = BaseGenerateObjectOptions &
+  (
+    | StandardGenerateObjectOptions<T>
+    | { output: "enum"; enum: Array<T>; mode?: "auto" | "json" | "tool" }
+    | { output: "any"; schema: undefined; mode: "json" }
+  );
 
-type StreamObjectArgs<T> =
-  T extends Record<string, unknown>
-    ? GenerateObjectObjectOptions<T>
-    : T extends Array<unknown>
-      ? GenerateObjectArrayOptions<T>
-      : GenerateObjectNoSchemaOptions;
+type StreamObjectArgs<T> = BaseGenerateObjectOptions &
+  (
+    | StandardGenerateObjectOptions<T>
+    | { output: "any"; schema: undefined; mode: "json" }
+  );
 
 export type OurObjectArgs<T> = GenerateObjectArgs<T> &
   Pick<
@@ -310,11 +287,12 @@ export type OurObjectArgs<T> = GenerateObjectArgs<T> &
     "experimental_repairText" | "abortSignal"
   >;
 
-export type OurStreamObjectArgs<T> = StreamObjectArgs<T> &
-  Pick<
-    Parameters<typeof streamObject<T>>[0],
-    "onError" | "onFinish" | "abortSignal"
-  >;
+export type OurStreamObjectArgs<T extends Schema | z.Schema> =
+  StreamObjectArgs<T> &
+    Pick<
+      Parameters<typeof streamObject<T>>[0],
+      "onError" | "onFinish" | "abortSignal"
+    >;
 
 type ThreadOutputMetadata = Required<GenerationOutputMetadata>;
 
@@ -415,24 +393,10 @@ export interface Thread<DefaultTools extends ToolSet> {
    * for the {@link ContextOptions} and {@link StorageOptions}.
    * @returns The result of the generateObject function.
    */
-  generateObject<T>(
+  generateObject<T = JSONValue>(
     args: OurObjectArgs<T>,
     options?: Options,
   ): Promise<GenerateObjectResult<T> & ThreadOutputMetadata>;
-  /**
-   * This behaves like {@link generateObject} from the "ai" package except that
-   * it add context based on the userId and threadId and saves the input and
-   * resulting messages to the thread, if specified. This overload is for when there's no schema.
-   * Use {@link continueThread} to get a version of this function already scoped
-   * to a thread (and optionally userId).
-   * @param args The arguments to the generateObject function, along with extra controls
-   * for the {@link ContextOptions} and {@link StorageOptions}.
-   * @returns The result of the generateObject function.
-   */
-  generateObject(
-    args: GenerateObjectNoSchemaOptions,
-    options?: Options,
-  ): Promise<GenerateObjectResult<JSONValue> & ThreadOutputMetadata>;
   /**
    * This behaves like {@link streamObject} from the "ai" package except that
    * it add context based on the userId and threadId and saves the input and
@@ -443,7 +407,7 @@ export interface Thread<DefaultTools extends ToolSet> {
    * for the {@link ContextOptions} and {@link StorageOptions}.
    * @returns The result of the streamObject function.
    */
-  streamObject<T>(
+  streamObject<T extends z.Schema | Schema>(
     args: OurStreamObjectArgs<T>,
     options?: Options,
   ): Promise<