@convex-dev/agent 0.7.1 → 0.7.3

package/dist/vercel/client/search.d.ts

@@ -3,6 +3,449 @@ import type { MessageDoc } from "../../validators.js";
 import { type VectorDimension } from "../../component/vector/tables.js";
 import type { Message } from "../../validators.js";
 import type { AgentComponent, Config, ContextOptions, Options, QueryCtx, MutationCtx, ActionCtx } from "./types.js";
+/**
+ * Omit the oldest order when a descending pagination window split it.
+ * Expects the messages to be sorted in ascending order.
+ */
+export declare function trimIncompleteOldestOrder(docs: MessageDoc[]): {
+    message?: {
+        providerOptions?: Record<string, Record<string, any>> | undefined;
+        role: "user";
+        content: string | ({
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            text: string;
+            type: "text";
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            mediaType?: string | undefined;
+            mimeType?: string | undefined;
+            type: "image";
+            image: string | ArrayBuffer | {
+                type: "reference";
+                reference: Record<string, string>;
+            };
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            mediaType?: string | undefined;
+            mimeType?: string | undefined;
+            filename?: string | undefined;
+            data: string | ArrayBuffer | {
+                type: "reference";
+                reference: Record<string, string>;
+            };
+            type: "file";
+        })[];
+    } | {
+        providerOptions?: Record<string, Record<string, any>> | undefined;
+        role: "assistant";
+        content: string | ({
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            text: string;
+            type: "text";
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            mediaType?: string | undefined;
+            mimeType?: string | undefined;
+            filename?: string | undefined;
+            data: string | ArrayBuffer | {
+                type: "reference";
+                reference: Record<string, string>;
+            };
+            type: "file";
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            signature?: string | undefined;
+            text: string;
+            type: "reasoning";
+        } | {
+            data?: string | ArrayBuffer | undefined;
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            url?: string | undefined;
+            type: "reasoning-file";
+            mediaType: string;
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            type: "custom";
+            kind: string;
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            data: string;
+            type: "redacted-reasoning";
+        } | {
+            title?: string | undefined;
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            args?: any;
+            providerExecuted?: boolean | undefined;
+            toolMetadata?: Record<string, any> | undefined;
+            type: "tool-call";
+            toolCallId: string;
+            toolName: string;
+            input: any;
+        } | {
+            title?: string | undefined;
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            input?: any;
+            providerExecuted?: boolean | undefined;
+            toolMetadata?: Record<string, any> | undefined;
+            type: "tool-call";
+            toolCallId: string;
+            toolName: string;
+            args: any;
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            args?: any;
+            providerExecuted?: boolean | undefined;
+            output?: {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "text";
+                value: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "json";
+                value: any;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "error-text";
+                value: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "error-json";
+                value: any;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                reason?: string | undefined;
+                type: "execution-denied";
+            } | {
+                type: "content";
+                value: ({
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    text: string;
+                    type: "text";
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    filename?: string | undefined;
+                    data: {
+                        type: "reference";
+                        reference: Record<string, string>;
+                    } | {
+                        type: "url";
+                        url: string;
+                    } | {
+                        data: string | ArrayBuffer;
+                        type: "data";
+                    } | {
+                        text: string;
+                        type: "text";
+                    };
+                    type: "file";
+                    mediaType: string;
+                } | {
+                    data: string;
+                    type: "media";
+                    mediaType: string;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    filename?: string | undefined;
+                    data: string;
+                    type: "file-data";
+                    mediaType: string;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    mediaType?: string | undefined;
+                    type: "file-url";
+                    url: string;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "file-id";
+                    fileId: string | Record<string, string>;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "file-reference";
+                    providerReference: Record<string, string>;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    data: string;
+                    type: "image-data";
+                    mediaType: string;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "image-file-reference";
+                    providerReference: Record<string, string>;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "image-url";
+                    url: string;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "image-file-id";
+                    fileId: string | Record<string, string>;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "custom";
+                })[];
+            } | undefined;
+            result?: any;
+            isError?: boolean | undefined;
+            experimental_content?: ({
+                text: string;
+                type: "text";
+            } | {
+                mimeType?: string | undefined;
+                data: string;
+                type: "image";
+            })[] | undefined;
+            type: "tool-result";
+            toolCallId: string;
+            toolName: string;
+        } | {
+            title?: string | undefined;
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            id: string;
+            type: "source";
+            url: string;
+            sourceType: "url";
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            filename?: string | undefined;
+            id: string;
+            title: string;
+            type: "source";
+            mediaType: string;
+            sourceType: "document";
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            signature?: string | undefined;
+            isAutomatic?: boolean | undefined;
+            type: "tool-approval-request";
+            toolCallId: string;
+            approvalId: string;
+        })[];
+    } | {
+        providerOptions?: Record<string, Record<string, any>> | undefined;
+        role: "tool";
+        content: ({
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            args?: any;
+            providerExecuted?: boolean | undefined;
+            output?: {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "text";
+                value: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "json";
+                value: any;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "error-text";
+                value: string;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "error-json";
+                value: any;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                reason?: string | undefined;
+                type: "execution-denied";
+            } | {
+                type: "content";
+                value: ({
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    text: string;
+                    type: "text";
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    filename?: string | undefined;
+                    data: {
+                        type: "reference";
+                        reference: Record<string, string>;
+                    } | {
+                        type: "url";
+                        url: string;
+                    } | {
+                        data: string | ArrayBuffer;
+                        type: "data";
+                    } | {
+                        text: string;
+                        type: "text";
+                    };
+                    type: "file";
+                    mediaType: string;
+                } | {
+                    data: string;
+                    type: "media";
+                    mediaType: string;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    filename?: string | undefined;
+                    data: string;
+                    type: "file-data";
+                    mediaType: string;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    mediaType?: string | undefined;
+                    type: "file-url";
+                    url: string;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "file-id";
+                    fileId: string | Record<string, string>;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "file-reference";
+                    providerReference: Record<string, string>;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    data: string;
+                    type: "image-data";
+                    mediaType: string;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "image-file-reference";
+                    providerReference: Record<string, string>;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "image-url";
+                    url: string;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "image-file-id";
+                    fileId: string | Record<string, string>;
+                } | {
+                    providerOptions?: Record<string, Record<string, any>> | undefined;
+                    type: "custom";
+                })[];
+            } | undefined;
+            result?: any;
+            isError?: boolean | undefined;
+            experimental_content?: ({
+                text: string;
+                type: "text";
+            } | {
+                mimeType?: string | undefined;
+                data: string;
+                type: "image";
+            })[] | undefined;
+            type: "tool-result";
+            toolCallId: string;
+            toolName: string;
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            providerMetadata?: Record<string, Record<string, any>> | undefined;
+            providerExecuted?: boolean | undefined;
+            reason?: string | undefined;
+            type: "tool-approval-response";
+            approvalId: string;
+            approved: boolean;
+        })[];
+    } | {
+        providerOptions?: Record<string, Record<string, any>> | undefined;
+        role: "system";
+        content: string;
+    } | undefined;
+    error?: string | undefined;
+    text?: string | undefined;
+    reasoning?: string | undefined;
+    id?: string | undefined;
+    userId?: string | undefined;
+    embeddingId?: string | undefined;
+    fileIds?: string[] | undefined;
+    agentName?: string | undefined;
+    model?: string | undefined;
+    provider?: string | undefined;
+    providerOptions?: Record<string, Record<string, any>> | undefined;
+    providerMetadata?: Record<string, Record<string, any>> | undefined;
+    usage?: {
+        promptTokens?: number | undefined;
+        completionTokens?: number | undefined;
+        totalTokens?: number | undefined;
+        reasoningTokens?: number | undefined;
+        cachedInputTokens?: number | undefined;
+        nonCachedInputTokens?: number | undefined;
+        cacheWriteInputTokens?: number | undefined;
+        textOutputTokens?: number | undefined;
+        raw?: Record<string, any> | undefined;
+    } | undefined;
+    sources?: ({
+        title?: string | undefined;
+        type?: "source" | undefined;
+        providerOptions?: Record<string, Record<string, any>> | undefined;
+        providerMetadata?: Record<string, Record<string, any>> | undefined;
+        id: string;
+        url: string;
+        sourceType: "url";
+    } | {
+        providerOptions?: Record<string, Record<string, any>> | undefined;
+        providerMetadata?: Record<string, Record<string, any>> | undefined;
+        filename?: string | undefined;
+        id: string;
+        title: string;
+        type: "source";
+        mediaType: string;
+        sourceType: "document";
+    })[] | undefined;
+    warnings?: ({
+        details?: string | undefined;
+        type: "unsupported";
+        feature: string;
+    } | {
+        details?: string | undefined;
+        type: "compatibility";
+        feature: string;
+    } | {
+        message: string;
+        type: "deprecated";
+        setting: string;
+    } | {
+        details?: string | undefined;
+        type: "unsupported-setting";
+        setting: string;
+    } | {
+        details?: string | undefined;
+        tool: any;
+        type: "unsupported-tool";
+    } | {
+        message: string;
+        type: "other";
+    })[] | undefined;
+    finishReason?: "error" | "length" | "other" | "stop" | "content-filter" | "tool-calls" | "unknown" | undefined;
+    reasoningDetails?: ({
+        providerOptions?: Record<string, Record<string, any>> | undefined;
+        providerMetadata?: Record<string, Record<string, any>> | undefined;
+        signature?: string | undefined;
+        text: string;
+        type: "reasoning";
+    } | {
+        signature?: string | undefined;
+        text: string;
+        type: "text";
+    } | {
+        data: string;
+        type: "redacted";
+    })[] | undefined;
+    tool: boolean;
+    status: "pending" | "success" | "failed";
+    order: number;
+    _creationTime: number;
+    threadId: string;
+    stepOrder: number;
+    _id: string;
+}[];
 export type GetEmbedding = (text: string) => Promise<{
     embedding: number[];
     /** @deprecated Use embeddingModel instead. */
@@ -81,17 +524,6 @@ export declare function fetchRecentAndSearchMessages(ctx: QueryCtx | MutationCtx
  * @returns The filtered messages.
  */
 export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
-    text?: string | undefined;
-    reasoning?: string | undefined;
-    id?: string | undefined;
-    userId?: string | undefined;
-    embeddingId?: string | undefined;
-    fileIds?: 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";
@@ -115,11 +547,11 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
             mediaType?: string | undefined;
             mimeType?: string | undefined;
             filename?: string | undefined;
-            type: "file";
             data: string | ArrayBuffer | {
                 type: "reference";
                 reference: Record<string, string>;
             };
+            type: "file";
         })[];
     } | {
         providerOptions?: Record<string, Record<string, any>> | undefined;
@@ -135,11 +567,11 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
             mediaType?: string | undefined;
             mimeType?: string | undefined;
             filename?: string | undefined;
-            type: "file";
             data: string | ArrayBuffer | {
                 type: "reference";
                 reference: Record<string, string>;
             };
+            type: "file";
         } | {
             providerOptions?: Record<string, Record<string, any>> | undefined;
             providerMetadata?: Record<string, Record<string, any>> | undefined;
@@ -147,9 +579,9 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
             text: string;
             type: "reasoning";
         } | {
+            data?: string | ArrayBuffer | undefined;
             providerOptions?: Record<string, Record<string, any>> | undefined;
             providerMetadata?: Record<string, Record<string, any>> | undefined;
-            data?: string | ArrayBuffer | undefined;
             url?: string | undefined;
             type: "reasoning-file";
             mediaType: string;
@@ -161,8 +593,8 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
         } | {
             providerOptions?: Record<string, Record<string, any>> | undefined;
             providerMetadata?: Record<string, Record<string, any>> | undefined;
-            type: "redacted-reasoning";
             data: string;
+            type: "redacted-reasoning";
         } | {
             title?: string | undefined;
             providerOptions?: Record<string, Record<string, any>> | undefined;
@@ -219,8 +651,6 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     filename?: string | undefined;
-                    type: "file";
-                    mediaType: string;
                     data: {
                         type: "reference";
                         reference: Record<string, string>;
@@ -228,22 +658,24 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
                         type: "url";
                         url: string;
                     } | {
-                        type: "data";
                         data: string | ArrayBuffer;
+                        type: "data";
                     } | {
                         text: string;
                         type: "text";
                     };
+                    type: "file";
+                    mediaType: string;
                 } | {
+                    data: string;
                     type: "media";
                     mediaType: string;
-                    data: string;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     filename?: string | undefined;
+                    data: string;
                     type: "file-data";
                     mediaType: string;
-                    data: string;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     mediaType?: string | undefined;
@@ -259,9 +691,9 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
                     providerReference: Record<string, string>;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
+                    data: string;
                     type: "image-data";
                     mediaType: string;
-                    data: string;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     type: "image-file-reference";
@@ -286,8 +718,8 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
                 type: "text";
             } | {
                 mimeType?: string | undefined;
-                type: "image";
                 data: string;
+                type: "image";
             })[] | undefined;
             type: "tool-result";
             toolCallId: string;
@@ -355,8 +787,6 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     filename?: string | undefined;
-                    type: "file";
-                    mediaType: string;
                     data: {
                         type: "reference";
                         reference: Record<string, string>;
@@ -364,22 +794,24 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
                         type: "url";
                         url: string;
                     } | {
-                        type: "data";
                         data: string | ArrayBuffer;
+                        type: "data";
                     } | {
                         text: string;
                         type: "text";
                     };
+                    type: "file";
+                    mediaType: string;
                 } | {
+                    data: string;
                     type: "media";
                     mediaType: string;
-                    data: string;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     filename?: string | undefined;
+                    data: string;
                     type: "file-data";
                     mediaType: string;
-                    data: string;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     mediaType?: string | undefined;
@@ -395,9 +827,9 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
                     providerReference: Record<string, string>;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
+                    data: string;
                     type: "image-data";
                     mediaType: string;
-                    data: string;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     type: "image-file-reference";
@@ -422,8 +854,8 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
                 type: "text";
             } | {
                 mimeType?: string | undefined;
-                type: "image";
                 data: string;
+                type: "image";
             })[] | undefined;
             type: "tool-result";
             toolCallId: string;
@@ -442,6 +874,17 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
         role: "system";
         content: string;
     } | undefined;
+    error?: string | undefined;
+    text?: string | undefined;
+    reasoning?: string | undefined;
+    id?: string | undefined;
+    userId?: string | undefined;
+    embeddingId?: string | undefined;
+    fileIds?: string[] | undefined;
+    agentName?: string | undefined;
+    model?: string | undefined;
+    provider?: string | undefined;
+    providerOptions?: Record<string, Record<string, any>> | undefined;
     providerMetadata?: Record<string, Record<string, any>> | undefined;
     usage?: {
         promptTokens?: number | undefined;
@@ -481,8 +924,8 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
         type: "compatibility";
         feature: string;
     } | {
-        type: "deprecated";
         message: string;
+        type: "deprecated";
         setting: string;
     } | {
         details?: string | undefined;
@@ -493,8 +936,8 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
         tool: any;
         type: "unsupported-tool";
     } | {
-        type: "other";
         message: string;
+        type: "other";
     })[] | undefined;
     finishReason?: "error" | "length" | "other" | "stop" | "content-filter" | "tool-calls" | "unknown" | undefined;
     reasoningDetails?: ({
@@ -508,8 +951,8 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
         text: string;
         type: "text";
     } | {
-        type: "redacted";
         data: string;
+        type: "redacted";
     })[] | undefined;
     tool: boolean;
     status: "pending" | "success" | "failed";