@objectstack/spec 6.3.0 → 6.5.0

package/dist/ai/index.d.mts

@@ -1,5 +1,6 @@
 export { A as AIKnowledgeSchema, a as AIModelConfigSchema, b as AITool, c as AIToolSchema, d as Agent, e as AgentSchema, S as Skill, f as SkillSchema, g as SkillTriggerCondition, h as SkillTriggerConditionSchema, i as StructuredOutputConfig, j as StructuredOutputConfigSchema, k as StructuredOutputFormat, l as StructuredOutputFormatSchema, T as Tool, m as ToolCategory, n as ToolCategorySchema, o as ToolSchema, p as TransformPipelineStep, q as TransformPipelineStepSchema, r as defineAgent, s as defineSkill, t as defineTool } from '../skill.zod-VSSbcYfM.mjs';
 import { z } from 'zod';
+export { F as FileKnowledgeSource, a as FileKnowledgeSourceSchema, H as HttpKnowledgeSource, b as HttpKnowledgeSourceSchema, K as KnowledgeChunk, c as KnowledgeChunkSchema, d as KnowledgeDocument, e as KnowledgeDocumentSchema, f as KnowledgeHit, g as KnowledgeHitSchema, h as KnowledgeRefreshPolicy, i as KnowledgeRefreshPolicySchema, j as KnowledgeSource, k as KnowledgeSourceKind, l as KnowledgeSourceKindSchema, m as KnowledgeSourceSchema, O as ObjectKnowledgeSource, n as ObjectKnowledgeSourceSchema } from '../knowledge-document.zod-C8B-jI53.mjs';
 import '../state-machine.zod-BNanU03M.mjs';
 
 declare const MessageRoleSchema: z.ZodEnum<{

package/dist/ai/index.d.ts

@@ -1,5 +1,6 @@
 export { A as AIKnowledgeSchema, a as AIModelConfigSchema, b as AITool, c as AIToolSchema, d as Agent, e as AgentSchema, S as Skill, f as SkillSchema, g as SkillTriggerCondition, h as SkillTriggerConditionSchema, i as StructuredOutputConfig, j as StructuredOutputConfigSchema, k as StructuredOutputFormat, l as StructuredOutputFormatSchema, T as Tool, m as ToolCategory, n as ToolCategorySchema, o as ToolSchema, p as TransformPipelineStep, q as TransformPipelineStepSchema, r as defineAgent, s as defineSkill, t as defineTool } from '../skill.zod-C-iIBnNt.js';
 import { z } from 'zod';
+export { F as FileKnowledgeSource, a as FileKnowledgeSourceSchema, H as HttpKnowledgeSource, b as HttpKnowledgeSourceSchema, K as KnowledgeChunk, c as KnowledgeChunkSchema, d as KnowledgeDocument, e as KnowledgeDocumentSchema, f as KnowledgeHit, g as KnowledgeHitSchema, h as KnowledgeRefreshPolicy, i as KnowledgeRefreshPolicySchema, j as KnowledgeSource, k as KnowledgeSourceKind, l as KnowledgeSourceKindSchema, m as KnowledgeSourceSchema, O as ObjectKnowledgeSource, n as ObjectKnowledgeSourceSchema } from '../knowledge-document.zod-C8B-jI53.js';
 import '../state-machine.zod-BNanU03M.js';
 
 declare const MessageRoleSchema: z.ZodEnum<{

package/dist/ai/index.js

@@ -816,6 +816,147 @@ var MCPToolBindingSchema = lazySchema(() => zod.z.object({
   /** Approval policy applied to this binding. */
   approval: MCPApprovalPolicySchema.default("never")
 }));
+var KnowledgeRefreshPolicySchema = lazySchema(() => zod.z.object({
+  /**
+   * Subscribe to ObjectQL `record.*` events for `object` sources.
+   * Defaults to `true` for object sources; ignored for file/http.
+   */
+  onRecordChange: zod.z.boolean().default(true).optional(),
+  /**
+   * Cron expression (5-field) for periodic full reindex. Optional.
+   * `service-knowledge` does not schedule the cron itself — it merely
+   * surfaces the value so an automation flow / external scheduler can
+   * trigger `reindexSource`.
+   */
+  cron: zod.z.string().optional()
+}));
+var ObjectKnowledgeSourceSchema = lazySchema(() => zod.z.object({
+  kind: zod.z.literal("object"),
+  /** Short object name (e.g. `task`, `kb_article`). */
+  object: zod.z.string().describe("Short object name to index"),
+  /**
+   * Fields to concatenate into the document body (in order).
+   * `*` means "use every readable text field" (adapter / service decides).
+   */
+  contentFields: zod.z.array(zod.z.string()).min(1).describe("Fields contributing to document content"),
+  /**
+   * Extra fields to project into `metadata` for filtering at search
+   * time (e.g. `status`, `owner_id`, `tags`).
+   */
+  metadataFields: zod.z.array(zod.z.string()).default([]).optional(),
+  /**
+   * Optional filter restricting which records are indexed.
+   * Uses ObjectQL `where` syntax.
+   */
+  where: zod.z.record(zod.z.string(), zod.z.unknown()).optional()
+}));
+var FileKnowledgeSourceSchema = lazySchema(() => zod.z.object({
+  kind: zod.z.literal("file"),
+  /** Storage prefix to scan (e.g. `kb/handbooks/`). */
+  prefix: zod.z.string().describe("Storage prefix"),
+  /** Optional MIME-type allow-list. Empty = all types. */
+  mimeTypes: zod.z.array(zod.z.string()).default([]).optional()
+}));
+var HttpKnowledgeSourceSchema = lazySchema(() => zod.z.object({
+  kind: zod.z.literal("http"),
+  /** URLs to fetch. */
+  urls: zod.z.array(zod.z.string().url()).min(1),
+  /** Optional User-Agent header. */
+  userAgent: zod.z.string().optional()
+}));
+var KnowledgeSourceKindSchema = lazySchema(() => zod.z.discriminatedUnion("kind", [
+  ObjectKnowledgeSourceSchema,
+  FileKnowledgeSourceSchema,
+  HttpKnowledgeSourceSchema
+]));
+var KnowledgeSourceSchema = lazySchema(() => zod.z.object({
+  /** Stable identifier. Snake_case. */
+  id: zod.z.string().regex(/^[a-z_][a-z0-9_]*$/).describe("Snake_case source id"),
+  /** Human-readable label. */
+  label: zod.z.string(),
+  /** Optional description. */
+  description: zod.z.string().optional(),
+  /**
+   * Adapter id this source binds to (e.g. `'ragflow'`, `'memory'`).
+   * Resolved at runtime by `IKnowledgeService.registerAdapter`.
+   */
+  adapter: zod.z.string().describe("Adapter id"),
+  /** Adapter-specific configuration (opaque to the service). */
+  adapterConfig: zod.z.record(zod.z.string(), zod.z.unknown()).default({}).optional(),
+  /** What gets indexed. */
+  source: KnowledgeSourceKindSchema,
+  /**
+   * Optional embedding model reference. Adapters that manage
+   * embeddings internally (RAGFlow, Dify, Vectara) may ignore this.
+   */
+  embedding: EmbeddingModelSchema.optional(),
+  /**
+   * Optional vector store reference. Same caveat as `embedding` — many
+   * adapters own their own backend.
+   */
+  vectorStore: VectorStoreSchema.optional(),
+  /** Refresh / sync configuration. */
+  refresh: KnowledgeRefreshPolicySchema.default({}).optional(),
+  /** Whether `search_knowledge` may expose this source to AI agents. */
+  aiExposed: zod.z.boolean().default(true).optional()
+}));
+var KnowledgeDocumentSchema = lazySchema(() => zod.z.object({
+  /** Globally-unique document id. Snake / kebab-safe. */
+  id: zod.z.string().describe("Document id"),
+  /** Logical source this document belongs to. */
+  sourceId: zod.z.string().describe("Owning KnowledgeSource id"),
+  /**
+   * Underlying ObjectQL record id when the source kind is `object`.
+   * Powers permission-aware retrieval: hits referencing a record are
+   * re-checked against the caller's `ExecutionContext`.
+   */
+  sourceRecordId: zod.z.string().optional(),
+  /** Document content. UTF-8 text. */
+  content: zod.z.string(),
+  /** Optional human-readable title (defaults to id when absent). */
+  title: zod.z.string().optional(),
+  /**
+   * Arbitrary key-value metadata. Adapters may use it for filtering
+   * (e.g. `{ status: 'active', tags: ['onboarding'] }`).
+   */
+  metadata: zod.z.record(zod.z.string(), zod.z.unknown()).default({}).optional(),
+  /**
+   * Optional permission descriptors for non-`object` sources. The
+   * framework treats this opaquely; permission-aware retrieval for
+   * `object` sources is handled by re-querying via the data engine.
+   */
+  permissions: zod.z.array(zod.z.string()).optional()
+}));
+var KnowledgeChunkSchema = lazySchema(() => zod.z.object({
+  /** Chunk id (typically `${documentId}#${index}`). */
+  id: zod.z.string(),
+  /** Owning document. */
+  documentId: zod.z.string(),
+  /** Index within the document (0-based). */
+  index: zod.z.number().int().nonnegative(),
+  /** Chunk text. */
+  content: zod.z.string(),
+  /** Optional metadata override (falls back to the document's). */
+  metadata: zod.z.record(zod.z.string(), zod.z.unknown()).optional()
+}));
+var KnowledgeHitSchema = lazySchema(() => zod.z.object({
+  /** Stable chunk id from the adapter. */
+  chunkId: zod.z.string(),
+  /** Owning document id. */
+  documentId: zod.z.string(),
+  /** Source this hit came from. */
+  sourceId: zod.z.string(),
+  /** ObjectQL record id when applicable — used for RLS re-check. */
+  sourceRecordId: zod.z.string().optional(),
+  /** Relevance score (higher = better). */
+  score: zod.z.number(),
+  /** Snippet shown to the user / LLM. */
+  snippet: zod.z.string(),
+  /** Optional title surfaced from the document. */
+  title: zod.z.string().optional(),
+  /** Free-form metadata propagated from the document. */
+  metadata: zod.z.record(zod.z.string(), zod.z.unknown()).default({}).optional()
+}));
 
 exports.AIKnowledgeSchema = AIKnowledgeSchema;
 exports.AIModelConfigSchema = AIModelConfigSchema;
@@ -830,8 +971,16 @@ exports.ConversationSessionSchema = ConversationSessionSchema;
 exports.ConversationSummarySchema = ConversationSummarySchema;
 exports.EmbeddingModelSchema = EmbeddingModelSchema;
 exports.FileContentSchema = FileContentSchema;
+exports.FileKnowledgeSourceSchema = FileKnowledgeSourceSchema;
 exports.FunctionCallSchema = FunctionCallSchema;
+exports.HttpKnowledgeSourceSchema = HttpKnowledgeSourceSchema;
 exports.ImageContentSchema = ImageContentSchema;
+exports.KnowledgeChunkSchema = KnowledgeChunkSchema;
+exports.KnowledgeDocumentSchema = KnowledgeDocumentSchema;
+exports.KnowledgeHitSchema = KnowledgeHitSchema;
+exports.KnowledgeRefreshPolicySchema = KnowledgeRefreshPolicySchema;
+exports.KnowledgeSourceKindSchema = KnowledgeSourceKindSchema;
+exports.KnowledgeSourceSchema = KnowledgeSourceSchema;
 exports.MCPApprovalPolicySchema = MCPApprovalPolicySchema;
 exports.MCPServerRefSchema = MCPServerRefSchema;
 exports.MCPToolBindingSchema = MCPToolBindingSchema;
@@ -848,6 +997,7 @@ exports.ModelProviderSchema = ModelProviderSchema;
 exports.ModelRegistryEntrySchema = ModelRegistryEntrySchema;
 exports.ModelRegistrySchema = ModelRegistrySchema;
 exports.ModelSelectionCriteriaSchema = ModelSelectionCriteriaSchema;
+exports.ObjectKnowledgeSourceSchema = ObjectKnowledgeSourceSchema;
 exports.PromptTemplateSchema = PromptTemplateSchema;
 exports.PromptVariableSchema = PromptVariableSchema;
 exports.SkillSchema = SkillSchema;