cayu.knowledge.maintenance_contracts

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

`KNOWLEDGE_MAINTENANCE_GOVERNANCE_METADATA_KEY`

from cayu import KNOWLEDGE_MAINTENANCE_GOVERNANCE_METADATA_KEY

KNOWLEDGE_MAINTENANCE_GOVERNANCE_METADATA_KEY = 'cayu_knowledge_maintenance_governance'

Release source · Runtime guarantees · Capability guides

`KnowledgeMaintenanceConflict`

from cayu.storage import KnowledgeMaintenanceConflict

A maintenance identity conflicts with immutable durable state.

Bases: RuntimeError.

init (method)

KnowledgeMaintenanceConflict.__init__(reason: str) -> None

Release source · Runtime guarantees · Capability guides

`KnowledgeMaintenanceDecision`

from cayu.storage import KnowledgeMaintenanceDecision

Immutable external review over one exact maintenance proposal.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
`schema_version`	`Literal[1]`	`1`
`operation_id`	`str`	`required`
`proposal_id`	`str`	`required`
`proposal_fingerprint`	`str`	`required`
`kind`	`KnowledgeMaintenanceDecisionKind`	`required`
`reviewer_type`	`KnowledgeActorType`	`required`
`reviewer`	`str`	`required`
`reason`	`str`	`required`
`decided_at`	`datetime`	`Field(default_factory=lambda: datetime.now(UTC))`
`metadata`	`dict[str, Any]`	`Field(default_factory=dict)`

validate_schema_version (method)

KnowledgeMaintenanceDecision.validate_schema_version(value: object) -> object

validate_identity (method)

KnowledgeMaintenanceDecision.validate_identity(value: str, info) -> str

validate_proposal_fingerprint (method)

KnowledgeMaintenanceDecision.validate_proposal_fingerprint(value: str) -> str

validate_reason (method)

KnowledgeMaintenanceDecision.validate_reason(value: str) -> str

validate_decided_at (method)

KnowledgeMaintenanceDecision.validate_decided_at(value: datetime) -> datetime

copy_metadata (method)

KnowledgeMaintenanceDecision.copy_metadata(value: dict[str, Any]) -> dict[str, Any]

validate_reviewer (method)

KnowledgeMaintenanceDecision.validate_reviewer() -> KnowledgeMaintenanceDecision

fingerprint (property)

KnowledgeMaintenanceDecision.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

`KnowledgeMaintenanceDecisionKind`

from cayu.storage import KnowledgeMaintenanceDecisionKind

Reviewer disposition for one exact maintenance proposal.

Bases: StrEnum.

Fields and attributes

Name	Type	Default
`APPROVE`	`class attribute`	`'approve'`
`REJECT`	`class attribute`	`'reject'`

Release source · Runtime guarantees · Capability guides

`KnowledgeMaintenanceDecisionReceipt`

from cayu.storage import KnowledgeMaintenanceDecisionReceipt

Immutable evidence for one atomic reviewed maintenance outcome.

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`operation_id`	`str`	`required`
`proposal_id`	`str`	`required`
`proposal_fingerprint`	`str`	`required`
`request_sha256`	`str`	`required`
`outcome`	`KnowledgeMaintenanceOutcome`	`required`
`replacement`	`KnowledgeRevisionRef \| None`	`None`
`archived_revisions`	`list[KnowledgeRevisionRef]`	`Field(default_factory=list)`
`relation_ids`	`list[str]`	`Field(default_factory=list)`
`committed_at`	`datetime`	`required`
`replayed`	`bool`	`False`

validate_identity (method)

KnowledgeMaintenanceDecisionReceipt.validate_identity(value: str, info) -> str

validate_sha256 (method)

KnowledgeMaintenanceDecisionReceipt.validate_sha256(value: str, info) -> str

copy_replacement (method)

KnowledgeMaintenanceDecisionReceipt.copy_replacement(value)

copy_archived_revisions (method)

KnowledgeMaintenanceDecisionReceipt.copy_archived_revisions(value) -> list[KnowledgeRevisionRef]

copy_relation_ids (method)

KnowledgeMaintenanceDecisionReceipt.copy_relation_ids(value) -> list[str]

validate_committed_at (method)

KnowledgeMaintenanceDecisionReceipt.validate_committed_at(value: datetime) -> datetime

validate_replayed (method)

KnowledgeMaintenanceDecisionReceipt.validate_replayed(value) -> bool

validate_outcome (method)

KnowledgeMaintenanceDecisionReceipt.validate_outcome() -> KnowledgeMaintenanceDecisionReceipt

Release source · Runtime guarantees · Capability guides

`KnowledgeMaintenanceOutcome`

from cayu.storage import KnowledgeMaintenanceOutcome

Durable outcome of an applied maintenance decision.

Bases: StrEnum.

Fields and attributes

Name	Type	Default
`APPLIED`	`class attribute`	`'applied'`
`REJECTED`	`class attribute`	`'rejected'`

Release source · Runtime guarantees · Capability guides

`KnowledgeMaintenanceProposal`

from cayu.storage import KnowledgeMaintenanceProposal

Immutable reviewed plan over exact current knowledge revisions.

Relations bind the replacement’s deterministic active successor revision. A supersedes relation archives its object; derived_from and contradicts preserve their source as active knowledge.

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`1`
`id`	`str`	`required`
`replacement`	`KnowledgeRevisionRef`	`required`
`sources`	`list[KnowledgeRevisionRef]`	`required`
`relations`	`list[KnowledgeRelation]`	`required`
`access_scope`	`KnowledgeAccessScope`	`required`
`policy_id`	`str`	`required`
`proposed_by_type`	`KnowledgeActorType`	`KnowledgeActorType.APP`
`proposed_by`	`str`	`'app'`
`created_at`	`datetime`	`Field(default_factory=lambda: datetime.now(UTC))`
`rationale`	`str`	`required`
`evidence_summary`	`str`	`required`
`metadata`	`dict[str, Any]`	`Field(default_factory=dict)`

validate_schema_version (method)

KnowledgeMaintenanceProposal.validate_schema_version(value: object) -> object

validate_identity (method)

KnowledgeMaintenanceProposal.validate_identity(value: str, info) -> str

copy_replacement (method)

KnowledgeMaintenanceProposal.copy_replacement(value)

copy_sources (method)

KnowledgeMaintenanceProposal.copy_sources(value) -> list[KnowledgeRevisionRef]

copy_relations (method)

KnowledgeMaintenanceProposal.copy_relations(value) -> list[KnowledgeRelation]

copy_access_scope (method)

KnowledgeMaintenanceProposal.copy_access_scope(value)

validate_created_at (method)

KnowledgeMaintenanceProposal.validate_created_at(value: datetime) -> datetime

validate_bounded_text (method)

KnowledgeMaintenanceProposal.validate_bounded_text(value: str, info) -> str

copy_metadata (method)

KnowledgeMaintenanceProposal.copy_metadata(value: dict[str, Any]) -> dict[str, Any]

validate_plan (method)

KnowledgeMaintenanceProposal.validate_plan() -> KnowledgeMaintenanceProposal

fingerprint (property)

KnowledgeMaintenanceProposal.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

`KnowledgeMaintenanceStale`

from cayu.storage import KnowledgeMaintenanceStale

A reviewed maintenance proposal no longer matches current knowledge.

Bases: RuntimeError.

init (method)

KnowledgeMaintenanceStale.__init__(reason: str) -> None

Release source · Runtime guarantees · Capability guides

`MAX_KNOWLEDGE_MAINTENANCE_BYTES`

from cayu.storage import MAX_KNOWLEDGE_MAINTENANCE_BYTES

MAX_KNOWLEDGE_MAINTENANCE_BYTES = 256000

Release source · Runtime guarantees · Capability guides

`MAX_KNOWLEDGE_MAINTENANCE_METADATA_BYTES`

from cayu.storage import MAX_KNOWLEDGE_MAINTENANCE_METADATA_BYTES

MAX_KNOWLEDGE_MAINTENANCE_METADATA_BYTES = 16384

Release source · Runtime guarantees · Capability guides

`MAX_KNOWLEDGE_MAINTENANCE_SOURCES`

from cayu.storage import MAX_KNOWLEDGE_MAINTENANCE_SOURCES

MAX_KNOWLEDGE_MAINTENANCE_SOURCES = 50

Release source · Runtime guarantees · Capability guides

`MAX_KNOWLEDGE_MAINTENANCE_TEXT_BYTES`

from cayu.storage import MAX_KNOWLEDGE_MAINTENANCE_TEXT_BYTES

MAX_KNOWLEDGE_MAINTENANCE_TEXT_BYTES = 16384

Release source · Runtime guarantees · Capability guides

`prepare_knowledge_maintenance_decision`

from cayu.storage import prepare_knowledge_maintenance_decision

Copy and bind one exact proposal and external review decision.

prepare_knowledge_maintenance_decision(proposal: KnowledgeMaintenanceProposal, decision: KnowledgeMaintenanceDecision) -> tuple[KnowledgeMaintenanceProposal, KnowledgeMaintenanceDecision, str]

Release source · Runtime guarantees · Capability guides