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

package/dist/esm/client/streaming.js

@@ -0,0 +1,121 @@
+import { smoothStream } from "ai";
+export const DEFAULT_STREAMING_OPTIONS = {
+    chunking: "word",
+    throttleMs: 250,
+};
+export function mergeTransforms(options, existing) {
+    if (!options) {
+        return existing;
+    }
+    const chunking = typeof options === "boolean"
+        ? DEFAULT_STREAMING_OPTIONS.chunking
+        : options.chunking;
+    const transforms = Array.isArray(existing)
+        ? existing
+        : existing
+            ? [existing]
+            : [];
+    transforms.push(smoothStream({ delayInMs: null, chunking }));
+    return transforms;
+}
+export class DeltaStreamer {
+    component;
+    ctx;
+    metadata;
+    streamId;
+    options;
+    #nextParts = [];
+    #nextOrder;
+    #nextStepOrder;
+    #latestWrite = 0;
+    #ongoingWrite;
+    #cursor = 0;
+    constructor(component, ctx, options, metadata) {
+        this.component = component;
+        this.ctx = ctx;
+        this.metadata = metadata;
+        this.options =
+            typeof options === "boolean"
+                ? DEFAULT_STREAMING_OPTIONS
+                : {
+                    ...DEFAULT_STREAMING_OPTIONS,
+                    ...options,
+                };
+        this.metadata = metadata;
+        this.#nextParts = [];
+        this.#nextOrder = metadata.order ?? 0;
+        this.#nextStepOrder = (metadata.stepOrder ?? 0) + 1;
+    }
+    async addParts(parts) {
+        if (!this.streamId) {
+            this.streamId = await this.ctx.runMutation(this.component.streams.create, {
+                ...this.metadata,
+                order: this.#nextOrder,
+                stepOrder: this.#nextStepOrder,
+            });
+        }
+        this.#nextParts.push(...parts);
+        if (!this.#ongoingWrite &&
+            Date.now() - this.#latestWrite >= this.options.throttleMs) {
+            this.#ongoingWrite = this.#sendDelta();
+        }
+    }
+    async #sendDelta() {
+        const delta = this.#createDelta();
+        this.#latestWrite = Date.now();
+        await this.ctx.runMutation(this.component.streams.addDelta, delta);
+        // Now that we've sent the delta, check if we need to send another one.
+        if (this.#nextParts.length > 0 &&
+            Date.now() - this.#latestWrite >= this.options.throttleMs) {
+            // We send again immediately with the accumulated deltas.
+            this.#ongoingWrite = this.#sendDelta();
+            console.debug("Sent delta immediately");
+        }
+        else {
+            this.#ongoingWrite = undefined;
+        }
+    }
+    #createDelta() {
+        const start = this.#cursor;
+        const end = start + this.#nextParts.length;
+        this.#cursor = end;
+        const parts = this.#nextParts;
+        this.#nextParts = [];
+        if (!this.streamId) {
+            throw new Error("Creating a delta before the stream is created");
+        }
+        return {
+            streamId: this.streamId,
+            start,
+            end,
+            parts,
+        };
+    }
+    async finish(messages) {
+        if (this.#ongoingWrite) {
+            await this.#ongoingWrite;
+            this.#ongoingWrite = undefined;
+        }
+        if (!this.streamId) {
+            throw new Error("Finish called before stream is created");
+        }
+        const lastMessage = messages.at(-1);
+        if (lastMessage) {
+            this.#nextOrder = lastMessage.order;
+            this.#nextStepOrder = lastMessage.stepOrder + 1;
+        }
+        else {
+            console.warn("Step finished without generating a message");
+        }
+        const finalDelta = this.#nextParts.length > 0 ? this.#createDelta() : undefined;
+        this.#nextParts = [];
+        const streamId = this.streamId;
+        this.streamId = undefined;
+        this.#cursor = 0;
+        await this.ctx.runMutation(this.component.streams.finish, {
+            streamId,
+            finalDelta,
+        });
+    }
+}
+//# sourceMappingURL=streaming.js.map

package/dist/esm/client/streaming.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.js","sourceRoot":"","sources":["../../../src/client/streaming.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,YAAY,EAAgC,MAAM,IAAI,CAAC;AAoB/E,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,QAAQ,EAAE,MAAM;IAChB,UAAU,EAAE,GAAG;CACW,CAAC;AAE7B,MAAM,UAAU,eAAe,CAC7B,OAA+C,EAC/C,QAGa;IAEb,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GACZ,OAAO,OAAO,KAAK,SAAS;QAC1B,CAAC,CAAC,yBAAyB,CAAC,QAAQ;QACpC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACvB,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;QACxC,CAAC,CAAC,QAAQ;QACV,CAAC,CAAC,QAAQ;YACR,CAAC,CAAC,CAAC,QAAQ,CAAC;YACZ,CAAC,CAAC,EAAE,CAAC;IACT,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC7D,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,OAAO,aAAa;IAWN;IACA;IAEA;IAbX,QAAQ,CAAqB;IACpB,OAAO,CAA6B;IACpD,UAAU,GAAqB,EAAE,CAAC;IAClC,UAAU,CAAS;IACnB,cAAc,CAAS;IACvB,YAAY,GAAW,CAAC,CAAC;IACzB,aAAa,CAA4B;IACzC,OAAO,GAAW,CAAC,CAAC;IAEpB,YACkB,SAAyB,EACzB,GAAiB,EACjC,OAAgC,EAChB,QASf;QAZe,cAAS,GAAT,SAAS,CAAgB;QACzB,QAAG,GAAH,GAAG,CAAc;QAEjB,aAAQ,GAAR,QAAQ,CASvB;QAED,IAAI,CAAC,OAAO;YACV,OAAO,OAAO,KAAK,SAAS;gBAC1B,CAAC,CAAC,yBAAyB;gBAC3B,CAAC,CAAC;oBACE,GAAG,yBAAyB;oBAC5B,GAAG,OAAO;iBACX,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,KAAK,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACtD,CAAC;IACM,KAAK,CAAC,QAAQ,CAAC,KAAuB;QAC3C,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CACxC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAC7B;gBACE,GAAG,IAAI,CAAC,QAAQ;gBAChB,KAAK,EAAE,IAAI,CAAC,UAAU;gBACtB,SAAS,EAAE,IAAI,CAAC,cAAc;aAC/B,CACF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC/B,IACE,CAAC,IAAI,CAAC,aAAa;YACnB,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EACzD,CAAC;YACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACzC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAClC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC/B,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACnE,uEAAuE;QACvE,IACE,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;YAC1B,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EACzD,CAAC;YACD,yDAAyD;YACzD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YACvC,OAAO,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QACjC,CAAC;IACH,CAAC;IAED,YAAY;QACV,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3B,MAAM,GAAG,GAAG,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACnB,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QACD,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK;YACL,GAAG;YACH,KAAK;SACN,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,QAAsB;QACxC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,aAAa,CAAC;YACzB,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QACD,MAAM,WAAW,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC;YACpC,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,SAAS,GAAG,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;QAC7D,CAAC;QACD,MAAM,UAAU,GACd,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/D,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;QACjB,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE;YACxD,QAAQ;YACR,UAAU;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/client/types.d.ts

@@ -1,5 +1,292 @@
-import { GenericQueryCtx, GenericDataModel, GenericMutationCtx, Expand, FunctionReference, GenericActionCtx } from "convex/server";
-import { GenericId } from "convex/values";
+import type { CoreMessage, DeepPartial, GenerateObjectResult, GenerateTextResult, JSONValue, RepairTextFunction, StreamObjectResult, StreamTextResult, TelemetrySettings, ToolChoice, ToolSet } from "ai";
+import type { generateObject, generateText, LanguageModelV1, streamObject, streamText } from "ai";
+import type { Expand, FunctionReference, GenericActionCtx, GenericDataModel, GenericMutationCtx, GenericQueryCtx } from "convex/server";
+import type { GenericId } from "convex/values";
+import type { CallSettings, ProviderMetadata, ProviderOptions, StreamDelta, StreamMessage, Usage } from "../validators.js";
+import type { Mounts } from "../component/_generated/api.js";
+import type { Schema } from "zod";
+import type { StreamingOptions } from "./streaming.js";
+/**
+ * Options to configure what messages are fetched as context,
+ * automatically with thread.generateText, or directly via search.
+ */
+export type ContextOptions = {
+    /** @deprecated Use excludeToolMessages instead. */
+    includeToolCalls?: boolean;
+    /**
+     * Whether to include tool messages in the context.
+     * By default, tool calls and results are not included.
+     */
+    excludeToolMessages?: boolean;
+    /**
+     * How many recent messages to include. These are added after the search
+     * messages, and do not count against the search limit.
+     * Default: 100
+     */
+    recentMessages?: number;
+    /**
+     * Options for searching messages.
+     */
+    searchOptions?: {
+        /**
+         * The maximum number of messages to fetch. Default is 10.
+         */
+        limit: number;
+        /**
+         * Whether to use text search to find messages. Default is false.
+         */
+        textSearch?: boolean;
+        /**
+         * Whether to use vector search to find messages. Default is false.
+         * At least one of textSearch or vectorSearch must be true.
+         */
+        vectorSearch?: boolean;
+        /**
+         * What messages around the search results to include.
+         * Default: { before: 2, after: 1 }
+         * (two before, and one after each message found in the search)
+         * Note, this is after the limit is applied.
+         * By default this will quadruple the number of messages fetched.
+         */
+        messageRange?: {
+            before: number;
+            after: number;
+        };
+    };
+    /**
+     * Whether to search across other threads for relevant messages.
+     * By default, only the current thread is searched.
+     */
+    searchOtherThreads?: boolean;
+};
+/**
+ * Options to configure the automatic saving of messages
+ * when generating text / objects in a thread.
+ */
+export type StorageOptions = {
+    /**
+     * 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. */
+    saveAnyInputMessages?: boolean;
+    /** Defaults to true. Whether to save messages generated while chatting. */
+    saveOutputMessages?: boolean;
+};
+export type GenerationOutputMetadata = {
+    messageId?: string;
+};
+export type UsageHandler = (ctx: RunActionCtx, args: {
+    userId: string | undefined;
+    threadId: string | undefined;
+    agentName: string | undefined;
+    usage: Usage;
+    providerMetadata: ProviderMetadata | undefined;
+    model: string;
+    provider: string;
+}) => void | Promise<void>;
+export type AgentComponent = UseApi<Mounts>;
+export type TextArgs<AgentTools extends ToolSet, TOOLS extends ToolSet | undefined = undefined, OUTPUT = never, OUTPUT_PARTIAL = never> = Omit<Parameters<typeof generateText<TOOLS extends undefined ? AgentTools : TOOLS, OUTPUT, OUTPUT_PARTIAL>>[0], "toolChoice" | "tools" | "model"> & {
+    /**
+     * If provided, this message will be used as the "prompt" for the LLM call,
+     * instead of the prompt or messages.
+     * This is useful if you want to first save a user message, then use it as
+     * the prompt for the LLM call in another call.
+     */
+    promptMessageId?: string;
+    /**
+     * The model to use for the tool calls. This will override the model specified
+     * in the Agent constructor.
+     */
+    model?: LanguageModelV1;
+    /**
+     * The tools to use for the tool calls. This will override tools specified
+     * in the Agent constructor or createThread / continueThread.
+     */
+    tools?: TOOLS;
+    /**
+     * The tool choice to use for the tool calls. This must be one of the tools
+     * specified in the tools array. e.g. {toolName: "getWeather", type: "tool"}
+     */
+    toolChoice?: ToolChoice<TOOLS extends undefined ? AgentTools : TOOLS>;
+};
+export type StreamingTextArgs<AgentTools extends ToolSet, TOOLS extends ToolSet | undefined = undefined, OUTPUT = never, OUTPUT_PARTIAL = never> = Omit<Parameters<typeof streamText<TOOLS extends undefined ? AgentTools : TOOLS, OUTPUT, OUTPUT_PARTIAL>>[0], "toolChoice" | "tools" | "model"> & {
+    /**
+     * The model to use for the tool calls. This will override the model specified
+     * in the Agent constructor.
+     */
+    model?: LanguageModelV1;
+    /**
+     * The tools to use for the tool calls. This will override tools specified
+     * in the Agent constructor or createThread / continueThread.
+     */
+    tools?: TOOLS;
+    /**
+     * The tool choice to use for the tool calls. This must be one of the tools
+     * specified in the tools array. e.g. {toolName: "getWeather", type: "tool"}
+     */
+    toolChoice?: ToolChoice<TOOLS extends undefined ? AgentTools : TOOLS>;
+};
+type BaseGenerateObjectOptions = CallSettings & {
+    /**
+     * The model to use for the object generation. This will override the model
+     * specified in the Agent constructor.
+     */
+    model?: LanguageModelV1;
+    /**
+     * The system prompt to use for the object generation. This will override the
+     * system prompt specified in the Agent constructor.
+     */
+    system?: string;
+    /**
+     * The prompt to the LLM to use for the object generation.
+     * Specify this or messages, but not both.
+     */
+    prompt?: string;
+    /**
+     * 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[];
+    /**
+     * 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.
+     * This is useful if you want to first save a user message, then use it as
+     * the prompt for the object generation in another call.
+     */
+    promptMessageId?: string;
+    experimental_repairText?: RepairTextFunction;
+    experimental_telemetry?: TelemetrySettings;
+    providerOptions?: ProviderOptions;
+    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>;
+    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";
+};
+type GenerateObjectArgs<T> = T extends Record<string, unknown> ? GenerateObjectObjectOptions<T> : T extends Array<unknown> ? GenerateObjectArrayOptions<T> : T extends string ? GenerateObjectWithEnumOptions<T> : GenerateObjectNoSchemaOptions;
+type StreamObjectArgs<T> = T extends Record<string, unknown> ? GenerateObjectObjectOptions<T> : T extends Array<unknown> ? GenerateObjectArrayOptions<T> : GenerateObjectNoSchemaOptions;
+export type OurObjectArgs<T> = GenerateObjectArgs<T> & Pick<Parameters<typeof generateObject<any>>[0], "experimental_repairText" | "abortSignal">;
+export type OurStreamObjectArgs<T> = StreamObjectArgs<T> & Pick<Parameters<typeof streamObject<T>>[0], "onError" | "onFinish" | "abortSignal">;
+type ThreadOutputMetadata = GenerationOutputMetadata & {
+    messageId: string;
+};
+/**
+ * The interface for a thread returned from {@link createThread} or {@link continueThread}.
+ * This is contextual to a thread and/or user.
+ */
+export interface Thread<DefaultTools extends ToolSet> {
+    /**
+     * The target threadId, from the startThread or continueThread initializers.
+     */
+    threadId: string;
+    /**
+     * 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
+     * resulting messages to the thread, if specified.
+     * Use {@link continueThread} to get a version of this function already scoped
+     * to a thread (and optionally userId).
+     * @param args The arguments to the generateText function, along with extra controls
+     * for the {@link ContextOptions} and {@link StorageOptions}.
+     * @returns The result of the generateText function.
+     */
+    generateText<TOOLS extends ToolSet | undefined = undefined, OUTPUT = never, OUTPUT_PARTIAL = never>(args: TextArgs<TOOLS extends undefined ? DefaultTools : TOOLS, TOOLS, OUTPUT, OUTPUT_PARTIAL>, options?: Options): Promise<GenerateTextResult<TOOLS extends undefined ? DefaultTools : TOOLS, OUTPUT> & ThreadOutputMetadata>;
+    /**
+     * This behaves like {@link streamText} 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.
+     * Use {@link continueThread} to get a version of this function already scoped
+     * to a thread (and optionally userId).
+     * @param args The arguments to the streamText function, along with extra controls
+     * for the {@link ContextOptions} and {@link StorageOptions}.
+     * @returns The result of the streamText function.
+     */
+    streamText<TOOLS extends ToolSet | undefined = undefined, OUTPUT = never, PARTIAL_OUTPUT = never>(args: StreamingTextArgs<TOOLS extends undefined ? DefaultTools : TOOLS, TOOLS, OUTPUT, PARTIAL_OUTPUT>, options?: Options & {
+        /**
+         * Whether to save incremental data (deltas) from streaming responses.
+         * Defaults to false.
+         * If false, it will not save any deltas to the database.
+         * If true, it will save deltas with {@link DEFAULT_STREAMING_OPTIONS}.
+         *
+         * Regardless of this option, when streaming you are able to use this
+         * `streamText` function as you would with the "ai" package's version:
+         * iterating over the text, streaming it over HTTP, etc.
+         */
+        saveStreamDeltas?: boolean | StreamingOptions;
+    }): Promise<StreamTextResult<TOOLS extends undefined ? DefaultTools : TOOLS, PARTIAL_OUTPUT> & 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 objects, arrays, and enums.
+     * 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<T>(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
+     * resulting messages to the thread, if specified.
+     * Use {@link continueThread} to get a version of this function already scoped
+     * to a thread (and optionally userId).
+     * @param args The arguments to the streamObject function, along with extra controls
+     * for the {@link ContextOptions} and {@link StorageOptions}.
+     * @returns The result of the streamObject function.
+     */
+    streamObject<T>(args: OurStreamObjectArgs<T>, options?: Options): Promise<StreamObjectResult<DeepPartial<T>, T, never> & ThreadOutputMetadata>;
+}
+export type Options = {
+    /**
+     * The context options to use for passing in message history to the LLM.
+     */
+    contextOptions?: ContextOptions;
+    /**
+     * The storage options to use for saving the input and output messages to the thread.
+     */
+    storageOptions?: StorageOptions;
+};
+export type SyncStreamsReturnValue = {
+    kind: "list";
+    messages: StreamMessage[];
+} | {
+    kind: "deltas";
+    deltas: StreamDelta[];
+} | undefined;
 export type RunQueryCtx = {
     runQuery: GenericQueryCtx<GenericDataModel>["runQuery"];
 };
@@ -18,4 +305,5 @@ export type OpaqueIds<T> = T extends GenericId<infer _T> ? string : T extends (i
 export type UseApi<API> = Expand<{
     [mod in keyof API]: API[mod] extends FunctionReference<infer FType, "public", infer FArgs, infer FReturnType, infer FComponentPath> ? FunctionReference<FType, "internal", OpaqueIds<FArgs>, OpaqueIds<FReturnType>, FComponentPath> : UseApi<API[mod]>;
 }>;
+export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/esm/client/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/client/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,MAAM,EACN,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAI1C,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;CACzD,CAAC;AACF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;IAC3D,WAAW,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,CAAC;CAClE,CAAC;AACF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;IACzD,WAAW,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,CAAC;IAC/D,SAAS,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,WAAW,CAAC,CAAC;CAC5D,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,IACrB,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,CAAC,GACzB,MAAM,GACN,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACnB,SAAS,CAAC,CAAC,CAAC,EAAE,GACd,CAAC,SAAS,WAAW,GACnB,WAAW,GACX,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChC,GACD,CAAC,CAAC;AAEd,MAAM,MAAM,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC;KAC9B,GAAG,IAAI,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,SAAS,iBAAiB,CACpD,MAAM,KAAK,EACX,QAAQ,EACR,MAAM,KAAK,EACX,MAAM,WAAW,EACjB,MAAM,cAAc,CACrB,GACG,iBAAiB,CACf,KAAK,EACL,UAAU,EACV,SAAS,CAAC,KAAK,CAAC,EAChB,SAAS,CAAC,WAAW,CAAC,EACtB,cAAc,CACf,GACD,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACrB,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/client/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,oBAAoB,EACpB,kBAAkB,EAClB,SAAS,EACT,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,UAAU,EACV,OAAO,EACR,MAAM,IAAI,CAAC;AACZ,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,UAAU,EACX,MAAM,IAAI,CAAC;AACZ,OAAO,KAAK,EACV,MAAM,EACN,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAChB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,WAAW,EACX,aAAa,EACb,KAAK,EACN,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC;AAClC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,mDAAmD;IACnD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE;QACd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB;;;WAGG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB;;;;;;WAMG;QACH,YAAY,CAAC,EAAE;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC;KAClD,CAAC;IACF;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,mFAAmF;IACnF,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,2EAA2E;IAC3E,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9D,MAAM,MAAM,YAAY,GAAG,CACzB,GAAG,EAAE,YAAY,EACjB,IAAI,EAAE;IACJ,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;IAEb,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,KACE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1B,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAE5C,MAAM,MAAM,QAAQ,CAClB,UAAU,SAAS,OAAO,EAC1B,KAAK,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,EAC7C,MAAM,GAAG,KAAK,EACd,cAAc,GAAG,KAAK,IACpB,IAAI,CACN,UAAU,CACR,OAAO,YAAY,CACjB,KAAK,SAAS,SAAS,GAAG,UAAU,GAAG,KAAK,EAC5C,MAAM,EACN,cAAc,CACf,CACF,CAAC,CAAC,CAAC,EACJ,YAAY,GAAG,OAAO,GAAG,OAAO,CACjC,GAAG;IACF;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,KAAK,SAAS,SAAS,GAAG,UAAU,GAAG,KAAK,CAAC,CAAC;CACvE,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAC3B,UAAU,SAAS,OAAO,EAC1B,KAAK,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,EAC7C,MAAM,GAAG,KAAK,EACd,cAAc,GAAG,KAAK,IACpB,IAAI,CACN,UAAU,CACR,OAAO,UAAU,CACf,KAAK,SAAS,SAAS,GAAG,UAAU,GAAG,KAAK,EAC5C,MAAM,EACN,cAAc,CACf,CACF,CAAC,CAAC,CAAC,EACJ,YAAY,GAAG,OAAO,GAAG,OAAO,CACjC,GAAG;IACF;;;OAGG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,KAAK,SAAS,SAAS,GAAG,UAAU,GAAG,KAAK,CAAC,CAAC;CACvE,CAAC;AAEF,KAAK,yBAAyB,GAAG,YAAY,GAAG;IAC9C;;;OAGG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uBAAuB,CAAC,EAAE,kBAAkB,CAAC;IAC7C,sBAAsB,CAAC,EAAE,iBAAiB,CAAC;IAC3C,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,6BAA6B,CAAC,EAAE,gBAAgB,CAAC;CAClD,CAAC;AAEF,KAAK,2BAA2B,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAChE,yBAAyB,GAAG;IAC1B,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEJ,KAAK,0BAA0B,CAAC,CAAC,IAAI,yBAAyB,GAAG;IAC/D,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,KAAK,6BAA6B,CAAC,CAAC,SAAS,MAAM,IACjD,yBAAyB,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACjC,CAAC;AAEJ,KAAK,6BAA6B,GAAG,yBAAyB,GAAG;IAC/D,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAIF,KAAK,kBAAkB,CAAC,CAAC,IACvB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,2BAA2B,CAAC,CAAC,CAAC,GAC9B,CAAC,SAAS,KAAK,CAAC,OAAO,CAAC,GACtB,0BAA0B,CAAC,CAAC,CAAC,GAC7B,CAAC,SAAS,MAAM,GACd,6BAA6B,CAAC,CAAC,CAAC,GAChC,6BAA6B,CAAC;AAExC,KAAK,gBAAgB,CAAC,CAAC,IACrB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,2BAA2B,CAAC,CAAC,CAAC,GAC9B,CAAC,SAAS,KAAK,CAAC,OAAO,CAAC,GACtB,0BAA0B,CAAC,CAAC,CAAC,GAC7B,6BAA6B,CAAC;AAEtC,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAClD,IAAI,CAEF,UAAU,CAAC,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EACzC,yBAAyB,GAAG,aAAa,CAC1C,CAAC;AAEJ,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,gBAAgB,CAAC,CAAC,CAAC,GACtD,IAAI,CACF,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACrC,SAAS,GAAG,UAAU,GAAG,aAAa,CACvC,CAAC;AAEJ,KAAK,oBAAoB,GAAG,wBAAwB,GAAG;IACrD,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,MAAM,CAAC,YAAY,SAAS,OAAO;IAClD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;;;;;OASG;IACH,YAAY,CACV,KAAK,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,EAC7C,MAAM,GAAG,KAAK,EACd,cAAc,GAAG,KAAK,EAEtB,IAAI,EAAE,QAAQ,CACZ,KAAK,SAAS,SAAS,GAAG,YAAY,GAAG,KAAK,EAC9C,KAAK,EACL,MAAM,EACN,cAAc,CACf,EACD,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CACR,kBAAkB,CAAC,KAAK,SAAS,SAAS,GAAG,YAAY,GAAG,KAAK,EAAE,MAAM,CAAC,GACxE,oBAAoB,CACvB,CAAC;IAEF;;;;;;;;;OASG;IACH,UAAU,CACR,KAAK,SAAS,OAAO,GAAG,SAAS,GAAG,SAAS,EAC7C,MAAM,GAAG,KAAK,EACd,cAAc,GAAG,KAAK,EAEtB,IAAI,EAAE,iBAAiB,CACrB,KAAK,SAAS,SAAS,GAAG,YAAY,GAAG,KAAK,EAC9C,KAAK,EACL,MAAM,EACN,cAAc,CACf,EACD,OAAO,CAAC,EAAE,OAAO,GAAG;QAClB;;;;;;;;;WASG;QACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC;KAC/C,GACA,OAAO,CACR,gBAAgB,CACd,KAAK,SAAS,SAAS,GAAG,YAAY,GAAG,KAAK,EAC9C,cAAc,CACf,GACC,oBAAoB,CACvB,CAAC;IACF;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,EACd,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,EACtB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC;IAC3D;;;;;;;;;OASG;IACH,cAAc,CACZ,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,oBAAoB,CAAC,SAAS,CAAC,GAAG,oBAAoB,CAAC,CAAC;IACnE;;;;;;;;;OASG;IACH,YAAY,CAAC,CAAC,EACZ,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAC5B,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CACR,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,oBAAoB,CACpE,CAAC;CACH;AAED,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAC9B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,aAAa,EAAE,CAAA;CAAE,GAC3C;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,WAAW,EAAE,CAAA;CAAE,GACzC,SAAS,CAAC;AAGd,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;CACzD,CAAC;AACF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;IAC3D,WAAW,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,CAAC;CAClE,CAAC;AACF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;IACzD,WAAW,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,CAAC;IAC/D,SAAS,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,WAAW,CAAC,CAAC;CAC5D,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,IACrB,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,CAAC,GACzB,MAAM,GACN,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACnB,SAAS,CAAC,CAAC,CAAC,EAAE,GACd,CAAC,SAAS,WAAW,GACnB,WAAW,GACX,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChC,GACD,CAAC,CAAC;AAEd,MAAM,MAAM,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC;KAC9B,GAAG,IAAI,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,SAAS,iBAAiB,CACpD,MAAM,KAAK,EACX,QAAQ,EACR,MAAM,KAAK,EACX,MAAM,WAAW,EACjB,MAAM,cAAc,CACrB,GACG,iBAAiB,CACf,KAAK,EACL,UAAU,EACV,SAAS,CAAC,KAAK,CAAC,EAChB,SAAS,CAAC,WAAW,CAAC,EACtB,cAAc,CACf,GACD,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACrB,CAAC,CAAC"}