@convex-dev/agent 0.0.16 → 0.0.17-alpha.0

package/dist/commonjs/client/playground.d.ts

@@ -0,0 +1,609 @@
+import { GenericDataModel, GenericQueryCtx, ApiFromModules } from "convex/server";
+import { type AgentComponent, type Agent } from "./index";
+import type { ToolSet } from "ai";
+export type PlaygroundAPI = ApiFromModules<{
+    playground: ReturnType<typeof definePlaygroundAPI>;
+}>["playground"];
+export declare function definePlaygroundAPI(component: AgentComponent, { agents, userNameLookup, }: {
+    agents: Agent<ToolSet>[];
+    userNameLookup?: <DataModel extends GenericDataModel>(ctx: GenericQueryCtx<DataModel>, userId: string) => string | Promise<string>;
+}): {
+    isApiKeyValid: import("convex/server").RegisteredQuery<"public", {
+        apiKey: string;
+    }, Promise<boolean>>;
+    listUsers: import("convex/server").RegisteredQuery<"public", {
+        apiKey: string;
+        paginationOpts: {
+            id?: number | undefined;
+            endCursor?: string | null | undefined;
+            maximumRowsRead?: number | undefined;
+            maximumBytesRead?: number | undefined;
+            numItems: number;
+            cursor: string | null;
+        };
+    }, Promise<{
+        page: {
+            _id: string;
+            name: string;
+        }[];
+        continueCursor: string;
+        isDone: boolean;
+        pageStatus?: "SplitRecommended" | "SplitRequired" | null | undefined;
+        splitCursor?: string | null | undefined;
+    }>>;
+    listThreads: import("convex/server").RegisteredQuery<"public", {
+        userId: string;
+        apiKey: string;
+        paginationOpts: {
+            id?: number | undefined;
+            endCursor?: string | null | undefined;
+            maximumRowsRead?: number | undefined;
+            maximumBytesRead?: number | undefined;
+            numItems: number;
+            cursor: string | null;
+        };
+    }, Promise<{
+        page: {
+            latestMessage: string | undefined;
+            lastMessageAt: number;
+            _creationTime: number;
+            _id: string;
+            status: "active" | "archived";
+            summary?: string | undefined;
+            title?: string | undefined;
+            userId?: string | undefined;
+        }[];
+        continueCursor: string;
+        isDone: boolean;
+        pageStatus?: "SplitRecommended" | "SplitRequired" | null | undefined;
+        splitCursor?: string | null | undefined;
+    }>>;
+    listMessages: import("convex/server").RegisteredQuery<"public", {
+        threadId: string;
+        apiKey: string;
+        paginationOpts: {
+            id?: number | undefined;
+            endCursor?: string | null | undefined;
+            maximumRowsRead?: number | undefined;
+            maximumBytesRead?: number | undefined;
+            numItems: number;
+            cursor: string | null;
+        };
+    }, Promise<{
+        continueCursor: string;
+        isDone: boolean;
+        page: {
+            _creationTime: number;
+            _id: string;
+            agentName?: string | undefined;
+            embeddingId?: string | string | string | string | string | string | string | string | string | undefined;
+            error?: string | undefined;
+            files?: {
+                data?: (ArrayBuffer | string) | undefined;
+                fileId?: string | undefined;
+                mimeType: string;
+                url?: string | undefined;
+            }[] | undefined;
+            finishReason?: "stop" | "length" | "content-filter" | "tool-calls" | "error" | "other" | "unknown" | undefined;
+            id?: string | undefined;
+            message?: {
+                content: string | ({
+                    providerOptions?: {
+                        [x: string]: {
+                            [x: string]: any;
+                        };
+                    } | undefined;
+                    text: string;
+                    type: "text";
+                } | {
+                    image: string | ArrayBuffer;
+                    mimeType?: string | undefined;
+                    providerOptions?: {
+                        [x: string]: {
+                            [x: string]: any;
+                        };
+                    } | undefined;
+                    type: "image";
+                } | {
+                    data: string | ArrayBuffer;
+                    mimeType: string;
+                    providerOptions?: {
+                        [x: string]: {
+                            [x: string]: any;
+                        };
+                    } | undefined;
+                    type: "file";
+                })[];
+                providerOptions?: {
+                    [x: string]: {
+                        [x: string]: any;
+                    };
+                } | undefined;
+                role: "user";
+            } | {
+                content: string | ({
+                    providerOptions?: {
+                        [x: string]: {
+                            [x: string]: any;
+                        };
+                    } | undefined;
+                    text: string;
+                    type: "text";
+                } | {
+                    data: string | ArrayBuffer;
+                    mimeType: string;
+                    providerOptions?: {
+                        [x: string]: {
+                            [x: string]: any;
+                        };
+                    } | undefined;
+                    type: "file";
+                } | {
+                    providerOptions?: {
+                        [x: string]: {
+                            [x: string]: any;
+                        };
+                    } | undefined;
+                    signature?: string | undefined;
+                    text: string;
+                    type: "reasoning";
+                } | {
+                    data: string;
+                    providerOptions?: {
+                        [x: string]: {
+                            [x: string]: any;
+                        };
+                    } | undefined;
+                    type: "redacted-reasoning";
+                } | {
+                    args: any;
+                    providerOptions?: {
+                        [x: string]: {
+                            [x: string]: any;
+                        };
+                    } | undefined;
+                    toolCallId: string;
+                    toolName: string;
+                    type: "tool-call";
+                })[];
+                providerOptions?: {
+                    [x: string]: {
+                        [x: string]: any;
+                    };
+                } | undefined;
+                role: "assistant";
+            } | {
+                content: {
+                    args?: any;
+                    experimental_content?: ({
+                        text: string;
+                        type: "text";
+                    } | {
+                        data: string;
+                        mimeType?: string | undefined;
+                        type: "image";
+                    })[] | undefined;
+                    isError?: boolean | undefined;
+                    providerOptions?: {
+                        [x: string]: {
+                            [x: string]: any;
+                        };
+                    } | undefined;
+                    result: any;
+                    toolCallId: string;
+                    toolName: string;
+                    type: "tool-result";
+                }[];
+                providerOptions?: {
+                    [x: string]: {
+                        [x: string]: any;
+                    };
+                } | undefined;
+                role: "tool";
+            } | {
+                content: string;
+                providerOptions?: {
+                    [x: string]: {
+                        [x: string]: any;
+                    };
+                } | undefined;
+                role: "system";
+            } | undefined;
+            model?: string | undefined;
+            order: number;
+            parentMessageId?: string | undefined;
+            provider?: string | undefined;
+            providerMetadata?: {
+                [x: string]: {
+                    [x: string]: any;
+                };
+            } | undefined;
+            providerOptions?: {
+                [x: string]: {
+                    [x: string]: any;
+                };
+            } | undefined;
+            reasoning?: string | undefined;
+            reasoningDetails?: ({
+                signature?: string | undefined;
+                text: string;
+                type: "text";
+            } | {
+                data: string;
+                type: "redacted";
+            })[] | undefined;
+            sources?: {
+                id: string;
+                providerOptions?: {
+                    [x: string]: {
+                        [x: string]: any;
+                    };
+                } | undefined;
+                sourceType: "url";
+                title?: string | undefined;
+                url: string;
+            }[] | undefined;
+            status: "pending" | "success" | "failed";
+            stepId?: string | undefined;
+            stepOrder: number;
+            text?: string | undefined;
+            threadId: string;
+            tool: boolean;
+            usage?: {
+                completionTokens: number;
+                promptTokens: number;
+                totalTokens: number;
+            } | undefined;
+            userId?: string | undefined;
+            warnings?: ({
+                details?: string | undefined;
+                setting: string;
+                type: "unsupported-setting";
+            } | {
+                details?: string | undefined;
+                tool: any;
+                type: "unsupported-tool";
+            } | {
+                message: string;
+                type: "other";
+            })[] | undefined;
+        }[];
+        pageStatus?: "SplitRecommended" | "SplitRequired" | null | undefined;
+        splitCursor?: string | null | undefined;
+    }>>;
+    listAgents: import("convex/server").RegisteredQuery<"public", {
+        apiKey: string;
+    }, Promise<string[]>>;
+    createThread: import("convex/server").RegisteredMutation<"public", {
+        title?: string | undefined;
+        summary?: string | undefined;
+        userId: string;
+        agentName: string;
+        apiKey: string;
+    }, Promise<{
+        threadId: string;
+    }>>;
+    generateText: import("convex/server").RegisteredAction<"public", {
+        messages?: ({
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "user";
+            content: string | ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "text";
+                text: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                mimeType?: string | undefined;
+                type: "image";
+                image: string | ArrayBuffer;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "file";
+                mimeType: string;
+                data: string | ArrayBuffer;
+            })[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "assistant";
+            content: string | ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "text";
+                text: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "file";
+                mimeType: string;
+                data: string | ArrayBuffer;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                signature?: string | undefined;
+                type: "reasoning";
+                text: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "redacted-reasoning";
+                data: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "tool-call";
+                toolCallId: string;
+                toolName: string;
+                args: any;
+            })[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "tool";
+            content: {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                args?: any;
+                experimental_content?: ({
+                    type: "text";
+                    text: string;
+                } | {
+                    mimeType?: string | undefined;
+                    type: "image";
+                    data: string;
+                })[] | undefined;
+                isError?: boolean | undefined;
+                type: "tool-result";
+                toolCallId: string;
+                toolName: string;
+                result: any;
+            }[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "system";
+            content: string;
+        })[] | undefined;
+        prompt?: string | undefined;
+        contextOptions?: {
+            excludeToolMessages?: boolean | undefined;
+            recentMessages?: number | undefined;
+            searchOptions?: {
+                messageRange?: {
+                    before: number;
+                    after: number;
+                } | undefined;
+                textSearch?: boolean | undefined;
+                vectorSearch?: boolean | undefined;
+                limit: number;
+            } | undefined;
+            searchOtherThreads?: boolean | undefined;
+        } | undefined;
+        storageOptions?: {
+            saveAllInputMessages?: boolean | undefined;
+            saveAnyInputMessages?: boolean | undefined;
+            saveOutputMessages?: boolean | undefined;
+        } | undefined;
+        userId: string;
+        threadId: string;
+        agentName: string;
+        apiKey: string;
+    }, Promise<import("ai").GenerateTextResult<ToolSet, never> & import("./index").GenerationOutputMetadata & {
+        messageId: string;
+    }>>;
+    fetchPromptContext: import("convex/server").RegisteredAction<"public", {
+        userId?: string | undefined;
+        threadId?: string | undefined;
+        beforeMessageId?: string | undefined;
+        messages: ({
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "user";
+            content: string | ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "text";
+                text: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                mimeType?: string | undefined;
+                type: "image";
+                image: string | ArrayBuffer;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "file";
+                mimeType: string;
+                data: string | ArrayBuffer;
+            })[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "assistant";
+            content: string | ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "text";
+                text: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "file";
+                mimeType: string;
+                data: string | ArrayBuffer;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                signature?: string | undefined;
+                type: "reasoning";
+                text: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "redacted-reasoning";
+                data: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "tool-call";
+                toolCallId: string;
+                toolName: string;
+                args: any;
+            })[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "tool";
+            content: {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                args?: any;
+                experimental_content?: ({
+                    type: "text";
+                    text: string;
+                } | {
+                    mimeType?: string | undefined;
+                    type: "image";
+                    data: string;
+                })[] | undefined;
+                isError?: boolean | undefined;
+                type: "tool-result";
+                toolCallId: string;
+                toolName: string;
+                result: any;
+            }[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "system";
+            content: string;
+        })[];
+        agentName: string;
+        contextOptions: {
+            excludeToolMessages?: boolean | undefined;
+            recentMessages?: number | undefined;
+            searchOptions?: {
+                messageRange?: {
+                    before: number;
+                    after: number;
+                } | undefined;
+                textSearch?: boolean | undefined;
+                vectorSearch?: boolean | undefined;
+                limit: number;
+            } | undefined;
+            searchOtherThreads?: boolean | undefined;
+        };
+        apiKey: string;
+    }, Promise<{
+        id?: string | undefined;
+        userId?: string | undefined;
+        parentMessageId?: string | undefined;
+        stepId?: string | undefined;
+        embeddingId?: string | undefined;
+        error?: string | undefined;
+        agentName?: string | undefined;
+        model?: string | undefined;
+        provider?: string | undefined;
+        providerOptions?: Record<string, Record<string, any>> | undefined;
+        message?: {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "user";
+            content: string | ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "text";
+                text: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                mimeType?: string | undefined;
+                type: "image";
+                image: string | ArrayBuffer;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "file";
+                mimeType: string;
+                data: string | ArrayBuffer;
+            })[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "assistant";
+            content: string | ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "text";
+                text: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "file";
+                mimeType: string;
+                data: string | ArrayBuffer;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                signature?: string | undefined;
+                type: "reasoning";
+                text: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "redacted-reasoning";
+                data: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "tool-call";
+                toolCallId: string;
+                toolName: string;
+                args: any;
+            })[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "tool";
+            content: {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                args?: any;
+                experimental_content?: ({
+                    type: "text";
+                    text: string;
+                } | {
+                    mimeType?: string | undefined;
+                    type: "image";
+                    data: string;
+                })[] | undefined;
+                isError?: boolean | undefined;
+                type: "tool-result";
+                toolCallId: string;
+                toolName: string;
+                result: any;
+            }[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "system";
+            content: string;
+        } | undefined;
+        text?: string | undefined;
+        reasoning?: string | undefined;
+        files?: {
+            bytes?: ArrayBuffer | undefined;
+            url?: string | undefined;
+            fileId?: string | undefined;
+            mimeType: string;
+        }[] | undefined;
+        usage?: {
+            promptTokens: number;
+            completionTokens: number;
+            totalTokens: number;
+        } | undefined;
+        providerMetadata?: Record<string, Record<string, any>> | undefined;
+        sources?: {
+            title?: string | undefined;
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            id: string;
+            url: string;
+            sourceType: "url";
+        }[] | undefined;
+        reasoningDetails?: ({
+            signature?: string | undefined;
+            type: "text";
+            text: string;
+        } | {
+            type: "redacted";
+            data: string;
+        })[] | undefined;
+        warnings?: ({
+            details?: string | undefined;
+            type: "unsupported-setting";
+            setting: string;
+        } | {
+            details?: string | undefined;
+            type: "unsupported-tool";
+            tool: any;
+        } | {
+            type: "other";
+            message: string;
+        })[] | undefined;
+        finishReason?: "length" | "error" | "other" | "stop" | "content-filter" | "tool-calls" | "unknown" | undefined;
+        status: "pending" | "success" | "failed";
+        order: number;
+        _creationTime: number;
+        threadId: string;
+        stepOrder: number;
+        tool: boolean;
+        _id: string;
+    }[]>>;
+};
+//# sourceMappingURL=playground.d.ts.map

package/dist/commonjs/client/playground.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"playground.d.ts","sourceRoot":"","sources":["../../../src/client/playground.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,gBAAgB,EAChB,eAAe,EACf,cAAc,EACf,MAAM,eAAe,CAAC;AACvB,OAAO,EAOL,KAAK,cAAc,EACnB,KAAK,KAAK,EACX,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAGlC,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC;IACzC,UAAU,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC;CACpD,CAAC,CAAC,YAAY,CAAC,CAAC;AAGjB,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,cAAc,EACzB,EACE,MAAM,EACN,cAAc,GACf,EAAE;IACD,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE,CAAC,SAAS,SAAS,gBAAgB,EAClD,GAAG,EAAE,eAAe,CAAC,SAAS,CAAC,EAC/B,MAAM,EAAE,MAAM,KACX,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwNF"}