cayu.knowledge.maintenance_persistence

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_PROPOSAL_PIPELINE_VERSION

from cayu import KNOWLEDGE_MAINTENANCE_PROPOSAL_PIPELINE_VERSION

KNOWLEDGE_MAINTENANCE_PROPOSAL_PIPELINE_VERSION = 'cayu.knowledge-maintenance-proposal-publication.v1'

Release source · Runtime guarantees · Capability guides

KNOWLEDGE_MAINTENANCE_PROPOSAL_PUBLICATION_SCHEMA_VERSION

from cayu import KNOWLEDGE_MAINTENANCE_PROPOSAL_PUBLICATION_SCHEMA_VERSION

KNOWLEDGE_MAINTENANCE_PROPOSAL_PUBLICATION_SCHEMA_VERSION = 1

Release source · Runtime guarantees · Capability guides

KnowledgeMaintenanceAcceptedPlan

from cayu import KnowledgeMaintenanceAcceptedPlan

Attempt-independent accepted semantic plan retained for review.

Provider usage and processing timestamps remain attempt telemetry on KnowledgeMaintenancePlanningResult. The durable review artifact keeps the exact plan, evaluation, routing/configuration bindings, and component identities that determine review authority. Equivalent accepted attempts therefore converge on one proposal identity.

Bases: _PersistenceModel.

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]	KNOWLEDGE_MAINTENANCE_PROPOSAL_PUBLICATION_SCHEMA_VERSION
request_id	StrictStr	required
request_fingerprint	StrictStr	required
routing_result_fingerprint	StrictStr	required
routing_configuration_fingerprint	StrictStr	required
configuration_fingerprint	StrictStr	required
planner_id	StrictStr	required
planner_version	StrictStr	required
evaluator_id	StrictStr	required
evaluator_version	StrictStr	required
deterministic_evaluator_version	Literal['cayu.knowledge-maintenance-deterministic-evaluator.v1']	KNOWLEDGE_MAINTENANCE_DETERMINISTIC_EVALUATOR_VERSION
plan	KnowledgeMaintenancePlanDraft	required
evaluation	KnowledgeMaintenancePlanEvaluation	required

validate_schema_version (method)

KnowledgeMaintenanceAcceptedPlan.validate_schema_version(value: object) -> object

validate_identity (method)

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

validate_fingerprint (method)

KnowledgeMaintenanceAcceptedPlan.validate_fingerprint(value: str, info) -> str

copy_plan (method)

KnowledgeMaintenanceAcceptedPlan.copy_plan(value: object) -> object

copy_evaluation (method)

KnowledgeMaintenanceAcceptedPlan.copy_evaluation(value: object) -> object

validate_acceptance (method)

KnowledgeMaintenanceAcceptedPlan.validate_acceptance() -> KnowledgeMaintenanceAcceptedPlan

fingerprint (method)

KnowledgeMaintenanceAcceptedPlan.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

KnowledgeMaintenanceProposalPublication

from cayu import KnowledgeMaintenanceProposalPublication

One durable proposal, accepted semantic record, and pending replacement.

Bases: _PersistenceModel.

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
proposal	KnowledgeMaintenanceProposal	required
accepted_plan	KnowledgeMaintenanceAcceptedPlan	required
replacement	KnowledgeEntry	required
receipt	KnowledgeMaintenanceProposalPublicationReceipt	required
outcome	KnowledgeMaintenanceProposalPublicationOutcome	required

copy_proposal (method)

KnowledgeMaintenanceProposalPublication.copy_proposal(value: object) -> object

copy_accepted_plan (method)

KnowledgeMaintenanceProposalPublication.copy_accepted_plan(value: object) -> object

copy_replacement (method)

KnowledgeMaintenanceProposalPublication.copy_replacement(value: object) -> object

copy_receipt (method)

KnowledgeMaintenanceProposalPublication.copy_receipt(value: object) -> object

validate_publication (method)

KnowledgeMaintenanceProposalPublication.validate_publication() -> KnowledgeMaintenanceProposalPublication

Release source · Runtime guarantees · Capability guides

KnowledgeMaintenanceProposalPublicationConflict

from cayu import KnowledgeMaintenanceProposalPublicationConflict

A proposal publication identity is occupied by different material.

Bases: ValueError.

init (method)

KnowledgeMaintenanceProposalPublicationConflict.__init__(reason: str) -> None

Release source · Runtime guarantees · Capability guides

KnowledgeMaintenanceProposalPublicationOutcome

from cayu import KnowledgeMaintenanceProposalPublicationOutcome

Durable outcome of one accepted-plan handoff.

Bases: StrEnum.

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
PENDING_PERSISTED	class attribute	'pending_persisted'
EXISTING_PENDING	class attribute	'existing_pending'
EXISTING_DECIDED	class attribute	'existing_decided'

Release source · Runtime guarantees · Capability guides

KnowledgeMaintenanceProposalPublicationReceipt

from cayu import KnowledgeMaintenanceProposalPublicationReceipt

Immutable replay evidence for one atomic pending proposal publication.

Bases: _PersistenceModel.

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]	KNOWLEDGE_MAINTENANCE_PROPOSAL_PUBLICATION_SCHEMA_VERSION
operation_id	StrictStr	required
proposal_id	StrictStr	required
proposal_fingerprint	StrictStr	required
accepted_plan_fingerprint	StrictStr	required
request_sha256	StrictStr	required
replacement	KnowledgeRevisionRef	required
committed_at	datetime	required
replayed	bool	False

validate_schema_version (method)

KnowledgeMaintenanceProposalPublicationReceipt.validate_schema_version(value: object) -> object

validate_identity (method)

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

validate_fingerprint (method)

KnowledgeMaintenanceProposalPublicationReceipt.validate_fingerprint(value: str, info) -> str

copy_replacement (method)

KnowledgeMaintenanceProposalPublicationReceipt.copy_replacement(value: object) -> object

validate_committed_at (method)

KnowledgeMaintenanceProposalPublicationReceipt.validate_committed_at(value: datetime) -> datetime

validate_replayed (method)

KnowledgeMaintenanceProposalPublicationReceipt.validate_replayed(value: object) -> bool

Release source · Runtime guarantees · Capability guides

KnowledgeMaintenanceProposalPublisher

from cayu import KnowledgeMaintenanceProposalPublisher

Persist accepted planning output as one immutable pending review artifact.

init (method)

KnowledgeMaintenanceProposalPublisher.__init__(store: _ProposalStore, *, access_scope: KnowledgeAccessScope, config: KnowledgeMaintenanceProposalPublisherConfig) -> None

config (property)

KnowledgeMaintenanceProposalPublisher.config() -> KnowledgeMaintenanceProposalPublisherConfig

publish (method)

async KnowledgeMaintenanceProposalPublisher.publish(routing_request: KnowledgeMaintenanceRoutingRequest, routing_result: KnowledgeMaintenanceRoutingResult, planning_result: KnowledgeMaintenancePlanningResult) -> KnowledgeMaintenanceProposalPublication

Materialize one accepted result without granting lifecycle authority.

load (method)

async KnowledgeMaintenanceProposalPublisher.load(proposal_id: str) -> KnowledgeMaintenanceProposalPublication | None

Load one exact pending or already-decided durable proposal artifact.

Release source · Runtime guarantees · Capability guides

KnowledgeMaintenanceProposalPublisherConfig

from cayu import KnowledgeMaintenanceProposalPublisherConfig

Application-owned publication identity and deterministic chunk bounds.

Bases: _PersistenceModel.

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]	KNOWLEDGE_MAINTENANCE_PROPOSAL_PUBLICATION_SCHEMA_VERSION
publisher_id	StrictStr	required
publisher_version	StrictStr	required
created_by	StrictStr	'knowledge_maintenance'
proposed_by	StrictStr	'knowledge_maintenance'
pipeline_version	StrictStr	KNOWLEDGE_MAINTENANCE_PROPOSAL_PIPELINE_VERSION
chunk_target_bytes	StrictInt	DEFAULT_KNOWLEDGE_CHUNK_TARGET_BYTES
chunk_overlap_bytes	StrictInt	DEFAULT_KNOWLEDGE_CHUNK_OVERLAP_BYTES
max_chunks	StrictInt	DEFAULT_KNOWLEDGE_INDEX_MAX_CHUNKS

validate_schema_version (method)

KnowledgeMaintenanceProposalPublisherConfig.validate_schema_version(value: object) -> object

validate_identity (method)

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

validate_chunk_bound (method)

KnowledgeMaintenanceProposalPublisherConfig.validate_chunk_bound(value: int, info) -> int

validate_chunk_bounds (method)

KnowledgeMaintenanceProposalPublisherConfig.validate_chunk_bounds() -> KnowledgeMaintenanceProposalPublisherConfig

fingerprint (method)

KnowledgeMaintenanceProposalPublisherConfig.fingerprint() -> str

Release source · Runtime guarantees · Capability guides