@opengeni/contracts 0.44.1 → 0.50.0

package/dist/knowledge.d.ts

@@ -0,0 +1,543 @@
+import { z } from "zod";
+export declare const KNOWLEDGE_BROWSE_CURSOR_MAX_CHARS = 1024;
+export declare const KNOWLEDGE_BROWSE_DEFAULT_LIMIT = 20;
+export declare const KNOWLEDGE_BROWSE_MAX_LIMIT = 50;
+export declare const KNOWLEDGE_TITLE_MAX_BYTES = 1024;
+export declare const KNOWLEDGE_BODY_MAX_BYTES: number;
+export declare const KNOWLEDGE_SUMMARY_MAX_BYTES: number;
+export declare const KNOWLEDGE_TOPIC_MAX_BYTES = 256;
+export declare const KNOWLEDGE_TOPICS_MAX_ITEMS = 32;
+export declare const KNOWLEDGE_METADATA_MAX_BYTES: number;
+export declare const KNOWLEDGE_METADATA_MAX_ITEMS = 64;
+export declare const KNOWLEDGE_METADATA_MAX_DEPTH = 4;
+export declare const KNOWLEDGE_SOURCE_STRING_MAX_BYTES = 2048;
+export declare const KNOWLEDGE_SOURCE_URI_MAX_BYTES = 8192;
+export declare const KnowledgeRecordId: z.ZodString;
+export type KnowledgeRecordId = z.infer<typeof KnowledgeRecordId>;
+export declare const KnowledgeRecordKind: z.ZodEnum<{
+    document: "document";
+    document_chunk: "document_chunk";
+}>;
+export type KnowledgeRecordKind = z.infer<typeof KnowledgeRecordKind>;
+export declare const KnowledgeAuthority: z.ZodObject<{
+    kind: z.ZodEnum<{
+        organization: "organization";
+        personal: "personal";
+        workspace: "workspace";
+    }>;
+}, z.core.$strip>;
+export type KnowledgeAuthority = z.infer<typeof KnowledgeAuthority>;
+export declare const KnowledgeSource: z.ZodObject<{
+    kind: z.ZodEnum<{
+        chat: "chat";
+        document: "document";
+        email: "email";
+        manual_upload: "manual_upload";
+        meeting_transcript: "meeting_transcript";
+        other: "other";
+        repository: "repository";
+        web: "web";
+    }>;
+    uri: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodString>>;
+    externalId: z.ZodNullable<z.ZodString>;
+    title: z.ZodNullable<z.ZodString>;
+    author: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodNullable<z.ZodString>;
+    updatedAt: z.ZodNullable<z.ZodString>;
+    version: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type KnowledgeSource = z.infer<typeof KnowledgeSource>;
+export declare const KnowledgeLinkTarget: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"knowledge">;
+    id: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    kind: z.ZodLiteral<"external">;
+    uri: z.ZodPipe<z.ZodString, z.ZodString>;
+}, z.core.$strip>], "kind">;
+export type KnowledgeLinkTarget = z.infer<typeof KnowledgeLinkTarget>;
+export declare const KnowledgeLink: z.ZodObject<{
+    relation: z.ZodEnum<{
+        contents: "contents";
+        next: "next";
+        parent: "parent";
+        previous: "previous";
+        source: "source";
+    }>;
+    target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"knowledge">;
+        id: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"external">;
+        uri: z.ZodPipe<z.ZodString, z.ZodString>;
+    }, z.core.$strip>], "kind">;
+}, z.core.$strip>;
+export type KnowledgeLink = z.infer<typeof KnowledgeLink>;
+/**
+ * Permission-safe agent projection over one flexible knowledge record. Scope,
+ * provenance, lifecycle, and stable identity are strict. The body and metadata
+ * stay source-shaped so varied company knowledge does not require one rigid
+ * taxonomy. Personal subject ids and inaccessible linked-record metadata are
+ * deliberately absent.
+ */
+export declare const KnowledgeRecord: z.ZodObject<{
+    id: z.ZodString;
+    kind: z.ZodEnum<{
+        document: "document";
+        document_chunk: "document_chunk";
+    }>;
+    title: z.ZodString;
+    content: z.ZodObject<{
+        format: z.ZodLiteral<"markdown">;
+        body: z.ZodNullable<z.ZodString>;
+        summary: z.ZodNullable<z.ZodString>;
+        topics: z.ZodArray<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    }, z.core.$strip>;
+    authority: z.ZodObject<{
+        kind: z.ZodEnum<{
+            organization: "organization";
+            personal: "personal";
+            workspace: "workspace";
+        }>;
+    }, z.core.$strip>;
+    provenance: z.ZodObject<{
+        source: z.ZodObject<{
+            kind: z.ZodEnum<{
+                chat: "chat";
+                document: "document";
+                email: "email";
+                manual_upload: "manual_upload";
+                meeting_transcript: "meeting_transcript";
+                other: "other";
+                repository: "repository";
+                web: "web";
+            }>;
+            uri: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodString>>;
+            externalId: z.ZodNullable<z.ZodString>;
+            title: z.ZodNullable<z.ZodString>;
+            author: z.ZodNullable<z.ZodString>;
+            createdAt: z.ZodNullable<z.ZodString>;
+            updatedAt: z.ZodNullable<z.ZodString>;
+            version: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
+        indexedAt: z.ZodString;
+    }, z.core.$strip>;
+    lifecycle: z.ZodObject<{
+        state: z.ZodLiteral<"active">;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>;
+    quality: z.ZodObject<{
+        trust: z.ZodLiteral<"sourced">;
+        freshnessAt: z.ZodString;
+        conflict: z.ZodLiteral<"not_evaluated">;
+        correction: z.ZodLiteral<"current_source_version">;
+    }, z.core.$strip>;
+    links: z.ZodArray<z.ZodObject<{
+        relation: z.ZodEnum<{
+            contents: "contents";
+            next: "next";
+            parent: "parent";
+            previous: "previous";
+            source: "source";
+        }>;
+        target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            kind: z.ZodLiteral<"knowledge">;
+            id: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            kind: z.ZodLiteral<"external">;
+            uri: z.ZodPipe<z.ZodString, z.ZodString>;
+        }, z.core.$strip>], "kind">;
+    }, z.core.$strip>>;
+    projection: z.ZodObject<{
+        truncated: z.ZodBoolean;
+        fields: z.ZodArray<z.ZodEnum<{
+            "content.body": "content.body";
+            "content.metadata": "content.metadata";
+            "content.summary": "content.summary";
+            "content.topics": "content.topics";
+            "provenance.source.author": "provenance.source.author";
+            "provenance.source.externalId": "provenance.source.externalId";
+            "provenance.source.title": "provenance.source.title";
+            "provenance.source.uri": "provenance.source.uri";
+            "provenance.source.version": "provenance.source.version";
+            title: "title";
+        }>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type KnowledgeRecord = z.infer<typeof KnowledgeRecord>;
+export declare const KnowledgeSearchResult: z.ZodObject<{
+    record: z.ZodObject<{
+        id: z.ZodString;
+        kind: z.ZodEnum<{
+            document: "document";
+            document_chunk: "document_chunk";
+        }>;
+        title: z.ZodString;
+        content: z.ZodObject<{
+            format: z.ZodLiteral<"markdown">;
+            body: z.ZodNullable<z.ZodString>;
+            summary: z.ZodNullable<z.ZodString>;
+            topics: z.ZodArray<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, z.core.$strip>;
+        authority: z.ZodObject<{
+            kind: z.ZodEnum<{
+                organization: "organization";
+                personal: "personal";
+                workspace: "workspace";
+            }>;
+        }, z.core.$strip>;
+        provenance: z.ZodObject<{
+            source: z.ZodObject<{
+                kind: z.ZodEnum<{
+                    chat: "chat";
+                    document: "document";
+                    email: "email";
+                    manual_upload: "manual_upload";
+                    meeting_transcript: "meeting_transcript";
+                    other: "other";
+                    repository: "repository";
+                    web: "web";
+                }>;
+                uri: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodString>>;
+                externalId: z.ZodNullable<z.ZodString>;
+                title: z.ZodNullable<z.ZodString>;
+                author: z.ZodNullable<z.ZodString>;
+                createdAt: z.ZodNullable<z.ZodString>;
+                updatedAt: z.ZodNullable<z.ZodString>;
+                version: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+            indexedAt: z.ZodString;
+        }, z.core.$strip>;
+        lifecycle: z.ZodObject<{
+            state: z.ZodLiteral<"active">;
+            updatedAt: z.ZodString;
+        }, z.core.$strip>;
+        quality: z.ZodObject<{
+            trust: z.ZodLiteral<"sourced">;
+            freshnessAt: z.ZodString;
+            conflict: z.ZodLiteral<"not_evaluated">;
+            correction: z.ZodLiteral<"current_source_version">;
+        }, z.core.$strip>;
+        links: z.ZodArray<z.ZodObject<{
+            relation: z.ZodEnum<{
+                contents: "contents";
+                next: "next";
+                parent: "parent";
+                previous: "previous";
+                source: "source";
+            }>;
+            target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+                kind: z.ZodLiteral<"knowledge">;
+                id: z.ZodString;
+            }, z.core.$strip>, z.ZodObject<{
+                kind: z.ZodLiteral<"external">;
+                uri: z.ZodPipe<z.ZodString, z.ZodString>;
+            }, z.core.$strip>], "kind">;
+        }, z.core.$strip>>;
+        projection: z.ZodObject<{
+            truncated: z.ZodBoolean;
+            fields: z.ZodArray<z.ZodEnum<{
+                "content.body": "content.body";
+                "content.metadata": "content.metadata";
+                "content.summary": "content.summary";
+                "content.topics": "content.topics";
+                "provenance.source.author": "provenance.source.author";
+                "provenance.source.externalId": "provenance.source.externalId";
+                "provenance.source.title": "provenance.source.title";
+                "provenance.source.uri": "provenance.source.uri";
+                "provenance.source.version": "provenance.source.version";
+                title: "title";
+            }>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    retrieval: z.ZodObject<{
+        score: z.ZodNumber;
+        matchType: z.ZodEnum<{
+            hybrid: "hybrid";
+            keyword: "keyword";
+            vector: "vector";
+        }>;
+        vectorScore: z.ZodNullable<z.ZodNumber>;
+        keywordScore: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type KnowledgeSearchResult = z.infer<typeof KnowledgeSearchResult>;
+export declare const KnowledgeSearchResponse: z.ZodObject<{
+    results: z.ZodArray<z.ZodObject<{
+        record: z.ZodObject<{
+            id: z.ZodString;
+            kind: z.ZodEnum<{
+                document: "document";
+                document_chunk: "document_chunk";
+            }>;
+            title: z.ZodString;
+            content: z.ZodObject<{
+                format: z.ZodLiteral<"markdown">;
+                body: z.ZodNullable<z.ZodString>;
+                summary: z.ZodNullable<z.ZodString>;
+                topics: z.ZodArray<z.ZodString>;
+                metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            }, z.core.$strip>;
+            authority: z.ZodObject<{
+                kind: z.ZodEnum<{
+                    organization: "organization";
+                    personal: "personal";
+                    workspace: "workspace";
+                }>;
+            }, z.core.$strip>;
+            provenance: z.ZodObject<{
+                source: z.ZodObject<{
+                    kind: z.ZodEnum<{
+                        chat: "chat";
+                        document: "document";
+                        email: "email";
+                        manual_upload: "manual_upload";
+                        meeting_transcript: "meeting_transcript";
+                        other: "other";
+                        repository: "repository";
+                        web: "web";
+                    }>;
+                    uri: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodString>>;
+                    externalId: z.ZodNullable<z.ZodString>;
+                    title: z.ZodNullable<z.ZodString>;
+                    author: z.ZodNullable<z.ZodString>;
+                    createdAt: z.ZodNullable<z.ZodString>;
+                    updatedAt: z.ZodNullable<z.ZodString>;
+                    version: z.ZodNullable<z.ZodString>;
+                }, z.core.$strip>;
+                indexedAt: z.ZodString;
+            }, z.core.$strip>;
+            lifecycle: z.ZodObject<{
+                state: z.ZodLiteral<"active">;
+                updatedAt: z.ZodString;
+            }, z.core.$strip>;
+            quality: z.ZodObject<{
+                trust: z.ZodLiteral<"sourced">;
+                freshnessAt: z.ZodString;
+                conflict: z.ZodLiteral<"not_evaluated">;
+                correction: z.ZodLiteral<"current_source_version">;
+            }, z.core.$strip>;
+            links: z.ZodArray<z.ZodObject<{
+                relation: z.ZodEnum<{
+                    contents: "contents";
+                    next: "next";
+                    parent: "parent";
+                    previous: "previous";
+                    source: "source";
+                }>;
+                target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    kind: z.ZodLiteral<"knowledge">;
+                    id: z.ZodString;
+                }, z.core.$strip>, z.ZodObject<{
+                    kind: z.ZodLiteral<"external">;
+                    uri: z.ZodPipe<z.ZodString, z.ZodString>;
+                }, z.core.$strip>], "kind">;
+            }, z.core.$strip>>;
+            projection: z.ZodObject<{
+                truncated: z.ZodBoolean;
+                fields: z.ZodArray<z.ZodEnum<{
+                    "content.body": "content.body";
+                    "content.metadata": "content.metadata";
+                    "content.summary": "content.summary";
+                    "content.topics": "content.topics";
+                    "provenance.source.author": "provenance.source.author";
+                    "provenance.source.externalId": "provenance.source.externalId";
+                    "provenance.source.title": "provenance.source.title";
+                    "provenance.source.uri": "provenance.source.uri";
+                    "provenance.source.version": "provenance.source.version";
+                    title: "title";
+                }>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        retrieval: z.ZodObject<{
+            score: z.ZodNumber;
+            matchType: z.ZodEnum<{
+                hybrid: "hybrid";
+                keyword: "keyword";
+                vector: "vector";
+            }>;
+            vectorScore: z.ZodNullable<z.ZodNumber>;
+            keywordScore: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type KnowledgeSearchResponse = z.infer<typeof KnowledgeSearchResponse>;
+export declare const KnowledgeGetResponse: z.ZodObject<{
+    record: z.ZodObject<{
+        id: z.ZodString;
+        kind: z.ZodEnum<{
+            document: "document";
+            document_chunk: "document_chunk";
+        }>;
+        title: z.ZodString;
+        content: z.ZodObject<{
+            format: z.ZodLiteral<"markdown">;
+            body: z.ZodNullable<z.ZodString>;
+            summary: z.ZodNullable<z.ZodString>;
+            topics: z.ZodArray<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, z.core.$strip>;
+        authority: z.ZodObject<{
+            kind: z.ZodEnum<{
+                organization: "organization";
+                personal: "personal";
+                workspace: "workspace";
+            }>;
+        }, z.core.$strip>;
+        provenance: z.ZodObject<{
+            source: z.ZodObject<{
+                kind: z.ZodEnum<{
+                    chat: "chat";
+                    document: "document";
+                    email: "email";
+                    manual_upload: "manual_upload";
+                    meeting_transcript: "meeting_transcript";
+                    other: "other";
+                    repository: "repository";
+                    web: "web";
+                }>;
+                uri: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodString>>;
+                externalId: z.ZodNullable<z.ZodString>;
+                title: z.ZodNullable<z.ZodString>;
+                author: z.ZodNullable<z.ZodString>;
+                createdAt: z.ZodNullable<z.ZodString>;
+                updatedAt: z.ZodNullable<z.ZodString>;
+                version: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+            indexedAt: z.ZodString;
+        }, z.core.$strip>;
+        lifecycle: z.ZodObject<{
+            state: z.ZodLiteral<"active">;
+            updatedAt: z.ZodString;
+        }, z.core.$strip>;
+        quality: z.ZodObject<{
+            trust: z.ZodLiteral<"sourced">;
+            freshnessAt: z.ZodString;
+            conflict: z.ZodLiteral<"not_evaluated">;
+            correction: z.ZodLiteral<"current_source_version">;
+        }, z.core.$strip>;
+        links: z.ZodArray<z.ZodObject<{
+            relation: z.ZodEnum<{
+                contents: "contents";
+                next: "next";
+                parent: "parent";
+                previous: "previous";
+                source: "source";
+            }>;
+            target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+                kind: z.ZodLiteral<"knowledge">;
+                id: z.ZodString;
+            }, z.core.$strip>, z.ZodObject<{
+                kind: z.ZodLiteral<"external">;
+                uri: z.ZodPipe<z.ZodString, z.ZodString>;
+            }, z.core.$strip>], "kind">;
+        }, z.core.$strip>>;
+        projection: z.ZodObject<{
+            truncated: z.ZodBoolean;
+            fields: z.ZodArray<z.ZodEnum<{
+                "content.body": "content.body";
+                "content.metadata": "content.metadata";
+                "content.summary": "content.summary";
+                "content.topics": "content.topics";
+                "provenance.source.author": "provenance.source.author";
+                "provenance.source.externalId": "provenance.source.externalId";
+                "provenance.source.title": "provenance.source.title";
+                "provenance.source.uri": "provenance.source.uri";
+                "provenance.source.version": "provenance.source.version";
+                title: "title";
+            }>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type KnowledgeGetResponse = z.infer<typeof KnowledgeGetResponse>;
+export declare const KnowledgeBrowseResponse: z.ZodObject<{
+    records: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        kind: z.ZodEnum<{
+            document: "document";
+            document_chunk: "document_chunk";
+        }>;
+        title: z.ZodString;
+        content: z.ZodObject<{
+            format: z.ZodLiteral<"markdown">;
+            body: z.ZodNullable<z.ZodString>;
+            summary: z.ZodNullable<z.ZodString>;
+            topics: z.ZodArray<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, z.core.$strip>;
+        authority: z.ZodObject<{
+            kind: z.ZodEnum<{
+                organization: "organization";
+                personal: "personal";
+                workspace: "workspace";
+            }>;
+        }, z.core.$strip>;
+        provenance: z.ZodObject<{
+            source: z.ZodObject<{
+                kind: z.ZodEnum<{
+                    chat: "chat";
+                    document: "document";
+                    email: "email";
+                    manual_upload: "manual_upload";
+                    meeting_transcript: "meeting_transcript";
+                    other: "other";
+                    repository: "repository";
+                    web: "web";
+                }>;
+                uri: z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodString>>;
+                externalId: z.ZodNullable<z.ZodString>;
+                title: z.ZodNullable<z.ZodString>;
+                author: z.ZodNullable<z.ZodString>;
+                createdAt: z.ZodNullable<z.ZodString>;
+                updatedAt: z.ZodNullable<z.ZodString>;
+                version: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+            indexedAt: z.ZodString;
+        }, z.core.$strip>;
+        lifecycle: z.ZodObject<{
+            state: z.ZodLiteral<"active">;
+            updatedAt: z.ZodString;
+        }, z.core.$strip>;
+        quality: z.ZodObject<{
+            trust: z.ZodLiteral<"sourced">;
+            freshnessAt: z.ZodString;
+            conflict: z.ZodLiteral<"not_evaluated">;
+            correction: z.ZodLiteral<"current_source_version">;
+        }, z.core.$strip>;
+        links: z.ZodArray<z.ZodObject<{
+            relation: z.ZodEnum<{
+                contents: "contents";
+                next: "next";
+                parent: "parent";
+                previous: "previous";
+                source: "source";
+            }>;
+            target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+                kind: z.ZodLiteral<"knowledge">;
+                id: z.ZodString;
+            }, z.core.$strip>, z.ZodObject<{
+                kind: z.ZodLiteral<"external">;
+                uri: z.ZodPipe<z.ZodString, z.ZodString>;
+            }, z.core.$strip>], "kind">;
+        }, z.core.$strip>>;
+        projection: z.ZodObject<{
+            truncated: z.ZodBoolean;
+            fields: z.ZodArray<z.ZodEnum<{
+                "content.body": "content.body";
+                "content.metadata": "content.metadata";
+                "content.summary": "content.summary";
+                "content.topics": "content.topics";
+                "provenance.source.author": "provenance.source.author";
+                "provenance.source.externalId": "provenance.source.externalId";
+                "provenance.source.title": "provenance.source.title";
+                "provenance.source.uri": "provenance.source.uri";
+                "provenance.source.version": "provenance.source.version";
+                title: "title";
+            }>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+    hasMore: z.ZodBoolean;
+}, z.core.$strip>;
+export type KnowledgeBrowseResponse = z.infer<typeof KnowledgeBrowseResponse>;