@convex-dev/agent 0.3.2 → 0.6.0-alpha.0

package/src/client/streamText.ts

@@ -17,6 +17,7 @@ import type {
   AgentPrompt,
   GenerationOutputMetadata,
   Options,
+  Output,
 } from "./types.js";
 import { startGeneration } from "./start.js";
 import type { Agent } from "./index.js";
@@ -32,8 +33,7 @@ import { errorToString, willContinue } from "./utils.js";
  */
 export async function streamText<
   TOOLS extends ToolSet,
-  OUTPUT = never,
-  PARTIAL_OUTPUT = never,
+  OUTPUT extends Output<any, any, any> = never,
 >(
   ctx: ActionCtx,
   component: AgentComponent,
@@ -43,7 +43,7 @@ export async function streamText<
    */
   streamTextArgs: AgentPrompt &
     Omit<
-      Parameters<typeof streamTextAi<TOOLS, OUTPUT, PARTIAL_OUTPUT>>[0],
+      Parameters<typeof streamTextAi<TOOLS, OUTPUT>>[0],
       "model" | "prompt" | "messages"
     > & {
       /**
@@ -73,7 +73,7 @@ export async function streamText<
     saveStreamDeltas?: boolean | StreamingOptions;
     agentForToolCtx?: Agent;
   },
-): Promise<StreamTextResult<TOOLS, PARTIAL_OUTPUT> & GenerationOutputMetadata> {
+): Promise<StreamTextResult<TOOLS, OUTPUT> & GenerationOutputMetadata> {
   const { threadId } = options ?? {};
   const { args, userId, order, stepOrder, promptMessageId, ...call } =
     await startGeneration(ctx, component, streamTextArgs, options);
@@ -141,7 +141,7 @@ export async function streamText<
       await call.save({ step }, createPendingMessage);
       return args.onStepFinish?.(step);
     },
-  }) as StreamTextResult<TOOLS, PARTIAL_OUTPUT>;
+  }) as StreamTextResult<TOOLS, OUTPUT>;
   const stream = streamer?.consumeStream(
     result.toUIMessageStream<AIUIMessage<TOOLS>>(),
   );

package/src/client/types.ts

@@ -21,6 +21,14 @@ import type {
   CallSettings,
   generateObject,
 } from "ai";
+
+export interface Output<_T = any, _P = any, _E = any> {
+  name: string;
+  responseFormat: any;
+  parseCompleteOutput: any;
+  parsePartialOutput: any;
+  createElementStreamTransform: any;
+}
 import type {
   GenericActionCtx,
   GenericDataModel,
@@ -99,8 +107,21 @@ export type Config = {
    * const myAgent = new Agent(components.agent, {
    *   ...
    *   textEmbeddingModel: openai.embedding("text-embedding-3-small")
+   * @deprecated — Use embeddingModel instead.
+   */
+  textEmbeddingModel?: EmbeddingModel;
+  /**
+   * The model to use for text embeddings. Optional.
+   * If specified, it will use this for generating vector embeddings
+   * of chats, and can opt-in to doing vector search for automatic context
+   * on generateText, etc.
+   * e.g.
+   * import { openai } from "@ai-sdk/openai"
+   * const myAgent = new Agent(components.agent, {
+   *   ...
+   *   embeddingModel: openai.embedding("text-embedding-3-small")
    */
-  textEmbeddingModel?: EmbeddingModel<string>;
+  embeddingModel?: EmbeddingModel;
   /**
    * Options to determine what messages are included as context in message
    * generation. To disable any messages automatically being added, pass:
@@ -330,14 +351,12 @@ export type AgentComponent = ComponentApi;
 export type TextArgs<
   AgentTools extends ToolSet,
   TOOLS extends ToolSet | undefined = undefined,
-  OUTPUT = never,
-  OUTPUT_PARTIAL = never,
+  OUTPUT extends Output<any, any, any> = never,
 > = Omit<
   Parameters<
     typeof generateText<
       TOOLS extends undefined ? AgentTools : TOOLS,
-      OUTPUT,
-      OUTPUT_PARTIAL
+      OUTPUT
     >
   >[0],
   "model" | "prompt" | "messages"
@@ -352,14 +371,12 @@ export type TextArgs<
 export type StreamingTextArgs<
   AgentTools extends ToolSet,
   TOOLS extends ToolSet | undefined = undefined,
-  OUTPUT = never,
-  OUTPUT_PARTIAL = never,
+  OUTPUT extends Output<any, any, any> = never,
 > = Omit<
   Parameters<
     typeof streamText<
       TOOLS extends undefined ? AgentTools : TOOLS,
-      OUTPUT,
-      OUTPUT_PARTIAL
+      OUTPUT
     >
   >[0],
   "model" | "prompt" | "messages"
@@ -474,15 +491,13 @@ export interface Thread<DefaultTools extends ToolSet> {
    */
   generateText<
     TOOLS extends ToolSet | undefined = undefined,
-    OUTPUT = never,
-    OUTPUT_PARTIAL = never,
+    OUTPUT extends Output<any, any, any> = never,
   >(
     generateTextArgs: AgentPrompt &
       TextArgs<
         TOOLS extends undefined ? DefaultTools : TOOLS,
         TOOLS,
-        OUTPUT,
-        OUTPUT_PARTIAL
+        OUTPUT
       >,
     options?: Options,
   ): Promise<
@@ -502,15 +517,13 @@ export interface Thread<DefaultTools extends ToolSet> {
    */
   streamText<
     TOOLS extends ToolSet | undefined = undefined,
-    OUTPUT = never,
-    PARTIAL_OUTPUT = never,
+    OUTPUT extends Output<any, any, any> = never,
   >(
     streamTextArgs: AgentPrompt &
       StreamingTextArgs<
         TOOLS extends undefined ? DefaultTools : TOOLS,
         TOOLS,
-        OUTPUT,
-        PARTIAL_OUTPUT
+        OUTPUT
       >,
     options?: Options & {
       /**
@@ -528,7 +541,7 @@ export interface Thread<DefaultTools extends ToolSet> {
   ): Promise<
     StreamTextResult<
       TOOLS extends undefined ? DefaultTools : TOOLS,
-      PARTIAL_OUTPUT
+      OUTPUT
     > &
       ThreadOutputMetadata
   >;