@convex-dev/agent 0.1.6 → 0.1.7-alpha.1

package/src/client/setup.test.ts

@@ -0,0 +1,29 @@
+/// <reference types="vite/client" />
+import { test } from "vitest";
+import { convexTest } from "convex-test";
+export const modules = import.meta.glob("./**/*.*s");
+
+import componentSchema from "../component/schema";
+import {
+  defineSchema,
+  type GenericSchema,
+  type SchemaDefinition,
+} from "convex/server";
+import { type AgentComponent } from ".";
+import { componentsGeneric } from "convex/server";
+export { componentSchema };
+export const componentModules = import.meta.glob("../component/**/*.ts");
+
+export function initConvexTest<
+  Schema extends SchemaDefinition<GenericSchema, boolean>,
+>(schema?: Schema) {
+  console.log({ modules });
+  const t = convexTest(schema ?? defineSchema({}), modules);
+  t.registerComponent("agent", componentSchema, componentModules);
+  return t;
+}
+export const components = componentsGeneric() as unknown as {
+  agent: AgentComponent;
+};
+
+test("setup", () => {});

package/src/client/types.ts

@@ -6,6 +6,8 @@ import type {
   generateText,
   GenerateTextResult,
   JSONValue,
+  LanguageModelRequestMetadata,
+  LanguageModelResponseMetadata,
   LanguageModelV1,
   RepairTextFunction,
   streamObject,
@@ -23,6 +25,8 @@ import type {
   GenericDataModel,
   GenericMutationCtx,
   GenericQueryCtx,
+  StorageActionWriter,
+  StorageReader,
   WithoutSystemFields,
 } from "convex/server";
 import type { GenericId } from "convex/values";
@@ -96,14 +100,31 @@ export type ContextOptions = {
  */
 export type StorageOptions = {
   /**
+   * Whether to save messages to the thread history.
+   * Pass "all" to save all input and output messages.
+   * Pass "none" to not save any input or output messages.
+   * Pass "promptAndOutput" to save the prompt and all output messages.
+   * If you pass {messages} but no {prompt}, it will assume messages.at(-1) is
+   * the prompt.
+   * Defaults to "promptAndOutput".
+   */
+  saveMessages?: "all" | "none" | "promptAndOutput";
+  /**
+   * @deprecated Use saveMessages instead.
    * Defaults to false, allowing you to pass in arbitrary context that will
    * be in addition to automatically fetched content.
    * Pass true to have all input messages saved to the thread history.
    */
   saveAllInputMessages?: boolean;
-  /** Defaults to true, saving the prompt, or last message passed to generateText. */
+  /**
+   * @deprecated Use saveMessages instead.
+   * Defaults to true, saving the prompt, or last message passed to generateText.
+   */
   saveAnyInputMessages?: boolean;
-  /** Defaults to true. Whether to save messages generated while chatting. */
+  /**
+   * @deprecated Use saveMessages instead.
+   * Defaults to true. Whether to save messages generated while chatting.
+   */
   saveOutputMessages?: boolean;
 };
 
@@ -123,6 +144,17 @@ export type UsageHandler = (
   }
 ) => void | Promise<void>;
 
+export type RawRequestResponseHandler = (
+  ctx: RunActionCtx,
+  args: {
+    userId: string | undefined;
+    threadId: string | undefined;
+    agentName: string | undefined;
+    request: LanguageModelRequestMetadata;
+    response: LanguageModelResponseMetadata;
+  }
+) => void | Promise<void>;
+
 export type AgentComponent = UseApi<Mounts>;
 
 export type TextArgs<
@@ -148,7 +180,7 @@ export type TextArgs<
    */
   promptMessageId?: string;
   /**
-   * The model to use for the tool calls. This will override the model specified
+   * The model to use for the LLM calls. This will override the model specified
    * in the Agent constructor.
    */
   model?: LanguageModelV1;
@@ -464,6 +496,12 @@ export type RunActionCtx = {
   runMutation: GenericActionCtx<GenericDataModel>["runMutation"];
   runAction: GenericActionCtx<GenericDataModel>["runAction"];
 };
+export type ActionCtx = RunActionCtx & {
+  storage: StorageActionWriter;
+};
+export type QueryCtx = RunQueryCtx & {
+  storage: StorageReader;
+};
 
 export type OpaqueIds<T> =
   T extends GenericId<infer _T>