cayu.knowledge.activation_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.

KnowledgeActivationAuthority

from cayu.storage import KnowledgeActivationAuthority

Validated request/decision pair handed to the mechanical store boundary.

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
request	KnowledgeActivationRequest	required
decision	KnowledgeActivationDecision	required

copy_request (method)

KnowledgeActivationAuthority.copy_request(value: object) -> object

copy_decision (method)

KnowledgeActivationAuthority.copy_decision(value: object) -> object

validate_binding (method)

KnowledgeActivationAuthority.validate_binding() -> KnowledgeActivationAuthority

Release source · Runtime guarantees · Capability guides

KnowledgeActivationConflict

from cayu.storage import KnowledgeActivationConflict

An idempotent activation operation conflicts with durable state.

Bases: RuntimeError.

init (method)

KnowledgeActivationConflict.__init__(reason: str) -> None

Release source · Runtime guarantees · Capability guides

KnowledgeActivationDecision

from cayu.storage import KnowledgeActivationDecision

Exact application-owned disposition for one activation request.

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
request_sha256	str	required
disposition	KnowledgeActivationDisposition	required
policy_identity	str	required
policy_version	str	required
code	str	required
annotations	dict[str, Any]	Field(default_factory=dict)

validate_schema_version (method)

KnowledgeActivationDecision.validate_schema_version(value: object) -> int

validate_request_sha256 (method)

KnowledgeActivationDecision.validate_request_sha256(value: str) -> str

validate_identity (method)

KnowledgeActivationDecision.validate_identity(value: object, info) -> str

copy_annotations (method)

KnowledgeActivationDecision.copy_annotations(value: dict[str, Any]) -> dict[str, Any]

fingerprint (property)

KnowledgeActivationDecision.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

KnowledgeActivationDisposition

from cayu.storage import KnowledgeActivationDisposition

Application-policy outcome for one exact activation request.

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
ACTIVATE	class attribute	'activate'
ROUTE_TO_REVIEW	class attribute	'route_to_review'
REJECT	class attribute	'reject'

Release source · Runtime guarantees · Capability guides

KnowledgeActivationReceipt

from cayu.storage import KnowledgeActivationReceipt

Immutable store-authored attribution for one governed revision operation.

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
entry_id	str	required
entry_revision	int	required
expected_revision	int | None	required
publication_request_sha256	str	required
authority	KnowledgeActivationAuthority	required
committed_at	datetime	required
replayed	bool	False

validate_schema_version (method)

KnowledgeActivationReceipt.validate_schema_version(value: object) -> int

validate_operation_id (method)

KnowledgeActivationReceipt.validate_operation_id(value: str) -> str

validate_entry_id (method)

KnowledgeActivationReceipt.validate_entry_id(value: str) -> str

validate_entry_revision (method)

KnowledgeActivationReceipt.validate_entry_revision(value: object) -> int

validate_expected_revision (method)

KnowledgeActivationReceipt.validate_expected_revision(value: object) -> int | None

validate_publication_request_sha256 (method)

KnowledgeActivationReceipt.validate_publication_request_sha256(value: str) -> str

validate_committed_at (method)

KnowledgeActivationReceipt.validate_committed_at(value: datetime) -> datetime

validate_replayed (method)

KnowledgeActivationReceipt.validate_replayed(value: object) -> bool

validate_exact_binding (method)

KnowledgeActivationReceipt.validate_exact_binding() -> KnowledgeActivationReceipt

Release source · Runtime guarantees · Capability guides

KnowledgeActivationRequest

from cayu.storage import KnowledgeActivationRequest

Copied bounded material presented to one application activation policy.

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
mode	KnowledgeGovernanceMode	required
source	KnowledgeActivationSource	required
candidate_entry	KnowledgeEntry	required
chunks	tuple[KnowledgeChunk, ...]	required
evidence	tuple[KnowledgeEvidence, ...]	()
expected_revision	int | None	None
target_revision	int	required
access_scope	KnowledgeAccessScope	required
evaluator_identity	str | None	None
evaluator_result	dict[str, Any] | None	None
evaluator_decision_sha256	str | None	None
forbidden_authority_identities	tuple[str, ...]	()

validate_schema_version (method)

KnowledgeActivationRequest.validate_schema_version(value: object) -> int

validate_operation_id (method)

KnowledgeActivationRequest.validate_operation_id(value: str) -> str

copy_entry (method)

KnowledgeActivationRequest.copy_entry(value: object) -> object

copy_chunks (method)

KnowledgeActivationRequest.copy_chunks(value: object) -> object

copy_evidence (method)

KnowledgeActivationRequest.copy_evidence(value: object) -> object

validate_expected_revision (method)

KnowledgeActivationRequest.validate_expected_revision(value: object) -> int | None

validate_target_revision (method)

KnowledgeActivationRequest.validate_target_revision(value: object) -> int

copy_access_scope (method)

KnowledgeActivationRequest.copy_access_scope(value: object) -> object

validate_sha256 (method)

KnowledgeActivationRequest.validate_sha256(value: str | None, info) -> str | None

validate_evaluator_identity (method)

KnowledgeActivationRequest.validate_evaluator_identity(value: object) -> str | None

copy_evaluator_result (method)

KnowledgeActivationRequest.copy_evaluator_result(value: object) -> object

copy_forbidden_identities (method)

KnowledgeActivationRequest.copy_forbidden_identities(value: object) -> tuple[str, ...]

validate_exact_material (method)

KnowledgeActivationRequest.validate_exact_material() -> KnowledgeActivationRequest

fingerprint (property)

KnowledgeActivationRequest.fingerprint() -> str

access_scope_sha256 (property)

KnowledgeActivationRequest.access_scope_sha256() -> str

Return the canonical identity of the copied policy-visible scope.

Release source · Runtime guarantees · Capability guides

KnowledgeActivationSource

from cayu.storage import KnowledgeActivationSource

High-level boundary that requested an activation decision.

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
CURATOR	class attribute	'curator'
MODEL_TOOL	class attribute	'model_tool'
REVIEW_APPROVAL	class attribute	'review_approval'

Release source · Runtime guarantees · Capability guides

KnowledgeGovernanceConfig

from cayu.storage import KnowledgeGovernanceConfig

Host-owned mode, policy identity, and execution bound for knowledge authority.

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
mode	KnowledgeGovernanceMode	KnowledgeGovernanceMode.REVIEWED
policy_identity	str | None	None
policy_version	str | None	None
policy_timeout_seconds	float	30.0

validate_schema_version (method)

KnowledgeGovernanceConfig.validate_schema_version(value: object) -> int

validate_optional_identity (method)

KnowledgeGovernanceConfig.validate_optional_identity(value: object, info) -> str | None

validate_timeout (method)

KnowledgeGovernanceConfig.validate_timeout(value: object) -> float

validate_policy_authority (method)

KnowledgeGovernanceConfig.validate_policy_authority() -> KnowledgeGovernanceConfig

Release source · Runtime guarantees · Capability guides

KnowledgeGovernanceMode

from cayu.storage import KnowledgeGovernanceMode

Application-selected authority model for one high-level knowledge write.

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
REVIEWED	class attribute	'reviewed'
POLICY_AUTOMATIC	class attribute	'policy_automatic'
AUTONOMOUS	class attribute	'autonomous'

Release source · Runtime guarantees · Capability guides

KnowledgeReviewApproval

from cayu.storage import KnowledgeReviewApproval

Exact activated revision and durable reviewed-approval attribution.

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
entry	KnowledgeEntry	required
receipt	KnowledgeActivationReceipt	required

validate_binding (method)

KnowledgeReviewApproval.validate_binding() -> KnowledgeReviewApproval

Release source · Runtime guarantees · Capability guides

MAX_KNOWLEDGE_ACTIVATION_ANNOTATION_BYTES

from cayu.storage import MAX_KNOWLEDGE_ACTIVATION_ANNOTATION_BYTES

MAX_KNOWLEDGE_ACTIVATION_ANNOTATION_BYTES = 16384

Release source · Runtime guarantees · Capability guides

MAX_KNOWLEDGE_ACTIVATION_CHUNKS

from cayu.storage import MAX_KNOWLEDGE_ACTIVATION_CHUNKS

MAX_KNOWLEDGE_ACTIVATION_CHUNKS = 10000

Release source · Runtime guarantees · Capability guides

MAX_KNOWLEDGE_ACTIVATION_EVALUATOR_RESULT_BYTES

from cayu.storage import MAX_KNOWLEDGE_ACTIVATION_EVALUATOR_RESULT_BYTES

MAX_KNOWLEDGE_ACTIVATION_EVALUATOR_RESULT_BYTES = 65536

Release source · Runtime guarantees · Capability guides

MAX_KNOWLEDGE_ACTIVATION_EVIDENCE_RECORDS

from cayu.storage import MAX_KNOWLEDGE_ACTIVATION_EVIDENCE_RECORDS

MAX_KNOWLEDGE_ACTIVATION_EVIDENCE_RECORDS = 10000

Release source · Runtime guarantees · Capability guides

MAX_KNOWLEDGE_ACTIVATION_RECEIPT_BYTES

from cayu.storage import MAX_KNOWLEDGE_ACTIVATION_RECEIPT_BYTES

MAX_KNOWLEDGE_ACTIVATION_RECEIPT_BYTES = 1114112

Release source · Runtime guarantees · Capability guides

MAX_KNOWLEDGE_ACTIVATION_REQUEST_BYTES

from cayu.storage import MAX_KNOWLEDGE_ACTIVATION_REQUEST_BYTES

MAX_KNOWLEDGE_ACTIVATION_REQUEST_BYTES = 1048576

Release source · Runtime guarantees · Capability guides

prepare_knowledge_activation_request

from cayu.storage import prepare_knowledge_activation_request

Copy the exact bounded candidate material presented to activation policy.

prepare_knowledge_activation_request(entry: KnowledgeEntry, chunks: list[KnowledgeChunk], *, evidence: list[KnowledgeEvidence] | None=None, access_scope: KnowledgeAccessScope, operation_id: str, governance_mode: KnowledgeGovernanceMode, source: KnowledgeActivationSource, expected_revision: int | None=None, evaluator_identity: str | None=None, evaluator_result: dict[str, Any] | None=None, evaluator_decision_sha256: str | None=None, forbidden_authority_identities: tuple[str, ...]=()) -> KnowledgeActivationRequest

Release source · Runtime guarantees · Capability guides