cayu.memory.processing

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.

AGENT_RECALL_PROCESSING_SCHEMA_VERSION

from cayu.memory import AGENT_RECALL_PROCESSING_SCHEMA_VERSION

AGENT_RECALL_PROCESSING_SCHEMA_VERSION = 'cayu.agent_recall_processing.v3'

Release source · Runtime guarantees · Capability guides

agent_recall_situation_input_sha256

from cayu.memory import agent_recall_situation_input_sha256

Fingerprint retrieval-shaping input, excluding clock and access authority.

agent_recall_situation_input_sha256(situation: RecallSituation) -> str

Release source · Runtime guarantees · Capability guides

agent_work_context_recall_text

from cayu.memory import agent_work_context_recall_text

Render deterministic bounded retrieval text from durable work context.

agent_work_context_recall_text(context: AgentWorkContext) -> str

Release source · Runtime guarantees · Capability guides

AgentRecallFrontier

from cayu.memory import AgentRecallFrontier

A caller-replayable pair of unchanged-context delta high-water marks.

Bases: _AgentRecallModel.

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
knowledge_sequence	int	required
index_readiness_sequence	int	required

model_copy (method)

AgentRecallFrontier.model_copy(*, update: Mapping[str, Any] | None=None, deep: bool=False) -> Self

validate_sequence (method)

AgentRecallFrontier.validate_sequence(value: int, info) -> int

fingerprint (method)

AgentRecallFrontier.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentRecallProcessingError

from cayu.memory import AgentRecallProcessingError

A required freshness source could not be evaluated safely.

Bases: RuntimeError.

init (method)

AgentRecallProcessingError.__init__(code: str) -> None

Release source · Runtime guarantees · Capability guides

AgentRecallProcessingMode

from cayu.memory import AgentRecallProcessingMode

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
FULL_INDEX	class attribute	'full_index'
DELTA	class attribute	'delta'
NO_WORK	class attribute	'no_work'

Release source · Runtime guarantees · Capability guides

AgentRecallProcessingRequest

from cayu.memory import AgentRecallProcessingRequest

One side-effect-free full-index or delta recall request.

Bases: _AgentRecallModel.

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
agent_id	str	required
work_context	AgentWorkContext	required
situation	RecallSituation	required
checkpoint_stream_id	str	required
checkpoint	AgentRecallCheckpoint | None	None
frontier	AgentRecallFrontier | None	None
processing_id	str	required
operation_id	str	required
updated_by	str	required
updated_at	datetime	required

model_copy (method)

AgentRecallProcessingRequest.model_copy(*, update: Mapping[str, Any] | None=None, deep: bool=False) -> Self

validate_identity (method)

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

copy_work_context (method)

AgentRecallProcessingRequest.copy_work_context(value: object, info) -> AgentWorkContext

copy_situation (method)

AgentRecallProcessingRequest.copy_situation(value: object, info) -> RecallSituation

copy_checkpoint (method)

AgentRecallProcessingRequest.copy_checkpoint(value: object, info) -> AgentRecallCheckpoint | None

copy_frontier (method)

AgentRecallProcessingRequest.copy_frontier(value: object) -> AgentRecallFrontier | None

validate_updated_at (method)

AgentRecallProcessingRequest.validate_updated_at(value: datetime) -> datetime

validate_authority (method)

AgentRecallProcessingRequest.validate_authority() -> AgentRecallProcessingRequest

Release source · Runtime guarantees · Capability guides

AgentRecallProcessingResult

from cayu.memory import AgentRecallProcessingResult

Immutable retrieval outcome and optional, unapplied checkpoint proposal.

Bases: _AgentRecallModel.

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['cayu.agent_recall_processing.v3']	AGENT_RECALL_PROCESSING_SCHEMA_VERSION
mode	AgentRecallProcessingMode	required
reason	str	required
agent_id	str	required
task_id	str	required
knowledge_namespace	str	required
work_context_revision	int	required
work_context_sha256	str	required
processing_id	str	required
operation_id	str	required
access_policy_sha256	str	required
checkpoint_stream_id	str	required
situation_sha256	str	required
frontier	AgentRecallFrontier	required
processed_frontier	AgentRecallFrontier	required
knowledge_event_count	int	required
index_readiness_event_count	int	required
knowledge_events	tuple[KnowledgeChange, ...]	()
index_readiness_events	tuple[KnowledgeIndexReadiness, ...]	()
eligible_revisions	tuple[KnowledgeRevisionRef, ...]	()
recall	RecallResult | None	None
proposed_checkpoint	AgentRecallCheckpoint | None	None
frontier_complete	bool	required
retry_required	bool	False

model_copy (method)

AgentRecallProcessingResult.model_copy(*, update: Mapping[str, Any] | None=None, deep: bool=False) -> Self

validate_mode (method)

AgentRecallProcessingResult.validate_mode(value: object) -> AgentRecallProcessingMode

validate_identity (method)

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

validate_sha256 (method)

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

validate_work_context_revision (method)

AgentRecallProcessingResult.validate_work_context_revision(value: int) -> int

validate_work_context_sha256 (method)

AgentRecallProcessingResult.validate_work_context_sha256(value: str) -> str

validate_event_count (method)

AgentRecallProcessingResult.validate_event_count(value: int, info) -> int

copy_knowledge_events (method)

AgentRecallProcessingResult.copy_knowledge_events(value) -> tuple[KnowledgeChange, ...]

copy_index_readiness_events (method)

AgentRecallProcessingResult.copy_index_readiness_events(value) -> tuple[KnowledgeIndexReadiness, ...]

copy_revisions (method)

AgentRecallProcessingResult.copy_revisions(value) -> tuple[KnowledgeRevisionRef, ...]

validate_boolean (method)

AgentRecallProcessingResult.validate_boolean(value: object, info) -> bool

validate_result_shape (method)

AgentRecallProcessingResult.validate_result_shape() -> AgentRecallProcessingResult

fingerprint (method)

AgentRecallProcessingResult.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentRecallProcessor

from cayu.memory import AgentRecallProcessor

Select and evaluate a full-index, delta, or explicit no-work recall lane.

init (method)

AgentRecallProcessor.__init__(knowledge_store: KnowledgeStore, *, fusion_config: WeightedReciprocalRankFusionConfig, engine_config: RecallEngineConfig | None=None, config: AgentRecallProcessorConfig | None=None) -> None

process (method)

async AgentRecallProcessor.process(request: AgentRecallProcessingRequest) -> AgentRecallProcessingResult

Release source · Runtime guarantees · Capability guides

AgentRecallProcessorConfig

from cayu.memory import AgentRecallProcessorConfig

Hard work and output bounds for one processor invocation.

Bases: _AgentRecallModel.

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
knowledge_change_limit	int	100
index_readiness_limit	int	100
candidate_limit	int	20
source_max_bytes	int	64000
max_record_bytes	int	8000
semantic_timeout_seconds	float	1.0
lineage_limit	int	0
lineage_candidate_limit	int	10
lineage_max_bytes	int	8192

model_copy (method)

AgentRecallProcessorConfig.model_copy(*, update: Mapping[str, Any] | None=None, deep: bool=False) -> Self

validate_page_limit (method)

AgentRecallProcessorConfig.validate_page_limit(value: int, info) -> int

validate_candidate_limit (method)

AgentRecallProcessorConfig.validate_candidate_limit(value: int) -> int

validate_result_byte_bound (method)

AgentRecallProcessorConfig.validate_result_byte_bound(value: int, info) -> int

validate_lineage_limit (method)

AgentRecallProcessorConfig.validate_lineage_limit(value: int) -> int

validate_lineage_candidate_limit (method)

AgentRecallProcessorConfig.validate_lineage_candidate_limit(value: int) -> int

validate_lineage_max_bytes (method)

AgentRecallProcessorConfig.validate_lineage_max_bytes(value: int) -> int

validate_semantic_timeout (method)

AgentRecallProcessorConfig.validate_semantic_timeout(value: object) -> float

validate_combined_revision_bound (method)

AgentRecallProcessorConfig.validate_combined_revision_bound() -> AgentRecallProcessorConfig

Release source · Runtime guarantees · Capability guides