cayu.knowledge.maintenance_planning
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_DETERMINISTIC_EVALUATOR_VERSION
Section titled “KNOWLEDGE_MAINTENANCE_DETERMINISTIC_EVALUATOR_VERSION”from cayu import KNOWLEDGE_MAINTENANCE_DETERMINISTIC_EVALUATOR_VERSIONKNOWLEDGE_MAINTENANCE_DETERMINISTIC_EVALUATOR_VERSION = 'cayu.knowledge-maintenance-deterministic-evaluator.v1'Release source · Runtime guarantees · Capability guides
KNOWLEDGE_MAINTENANCE_PLANNING_SCHEMA_VERSION
Section titled “KNOWLEDGE_MAINTENANCE_PLANNING_SCHEMA_VERSION”from cayu import KNOWLEDGE_MAINTENANCE_PLANNING_SCHEMA_VERSIONKNOWLEDGE_MAINTENANCE_PLANNING_SCHEMA_VERSION = 1Release source · Runtime guarantees · Capability guides
KnowledgeMaintenanceEvaluationFinding
Section titled “KnowledgeMaintenanceEvaluationFinding”from cayu import KnowledgeMaintenanceEvaluationFindingOne bounded diagnostic without source or replacement prose.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
kind |
KnowledgeMaintenanceEvaluationFindingKind |
required |
code |
KnowledgeMaintenanceEvaluationFindingCode |
required |
source_references |
tuple[KnowledgeRevisionRef, ...] |
() |
evidence_mapping_ids |
tuple[StrictStr, ...] |
() |
copy_source_references (method)
Section titled “copy_source_references (method)”KnowledgeMaintenanceEvaluationFinding.copy_source_references(value: object) -> tuple[KnowledgeRevisionRef, ...]copy_evidence_mapping_ids (method)
Section titled “copy_evidence_mapping_ids (method)”KnowledgeMaintenanceEvaluationFinding.copy_evidence_mapping_ids(value: object) -> tuple[str, ...]validate_code_for_kind (method)
Section titled “validate_code_for_kind (method)”KnowledgeMaintenanceEvaluationFinding.validate_code_for_kind() -> KnowledgeMaintenanceEvaluationFindingfingerprint (property)
Section titled “fingerprint (property)”KnowledgeMaintenanceEvaluationFinding.fingerprint() -> strRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenanceEvaluationFindingCode
Section titled “KnowledgeMaintenanceEvaluationFindingCode”from cayu import KnowledgeMaintenanceEvaluationFindingCodeClosed runtime-owned diagnostic vocabulary for one finding.
Bases: StrEnum.
Fields and attributes
Section titled “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 |
|---|---|---|
ROUTING_BINDING_INVALID |
class attribute |
'routing_binding_invalid' |
SOURCE_OUTSIDE_ROUTE |
class attribute |
'source_outside_route' |
SOURCE_COVERAGE_INCOMPLETE |
class attribute |
'source_coverage_incomplete' |
RELATION_COVERAGE_INVALID |
class attribute |
'relation_coverage_invalid' |
RELATION_ORIENTATION_INVALID |
class attribute |
'relation_orientation_invalid' |
SOURCE_REVISION_EXHAUSTED |
class attribute |
'source_revision_exhausted' |
EVIDENCE_COVERAGE_INCOMPLETE |
class attribute |
'evidence_coverage_incomplete' |
RELATION_EVIDENCE_MAPPING_INVALID |
class attribute |
'relation_evidence_mapping_invalid' |
UNREFERENCED_EVIDENCE_MAPPING |
class attribute |
'unreferenced_evidence_mapping' |
EVIDENCE_SOURCE_INVALID |
class attribute |
'evidence_source_invalid' |
REPLACEMENT_KIND_DISALLOWED |
class attribute |
'replacement_kind_disallowed' |
STALE_SOURCE |
class attribute |
'stale_source' |
UNSUPPORTED_CLAIM |
class attribute |
'unsupported_claim' |
INFORMATION_LOSS |
class attribute |
'information_loss' |
CONTRADICTION_MISHANDLED |
class attribute |
'contradiction_mishandled' |
RETENTION_VIOLATION |
class attribute |
'retention_violation' |
POLICY_VIOLATION |
class attribute |
'policy_violation' |
PROMPT_INJECTION |
class attribute |
'prompt_injection' |
Release source · Runtime guarantees · Capability guides
KnowledgeMaintenanceEvaluationFindingKind
Section titled “KnowledgeMaintenanceEvaluationFindingKind”from cayu import KnowledgeMaintenanceEvaluationFindingKindClosed, privacy-safe reasons a maintenance plan cannot proceed.
Bases: StrEnum.
Fields and attributes
Section titled “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 |
|---|---|---|
ROUTING_BINDING_INVALID |
class attribute |
'routing_binding_invalid' |
SOURCE_OUTSIDE_ROUTE |
class attribute |
'source_outside_route' |
SOURCE_COVERAGE_INCOMPLETE |
class attribute |
'source_coverage_incomplete' |
RELATION_COVERAGE_INVALID |
class attribute |
'relation_coverage_invalid' |
RELATION_ORIENTATION_INVALID |
class attribute |
'relation_orientation_invalid' |
SOURCE_REVISION_EXHAUSTED |
class attribute |
'source_revision_exhausted' |
EVIDENCE_COVERAGE_INCOMPLETE |
class attribute |
'evidence_coverage_incomplete' |
EVIDENCE_SOURCE_INVALID |
class attribute |
'evidence_source_invalid' |
REPLACEMENT_KIND_DISALLOWED |
class attribute |
'replacement_kind_disallowed' |
STALE_SOURCE |
class attribute |
'stale_source' |
UNSUPPORTED_CLAIM |
class attribute |
'unsupported_claim' |
INFORMATION_LOSS |
class attribute |
'information_loss' |
CONTRADICTION_MISHANDLED |
class attribute |
'contradiction_mishandled' |
RETENTION_VIOLATION |
class attribute |
'retention_violation' |
POLICY_VIOLATION |
class attribute |
'policy_violation' |
PROMPT_INJECTION |
class attribute |
'prompt_injection' |
Release source · Runtime guarantees · Capability guides
KnowledgeMaintenanceEvaluationVerdict
Section titled “KnowledgeMaintenanceEvaluationVerdict”from cayu import KnowledgeMaintenanceEvaluationVerdictIndependent semantic disposition of one structurally valid plan.
Bases: StrEnum.
Fields and attributes
Section titled “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 |
|---|---|---|
ACCEPTED |
class attribute |
'accepted' |
REJECTED |
class attribute |
'rejected' |
Release source · Runtime guarantees · Capability guides
KnowledgeMaintenanceEvaluatorDecision
Section titled “KnowledgeMaintenanceEvaluatorDecision”from cayu import KnowledgeMaintenanceEvaluatorDecisionStrict output from the injected independent semantic evaluator.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
plan_fingerprint |
StrictStr |
required |
routing_result_fingerprint |
StrictStr |
required |
configuration_fingerprint |
StrictStr |
required |
verdict |
KnowledgeMaintenanceEvaluationVerdict |
required |
findings |
tuple[KnowledgeMaintenanceEvaluationFinding, ...] |
() |
validate_fingerprints (method)
Section titled “validate_fingerprints (method)”KnowledgeMaintenanceEvaluatorDecision.validate_fingerprints(value: str, info) -> strcopy_findings (method)
Section titled “copy_findings (method)”KnowledgeMaintenanceEvaluatorDecision.copy_findings(value: object) -> tuple[KnowledgeMaintenanceEvaluationFinding, ...]validate_verdict (method)
Section titled “validate_verdict (method)”KnowledgeMaintenanceEvaluatorDecision.validate_verdict() -> KnowledgeMaintenanceEvaluatorDecisionRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenanceEvaluatorInput
Section titled “KnowledgeMaintenanceEvaluatorInput”from cayu import KnowledgeMaintenanceEvaluatorInputStructurally valid plan and exact snapshot passed to the evaluator.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
planner_input |
KnowledgeMaintenancePlannerInput |
required |
plan |
KnowledgeMaintenancePlanDraft |
required |
budget |
KnowledgeMaintenanceStageBudget |
required |
copy_planner_input (method)
Section titled “copy_planner_input (method)”KnowledgeMaintenanceEvaluatorInput.copy_planner_input(value: object) -> objectcopy_plan (method)
Section titled “copy_plan (method)”KnowledgeMaintenanceEvaluatorInput.copy_plan(value: object) -> objectcopy_budget (method)
Section titled “copy_budget (method)”KnowledgeMaintenanceEvaluatorInput.copy_budget(value: object) -> objectRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenanceEvaluatorOutput
Section titled “KnowledgeMaintenanceEvaluatorOutput”from cayu import KnowledgeMaintenanceEvaluatorOutputStrict evaluator response including independent provider usage.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
decision |
KnowledgeMaintenanceEvaluatorDecision |
required |
usage |
KnowledgeMaintenanceInferenceUsage |
Field(default_factory=KnowledgeMaintenanceInferenceUsage) |
copy_decision (method)
Section titled “copy_decision (method)”KnowledgeMaintenanceEvaluatorOutput.copy_decision(value: object) -> objectcopy_usage (method)
Section titled “copy_usage (method)”KnowledgeMaintenanceEvaluatorOutput.copy_usage(value: object) -> objectRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenanceEvidenceMapping
Section titled “KnowledgeMaintenanceEvidenceMapping”from cayu import KnowledgeMaintenanceEvidenceMappingOne replacement claim mapped to exact routed source revisions.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
id |
StrictStr |
required |
claim |
StrictStr |
required |
source_references |
tuple[KnowledgeRevisionRef, ...] |
required |
validate_id (method)
Section titled “validate_id (method)”KnowledgeMaintenanceEvidenceMapping.validate_id(value: str) -> strvalidate_claim (method)
Section titled “validate_claim (method)”KnowledgeMaintenanceEvidenceMapping.validate_claim(value: str) -> strcopy_source_references (method)
Section titled “copy_source_references (method)”KnowledgeMaintenanceEvidenceMapping.copy_source_references(value: object) -> tuple[KnowledgeRevisionRef, ...]Release source · Runtime guarantees · Capability guides
KnowledgeMaintenanceInferenceUsage
Section titled “KnowledgeMaintenanceInferenceUsage”from cayu import KnowledgeMaintenanceInferenceUsageMeasured provider use reported by an injected planning component.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
model_calls |
StrictInt |
0 |
input_tokens |
StrictInt |
0 |
output_tokens |
StrictInt |
0 |
cost_micro_usd |
StrictInt |
0 |
model_id |
StrictStr | None |
None |
validate_nonnegative (method)
Section titled “validate_nonnegative (method)”KnowledgeMaintenanceInferenceUsage.validate_nonnegative(value: int, info) -> intvalidate_model_id (method)
Section titled “validate_model_id (method)”KnowledgeMaintenanceInferenceUsage.validate_model_id(value: str | None) -> str | Nonevalidate_model_identity (method)
Section titled “validate_model_identity (method)”KnowledgeMaintenanceInferenceUsage.validate_model_identity() -> KnowledgeMaintenanceInferenceUsageRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanDraft
Section titled “KnowledgeMaintenancePlanDraft”from cayu import KnowledgeMaintenancePlanDraftStrict untrusted planner output over one exact routing snapshot.
Bases: _PlanningModel.
Fields and attributes
Section titled “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_PLANNING_SCHEMA_VERSION |
id |
StrictStr |
required |
routing_request_fingerprint |
StrictStr |
required |
routing_result_fingerprint |
StrictStr |
required |
configuration_fingerprint |
StrictStr |
required |
policy_id |
StrictStr |
required |
source_references |
tuple[KnowledgeRevisionRef, ...] |
required |
replacement |
KnowledgeMaintenanceReplacementDraft |
required |
relations |
tuple[KnowledgeMaintenanceRelationDraft, ...] |
required |
evidence_mappings |
tuple[KnowledgeMaintenanceEvidenceMapping, ...] |
required |
rationale |
StrictStr |
required |
evidence_summary |
StrictStr |
required |
validate_schema_version (method)
Section titled “validate_schema_version (method)”KnowledgeMaintenancePlanDraft.validate_schema_version(value: object) -> objectvalidate_identity (method)
Section titled “validate_identity (method)”KnowledgeMaintenancePlanDraft.validate_identity(value: str, info) -> strvalidate_fingerprints (method)
Section titled “validate_fingerprints (method)”KnowledgeMaintenancePlanDraft.validate_fingerprints(value: str, info) -> strcopy_source_references (method)
Section titled “copy_source_references (method)”KnowledgeMaintenancePlanDraft.copy_source_references(value: object) -> tuple[KnowledgeRevisionRef, ...]copy_replacement (method)
Section titled “copy_replacement (method)”KnowledgeMaintenancePlanDraft.copy_replacement(value: object) -> objectcopy_relations (method)
Section titled “copy_relations (method)”KnowledgeMaintenancePlanDraft.copy_relations(value: object) -> tuple[KnowledgeMaintenanceRelationDraft, ...]copy_evidence_mappings (method)
Section titled “copy_evidence_mappings (method)”KnowledgeMaintenancePlanDraft.copy_evidence_mappings(value: object) -> tuple[KnowledgeMaintenanceEvidenceMapping, ...]validate_bounded_text (method)
Section titled “validate_bounded_text (method)”KnowledgeMaintenancePlanDraft.validate_bounded_text(value: str, info) -> strvalidate_hard_byte_bound (method)
Section titled “validate_hard_byte_bound (method)”KnowledgeMaintenancePlanDraft.validate_hard_byte_bound() -> KnowledgeMaintenancePlanDraftfingerprint (property)
Section titled “fingerprint (property)”KnowledgeMaintenancePlanDraft.fingerprint() -> strRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanEndpoint
Section titled “KnowledgeMaintenancePlanEndpoint”from cayu import KnowledgeMaintenancePlanEndpointA replacement placeholder or one exact proposed source endpoint.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
kind |
KnowledgeMaintenancePlanEndpointKind |
required |
reference |
KnowledgeRevisionRef | None |
None |
copy_reference (method)
Section titled “copy_reference (method)”KnowledgeMaintenancePlanEndpoint.copy_reference(value: object) -> KnowledgeRevisionRef | Nonevalidate_endpoint (method)
Section titled “validate_endpoint (method)”KnowledgeMaintenancePlanEndpoint.validate_endpoint() -> KnowledgeMaintenancePlanEndpointRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanEndpointKind
Section titled “KnowledgeMaintenancePlanEndpointKind”from cayu import KnowledgeMaintenancePlanEndpointKindThe two endpoint roles representable in an unpersisted relation draft.
Bases: StrEnum.
Fields and attributes
Section titled “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 |
|---|---|---|
REPLACEMENT |
class attribute |
'replacement' |
SOURCE |
class attribute |
'source' |
Release source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanEvaluation
Section titled “KnowledgeMaintenancePlanEvaluation”from cayu import KnowledgeMaintenancePlanEvaluationFinal independent evaluation, including whether the injected evaluator ran.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
deterministic_evaluator_version |
Literal['cayu.knowledge-maintenance-deterministic-evaluator.v1'] |
KNOWLEDGE_MAINTENANCE_DETERMINISTIC_EVALUATOR_VERSION |
plan_fingerprint |
StrictStr |
required |
routing_result_fingerprint |
StrictStr |
required |
configuration_fingerprint |
StrictStr |
required |
evaluator_id |
StrictStr |
required |
evaluator_version |
StrictStr |
required |
evaluator_invoked |
StrictBool |
required |
verdict |
KnowledgeMaintenanceEvaluationVerdict |
required |
code |
StrictStr |
required |
findings |
tuple[KnowledgeMaintenanceEvaluationFinding, ...] |
() |
validate_fingerprints (method)
Section titled “validate_fingerprints (method)”KnowledgeMaintenancePlanEvaluation.validate_fingerprints(value: str, info) -> strvalidate_identity (method)
Section titled “validate_identity (method)”KnowledgeMaintenancePlanEvaluation.validate_identity(value: str, info) -> strvalidate_code (method)
Section titled “validate_code (method)”KnowledgeMaintenancePlanEvaluation.validate_code(value: str) -> strcopy_findings (method)
Section titled “copy_findings (method)”KnowledgeMaintenancePlanEvaluation.copy_findings(value: object) -> tuple[KnowledgeMaintenanceEvaluationFinding, ...]validate_verdict (method)
Section titled “validate_verdict (method)”KnowledgeMaintenancePlanEvaluation.validate_verdict() -> KnowledgeMaintenancePlanEvaluationfingerprint (property)
Section titled “fingerprint (property)”KnowledgeMaintenancePlanEvaluation.fingerprint() -> strRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanEvaluator
Section titled “KnowledgeMaintenancePlanEvaluator”from cayu import KnowledgeMaintenancePlanEvaluatorIndependent semantic and application-policy evaluation of one plan.
Bases: Protocol.
evaluate_maintenance_plan (method)
Section titled “evaluate_maintenance_plan (method)”async KnowledgeMaintenancePlanEvaluator.evaluate_maintenance_plan(request: KnowledgeMaintenanceEvaluatorInput) -> KnowledgeMaintenanceEvaluatorOutputRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanner
Section titled “KnowledgeMaintenancePlanner”from cayu import KnowledgeMaintenancePlannerProvider-neutral proposal generation over one copied bounded snapshot.
Bases: Protocol.
propose_maintenance (method)
Section titled “propose_maintenance (method)”async KnowledgeMaintenancePlanner.propose_maintenance(request: KnowledgeMaintenancePlannerInput) -> KnowledgeMaintenancePlannerOutputRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlannerBudget
Section titled “KnowledgeMaintenancePlannerBudget”from cayu import KnowledgeMaintenancePlannerBudgetPlanner invocation budget including every structured-output ceiling.
Bases: KnowledgeMaintenanceStageBudget.
Fields and attributes
Section titled “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 |
|---|---|---|
max_input_bytes |
StrictInt |
required |
max_output_bytes |
StrictInt |
required |
max_model_calls |
StrictInt |
required |
max_cost_micro_usd |
StrictInt |
required |
timeout_seconds |
StrictFloat |
required |
allowed_model_ids |
tuple[StrictStr, ...] |
required |
max_evidence_mappings |
StrictInt |
required |
max_replacement_text_bytes |
StrictInt |
required |
max_claim_bytes |
StrictInt |
required |
validate_positive_int (method)
Section titled “validate_positive_int (method)”KnowledgeMaintenancePlannerBudget.validate_positive_int(value: int, info) -> intvalidate_model_calls (method)
Section titled “validate_model_calls (method)”KnowledgeMaintenancePlannerBudget.validate_model_calls(value: int) -> intvalidate_cost (method)
Section titled “validate_cost (method)”KnowledgeMaintenancePlannerBudget.validate_cost(value: int) -> intvalidate_timeout (method)
Section titled “validate_timeout (method)”KnowledgeMaintenancePlannerBudget.validate_timeout(value: float) -> floatcopy_allowed_model_ids (method)
Section titled “copy_allowed_model_ids (method)”KnowledgeMaintenancePlannerBudget.copy_allowed_model_ids(value: object) -> tuple[str, ...]validate_model_authority (method)
Section titled “validate_model_authority (method)”KnowledgeMaintenancePlannerBudget.validate_model_authority() -> KnowledgeMaintenanceStageBudgetvalidate_evidence_mapping_count (method)
Section titled “validate_evidence_mapping_count (method)”KnowledgeMaintenancePlannerBudget.validate_evidence_mapping_count(value: int) -> intvalidate_replacement_text_bytes (method)
Section titled “validate_replacement_text_bytes (method)”KnowledgeMaintenancePlannerBudget.validate_replacement_text_bytes(value: int) -> intvalidate_claim_bytes (method)
Section titled “validate_claim_bytes (method)”KnowledgeMaintenancePlannerBudget.validate_claim_bytes(value: int) -> intRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlannerInput
Section titled “KnowledgeMaintenancePlannerInput”from cayu import KnowledgeMaintenancePlannerInputMinimized routed snapshot and budget passed to the untrusted planner.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
snapshot |
KnowledgeMaintenancePlanningSnapshot |
required |
configuration_fingerprint |
StrictStr |
required |
allowed_replacement_kinds |
tuple[StrictStr, ...] |
required |
budget |
KnowledgeMaintenancePlannerBudget |
required |
copy_snapshot (method)
Section titled “copy_snapshot (method)”KnowledgeMaintenancePlannerInput.copy_snapshot(value: object) -> objectvalidate_configuration_fingerprint (method)
Section titled “validate_configuration_fingerprint (method)”KnowledgeMaintenancePlannerInput.validate_configuration_fingerprint(value: str) -> strcopy_allowed_kinds (method)
Section titled “copy_allowed_kinds (method)”KnowledgeMaintenancePlannerInput.copy_allowed_kinds(value: object) -> tuple[str, ...]copy_budget (method)
Section titled “copy_budget (method)”KnowledgeMaintenancePlannerInput.copy_budget(value: object) -> objectfingerprint (property)
Section titled “fingerprint (property)”KnowledgeMaintenancePlannerInput.fingerprint() -> strRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlannerOutput
Section titled “KnowledgeMaintenancePlannerOutput”from cayu import KnowledgeMaintenancePlannerOutputStrict planner response including provider usage accounting.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
plan |
KnowledgeMaintenancePlanDraft |
required |
usage |
KnowledgeMaintenanceInferenceUsage |
Field(default_factory=KnowledgeMaintenanceInferenceUsage) |
copy_plan (method)
Section titled “copy_plan (method)”KnowledgeMaintenancePlannerOutput.copy_plan(value: object) -> objectcopy_usage (method)
Section titled “copy_usage (method)”KnowledgeMaintenancePlannerOutput.copy_usage(value: object) -> objectRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanningConfig
Section titled “KnowledgeMaintenancePlanningConfig”from cayu import KnowledgeMaintenancePlanningConfigApplication-owned identities, semantic policy, and resource ceilings.
Bases: _PlanningModel.
Fields and attributes
Section titled “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_PLANNING_SCHEMA_VERSION |
planner_id |
StrictStr |
required |
planner_version |
StrictStr |
required |
evaluator_id |
StrictStr |
required |
evaluator_version |
StrictStr |
required |
planner_model_ids |
tuple[StrictStr, ...] |
() |
evaluator_model_ids |
tuple[StrictStr, ...] |
() |
allowed_replacement_kinds |
tuple[StrictStr, ...] |
BUILTIN_KNOWLEDGE_KINDS |
max_planner_input_bytes |
StrictInt |
512 * 1024 |
max_plan_bytes |
StrictInt |
MAX_KNOWLEDGE_MAINTENANCE_BYTES |
max_evaluator_input_bytes |
StrictInt |
768 * 1024 |
max_evaluator_output_bytes |
StrictInt |
128 * 1024 |
max_revalidation_bytes |
StrictInt |
512 * 1024 |
max_revalidation_concurrency |
StrictInt |
8 |
max_evidence_mappings |
StrictInt |
100 |
max_replacement_text_bytes |
StrictInt |
64 * 1024 |
max_claim_bytes |
StrictInt |
MAX_KNOWLEDGE_MAINTENANCE_TEXT_BYTES |
max_planner_model_calls |
StrictInt |
1 |
max_evaluator_model_calls |
StrictInt |
1 |
max_planner_cost_micro_usd |
StrictInt |
500000 |
max_evaluator_cost_micro_usd |
StrictInt |
500000 |
max_total_cost_micro_usd |
StrictInt |
1000000 |
source_revalidation_timeout_seconds |
StrictFloat |
10.0 |
planner_timeout_seconds |
StrictFloat |
30.0 |
evaluator_timeout_seconds |
StrictFloat |
30.0 |
validate_schema_version (method)
Section titled “validate_schema_version (method)”KnowledgeMaintenancePlanningConfig.validate_schema_version(value: object) -> objectvalidate_identity (method)
Section titled “validate_identity (method)”KnowledgeMaintenancePlanningConfig.validate_identity(value: str, info) -> strcopy_model_identities (method)
Section titled “copy_model_identities (method)”KnowledgeMaintenancePlanningConfig.copy_model_identities(value: object, info) -> tuple[str, ...]copy_allowed_kinds (method)
Section titled “copy_allowed_kinds (method)”KnowledgeMaintenancePlanningConfig.copy_allowed_kinds(value: object) -> tuple[str, ...]validate_positive_int (method)
Section titled “validate_positive_int (method)”KnowledgeMaintenancePlanningConfig.validate_positive_int(value: int, info) -> intvalidate_model_call_limit (method)
Section titled “validate_model_call_limit (method)”KnowledgeMaintenancePlanningConfig.validate_model_call_limit(value: int, info) -> intvalidate_nonnegative_int (method)
Section titled “validate_nonnegative_int (method)”KnowledgeMaintenancePlanningConfig.validate_nonnegative_int(value: int, info) -> intvalidate_timeout (method)
Section titled “validate_timeout (method)”KnowledgeMaintenancePlanningConfig.validate_timeout(value: float, info) -> floatvalidate_bounds (method)
Section titled “validate_bounds (method)”KnowledgeMaintenancePlanningConfig.validate_bounds() -> KnowledgeMaintenancePlanningConfigfingerprint (property)
Section titled “fingerprint (property)”KnowledgeMaintenancePlanningConfig.fingerprint() -> strplanner_budget (property)
Section titled “planner_budget (property)”KnowledgeMaintenancePlanningConfig.planner_budget() -> KnowledgeMaintenancePlannerBudgetevaluator_budget (property)
Section titled “evaluator_budget (property)”KnowledgeMaintenancePlanningConfig.evaluator_budget() -> KnowledgeMaintenanceStageBudgetRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanningLimitExceeded
Section titled “KnowledgeMaintenancePlanningLimitExceeded”from cayu import KnowledgeMaintenancePlanningLimitExceededA planning request exceeds a configured pre-invocation ceiling.
Bases: ValueError.
init (method)
Section titled “init (method)”KnowledgeMaintenancePlanningLimitExceeded.__init__(limit: str) -> NoneRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanningOutcome
Section titled “KnowledgeMaintenancePlanningOutcome”from cayu import KnowledgeMaintenancePlanningOutcomeExhaustive result of one read-only planning attempt.
Bases: StrEnum.
Fields and attributes
Section titled “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 |
|---|---|---|
NO_CANDIDATES |
class attribute |
'no_candidates' |
ROUTING_INCOMPLETE |
class attribute |
'routing_incomplete' |
SOURCE_SET_CHANGED |
class attribute |
'source_set_changed' |
SOURCE_REVALIDATION_FAILED |
class attribute |
'source_revalidation_failed' |
SOURCE_REVALIDATION_FAILED_AFTER_PLANNING |
class attribute |
'source_revalidation_failed_after_planning' |
SOURCE_REVALIDATION_FAILED_AFTER_EVALUATION |
class attribute |
'source_revalidation_failed_after_evaluation' |
PLANNER_TIMED_OUT |
class attribute |
'planner_timed_out' |
PLANNER_FAILED |
class attribute |
'planner_failed' |
PLANNER_INVALID |
class attribute |
'planner_invalid' |
PLANNER_OVER_BUDGET |
class attribute |
'planner_over_budget' |
DETERMINISTIC_REJECTED |
class attribute |
'deterministic_rejected' |
EVALUATOR_TIMED_OUT |
class attribute |
'evaluator_timed_out' |
EVALUATOR_FAILED |
class attribute |
'evaluator_failed' |
EVALUATOR_INVALID |
class attribute |
'evaluator_invalid' |
EVALUATOR_OVER_BUDGET |
class attribute |
'evaluator_over_budget' |
EVALUATOR_REJECTED |
class attribute |
'evaluator_rejected' |
ACCEPTED |
class attribute |
'accepted' |
Release source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanningResult
Section titled “KnowledgeMaintenancePlanningResult”from cayu import KnowledgeMaintenancePlanningResultRead-only result; accepted plans still have no storage authority.
Bases: _PlanningModel.
Fields and attributes
Section titled “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_PLANNING_SCHEMA_VERSION |
request_id |
StrictStr |
required |
request_fingerprint |
StrictStr |
required |
routing_result_fingerprint |
StrictStr |
required |
configuration_fingerprint |
StrictStr |
required |
planner_id |
StrictStr |
required |
planner_version |
StrictStr |
required |
evaluator_id |
StrictStr |
required |
evaluator_version |
StrictStr |
required |
outcome |
KnowledgeMaintenancePlanningOutcome |
required |
code |
StrictStr |
required |
plan |
KnowledgeMaintenancePlanDraft | None |
None |
evaluation |
KnowledgeMaintenancePlanEvaluation | None |
None |
planner_usage |
KnowledgeMaintenanceInferenceUsage | None |
None |
evaluator_usage |
KnowledgeMaintenanceInferenceUsage | None |
None |
processed_at |
datetime |
required |
validate_schema_version (method)
Section titled “validate_schema_version (method)”KnowledgeMaintenancePlanningResult.validate_schema_version(value: object) -> objectvalidate_request_id (method)
Section titled “validate_request_id (method)”KnowledgeMaintenancePlanningResult.validate_request_id(value: str) -> strvalidate_fingerprints (method)
Section titled “validate_fingerprints (method)”KnowledgeMaintenancePlanningResult.validate_fingerprints(value: str, info) -> strvalidate_component_identity (method)
Section titled “validate_component_identity (method)”KnowledgeMaintenancePlanningResult.validate_component_identity(value: str, info) -> strvalidate_code (method)
Section titled “validate_code (method)”KnowledgeMaintenancePlanningResult.validate_code(value: str) -> strcopy_plan (method)
Section titled “copy_plan (method)”KnowledgeMaintenancePlanningResult.copy_plan(value: object) -> objectcopy_evaluation (method)
Section titled “copy_evaluation (method)”KnowledgeMaintenancePlanningResult.copy_evaluation(value: object) -> objectcopy_usage (method)
Section titled “copy_usage (method)”KnowledgeMaintenancePlanningResult.copy_usage(value: object) -> objectvalidate_processed_at (method)
Section titled “validate_processed_at (method)”KnowledgeMaintenancePlanningResult.validate_processed_at(value: datetime) -> datetimevalidate_result_shape (method)
Section titled “validate_result_shape (method)”KnowledgeMaintenancePlanningResult.validate_result_shape() -> KnowledgeMaintenancePlanningResultfingerprint (property)
Section titled “fingerprint (property)”KnowledgeMaintenancePlanningResult.fingerprint() -> strRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanningSnapshot
Section titled “KnowledgeMaintenancePlanningSnapshot”from cayu import KnowledgeMaintenancePlanningSnapshotMinimum authorized routing material disclosed to planning components.
Bases: _PlanningModel.
Fields and attributes
Section titled “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_id |
StrictStr |
required |
policy_id |
StrictStr |
required |
namespace |
StrictStr |
required |
labels |
dict[str, str] |
Field(default_factory=dict) |
routing_request_fingerprint |
StrictStr |
required |
routing_result_fingerprint |
StrictStr |
required |
routing_configuration_fingerprint |
StrictStr |
required |
candidate_payload_bytes |
StrictInt |
required |
candidates |
tuple[KnowledgeMaintenanceRoutedCandidate, ...] |
() |
routed_signals |
tuple[KnowledgeMaintenanceCandidateSignal, ...] |
() |
validate_identity (method)
Section titled “validate_identity (method)”KnowledgeMaintenancePlanningSnapshot.validate_identity(value: str, info) -> strcopy_labels (method)
Section titled “copy_labels (method)”KnowledgeMaintenancePlanningSnapshot.copy_labels(value: object) -> dict[str, str]validate_fingerprints (method)
Section titled “validate_fingerprints (method)”KnowledgeMaintenancePlanningSnapshot.validate_fingerprints(value: str, info) -> strvalidate_candidate_payload_bytes (method)
Section titled “validate_candidate_payload_bytes (method)”KnowledgeMaintenancePlanningSnapshot.validate_candidate_payload_bytes(value: int) -> intcopy_candidates (method)
Section titled “copy_candidates (method)”KnowledgeMaintenancePlanningSnapshot.copy_candidates(value: object) -> tuple[KnowledgeMaintenanceRoutedCandidate, ...]copy_routed_signals (method)
Section titled “copy_routed_signals (method)”KnowledgeMaintenancePlanningSnapshot.copy_routed_signals(value: object) -> tuple[KnowledgeMaintenanceCandidateSignal, ...]validate_authorized_snapshot (method)
Section titled “validate_authorized_snapshot (method)”KnowledgeMaintenancePlanningSnapshot.validate_authorized_snapshot() -> KnowledgeMaintenancePlanningSnapshotfingerprint (property)
Section titled “fingerprint (property)”KnowledgeMaintenancePlanningSnapshot.fingerprint() -> strRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenancePlanningWorkflow
Section titled “KnowledgeMaintenancePlanningWorkflow”from cayu import KnowledgeMaintenancePlanningWorkflowGenerate and independently evaluate a bounded plan without writes.
init (method)
Section titled “init (method)”KnowledgeMaintenancePlanningWorkflow.__init__(store: _PlanningStore, *, planner: KnowledgeMaintenancePlanner, evaluator: KnowledgeMaintenancePlanEvaluator, config: KnowledgeMaintenancePlanningConfig, clock: Callable[[], datetime] | None=None) -> Noneconfig (property)
Section titled “config (property)”KnowledgeMaintenancePlanningWorkflow.config() -> KnowledgeMaintenancePlanningConfigplan (method)
Section titled “plan (method)”async KnowledgeMaintenancePlanningWorkflow.plan(routing_request: KnowledgeMaintenanceRoutingRequest, routing_result: KnowledgeMaintenanceRoutingResult) -> KnowledgeMaintenancePlanningResultPlan and evaluate one exact routed snapshot, failing closed.
Release source · Runtime guarantees · Capability guides
KnowledgeMaintenanceRelationDraft
Section titled “KnowledgeMaintenanceRelationDraft”from cayu import KnowledgeMaintenanceRelationDraftOne proposed typed disposition before replacement identity allocation.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
id |
StrictStr |
required |
subject |
KnowledgeMaintenancePlanEndpoint |
required |
object |
KnowledgeMaintenancePlanEndpoint |
required |
kind |
KnowledgeRelationKind |
required |
evidence_mapping_ids |
tuple[StrictStr, ...] |
required |
validate_id (method)
Section titled “validate_id (method)”KnowledgeMaintenanceRelationDraft.validate_id(value: str) -> strcopy_endpoint (method)
Section titled “copy_endpoint (method)”KnowledgeMaintenanceRelationDraft.copy_endpoint(value: object) -> objectcopy_evidence_mapping_ids (method)
Section titled “copy_evidence_mapping_ids (method)”KnowledgeMaintenanceRelationDraft.copy_evidence_mapping_ids(value: object) -> tuple[str, ...]validate_endpoint_roles (method)
Section titled “validate_endpoint_roles (method)”KnowledgeMaintenanceRelationDraft.validate_endpoint_roles() -> KnowledgeMaintenanceRelationDraftsource_reference (property)
Section titled “source_reference (property)”KnowledgeMaintenanceRelationDraft.source_reference() -> KnowledgeRevisionRefRelease source · Runtime guarantees · Capability guides
KnowledgeMaintenanceReplacementDraft
Section titled “KnowledgeMaintenanceReplacementDraft”from cayu import KnowledgeMaintenanceReplacementDraftSemantic replacement content; application-owned scope fields are absent.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
text |
StrictStr |
required |
title |
StrictStr | None |
None |
kind |
StrictStr |
required |
aspects |
tuple[StrictStr, ...] |
() |
impact_targets |
tuple[StrictStr, ...] |
() |
validate_text (method)
Section titled “validate_text (method)”KnowledgeMaintenanceReplacementDraft.validate_text(value: str) -> strvalidate_title (method)
Section titled “validate_title (method)”KnowledgeMaintenanceReplacementDraft.validate_title(value: str | None) -> str | Nonevalidate_kind (method)
Section titled “validate_kind (method)”KnowledgeMaintenanceReplacementDraft.validate_kind(value: str) -> strcopy_facets (method)
Section titled “copy_facets (method)”KnowledgeMaintenanceReplacementDraft.copy_facets(value: object, info) -> tuple[str, ...]Release source · Runtime guarantees · Capability guides
KnowledgeMaintenanceStageBudget
Section titled “KnowledgeMaintenanceStageBudget”from cayu import KnowledgeMaintenanceStageBudgetOne explicit provider-neutral invocation budget.
Bases: _PlanningModel.
Fields and attributes
Section titled “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 |
|---|---|---|
max_input_bytes |
StrictInt |
required |
max_output_bytes |
StrictInt |
required |
max_model_calls |
StrictInt |
required |
max_cost_micro_usd |
StrictInt |
required |
timeout_seconds |
StrictFloat |
required |
allowed_model_ids |
tuple[StrictStr, ...] |
required |
validate_positive_int (method)
Section titled “validate_positive_int (method)”KnowledgeMaintenanceStageBudget.validate_positive_int(value: int, info) -> intvalidate_model_calls (method)
Section titled “validate_model_calls (method)”KnowledgeMaintenanceStageBudget.validate_model_calls(value: int) -> intvalidate_cost (method)
Section titled “validate_cost (method)”KnowledgeMaintenanceStageBudget.validate_cost(value: int) -> intvalidate_timeout (method)
Section titled “validate_timeout (method)”KnowledgeMaintenanceStageBudget.validate_timeout(value: float) -> floatcopy_allowed_model_ids (method)
Section titled “copy_allowed_model_ids (method)”KnowledgeMaintenanceStageBudget.copy_allowed_model_ids(value: object) -> tuple[str, ...]validate_model_authority (method)
Section titled “validate_model_authority (method)”KnowledgeMaintenanceStageBudget.validate_model_authority() -> KnowledgeMaintenanceStageBudgetRelease source · Runtime guarantees · Capability guides
MAX_KNOWLEDGE_MAINTENANCE_COST_MICRO_USD
Section titled “MAX_KNOWLEDGE_MAINTENANCE_COST_MICRO_USD”from cayu import MAX_KNOWLEDGE_MAINTENANCE_COST_MICRO_USDMAX_KNOWLEDGE_MAINTENANCE_COST_MICRO_USD = 1000000000Release source · Runtime guarantees · Capability guides
MAX_KNOWLEDGE_MAINTENANCE_EVALUATION_FINDINGS
Section titled “MAX_KNOWLEDGE_MAINTENANCE_EVALUATION_FINDINGS”from cayu import MAX_KNOWLEDGE_MAINTENANCE_EVALUATION_FINDINGSMAX_KNOWLEDGE_MAINTENANCE_EVALUATION_FINDINGS = 256Release source · Runtime guarantees · Capability guides
MAX_KNOWLEDGE_MAINTENANCE_MODEL_CALLS
Section titled “MAX_KNOWLEDGE_MAINTENANCE_MODEL_CALLS”from cayu import MAX_KNOWLEDGE_MAINTENANCE_MODEL_CALLSMAX_KNOWLEDGE_MAINTENANCE_MODEL_CALLS = 16Release source · Runtime guarantees · Capability guides
MAX_KNOWLEDGE_MAINTENANCE_PLAN_CLAIMS
Section titled “MAX_KNOWLEDGE_MAINTENANCE_PLAN_CLAIMS”from cayu import MAX_KNOWLEDGE_MAINTENANCE_PLAN_CLAIMSMAX_KNOWLEDGE_MAINTENANCE_PLAN_CLAIMS = 256Release source · Runtime guarantees · Capability guides
MAX_KNOWLEDGE_MAINTENANCE_PLANNING_BYTES
Section titled “MAX_KNOWLEDGE_MAINTENANCE_PLANNING_BYTES”from cayu import MAX_KNOWLEDGE_MAINTENANCE_PLANNING_BYTESMAX_KNOWLEDGE_MAINTENANCE_PLANNING_BYTES = 4 * 1024 * 1024Release source · Runtime guarantees · Capability guides
MAX_KNOWLEDGE_MAINTENANCE_PLANNING_TIMEOUT_SECONDS
Section titled “MAX_KNOWLEDGE_MAINTENANCE_PLANNING_TIMEOUT_SECONDS”from cayu import MAX_KNOWLEDGE_MAINTENANCE_PLANNING_TIMEOUT_SECONDSMAX_KNOWLEDGE_MAINTENANCE_PLANNING_TIMEOUT_SECONDS = 300.0Release source · Runtime guarantees · Capability guides
MAX_KNOWLEDGE_MAINTENANCE_TOKEN_COUNT
Section titled “MAX_KNOWLEDGE_MAINTENANCE_TOKEN_COUNT”from cayu import MAX_KNOWLEDGE_MAINTENANCE_TOKEN_COUNTMAX_KNOWLEDGE_MAINTENANCE_TOKEN_COUNT = 2 ** 63 - 1