@objectstack/spec 0.3.2 → 0.4.1

package/dist/ai/rag-pipeline.zod.d.ts

@@ -21,21 +21,21 @@ export declare const EmbeddingModelSchema: z.ZodObject<{
     endpoint: z.ZodOptional<z.ZodString>;
     apiKey: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    provider: "custom" | "openai" | "azure_openai" | "local" | "cohere" | "huggingface";
-    batchSize: number;
-    model: string;
     dimensions: number;
+    provider: "custom" | "local" | "openai" | "azure_openai" | "cohere" | "huggingface";
+    model: string;
+    batchSize: number;
     endpoint?: string | undefined;
     apiKey?: string | undefined;
     maxTokens?: number | undefined;
 }, {
-    provider: "custom" | "openai" | "azure_openai" | "local" | "cohere" | "huggingface";
-    model: string;
     dimensions: number;
-    batchSize?: number | undefined;
+    provider: "custom" | "local" | "openai" | "azure_openai" | "cohere" | "huggingface";
+    model: string;
     endpoint?: string | undefined;
     apiKey?: string | undefined;
     maxTokens?: number | undefined;
+    batchSize?: number | undefined;
 }>;
 /**
  * Text Chunking Strategy
@@ -118,25 +118,25 @@ export declare const DocumentMetadataSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     source: string;
     custom?: Record<string, any> | undefined;
+    tags?: string[] | undefined;
     language?: string | undefined;
     title?: string | undefined;
-    createdAt?: string | undefined;
-    updatedAt?: string | undefined;
-    tags?: string[] | undefined;
     category?: string | undefined;
-    sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
     author?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
 }, {
     source: string;
     custom?: Record<string, any> | undefined;
+    tags?: string[] | undefined;
     language?: string | undefined;
     title?: string | undefined;
-    createdAt?: string | undefined;
-    updatedAt?: string | undefined;
-    tags?: string[] | undefined;
     category?: string | undefined;
-    sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
     author?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
 }>;
 /**
  * Document Chunk
@@ -159,25 +159,25 @@ export declare const DocumentChunkSchema: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         source: string;
         custom?: Record<string, any> | undefined;
+        tags?: string[] | undefined;
         language?: string | undefined;
         title?: string | undefined;
-        createdAt?: string | undefined;
-        updatedAt?: string | undefined;
-        tags?: string[] | undefined;
         category?: string | undefined;
-        sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
         author?: string | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
     }, {
         source: string;
         custom?: Record<string, any> | undefined;
+        tags?: string[] | undefined;
         language?: string | undefined;
         title?: string | undefined;
-        createdAt?: string | undefined;
-        updatedAt?: string | undefined;
-        tags?: string[] | undefined;
         category?: string | undefined;
-        sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
         author?: string | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
     }>;
     chunkIndex: z.ZodNumber;
     tokens: z.ZodOptional<z.ZodNumber>;
@@ -186,14 +186,14 @@ export declare const DocumentChunkSchema: z.ZodObject<{
     metadata: {
         source: string;
         custom?: Record<string, any> | undefined;
+        tags?: string[] | undefined;
         language?: string | undefined;
         title?: string | undefined;
-        createdAt?: string | undefined;
-        updatedAt?: string | undefined;
-        tags?: string[] | undefined;
         category?: string | undefined;
-        sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
         author?: string | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
     };
     content: string;
     chunkIndex: number;
@@ -204,14 +204,14 @@ export declare const DocumentChunkSchema: z.ZodObject<{
     metadata: {
         source: string;
         custom?: Record<string, any> | undefined;
+        tags?: string[] | undefined;
         language?: string | undefined;
         title?: string | undefined;
-        createdAt?: string | undefined;
-        updatedAt?: string | undefined;
-        tags?: string[] | undefined;
         category?: string | undefined;
-        sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
         author?: string | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
     };
     content: string;
     chunkIndex: number;
@@ -290,8 +290,8 @@ export declare const RerankingConfigSchema: z.ZodObject<{
     provider?: "custom" | "cohere" | "huggingface" | undefined;
     model?: string | undefined;
 }, {
-    provider?: "custom" | "cohere" | "huggingface" | undefined;
     enabled?: boolean | undefined;
+    provider?: "custom" | "cohere" | "huggingface" | undefined;
     model?: string | undefined;
     topK?: number | undefined;
 }>;
@@ -314,28 +314,28 @@ export declare const VectorStoreConfigSchema: z.ZodObject<{
     connectionPoolSize: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     timeout: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
 }, "strip", z.ZodTypeAny, {
+    dimensions: number;
     timeout: number;
-    provider: "custom" | "redis" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "opensearch";
-    batchSize: number;
+    provider: "custom" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "redis" | "opensearch";
     metric: "cosine" | "euclidean" | "dotproduct";
-    dimensions: number;
+    batchSize: number;
     indexName: string;
     connectionPoolSize: number;
     apiKey?: string | undefined;
-    namespace?: string | undefined;
     host?: string | undefined;
     port?: number | undefined;
+    namespace?: string | undefined;
 }, {
-    provider: "custom" | "redis" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "opensearch";
     dimensions: number;
+    provider: "custom" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "redis" | "opensearch";
     indexName: string;
     timeout?: number | undefined;
-    batchSize?: number | undefined;
     metric?: "cosine" | "euclidean" | "dotproduct" | undefined;
     apiKey?: string | undefined;
-    namespace?: string | undefined;
     host?: string | undefined;
     port?: number | undefined;
+    batchSize?: number | undefined;
+    namespace?: string | undefined;
     connectionPoolSize?: number | undefined;
 }>;
 /**
@@ -357,7 +357,7 @@ export declare const DocumentLoaderConfigSchema: z.ZodObject<{
     /** Custom Loader */
     loaderConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
 }, "strip", z.ZodTypeAny, {
-    type: "url" | "file" | "custom" | "api" | "database" | "directory";
+    type: "custom" | "database" | "url" | "file" | "api" | "directory";
     source: string;
     recursive: boolean;
     extractImages: boolean;
@@ -367,7 +367,7 @@ export declare const DocumentLoaderConfigSchema: z.ZodObject<{
     excludePatterns?: string[] | undefined;
     loaderConfig?: Record<string, any> | undefined;
 }, {
-    type: "url" | "file" | "custom" | "api" | "database" | "directory";
+    type: "custom" | "database" | "url" | "file" | "api" | "directory";
     source: string;
     recursive?: boolean | undefined;
     fileTypes?: string[] | undefined;
@@ -395,21 +395,21 @@ export declare const RAGPipelineConfigSchema: z.ZodObject<{
         endpoint: z.ZodOptional<z.ZodString>;
         apiKey: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        provider: "custom" | "openai" | "azure_openai" | "local" | "cohere" | "huggingface";
-        batchSize: number;
-        model: string;
         dimensions: number;
+        provider: "custom" | "local" | "openai" | "azure_openai" | "cohere" | "huggingface";
+        model: string;
+        batchSize: number;
         endpoint?: string | undefined;
         apiKey?: string | undefined;
         maxTokens?: number | undefined;
     }, {
-        provider: "custom" | "openai" | "azure_openai" | "local" | "cohere" | "huggingface";
-        model: string;
         dimensions: number;
-        batchSize?: number | undefined;
+        provider: "custom" | "local" | "openai" | "azure_openai" | "cohere" | "huggingface";
+        model: string;
         endpoint?: string | undefined;
         apiKey?: string | undefined;
         maxTokens?: number | undefined;
+        batchSize?: number | undefined;
     }>;
     vectorStore: z.ZodObject<{
         provider: z.ZodEnum<["pinecone", "weaviate", "qdrant", "milvus", "chroma", "pgvector", "redis", "opensearch", "elasticsearch", "custom"]>;
@@ -427,28 +427,28 @@ export declare const RAGPipelineConfigSchema: z.ZodObject<{
         connectionPoolSize: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
         timeout: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     }, "strip", z.ZodTypeAny, {
+        dimensions: number;
         timeout: number;
-        provider: "custom" | "redis" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "opensearch";
-        batchSize: number;
+        provider: "custom" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "redis" | "opensearch";
         metric: "cosine" | "euclidean" | "dotproduct";
-        dimensions: number;
+        batchSize: number;
         indexName: string;
         connectionPoolSize: number;
         apiKey?: string | undefined;
-        namespace?: string | undefined;
         host?: string | undefined;
         port?: number | undefined;
+        namespace?: string | undefined;
     }, {
-        provider: "custom" | "redis" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "opensearch";
         dimensions: number;
+        provider: "custom" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "redis" | "opensearch";
         indexName: string;
         timeout?: number | undefined;
-        batchSize?: number | undefined;
         metric?: "cosine" | "euclidean" | "dotproduct" | undefined;
         apiKey?: string | undefined;
-        namespace?: string | undefined;
         host?: string | undefined;
         port?: number | undefined;
+        batchSize?: number | undefined;
+        namespace?: string | undefined;
         connectionPoolSize?: number | undefined;
     }>;
     chunking: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
@@ -578,8 +578,8 @@ export declare const RAGPipelineConfigSchema: z.ZodObject<{
         provider?: "custom" | "cohere" | "huggingface" | undefined;
         model?: string | undefined;
     }, {
-        provider?: "custom" | "cohere" | "huggingface" | undefined;
         enabled?: boolean | undefined;
+        provider?: "custom" | "cohere" | "huggingface" | undefined;
         model?: string | undefined;
         topK?: number | undefined;
     }>>;
@@ -600,7 +600,7 @@ export declare const RAGPipelineConfigSchema: z.ZodObject<{
         /** Custom Loader */
         loaderConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     }, "strip", z.ZodTypeAny, {
-        type: "url" | "file" | "custom" | "api" | "database" | "directory";
+        type: "custom" | "database" | "url" | "file" | "api" | "directory";
         source: string;
         recursive: boolean;
         extractImages: boolean;
@@ -610,7 +610,7 @@ export declare const RAGPipelineConfigSchema: z.ZodObject<{
         excludePatterns?: string[] | undefined;
         loaderConfig?: Record<string, any> | undefined;
     }, {
-        type: "url" | "file" | "custom" | "api" | "database" | "directory";
+        type: "custom" | "database" | "url" | "file" | "api" | "directory";
         source: string;
         recursive?: boolean | undefined;
         fileTypes?: string[] | undefined;
@@ -633,26 +633,26 @@ export declare const RAGPipelineConfigSchema: z.ZodObject<{
     label: string;
     name: string;
     embedding: {
-        provider: "custom" | "openai" | "azure_openai" | "local" | "cohere" | "huggingface";
-        batchSize: number;
-        model: string;
         dimensions: number;
+        provider: "custom" | "local" | "openai" | "azure_openai" | "cohere" | "huggingface";
+        model: string;
+        batchSize: number;
         endpoint?: string | undefined;
         apiKey?: string | undefined;
         maxTokens?: number | undefined;
     };
     vectorStore: {
+        dimensions: number;
         timeout: number;
-        provider: "custom" | "redis" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "opensearch";
-        batchSize: number;
+        provider: "custom" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "redis" | "opensearch";
         metric: "cosine" | "euclidean" | "dotproduct";
-        dimensions: number;
+        batchSize: number;
         indexName: string;
         connectionPoolSize: number;
         apiKey?: string | undefined;
-        namespace?: string | undefined;
         host?: string | undefined;
         port?: number | undefined;
+        namespace?: string | undefined;
     };
     chunking: {
         type: "fixed";
@@ -706,7 +706,7 @@ export declare const RAGPipelineConfigSchema: z.ZodObject<{
         model?: string | undefined;
     } | undefined;
     loaders?: {
-        type: "url" | "file" | "custom" | "api" | "database" | "directory";
+        type: "custom" | "database" | "url" | "file" | "api" | "directory";
         source: string;
         recursive: boolean;
         extractImages: boolean;
@@ -717,30 +717,30 @@ export declare const RAGPipelineConfigSchema: z.ZodObject<{
         loaderConfig?: Record<string, any> | undefined;
     }[] | undefined;
     metadataFilters?: Record<string, string | number | boolean | (string | number)[]> | undefined;
-    cacheInvalidationStrategy?: "manual" | "on_update" | "time_based" | undefined;
+    cacheInvalidationStrategy?: "time_based" | "manual" | "on_update" | undefined;
 }, {
     label: string;
     name: string;
     embedding: {
-        provider: "custom" | "openai" | "azure_openai" | "local" | "cohere" | "huggingface";
-        model: string;
         dimensions: number;
-        batchSize?: number | undefined;
+        provider: "custom" | "local" | "openai" | "azure_openai" | "cohere" | "huggingface";
+        model: string;
         endpoint?: string | undefined;
         apiKey?: string | undefined;
         maxTokens?: number | undefined;
+        batchSize?: number | undefined;
     };
     vectorStore: {
-        provider: "custom" | "redis" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "opensearch";
         dimensions: number;
+        provider: "custom" | "elasticsearch" | "pinecone" | "weaviate" | "qdrant" | "milvus" | "chroma" | "pgvector" | "redis" | "opensearch";
         indexName: string;
         timeout?: number | undefined;
-        batchSize?: number | undefined;
         metric?: "cosine" | "euclidean" | "dotproduct" | undefined;
         apiKey?: string | undefined;
-        namespace?: string | undefined;
         host?: string | undefined;
         port?: number | undefined;
+        batchSize?: number | undefined;
+        namespace?: string | undefined;
         connectionPoolSize?: number | undefined;
     };
     chunking: {
@@ -786,13 +786,13 @@ export declare const RAGPipelineConfigSchema: z.ZodObject<{
     description?: string | undefined;
     contextWindow?: number | undefined;
     reranking?: {
-        provider?: "custom" | "cohere" | "huggingface" | undefined;
         enabled?: boolean | undefined;
+        provider?: "custom" | "cohere" | "huggingface" | undefined;
         model?: string | undefined;
         topK?: number | undefined;
     } | undefined;
     loaders?: {
-        type: "url" | "file" | "custom" | "api" | "database" | "directory";
+        type: "custom" | "database" | "url" | "file" | "api" | "directory";
         source: string;
         recursive?: boolean | undefined;
         fileTypes?: string[] | undefined;
@@ -806,7 +806,7 @@ export declare const RAGPipelineConfigSchema: z.ZodObject<{
     metadataFilters?: Record<string, string | number | boolean | (string | number)[]> | undefined;
     enableCache?: boolean | undefined;
     cacheTTL?: number | undefined;
-    cacheInvalidationStrategy?: "manual" | "on_update" | "time_based" | undefined;
+    cacheInvalidationStrategy?: "time_based" | "manual" | "on_update" | undefined;
 }>;
 /**
  * RAG Query Request
@@ -822,10 +822,10 @@ export declare const RAGQueryRequestSchema: z.ZodObject<{
         role: z.ZodEnum<["user", "assistant", "system"]>;
         content: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        role: "system" | "user" | "assistant";
+        role: "user" | "system" | "assistant";
         content: string;
     }, {
-        role: "system" | "user" | "assistant";
+        role: "user" | "system" | "assistant";
         content: string;
     }>, "many">>;
     /** Options */
@@ -839,7 +839,7 @@ export declare const RAGQueryRequestSchema: z.ZodObject<{
     topK?: number | undefined;
     metadataFilters?: Record<string, any> | undefined;
     conversationHistory?: {
-        role: "system" | "user" | "assistant";
+        role: "user" | "system" | "assistant";
         content: string;
     }[] | undefined;
 }, {
@@ -848,7 +848,7 @@ export declare const RAGQueryRequestSchema: z.ZodObject<{
     topK?: number | undefined;
     metadataFilters?: Record<string, any> | undefined;
     conversationHistory?: {
-        role: "system" | "user" | "assistant";
+        role: "user" | "system" | "assistant";
         content: string;
     }[] | undefined;
     includeMetadata?: boolean | undefined;
@@ -876,25 +876,25 @@ export declare const RAGQueryResponseSchema: z.ZodObject<{
         }, "strip", z.ZodTypeAny, {
             source: string;
             custom?: Record<string, any> | undefined;
+            tags?: string[] | undefined;
             language?: string | undefined;
             title?: string | undefined;
-            createdAt?: string | undefined;
-            updatedAt?: string | undefined;
-            tags?: string[] | undefined;
             category?: string | undefined;
-            sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
             author?: string | undefined;
+            createdAt?: string | undefined;
+            updatedAt?: string | undefined;
+            sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
         }, {
             source: string;
             custom?: Record<string, any> | undefined;
+            tags?: string[] | undefined;
             language?: string | undefined;
             title?: string | undefined;
-            createdAt?: string | undefined;
-            updatedAt?: string | undefined;
-            tags?: string[] | undefined;
             category?: string | undefined;
-            sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
             author?: string | undefined;
+            createdAt?: string | undefined;
+            updatedAt?: string | undefined;
+            sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
         }>>;
         chunkId: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
@@ -903,14 +903,14 @@ export declare const RAGQueryResponseSchema: z.ZodObject<{
         metadata?: {
             source: string;
             custom?: Record<string, any> | undefined;
+            tags?: string[] | undefined;
             language?: string | undefined;
             title?: string | undefined;
-            createdAt?: string | undefined;
-            updatedAt?: string | undefined;
-            tags?: string[] | undefined;
             category?: string | undefined;
-            sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
             author?: string | undefined;
+            createdAt?: string | undefined;
+            updatedAt?: string | undefined;
+            sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
         } | undefined;
         chunkId?: string | undefined;
     }, {
@@ -919,14 +919,14 @@ export declare const RAGQueryResponseSchema: z.ZodObject<{
         metadata?: {
             source: string;
             custom?: Record<string, any> | undefined;
+            tags?: string[] | undefined;
             language?: string | undefined;
             title?: string | undefined;
-            createdAt?: string | undefined;
-            updatedAt?: string | undefined;
-            tags?: string[] | undefined;
             category?: string | undefined;
-            sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
             author?: string | undefined;
+            createdAt?: string | undefined;
+            updatedAt?: string | undefined;
+            sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
         } | undefined;
         chunkId?: string | undefined;
     }>, "many">;
@@ -942,14 +942,14 @@ export declare const RAGQueryResponseSchema: z.ZodObject<{
         metadata?: {
             source: string;
             custom?: Record<string, any> | undefined;
+            tags?: string[] | undefined;
             language?: string | undefined;
             title?: string | undefined;
-            createdAt?: string | undefined;
-            updatedAt?: string | undefined;
-            tags?: string[] | undefined;
             category?: string | undefined;
-            sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
             author?: string | undefined;
+            createdAt?: string | undefined;
+            updatedAt?: string | undefined;
+            sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
         } | undefined;
         chunkId?: string | undefined;
     }[];
@@ -964,14 +964,14 @@ export declare const RAGQueryResponseSchema: z.ZodObject<{
         metadata?: {
             source: string;
             custom?: Record<string, any> | undefined;
+            tags?: string[] | undefined;
             language?: string | undefined;
             title?: string | undefined;
-            createdAt?: string | undefined;
-            updatedAt?: string | undefined;
-            tags?: string[] | undefined;
             category?: string | undefined;
-            sourceType?: "url" | "file" | "custom" | "api" | "database" | undefined;
             author?: string | undefined;
+            createdAt?: string | undefined;
+            updatedAt?: string | undefined;
+            sourceType?: "custom" | "database" | "url" | "file" | "api" | undefined;
         } | undefined;
         chunkId?: string | undefined;
     }[];