@objectstack/spec 0.3.2 → 0.4.1

package/dist/ai/nlq.zod.d.ts

@@ -19,14 +19,14 @@ export declare const EntitySchema: z.ZodObject<{
     confidence: z.ZodNumber;
     span: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
 }, "strip", z.ZodTypeAny, {
-    text: string;
     type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+    text: string;
     confidence: number;
     value?: any;
     span?: [number, number] | undefined;
 }, {
-    text: string;
     type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+    text: string;
     confidence: number;
     value?: any;
     span?: [number, number] | undefined;
@@ -53,8 +53,8 @@ export declare const TimeframeSchema: z.ZodObject<{
     }>>;
     text: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    text: string;
     type: "absolute" | "relative";
+    text: string;
     start?: string | undefined;
     end?: string | undefined;
     relative?: {
@@ -63,8 +63,8 @@ export declare const TimeframeSchema: z.ZodObject<{
         direction: "past" | "future" | "current";
     } | undefined;
 }, {
-    text: string;
     type: "absolute" | "relative";
+    text: string;
     start?: string | undefined;
     end?: string | undefined;
     relative?: {
@@ -114,37 +114,37 @@ export declare const QueryContextSchema: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         timestamp: string;
         query: string;
-        intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+        intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
     }, {
         timestamp: string;
         query: string;
-        intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+        intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
     }>, "many">>;
     /** Preferences */
     defaultLimit: z.ZodDefault<z.ZodNumber>;
     timezone: z.ZodDefault<z.ZodString>;
     locale: z.ZodDefault<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    locale: string;
     timezone: string;
+    locale: string;
     defaultLimit: number;
     userId?: string | undefined;
     conversationHistory?: {
         timestamp: string;
         query: string;
-        intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+        intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
     }[] | undefined;
     userRole?: string | undefined;
     currentObject?: string | undefined;
     currentRecordId?: string | undefined;
 }, {
     userId?: string | undefined;
-    locale?: string | undefined;
     timezone?: string | undefined;
+    locale?: string | undefined;
     conversationHistory?: {
         timestamp: string;
         query: string;
-        intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+        intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
     }[] | undefined;
     userRole?: string | undefined;
     currentObject?: string | undefined;
@@ -168,14 +168,14 @@ export declare const NLQParseResultSchema: z.ZodObject<{
         confidence: z.ZodNumber;
         span: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
     }, "strip", z.ZodTypeAny, {
-        text: string;
         type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+        text: string;
         confidence: number;
         value?: any;
         span?: [number, number] | undefined;
     }, {
-        text: string;
         type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+        text: string;
         confidence: number;
         value?: any;
         span?: [number, number] | undefined;
@@ -221,8 +221,8 @@ export declare const NLQParseResultSchema: z.ZodObject<{
         }>>;
         text: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        text: string;
         type: "absolute" | "relative";
+        text: string;
         start?: string | undefined;
         end?: string | undefined;
         relative?: {
@@ -231,8 +231,8 @@ export declare const NLQParseResultSchema: z.ZodObject<{
             direction: "past" | "future" | "current";
         } | undefined;
     }, {
-        text: string;
         type: "absolute" | "relative";
+        text: string;
         start?: string | undefined;
         end?: string | undefined;
         relative?: {
@@ -274,12 +274,12 @@ export declare const NLQParseResultSchema: z.ZodObject<{
     }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     confidence: number;
-    intent: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight";
+    intent: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight";
     originalQuery: string;
     intentConfidence: number;
     entities: {
-        text: string;
         type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+        text: string;
         confidence: number;
         value?: any;
         span?: [number, number] | undefined;
@@ -291,10 +291,9 @@ export declare const NLQParseResultSchema: z.ZodObject<{
         naturalLanguage: string;
         objectField: string;
     }[] | undefined;
-    targetObject?: string | undefined;
     timeframe?: {
-        text: string;
         type: "absolute" | "relative";
+        text: string;
         start?: string | undefined;
         end?: string | undefined;
         relative?: {
@@ -303,6 +302,7 @@ export declare const NLQParseResultSchema: z.ZodObject<{
             direction: "past" | "future" | "current";
         } | undefined;
     } | undefined;
+    targetObject?: string | undefined;
     ast?: any;
     ambiguities?: {
         type: string;
@@ -316,12 +316,12 @@ export declare const NLQParseResultSchema: z.ZodObject<{
     }[] | undefined;
 }, {
     confidence: number;
-    intent: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight";
+    intent: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight";
     originalQuery: string;
     intentConfidence: number;
     entities: {
-        text: string;
         type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+        text: string;
         confidence: number;
         value?: any;
         span?: [number, number] | undefined;
@@ -333,10 +333,9 @@ export declare const NLQParseResultSchema: z.ZodObject<{
         naturalLanguage: string;
         objectField: string;
     }[] | undefined;
-    targetObject?: string | undefined;
     timeframe?: {
-        text: string;
         type: "absolute" | "relative";
+        text: string;
         start?: string | undefined;
         end?: string | undefined;
         relative?: {
@@ -345,6 +344,7 @@ export declare const NLQParseResultSchema: z.ZodObject<{
             direction?: "past" | "future" | "current" | undefined;
         } | undefined;
     } | undefined;
+    targetObject?: string | undefined;
     ast?: any;
     ambiguities?: {
         type: string;
@@ -379,37 +379,37 @@ export declare const NLQRequestSchema: z.ZodObject<{
         }, "strip", z.ZodTypeAny, {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }, {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }>, "many">>;
         /** Preferences */
         defaultLimit: z.ZodDefault<z.ZodNumber>;
         timezone: z.ZodDefault<z.ZodString>;
         locale: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        locale: string;
         timezone: string;
+        locale: string;
         defaultLimit: number;
         userId?: string | undefined;
         conversationHistory?: {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }[] | undefined;
         userRole?: string | undefined;
         currentObject?: string | undefined;
         currentRecordId?: string | undefined;
     }, {
         userId?: string | undefined;
-        locale?: string | undefined;
         timezone?: string | undefined;
+        locale?: string | undefined;
         conversationHistory?: {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }[] | undefined;
         userRole?: string | undefined;
         currentObject?: string | undefined;
@@ -430,14 +430,14 @@ export declare const NLQRequestSchema: z.ZodObject<{
     minConfidence: number;
     executeQuery: boolean;
     context?: {
-        locale: string;
         timezone: string;
+        locale: string;
         defaultLimit: number;
         userId?: string | undefined;
         conversationHistory?: {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }[] | undefined;
         userRole?: string | undefined;
         currentObject?: string | undefined;
@@ -448,12 +448,12 @@ export declare const NLQRequestSchema: z.ZodObject<{
     query: string;
     context?: {
         userId?: string | undefined;
-        locale?: string | undefined;
         timezone?: string | undefined;
+        locale?: string | undefined;
         conversationHistory?: {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }[] | undefined;
         userRole?: string | undefined;
         currentObject?: string | undefined;
@@ -485,14 +485,14 @@ export declare const NLQResponseSchema: z.ZodObject<{
             confidence: z.ZodNumber;
             span: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
         }, "strip", z.ZodTypeAny, {
-            text: string;
             type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+            text: string;
             confidence: number;
             value?: any;
             span?: [number, number] | undefined;
         }, {
-            text: string;
             type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+            text: string;
             confidence: number;
             value?: any;
             span?: [number, number] | undefined;
@@ -538,8 +538,8 @@ export declare const NLQResponseSchema: z.ZodObject<{
             }>>;
             text: z.ZodString;
         }, "strip", z.ZodTypeAny, {
-            text: string;
             type: "absolute" | "relative";
+            text: string;
             start?: string | undefined;
             end?: string | undefined;
             relative?: {
@@ -548,8 +548,8 @@ export declare const NLQResponseSchema: z.ZodObject<{
                 direction: "past" | "future" | "current";
             } | undefined;
         }, {
-            text: string;
             type: "absolute" | "relative";
+            text: string;
             start?: string | undefined;
             end?: string | undefined;
             relative?: {
@@ -591,12 +591,12 @@ export declare const NLQResponseSchema: z.ZodObject<{
         }>, "many">>;
     }, "strip", z.ZodTypeAny, {
         confidence: number;
-        intent: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight";
+        intent: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight";
         originalQuery: string;
         intentConfidence: number;
         entities: {
-            text: string;
             type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+            text: string;
             confidence: number;
             value?: any;
             span?: [number, number] | undefined;
@@ -608,10 +608,9 @@ export declare const NLQResponseSchema: z.ZodObject<{
             naturalLanguage: string;
             objectField: string;
         }[] | undefined;
-        targetObject?: string | undefined;
         timeframe?: {
-            text: string;
             type: "absolute" | "relative";
+            text: string;
             start?: string | undefined;
             end?: string | undefined;
             relative?: {
@@ -620,6 +619,7 @@ export declare const NLQResponseSchema: z.ZodObject<{
                 direction: "past" | "future" | "current";
             } | undefined;
         } | undefined;
+        targetObject?: string | undefined;
         ast?: any;
         ambiguities?: {
             type: string;
@@ -633,12 +633,12 @@ export declare const NLQResponseSchema: z.ZodObject<{
         }[] | undefined;
     }, {
         confidence: number;
-        intent: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight";
+        intent: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight";
         originalQuery: string;
         intentConfidence: number;
         entities: {
-            text: string;
             type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+            text: string;
             confidence: number;
             value?: any;
             span?: [number, number] | undefined;
@@ -650,10 +650,9 @@ export declare const NLQResponseSchema: z.ZodObject<{
             naturalLanguage: string;
             objectField: string;
         }[] | undefined;
-        targetObject?: string | undefined;
         timeframe?: {
-            text: string;
             type: "absolute" | "relative";
+            text: string;
             start?: string | undefined;
             end?: string | undefined;
             relative?: {
@@ -662,6 +661,7 @@ export declare const NLQResponseSchema: z.ZodObject<{
                 direction?: "past" | "future" | "current" | undefined;
             } | undefined;
         } | undefined;
+        targetObject?: string | undefined;
         ast?: any;
         ambiguities?: {
             type: string;
@@ -685,12 +685,12 @@ export declare const NLQResponseSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     parseResult: {
         confidence: number;
-        intent: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight";
+        intent: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight";
         originalQuery: string;
         intentConfidence: number;
         entities: {
-            text: string;
             type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+            text: string;
             confidence: number;
             value?: any;
             span?: [number, number] | undefined;
@@ -702,10 +702,9 @@ export declare const NLQResponseSchema: z.ZodObject<{
             naturalLanguage: string;
             objectField: string;
         }[] | undefined;
-        targetObject?: string | undefined;
         timeframe?: {
-            text: string;
             type: "absolute" | "relative";
+            text: string;
             start?: string | undefined;
             end?: string | undefined;
             relative?: {
@@ -714,6 +713,7 @@ export declare const NLQResponseSchema: z.ZodObject<{
                 direction: "past" | "future" | "current";
             } | undefined;
         } | undefined;
+        targetObject?: string | undefined;
         ast?: any;
         ambiguities?: {
             type: string;
@@ -734,12 +734,12 @@ export declare const NLQResponseSchema: z.ZodObject<{
 }, {
     parseResult: {
         confidence: number;
-        intent: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight";
+        intent: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight";
         originalQuery: string;
         intentConfidence: number;
         entities: {
-            text: string;
             type: "object" | "function" | "value" | "field" | "operator" | "timeframe";
+            text: string;
             confidence: number;
             value?: any;
             span?: [number, number] | undefined;
@@ -751,10 +751,9 @@ export declare const NLQResponseSchema: z.ZodObject<{
             naturalLanguage: string;
             objectField: string;
         }[] | undefined;
-        targetObject?: string | undefined;
         timeframe?: {
-            text: string;
             type: "absolute" | "relative";
+            text: string;
             start?: string | undefined;
             end?: string | undefined;
             relative?: {
@@ -763,6 +762,7 @@ export declare const NLQResponseSchema: z.ZodObject<{
                 direction?: "past" | "future" | "current" | undefined;
             } | undefined;
         } | undefined;
+        targetObject?: string | undefined;
         ast?: any;
         ambiguities?: {
             type: string;
@@ -802,37 +802,37 @@ export declare const NLQTrainingExampleSchema: z.ZodObject<{
         }, "strip", z.ZodTypeAny, {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }, {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }>, "many">>;
         /** Preferences */
         defaultLimit: z.ZodDefault<z.ZodNumber>;
         timezone: z.ZodDefault<z.ZodString>;
         locale: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        locale: string;
         timezone: string;
+        locale: string;
         defaultLimit: number;
         userId?: string | undefined;
         conversationHistory?: {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }[] | undefined;
         userRole?: string | undefined;
         currentObject?: string | undefined;
         currentRecordId?: string | undefined;
     }, {
         userId?: string | undefined;
-        locale?: string | undefined;
         timezone?: string | undefined;
+        locale?: string | undefined;
         conversationHistory?: {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }[] | undefined;
         userRole?: string | undefined;
         currentObject?: string | undefined;
@@ -849,45 +849,45 @@ export declare const NLQTrainingExampleSchema: z.ZodObject<{
     notes: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     query: string;
-    expectedIntent: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight";
+    expectedIntent: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight";
+    tags?: string[] | undefined;
+    category?: string | undefined;
     context?: {
-        locale: string;
         timezone: string;
+        locale: string;
         defaultLimit: number;
         userId?: string | undefined;
         conversationHistory?: {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }[] | undefined;
         userRole?: string | undefined;
         currentObject?: string | undefined;
         currentRecordId?: string | undefined;
     } | undefined;
-    tags?: string[] | undefined;
-    category?: string | undefined;
     expectedObject?: string | undefined;
     expectedAST?: any;
     notes?: string | undefined;
 }, {
     query: string;
-    expectedIntent: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight";
+    expectedIntent: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight";
+    tags?: string[] | undefined;
+    category?: string | undefined;
     context?: {
         userId?: string | undefined;
-        locale?: string | undefined;
         timezone?: string | undefined;
+        locale?: string | undefined;
         conversationHistory?: {
             timestamp: string;
             query: string;
-            intent?: "select" | "sort" | "filter" | "create" | "update" | "delete" | "aggregate" | "compare" | "trend" | "insight" | undefined;
+            intent?: "sort" | "filter" | "select" | "update" | "delete" | "create" | "aggregate" | "compare" | "trend" | "insight" | undefined;
         }[] | undefined;
         userRole?: string | undefined;
         currentObject?: string | undefined;
         currentRecordId?: string | undefined;
         defaultLimit?: number | undefined;
     } | undefined;
-    tags?: string[] | undefined;
-    category?: string | undefined;
     expectedObject?: string | undefined;
     expectedAST?: any;
     notes?: string | undefined;
@@ -1068,8 +1068,8 @@ export declare const QueryTemplateSchema: z.ZodObject<{
         required: z.ZodDefault<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         type: "object" | "value" | "field" | "timeframe";
-        name: string;
         required: boolean;
+        name: string;
     }, {
         type: "object" | "value" | "field" | "timeframe";
         name: string;
@@ -1085,12 +1085,12 @@ export declare const QueryTemplateSchema: z.ZodObject<{
     label: string;
     name: string;
     id: string;
+    pattern: string;
     variables: {
         type: "object" | "value" | "field" | "timeframe";
-        name: string;
         required: boolean;
+        name: string;
     }[];
-    pattern: string;
     tags?: string[] | undefined;
     category?: string | undefined;
     examples?: string[] | undefined;
@@ -1099,12 +1099,12 @@ export declare const QueryTemplateSchema: z.ZodObject<{
     label: string;
     name: string;
     id: string;
+    pattern: string;
     variables: {
         type: "object" | "value" | "field" | "timeframe";
         name: string;
         required?: boolean | undefined;
     }[];
-    pattern: string;
     tags?: string[] | undefined;
     category?: string | undefined;
     examples?: string[] | undefined;