{ "contractVersion": 1, "engine": "@soulcraftlabs/brainy", "prose": "docs/contract-1-ratification.md", "compatibility": { "minor": "additive — a new optional door, a new served operator, a new error class; every existing implementation still conforms", "major": "breaking — a door removed, an answer narrowed, an ordering law changed, an optional door promoted to required, or an operator moved from served to refused" }, "doors": [ { "name": "adaptiveHistoryBudgetBytes", "kind": "method", "arity": 1 }, { "name": "add", "kind": "method", "arity": 1 }, { "name": "addMany", "kind": "method", "arity": 1 }, { "name": "adoptLogAuthority", "kind": "method", "arity": 0 }, { "name": "adoptLogAuthorityInner", "kind": "method", "arity": 0 }, { "name": "aggViewFromEntity", "kind": "method", "arity": 1 }, { "name": "anyProviderMigrating", "kind": "method", "arity": 0 }, { "name": "applyFusionScoring", "kind": "method", "arity": 2 }, { "name": "applyGraphConstraints", "kind": "method", "arity": 2 }, { "name": "armIdleFlushTimer", "kind": "method", "arity": 2 }, { "name": "asOf", "kind": "method", "arity": 2 }, { "name": "assertGenerationStoreReady", "kind": "method", "arity": 1 }, { "name": "assertWritable", "kind": "method", "arity": 1 }, { "name": "audit", "kind": "method", "arity": 0 }, { "name": "auditGraph", "kind": "method", "arity": 0 }, { "name": "autoAdoptLegacyVfsBlobsIfNeeded", "kind": "method", "arity": 0 }, { "name": "autoAlpha", "kind": "method", "arity": 1 }, { "name": "autoCompactHistory", "kind": "method", "arity": 0 }, { "name": "awaitMigrationLock", "kind": "method", "arity": 1 }, { "name": "awaitPendingEmbeds", "kind": "method", "arity": 0 }, { "name": "backfillAggregateIfNeeded", "kind": "method", "arity": 1 }, { "name": "batchGet", "kind": "method", "arity": 2 }, { "name": "brainWideStrictRequiresSubtype", "kind": "method", "arity": 1 }, { "name": "bridgeLegacyPendingEmbedSidecars", "kind": "method", "arity": 0 }, { "name": "buildAtGenerationVectors", "kind": "method", "arity": 2 }, { "name": "buildGraphView", "kind": "method", "arity": 4 }, { "name": "buildMetadataFilter", "kind": "method", "arity": 1 }, { "name": "buildMigrationUpdate", "kind": "method", "arity": 5 }, { "name": "buildRelationMigrationUpdate", "kind": "method", "arity": 5 }, { "name": "cacheVerbInt", "kind": "method", "arity": 2 }, { "name": "canServeVectorAtGeneration", "kind": "method", "arity": 1 }, { "name": "checkHealth", "kind": "method", "arity": 0 }, { "name": "checkMigrations", "kind": "method", "arity": 0 }, { "name": "clear", "kind": "method", "arity": 0 }, { "name": "clearPendingEmbed", "kind": "method", "arity": 1 }, { "name": "close", "kind": "method", "arity": 0 }, { "name": "closeDurableSteps", "kind": "method", "arity": 0 }, { "name": "cluster", "kind": "method", "arity": 1 }, { "name": "collectProviderInvariants", "kind": "method", "arity": 0 }, { "name": "compactHistory", "kind": "method", "arity": 1 }, { "name": "consumeMetadataWatermarkVerdict", "kind": "method", "arity": 1 }, { "name": "convertMetadataToEntity", "kind": "method", "arity": 2 }, { "name": "convertNounToEntity", "kind": "method", "arity": 1 }, { "name": "counts", "kind": "accessor" }, { "name": "createIndex", "kind": "method", "arity": 0 }, { "name": "createMigrationBackupIfNeeded", "kind": "method", "arity": 0 }, { "name": "createPinnedDb", "kind": "method", "arity": 1 }, { "name": "createResult", "kind": "method", "arity": 4 }, { "name": "dbFinalizationRegistry", "kind": "accessor" }, { "name": "dbHost", "kind": "accessor" }, { "name": "defineAggregate", "kind": "method", "arity": 1 }, { "name": "detectIdKind", "kind": "method", "arity": 3 }, { "name": "diagnostics", "kind": "method", "arity": 0 }, { "name": "diff", "kind": "method", "arity": 2 }, { "name": "embed", "kind": "method", "arity": 1 }, { "name": "embedBatch", "kind": "method", "arity": 2 }, { "name": "emitCommitted", "kind": "method", "arity": 4 }, { "name": "enforceSubtypeOnAdd", "kind": "method", "arity": 4 }, { "name": "enforceSubtypeOnRelate", "kind": "method", "arity": 4 }, { "name": "enforceTrackedFieldValues", "kind": "method", "arity": 2 }, { "name": "enhanceNLPResult", "kind": "method", "arity": 2 }, { "name": "enqueuePendingEmbed", "kind": "method", "arity": 1 }, { "name": "ensureAggregationIndex", "kind": "method", "arity": 0 }, { "name": "ensureIndexesLoaded", "kind": "method", "arity": 0 }, { "name": "ensureInitialized", "kind": "method", "arity": 1 }, { "name": "entityForAggFromRawRecord", "kind": "method", "arity": 1 }, { "name": "entityFromGenerationRecord", "kind": "method", "arity": 3 }, { "name": "entityIntsToUuids", "kind": "method", "arity": 1 }, { "name": "entityViewFromRawRecord", "kind": "method", "arity": 2 }, { "name": "excludedVisibilityTiers", "kind": "method", "arity": 1 }, { "name": "executeGraphSearch", "kind": "method", "arity": 2 }, { "name": "executeProximitySearch", "kind": "method", "arity": 1 }, { "name": "executeTextSearch", "kind": "method", "arity": 2 }, { "name": "executeVectorSearch", "kind": "method", "arity": 3 }, { "name": "explain", "kind": "method", "arity": 1 }, { "name": "export", "kind": "method", "arity": 0 }, { "name": "extract", "kind": "method", "arity": 2 }, { "name": "extractConcepts", "kind": "method", "arity": 2 }, { "name": "extractEntities", "kind": "method", "arity": 2 }, { "name": "factSegmentPaths", "kind": "method", "arity": 1 }, { "name": "fieldCountsAggregateName", "kind": "method", "arity": 1 }, { "name": "fillSubtypes", "kind": "method", "arity": 1 }, { "name": "filterIdsBelted", "kind": "method", "arity": 2 }, { "name": "find", "kind": "method", "arity": 1 }, { "name": "findAggregate", "kind": "method", "arity": 1 }, { "name": "findDuplicates", "kind": "method", "arity": 1 }, { "name": "findMatchingWords", "kind": "method", "arity": 3 }, { "name": "flush", "kind": "method", "arity": 0 }, { "name": "formatInfo", "kind": "method", "arity": 0 }, { "name": "formatSubtypeError", "kind": "method", "arity": 1 }, { "name": "generation", "kind": "method", "arity": 0 }, { "name": "generationDigest", "kind": "method", "arity": 1 }, { "name": "get", "kind": "method", "arity": 2 }, { "name": "getActivePlugins", "kind": "method", "arity": 0 }, { "name": "getAvailableFields", "kind": "method", "arity": 0 }, { "name": "getBackgroundDeduplicator", "kind": "method", "arity": 0 }, { "name": "getFieldsForType", "kind": "method", "arity": 1 }, { "name": "getFieldStatistics", "kind": "method", "arity": 0 }, { "name": "getFieldsWithCardinality", "kind": "method", "arity": 0 }, { "name": "getFieldValues", "kind": "method", "arity": 1 }, { "name": "getIndexStats", "kind": "method", "arity": 0 }, { "name": "getIndexStatus", "kind": "method", "arity": 0 }, { "name": "getMemoryStats", "kind": "method", "arity": 0 }, { "name": "getNeighborUuids", "kind": "method", "arity": 2 }, { "name": "getNounCount", "kind": "method", "arity": 0 }, { "name": "getOptimalQueryPlan", "kind": "method", "arity": 1 }, { "name": "getStats", "kind": "method", "arity": 1 }, { "name": "getStorageType", "kind": "method", "arity": 0 }, { "name": "getSubtypeRule", "kind": "method", "arity": 1 }, { "name": "getTripleIntelligence", "kind": "method", "arity": 0 }, { "name": "getTypedNeighbors", "kind": "method", "arity": 4 }, { "name": "getVerbCount", "kind": "method", "arity": 0 }, { "name": "graph", "kind": "accessor" }, { "name": "graphAccelerationProvider", "kind": "method", "arity": 0 }, { "name": "graphCommunities", "kind": "method", "arity": 1 }, { "name": "graphCommunitiesFallback", "kind": "method", "arity": 1 }, { "name": "graphCommunitiesNative", "kind": "method", "arity": 2 }, { "name": "graphEntityInt", "kind": "method", "arity": 1 }, { "name": "graphExport", "kind": "method", "arity": 1 }, { "name": "graphExportFallback", "kind": "method", "arity": 1 }, { "name": "graphExportNative", "kind": "method", "arity": 2 }, { "name": "graphPath", "kind": "method", "arity": 3 }, { "name": "graphPathFallback", "kind": "method", "arity": 3 }, { "name": "graphPathNative", "kind": "method", "arity": 4 }, { "name": "graphRank", "kind": "method", "arity": 1 }, { "name": "graphRankFallback", "kind": "method", "arity": 1 }, { "name": "graphRankNative", "kind": "method", "arity": 2 }, { "name": "graphSubgraph", "kind": "method", "arity": 2 }, { "name": "graphSubgraphFallback", "kind": "method", "arity": 4 }, { "name": "graphSubgraphFromQuery", "kind": "method", "arity": 5 }, { "name": "graphSubgraphNative", "kind": "method", "arity": 5 }, { "name": "groupByLabel", "kind": "method", "arity": 2 }, { "name": "hasStorageMethod", "kind": "method", "arity": 1 }, { "name": "hasVectorOrTextCriteria", "kind": "method", "arity": 1 }, { "name": "health", "kind": "method", "arity": 0 }, { "name": "highlight", "kind": "method", "arity": 1 }, { "name": "highlightSemanticPhase", "kind": "method", "arity": 5 }, { "name": "history", "kind": "method", "arity": 2 }, { "name": "historyStats", "kind": "method", "arity": 0 }, { "name": "hub", "kind": "accessor" }, { "name": "hydrateIdMapperForGraphRebuild", "kind": "method", "arity": 0 }, { "name": "hydrateNativeSubgraph", "kind": "method", "arity": 2 }, { "name": "import", "kind": "method", "arity": 2 }, { "name": "importPluginPackage", "kind": "method", "arity": 1 }, { "name": "incidentEdges", "kind": "method", "arity": 3 }, { "name": "indexStats", "kind": "method", "arity": 0 }, { "name": "init", "kind": "method", "arity": 1 }, { "name": "insights", "kind": "method", "arity": 0 }, { "name": "isEmbeddingReady", "kind": "method", "arity": 0 }, { "name": "isInfrastructureWrite", "kind": "method", "arity": 1 }, { "name": "isInitialized", "kind": "accessor" }, { "name": "isReadOnly", "kind": "accessor" }, { "name": "kickBackgroundFlush", "kind": "method", "arity": 1 }, { "name": "kickEmbedWorker", "kind": "method", "arity": 0 }, { "name": "legacyLayoutMigrationPhase", "kind": "method", "arity": 0 }, { "name": "loadAnalyticsGraph", "kind": "method", "arity": 1 }, { "name": "loadPlugins", "kind": "method", "arity": 0 }, { "name": "logAuthority", "kind": "method", "arity": 0 }, { "name": "maintenanceDebt", "kind": "method", "arity": 0 }, { "name": "materializeAtGeneration", "kind": "method", "arity": 1 }, { "name": "metadataIndexRetractionOp", "kind": "method", "arity": 3 }, { "name": "migrate", "kind": "method", "arity": 1 }, { "name": "migrateField", "kind": "method", "arity": 1 }, { "name": "migrateInternal", "kind": "method", "arity": 2 }, { "name": "migrateLegacyZeroNormVfsRootIfNeeded", "kind": "method", "arity": 0 }, { "name": "migrationSnapshot", "kind": "method", "arity": 0 }, { "name": "neededFamiliesMigrating", "kind": "method", "arity": 1 }, { "name": "neighbors", "kind": "method", "arity": 2 }, { "name": "newId", "kind": "method", "arity": 0 }, { "name": "nlp", "kind": "method", "arity": 0 }, { "name": "normalizeConfig", "kind": "method", "arity": 1 }, { "name": "noteWriteForPersistence", "kind": "method", "arity": 0 }, { "name": "now", "kind": "method", "arity": 0 }, { "name": "onChange", "kind": "method", "arity": 1 }, { "name": "pagination", "kind": "accessor" }, { "name": "parseMigrationPath", "kind": "method", "arity": 1 }, { "name": "parseNaturalQuery", "kind": "method", "arity": 1 }, { "name": "pathExists", "kind": "method", "arity": 2 }, { "name": "pendingEmbedCount", "kind": "method", "arity": 0 }, { "name": "performInit", "kind": "method", "arity": 1 }, { "name": "persistPinnedGeneration", "kind": "method", "arity": 2 }, { "name": "persistSingleOp", "kind": "method", "arity": 6 }, { "name": "pickMetadataProbe", "kind": "method", "arity": 1 }, { "name": "pickVectorProbe", "kind": "method", "arity": 0 }, { "name": "pinGeneration", "kind": "method", "arity": 1 }, { "name": "planGetEntity", "kind": "method", "arity": 3 }, { "name": "planTransact", "kind": "method", "arity": 1 }, { "name": "planTxAdd", "kind": "method", "arity": 3 }, { "name": "planTxRelate", "kind": "method", "arity": 3 }, { "name": "planTxRemove", "kind": "method", "arity": 3 }, { "name": "planTxUnrelate", "kind": "method", "arity": 3 }, { "name": "planTxUpdate", "kind": "method", "arity": 3 }, { "name": "projectionGauges", "kind": "method", "arity": 0 }, { "name": "providerForFamily", "kind": "method", "arity": 1 }, { "name": "providerIsMigrating", "kind": "method", "arity": 1 }, { "name": "providerMigrationStatus", "kind": "method", "arity": 0 }, { "name": "queryAggregate", "kind": "method", "arity": 2 }, { "name": "queryIndexFamilies", "kind": "method", "arity": 1 }, { "name": "readPath", "kind": "method", "arity": 2 }, { "name": "ready", "kind": "accessor" }, { "name": "rebuildIndexesIfNeeded", "kind": "method", "arity": 0 }, { "name": "rebuildMetadataIndexOnline", "kind": "method", "arity": 0 }, { "name": "reconcileLogDivergence", "kind": "method", "arity": 2 }, { "name": "reconstructPath", "kind": "method", "arity": 4 }, { "name": "recordStateAt", "kind": "method", "arity": 3 }, { "name": "recoverPendingEmbedsFromLog", "kind": "method", "arity": 0 }, { "name": "registerShutdownHooks", "kind": "method", "arity": 0 }, { "name": "relate", "kind": "method", "arity": 1 }, { "name": "related", "kind": "method", "arity": 1 }, { "name": "relateMany", "kind": "method", "arity": 1 }, { "name": "relationFromGenerationRecord", "kind": "method", "arity": 2 }, { "name": "relationshipSubtypesOf", "kind": "method", "arity": 1 }, { "name": "releaseGeneration", "kind": "method", "arity": 1 }, { "name": "remove", "kind": "method", "arity": 1 }, { "name": "removeAggregate", "kind": "method", "arity": 1 }, { "name": "removeMany", "kind": "method", "arity": 1 }, { "name": "removeMigrationBackupSafe", "kind": "method", "arity": 0 }, { "name": "repackHistory", "kind": "method", "arity": 1 }, { "name": "repairIndex", "kind": "method", "arity": 1 }, { "name": "requestFlush", "kind": "method", "arity": 1 }, { "name": "requireProviders", "kind": "method", "arity": 1 }, { "name": "requireSubtype", "kind": "method", "arity": 1 }, { "name": "resolveAsOfGeneration", "kind": "method", "arity": 2 }, { "name": "resolveDiffEndpoint", "kind": "method", "arity": 1 }, { "name": "resolveHiddenIds", "kind": "method", "arity": 1 }, { "name": "resolveHNSWPersistMode", "kind": "method", "arity": 0 }, { "name": "resolveRawGeneration", "kind": "method", "arity": 1 }, { "name": "resolveRetentionPolicy", "kind": "method", "arity": 0 }, { "name": "resolveVerbEndpointInts", "kind": "method", "arity": 1 }, { "name": "resolveVerbIntsToIds", "kind": "method", "arity": 1 }, { "name": "restore", "kind": "method", "arity": 2 }, { "name": "rrfFusion", "kind": "method", "arity": 4 }, { "name": "runAggregationBackfillWalk", "kind": "method", "arity": 0 }, { "name": "runAggregationCatchUp", "kind": "method", "arity": 0 }, { "name": "runEmbedWorker", "kind": "method", "arity": 0 }, { "name": "runOracle", "kind": "method", "arity": 1 }, { "name": "runRepairIndexPhases", "kind": "method", "arity": 5 }, { "name": "scanFacts", "kind": "method", "arity": 1 }, { "name": "seedIdsToInts", "kind": "method", "arity": 1 }, { "name": "selectorToSeedIds", "kind": "method", "arity": 1 }, { "name": "setRetentionBudget", "kind": "method", "arity": 1 }, { "name": "setupEmbedder", "kind": "method", "arity": 0 }, { "name": "setupIndex", "kind": "method", "arity": 0 }, { "name": "setupStorage", "kind": "method", "arity": 0 }, { "name": "similar", "kind": "method", "arity": 1 }, { "name": "similarity", "kind": "method", "arity": 2 }, { "name": "splitForHighlighting", "kind": "method", "arity": 2 }, { "name": "stampBrainFormat", "kind": "method", "arity": 0 }, { "name": "stampBrainFormatIfNeeded", "kind": "method", "arity": 0 }, { "name": "stampEntityTree", "kind": "method", "arity": 0 }, { "name": "stampProjectionWatermarks", "kind": "method", "arity": 0 }, { "name": "stats", "kind": "method", "arity": 0 }, { "name": "storageAdapter", "kind": "accessor" }, { "name": "stream", "kind": "method", "arity": 0 }, { "name": "streaming", "kind": "accessor" }, { "name": "subtypesOf", "kind": "method", "arity": 1 }, { "name": "trackField", "kind": "method", "arity": 1 }, { "name": "transact", "kind": "method", "arity": 2 }, { "name": "transactionLog", "kind": "method", "arity": 1 }, { "name": "unrelate", "kind": "method", "arity": 1 }, { "name": "unvectorNounForRootMigration", "kind": "method", "arity": 1 }, { "name": "update", "kind": "method", "arity": 1 }, { "name": "updateMany", "kind": "method", "arity": 1 }, { "name": "updateRelation", "kind": "method", "arity": 1 }, { "name": "upsertMergeParams", "kind": "method", "arity": 2 }, { "name": "use", "kind": "method", "arity": 1 }, { "name": "usesDefaultWasmEmbedder", "kind": "method", "arity": 0 }, { "name": "validateIndexConsistency", "kind": "method", "arity": 0 }, { "name": "vectorSearchAtGeneration", "kind": "method", "arity": 4 }, { "name": "verbsToRelations", "kind": "method", "arity": 1 }, { "name": "verbToRelationLike", "kind": "method", "arity": 1 }, { "name": "verifyEntityTreeStamp", "kind": "method", "arity": 0 }, { "name": "verifyGraphAdjacencyLive", "kind": "method", "arity": 0 }, { "name": "verifyLogAuthority", "kind": "method", "arity": 0 }, { "name": "verifyMetadataLive", "kind": "method", "arity": 0 }, { "name": "verifyVectorLive", "kind": "method", "arity": 0 }, { "name": "versionedIndexProviders", "kind": "method", "arity": 0 }, { "name": "vfs", "kind": "accessor" }, { "name": "waitForIndexed", "kind": "method", "arity": 2 }, { "name": "warm", "kind": "method", "arity": 0 }, { "name": "warmupEmbeddings", "kind": "method", "arity": 0 }, { "name": "warnIfReadsDegraded", "kind": "method", "arity": 1 }, { "name": "wireConnectionsCodec", "kind": "method", "arity": 0 }, { "name": "wireGraphIdResolver", "kind": "method", "arity": 0 } ], "errors": [ "BrainyError", "DerivedArtifactMissingError", "GraphIndexNotReadyError", "MetadataIndexNotReadyError", "MigrationInProgressError", "ProtectedArtifactError", "VectorIndexNotReadyError" ], "operators": { "accepted": [ "between", "contains", "endsWith", "eq", "equals", "excludes", "exists", "greaterThan", "greaterThanOrEqual", "gt", "gte", "hasAll", "in", "length", "lessThan", "lessThanOrEqual", "lt", "lte", "matches", "missing", "ne", "noneOf", "notEquals", "oneOf", "startsWith" ], "servedOnIndexPath": [ "between", "contains", "eq", "equals", "excludes", "exists", "greaterThan", "greaterThanOrEqual", "gt", "gte", "hasAll", "in", "lessThan", "lessThanOrEqual", "lt", "lte", "missing", "ne", "noneOf", "notEquals", "oneOf" ], "refusedByIndexPath": [ "endsWith", "length", "matches", "startsWith" ], "combinators": [ "allOf", "anyOf", "not" ] }, "fieldAddressing": { "systemKeyPrefix": "system.", "systemEntityScalars": [ "confidence", "createdAt", "createdBy", "id", "service", "subtype", "type", "updatedAt", "visibility", "weight" ], "systemRelationScalars": [ "confidence", "createdAt", "createdBy", "service", "sourceId", "subtype", "targetId", "updatedAt", "verb", "visibility", "weight" ], "plumbingFields": [ "_rev", "connections", "data", "level", "vector" ] }, "health": { "verdicts": [ "pass", "warn", "fail" ], "healKinds": [ "none", "repair", "rebuild" ], "servingWithholdingInvariants": [ "index-initialized", "durable-state-present", "manifest-residency", "replay-clean", "strand-latch" ] } }