@opengeni/contracts 0.50.0 → 2.2.0-canary.0

package/dist/company-brain.d.ts

@@ -0,0 +1,398 @@
+import { z } from "zod";
+export declare const COMPANY_BRAIN_OKF_SCHEMA_VERSION: 1;
+export declare const COMPANY_BRAIN_GUIDANCE_MAX_ENTRIES = 512;
+export declare const COMPANY_BRAIN_GUIDANCE_CONTENT_MAX_CHARS = 262144;
+export declare const COMPANY_BRAIN_GUIDANCE_MAX_CONTENT_BYTES: number;
+export declare const COMPANY_BRAIN_INSPECTOR_DEFAULT_LIMIT = 20;
+export declare const COMPANY_BRAIN_INSPECTOR_MAX_LIMIT = 50;
+export declare const COMPANY_BRAIN_INSPECTOR_CURSOR_MAX_CHARS = 1024;
+export declare const COMPANY_BRAIN_PROPOSAL_CONTENT_MAX_BYTES: number;
+export declare const COMPANY_BRAIN_PROPOSAL_RESPONSE_MAX_BYTES: number;
+export declare const CompanyBrainContextReceipt: z.ZodObject<{
+    id: z.ZodString;
+    sessionId: z.ZodString;
+    rootSessionId: z.ZodString;
+    turnId: z.ZodString;
+    acceptedAt: z.ZodString;
+    createdAt: z.ZodString;
+    sessionRole: z.ZodEnum<{
+        child: "child";
+        root: "root";
+    }>;
+    memoryEnabled: z.ZodBoolean;
+    memoryPromptMode: z.ZodEnum<{
+        legacy_standing: "legacy_standing";
+        retrieval_only: "retrieval_only";
+    }>;
+    companyProfileIncluded: z.ZodBoolean;
+    instructionPolicyEntryHash: z.ZodString;
+    preferenceDescriptorHash: z.ZodNullable<z.ZodString>;
+    companyProfileSnapshotHash: z.ZodString;
+    turnContextSnapshotId: z.ZodString;
+    turnContextSnapshotHash: z.ZodString;
+    turnContextSnapshotSource: z.ZodEnum<{
+        accepted_turn: "accepted_turn";
+        legacy_first_claim: "legacy_first_claim";
+    }>;
+    selectionHash: z.ZodString;
+    selectedMemoryCount: z.ZodNumber;
+    renderedMemoryCount: z.ZodNumber;
+    budgetOmittedMemoryCount: z.ZodNumber;
+}, z.core.$strict>;
+export type CompanyBrainContextReceipt = z.infer<typeof CompanyBrainContextReceipt>;
+export declare const CompanyBrainContextReceiptPage: z.ZodObject<{
+    receipts: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        sessionId: z.ZodString;
+        rootSessionId: z.ZodString;
+        turnId: z.ZodString;
+        acceptedAt: z.ZodString;
+        createdAt: z.ZodString;
+        sessionRole: z.ZodEnum<{
+            child: "child";
+            root: "root";
+        }>;
+        memoryEnabled: z.ZodBoolean;
+        memoryPromptMode: z.ZodEnum<{
+            legacy_standing: "legacy_standing";
+            retrieval_only: "retrieval_only";
+        }>;
+        companyProfileIncluded: z.ZodBoolean;
+        instructionPolicyEntryHash: z.ZodString;
+        preferenceDescriptorHash: z.ZodNullable<z.ZodString>;
+        companyProfileSnapshotHash: z.ZodString;
+        turnContextSnapshotId: z.ZodString;
+        turnContextSnapshotHash: z.ZodString;
+        turnContextSnapshotSource: z.ZodEnum<{
+            accepted_turn: "accepted_turn";
+            legacy_first_claim: "legacy_first_claim";
+        }>;
+        selectionHash: z.ZodString;
+        selectedMemoryCount: z.ZodNumber;
+        renderedMemoryCount: z.ZodNumber;
+        budgetOmittedMemoryCount: z.ZodNumber;
+    }, z.core.$strict>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+    hasMore: z.ZodBoolean;
+}, z.core.$strict>;
+export type CompanyBrainContextReceiptPage = z.infer<typeof CompanyBrainContextReceiptPage>;
+export declare const CompanyBrainKnowledgeProposal: z.ZodObject<{
+    id: z.ZodString;
+    authority: z.ZodObject<{
+        kind: z.ZodEnum<{
+            organization: "organization";
+            personal: "personal";
+            workspace: "workspace";
+        }>;
+    }, z.core.$strict>;
+    targetKind: z.ZodEnum<{
+        instruction_policy: "instruction_policy";
+        preference: "preference";
+    }>;
+    targetScope: z.ZodString;
+    targetKey: z.ZodNullable<z.ZodString>;
+    content: z.ZodString;
+    contentHash: z.ZodString;
+    source: z.ZodObject<{
+        claimId: z.ZodString;
+        evidenceId: z.ZodString;
+    }, z.core.$strict>;
+    status: z.ZodLiteral<"proposed">;
+    createdAt: z.ZodString;
+    projection: z.ZodObject<{
+        truncated: z.ZodBoolean;
+        originalContentUtf8Bytes: z.ZodNumber;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export type CompanyBrainKnowledgeProposal = z.infer<typeof CompanyBrainKnowledgeProposal>;
+export declare const CompanyBrainKnowledgeProposalPage: z.ZodObject<{
+    proposals: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        authority: z.ZodObject<{
+            kind: z.ZodEnum<{
+                organization: "organization";
+                personal: "personal";
+                workspace: "workspace";
+            }>;
+        }, z.core.$strict>;
+        targetKind: z.ZodEnum<{
+            instruction_policy: "instruction_policy";
+            preference: "preference";
+        }>;
+        targetScope: z.ZodString;
+        targetKey: z.ZodNullable<z.ZodString>;
+        content: z.ZodString;
+        contentHash: z.ZodString;
+        source: z.ZodObject<{
+            claimId: z.ZodString;
+            evidenceId: z.ZodString;
+        }, z.core.$strict>;
+        status: z.ZodLiteral<"proposed">;
+        createdAt: z.ZodString;
+        projection: z.ZodObject<{
+            truncated: z.ZodBoolean;
+            originalContentUtf8Bytes: z.ZodNumber;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+    truncatedForCount: z.ZodBoolean;
+    truncatedForResponseBytes: z.ZodBoolean;
+    responseBytes: z.ZodNumber;
+}, z.core.$strict>;
+export type CompanyBrainKnowledgeProposalPage = z.infer<typeof CompanyBrainKnowledgeProposalPage>;
+export declare const CompanyBrainGuidanceClassification: z.ZodEnum<{
+    company_profile: "company_profile";
+    guide: "guide";
+    mandatory_rule: "mandatory_rule";
+}>;
+export type CompanyBrainGuidanceClassification = z.infer<typeof CompanyBrainGuidanceClassification>;
+export declare const CompanyBrainGuidanceScope: z.ZodEnum<{
+    organization: "organization";
+    personal: "personal";
+    workspace: "workspace";
+}>;
+export type CompanyBrainGuidanceScope = z.infer<typeof CompanyBrainGuidanceScope>;
+export declare const CompanyBrainGuidanceLifecycle: z.ZodEnum<{
+    active: "active";
+    expired: "expired";
+    historical: "historical";
+    inactive: "inactive";
+    proposal: "proposal";
+    rejected: "rejected";
+    superseded: "superseded";
+}>;
+export type CompanyBrainGuidanceLifecycle = z.infer<typeof CompanyBrainGuidanceLifecycle>;
+export declare const CompanyBrainGuidanceRelationship: z.ZodObject<{
+    type: z.ZodEnum<{
+        corrects: "corrects";
+        superseded_by: "superseded_by";
+        supersedes: "supersedes";
+    }>;
+    targetId: z.ZodString;
+}, z.core.$strict>;
+export type CompanyBrainGuidanceRelationship = z.infer<typeof CompanyBrainGuidanceRelationship>;
+export declare const CompanyBrainGuidanceEntry: z.ZodObject<{
+    id: z.ZodString;
+    revisionId: z.ZodString;
+    path: z.ZodString;
+    scope: z.ZodEnum<{
+        organization: "organization";
+        personal: "personal";
+        workspace: "workspace";
+    }>;
+    classification: z.ZodEnum<{
+        company_profile: "company_profile";
+        guide: "guide";
+        mandatory_rule: "mandatory_rule";
+    }>;
+    title: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    content: z.ZodString;
+    contentHash: z.ZodString;
+    revision: z.ZodNumber;
+    active: z.ZodBoolean;
+    lifecycle: z.ZodEnum<{
+        active: "active";
+        expired: "expired";
+        historical: "historical";
+        inactive: "inactive";
+        proposal: "proposal";
+        rejected: "rejected";
+        superseded: "superseded";
+    }>;
+    provenance: z.ZodObject<{
+        source: z.ZodString;
+        sourceId: z.ZodNullable<z.ZodString>;
+        trust: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    relationships: z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            corrects: "corrects";
+            superseded_by: "superseded_by";
+            supersedes: "supersedes";
+        }>;
+        targetId: z.ZodString;
+    }, z.core.$strict>>;
+    createdAt: z.ZodString;
+}, z.core.$strict>;
+export type CompanyBrainGuidanceEntry = z.infer<typeof CompanyBrainGuidanceEntry>;
+export declare const CompanyBrainGuidanceTruncationReason: z.ZodEnum<{
+    aggregate_content_bytes: "aggregate_content_bytes";
+    aggregate_item_count: "aggregate_item_count";
+    company_profile_history: "company_profile_history";
+    instruction_policy_history: "instruction_policy_history";
+    preference_count: "preference_count";
+    preference_history: "preference_history";
+}>;
+export type CompanyBrainGuidanceTruncationReason = z.infer<typeof CompanyBrainGuidanceTruncationReason>;
+export declare const CompanyBrainOkfPackage: z.ZodObject<{
+    kind: z.ZodLiteral<"opengeni.company_brain.okf">;
+    schemaVersion: z.ZodLiteral<1>;
+    workspaceId: z.ZodString;
+    generatedAt: z.ZodString;
+    permissions: z.ZodObject<{
+        guidance: z.ZodLiteral<"available">;
+        knowledge: z.ZodEnum<{
+            available: "available";
+            unavailable: "unavailable";
+        }>;
+    }, z.core.$strict>;
+    guidance: z.ZodObject<{
+        entries: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            revisionId: z.ZodString;
+            path: z.ZodString;
+            scope: z.ZodEnum<{
+                organization: "organization";
+                personal: "personal";
+                workspace: "workspace";
+            }>;
+            classification: z.ZodEnum<{
+                company_profile: "company_profile";
+                guide: "guide";
+                mandatory_rule: "mandatory_rule";
+            }>;
+            title: z.ZodString;
+            description: z.ZodNullable<z.ZodString>;
+            content: z.ZodString;
+            contentHash: z.ZodString;
+            revision: z.ZodNumber;
+            active: z.ZodBoolean;
+            lifecycle: z.ZodEnum<{
+                active: "active";
+                expired: "expired";
+                historical: "historical";
+                inactive: "inactive";
+                proposal: "proposal";
+                rejected: "rejected";
+                superseded: "superseded";
+            }>;
+            provenance: z.ZodObject<{
+                source: z.ZodString;
+                sourceId: z.ZodNullable<z.ZodString>;
+                trust: z.ZodNullable<z.ZodString>;
+            }, z.core.$strict>;
+            relationships: z.ZodArray<z.ZodObject<{
+                type: z.ZodEnum<{
+                    corrects: "corrects";
+                    superseded_by: "superseded_by";
+                    supersedes: "supersedes";
+                }>;
+                targetId: z.ZodString;
+            }, z.core.$strict>>;
+            createdAt: z.ZodString;
+        }, z.core.$strict>>;
+        truncated: z.ZodBoolean;
+        truncationReasons: z.ZodArray<z.ZodEnum<{
+            aggregate_content_bytes: "aggregate_content_bytes";
+            aggregate_item_count: "aggregate_item_count";
+            company_profile_history: "company_profile_history";
+            instruction_policy_history: "instruction_policy_history";
+            preference_count: "preference_count";
+            preference_history: "preference_history";
+        }>>;
+    }, z.core.$strict>;
+    knowledge: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        availability: z.ZodLiteral<"available">;
+        coverage: z.ZodEnum<{
+            complete: "complete";
+            partial: "partial";
+        }>;
+        baseCount: z.ZodNumber;
+        bases: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            visibleDocumentCount: z.ZodNumber;
+            statusCounts: z.ZodObject<{
+                queued: z.ZodNumber;
+                indexing: z.ZodNumber;
+                ready: z.ZodNumber;
+                failed: z.ZodNumber;
+            }, z.core.$strict>;
+            latestUpdatedAt: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+        basesTruncated: z.ZodBoolean;
+        inspectedVisibleDocumentCount: z.ZodNumber;
+        documentStatusCounts: z.ZodObject<{
+            queued: z.ZodNumber;
+            indexing: z.ZodNumber;
+            ready: z.ZodNumber;
+            failed: z.ZodNumber;
+        }, z.core.$strict>;
+        sourceKindCounts: z.ZodObject<{
+            manual_upload: z.ZodNumber;
+            meeting_transcript: z.ZodNumber;
+            repository: z.ZodNumber;
+            email: z.ZodNumber;
+            chat: z.ZodNumber;
+            document: z.ZodNumber;
+            web: z.ZodNumber;
+            other: z.ZodNumber;
+        }, z.core.$strict>;
+        authorityKindCounts: z.ZodObject<{
+            organization: z.ZodNumber;
+            workspace: z.ZodNumber;
+            personal: z.ZodNumber;
+        }, z.core.$strict>;
+        topics: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            documentCount: z.ZodNumber;
+        }, z.core.$strict>>;
+        topicsTruncated: z.ZodBoolean;
+        latestDocumentUpdatedAt: z.ZodNullable<z.ZodString>;
+        memorySample: z.ZodObject<{
+            recordCount: z.ZodNumber;
+            sampleLimit: z.ZodLiteral<100>;
+            limitReached: z.ZodBoolean;
+            statusCounts: z.ZodObject<{
+                proposed: z.ZodNumber;
+                approved: z.ZodNumber;
+                rejected: z.ZodNumber;
+                active: z.ZodNumber;
+                superseded: z.ZodNumber;
+                archived: z.ZodNumber;
+            }, z.core.$strict>;
+            kindCounts: z.ZodObject<{
+                semantic: z.ZodNumber;
+                episodic: z.ZodNumber;
+                procedural: z.ZodNumber;
+                decision: z.ZodNumber;
+                preference: z.ZodNumber;
+            }, z.core.$strict>;
+            preferenceAuthority: z.ZodObject<{
+                kindCountSource: z.ZodLiteral<"knowledge_memories_legacy_observations">;
+                activeAuthority: z.ZodLiteral<"structured_preference_registry">;
+            }, z.core.$strict>;
+            latestUpdatedAt: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>;
+        gaps: z.ZodArray<z.ZodObject<{
+            code: z.ZodEnum<{
+                failed_documents: "failed_documents";
+                missing_topic_coverage: "missing_topic_coverage";
+                no_document_bases: "no_document_bases";
+                no_memory_records: "no_memory_records";
+                no_visible_documents: "no_visible_documents";
+                partial_inventory: "partial_inventory";
+                pending_memory_review: "pending_memory_review";
+                processing_documents: "processing_documents";
+            }>;
+            severity: z.ZodEnum<{
+                info: "info";
+                warning: "warning";
+            }>;
+            relatedCount: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>, z.ZodObject<{
+        availability: z.ZodLiteral<"unavailable">;
+        reason: z.ZodLiteral<"missing_permission">;
+        requiredPermission: z.ZodLiteral<"documents:search">;
+    }, z.core.$strict>], "availability">;
+    omissions: z.ZodArray<z.ZodEnum<{
+        document_bodies_use_documents_export: "document_bodies_use_documents_export";
+        inaccessible_knowledge: "inaccessible_knowledge";
+        memory_bodies_and_provenance: "memory_bodies_and_provenance";
+        policy_and_preference_actor_identifiers: "policy_and_preference_actor_identifiers";
+        secret_values_and_credentials: "secret_values_and_credentials";
+        session_messages_and_task_notes: "session_messages_and_task_notes";
+    }>>;
+}, z.core.$strict>;
+export type CompanyBrainOkfPackage = z.infer<typeof CompanyBrainOkfPackage>;