cayu.work_context

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_CHECKPOINT_SCHEMA_VERSION

from cayu import AGENT_RECALL_CHECKPOINT_SCHEMA_VERSION

AGENT_RECALL_CHECKPOINT_SCHEMA_VERSION = 'cayu.agent_recall_checkpoint.v2'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_DELIVERY_ACKNOWLEDGEMENT_SCHEMA_VERSION

from cayu import AGENT_RECALL_DELIVERY_ACKNOWLEDGEMENT_SCHEMA_VERSION

AGENT_RECALL_DELIVERY_ACKNOWLEDGEMENT_SCHEMA_VERSION = 'cayu.agent_recall_delivery_acknowledgement.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_DELIVERY_CLAIM_SCHEMA_VERSION

from cayu import AGENT_RECALL_DELIVERY_CLAIM_SCHEMA_VERSION

AGENT_RECALL_DELIVERY_CLAIM_SCHEMA_VERSION = 'cayu.agent_recall_delivery_claim.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_DELIVERY_RECORD_SCHEMA_VERSION

from cayu import AGENT_RECALL_DELIVERY_RECORD_SCHEMA_VERSION

AGENT_RECALL_DELIVERY_RECORD_SCHEMA_VERSION = 'cayu.agent_recall_delivery_record.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_DELIVERY_RELEASE_SCHEMA_VERSION

from cayu import AGENT_RECALL_DELIVERY_RELEASE_SCHEMA_VERSION

AGENT_RECALL_DELIVERY_RELEASE_SCHEMA_VERSION = 'cayu.agent_recall_delivery_release.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_DELIVERY_SCHEMA_VERSION

from cayu import AGENT_RECALL_DELIVERY_SCHEMA_VERSION

AGENT_RECALL_DELIVERY_SCHEMA_VERSION = 'cayu.agent_recall_delivery.v1'

Release source · Runtime guarantees · Capability guides

agent_recall_facet_aspect

from cayu import agent_recall_facet_aspect

Encode one typed work-context facet as an exact knowledge aspect.

agent_recall_facet_aspect(field_name: str, value: str) -> str

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_SUBSCRIPTION_CLAIM_SCHEMA_VERSION

from cayu import AGENT_RECALL_SUBSCRIPTION_CLAIM_SCHEMA_VERSION

AGENT_RECALL_SUBSCRIPTION_CLAIM_SCHEMA_VERSION = 'cayu.agent_recall_subscription_claim.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_SUBSCRIPTION_EVALUATION_SCHEMA_VERSION

from cayu import AGENT_RECALL_SUBSCRIPTION_EVALUATION_SCHEMA_VERSION

AGENT_RECALL_SUBSCRIPTION_EVALUATION_SCHEMA_VERSION = 'cayu.agent_recall_subscription_evaluation.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_SUBSCRIPTION_PUBLICATION_SCHEMA_VERSION

from cayu import AGENT_RECALL_SUBSCRIPTION_PUBLICATION_SCHEMA_VERSION

AGENT_RECALL_SUBSCRIPTION_PUBLICATION_SCHEMA_VERSION = 'cayu.agent_recall_subscription_publication_receipt.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_SUBSCRIPTION_RECORD_SCHEMA_VERSION

from cayu import AGENT_RECALL_SUBSCRIPTION_RECORD_SCHEMA_VERSION

AGENT_RECALL_SUBSCRIPTION_RECORD_SCHEMA_VERSION = 'cayu.agent_recall_subscription_record.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_SUBSCRIPTION_RELEASE_SCHEMA_VERSION

from cayu import AGENT_RECALL_SUBSCRIPTION_RELEASE_SCHEMA_VERSION

AGENT_RECALL_SUBSCRIPTION_RELEASE_SCHEMA_VERSION = 'cayu.agent_recall_subscription_release.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_SUBSCRIPTION_SCHEMA_VERSION

from cayu import AGENT_RECALL_SUBSCRIPTION_SCHEMA_VERSION

AGENT_RECALL_SUBSCRIPTION_SCHEMA_VERSION = 'cayu.agent_recall_subscription.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_SUBSCRIPTION_WAKE_ACKNOWLEDGEMENT_SCHEMA_VERSION

from cayu import AGENT_RECALL_SUBSCRIPTION_WAKE_ACKNOWLEDGEMENT_SCHEMA_VERSION

AGENT_RECALL_SUBSCRIPTION_WAKE_ACKNOWLEDGEMENT_SCHEMA_VERSION = 'cayu.agent_recall_subscription_wake_acknowledgement.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_SUBSCRIPTION_WAKE_CLAIM_SCHEMA_VERSION

from cayu import AGENT_RECALL_SUBSCRIPTION_WAKE_CLAIM_SCHEMA_VERSION

AGENT_RECALL_SUBSCRIPTION_WAKE_CLAIM_SCHEMA_VERSION = 'cayu.agent_recall_subscription_wake_claim.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_SUBSCRIPTION_WAKE_RELEASE_SCHEMA_VERSION

from cayu import AGENT_RECALL_SUBSCRIPTION_WAKE_RELEASE_SCHEMA_VERSION

AGENT_RECALL_SUBSCRIPTION_WAKE_RELEASE_SCHEMA_VERSION = 'cayu.agent_recall_subscription_wake_release.v1'

Release source · Runtime guarantees · Capability guides

AGENT_RECALL_SUBSCRIPTION_WAKE_SCHEMA_VERSION

from cayu import AGENT_RECALL_SUBSCRIPTION_WAKE_SCHEMA_VERSION

AGENT_RECALL_SUBSCRIPTION_WAKE_SCHEMA_VERSION = 'cayu.agent_recall_subscription_wake.v1'

Release source · Runtime guarantees · Capability guides

AGENT_WORK_CONTEXT_PUBLICATION_SCHEMA_VERSION

from cayu import AGENT_WORK_CONTEXT_PUBLICATION_SCHEMA_VERSION

AGENT_WORK_CONTEXT_PUBLICATION_SCHEMA_VERSION = 'cayu.agent_work_context_publication_receipt.v1'

Release source · Runtime guarantees · Capability guides

AGENT_WORK_CONTEXT_SCHEMA_VERSION

from cayu import AGENT_WORK_CONTEXT_SCHEMA_VERSION

AGENT_WORK_CONTEXT_SCHEMA_VERSION = 'cayu.agent_work_context.v1'

Release source · Runtime guarantees · Capability guides

AgentRecallCheckpoint

from cayu import AgentRecallCheckpoint

Processed freshness frontier for one exact agent/task/access view.

Bases: _WorkContextModel.

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_checkpoint.v2']	AGENT_RECALL_CHECKPOINT_SCHEMA_VERSION
agent_id	str	required
task_id	str	required
knowledge_namespace	str	required
access_policy_sha256	str	required
checkpoint_stream_id	str	DEFAULT_AGENT_RECALL_CHECKPOINT_STREAM_ID
revision	int	required
work_context_revision	int	required
work_context_sha256	str	required
knowledge_sequence	int	required
index_readiness_sequence	int	required
knowledge_high_water_sequence	int	required
index_readiness_high_water_sequence	int	required
processing_mode	AgentRecallCheckpointMode	required
processing_id	str	required
operation_id	str	required
updated_by	str	required
updated_at	datetime	required

model_copy (method)

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

validate_key_identity (method)

AgentRecallCheckpoint.validate_key_identity(value: str, info) -> str

validate_processing_identity (method)

AgentRecallCheckpoint.validate_processing_identity(value: str, info) -> str

validate_digest (method)

AgentRecallCheckpoint.validate_digest(value: str, info) -> str

validate_positive_revision (method)

AgentRecallCheckpoint.validate_positive_revision(value: int, info) -> int

validate_sequence (method)

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

validate_processing_mode (method)

AgentRecallCheckpoint.validate_processing_mode(value: object) -> AgentRecallCheckpointMode

validate_updated_at (method)

AgentRecallCheckpoint.validate_updated_at(value: datetime) -> datetime

validate_captured_frontiers (method)

AgentRecallCheckpoint.validate_captured_frontiers() -> AgentRecallCheckpoint

key (method)

AgentRecallCheckpoint.key() -> AgentRecallCheckpointKey

fingerprint (method)

AgentRecallCheckpoint.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentRecallCheckpointKey

from cayu import AgentRecallCheckpointKey

Bases: _WorkContextModel.

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
task_id	str	required
knowledge_namespace	str	required
access_policy_sha256	str	required
checkpoint_stream_id	str	DEFAULT_AGENT_RECALL_CHECKPOINT_STREAM_ID

model_copy (method)

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

validate_identity (method)

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

validate_access_policy_sha256 (method)

AgentRecallCheckpointKey.validate_access_policy_sha256(value: str) -> str

sort_key (method)

AgentRecallCheckpointKey.sort_key() -> tuple[str, str, str, str, str]

authority_sort_key (method)

AgentRecallCheckpointKey.authority_sort_key() -> tuple[str, str, str, str]

Return the selector shared by all checkpoint streams for this authority.

fingerprint (method)

AgentRecallCheckpointKey.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentRecallCheckpointMode

from cayu import AgentRecallCheckpointMode

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'

Release source · Runtime guarantees · Capability guides

AgentRecallDelivery

from cayu import AgentRecallDelivery

Immutable materialized recall staged beside its committed checkpoint.

Bases: _WorkContextModel.

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_delivery.v1']	AGENT_RECALL_DELIVERY_SCHEMA_VERSION
delivery_id	str	required
agent_id	str	required
task_id	str	required
knowledge_namespace	str	required
access_policy_sha256	str	required
work_context_revision	int	required
work_context_sha256	str	required
processing_id	str	required
operation_id	str	required
processing_result_sha256	str	required
processing_result	Mapping[str, Any]	required
checkpoint	AgentRecallCheckpoint	required
checkpoint_sha256	str	required
processing_mode	AgentRecallCheckpointMode	required
expected_checkpoint_revision	int | None	required
staged_by	str	required
staged_at	datetime	required

model_copy (method)

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

validate_identity (method)

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

validate_digest (method)

AgentRecallDelivery.validate_digest(value: str, info) -> str

validate_work_context_revision (method)

AgentRecallDelivery.validate_work_context_revision(value: int) -> int

validate_expected_checkpoint_revision (method)

AgentRecallDelivery.validate_expected_checkpoint_revision(value: int | None) -> int | None

copy_processing_result (method)

AgentRecallDelivery.copy_processing_result(value: object) -> dict[str, Any]

freeze_processing_result (method)

AgentRecallDelivery.freeze_processing_result(value: Mapping[str, Any]) -> Mapping[str, Any]

serialize_processing_result (method)

AgentRecallDelivery.serialize_processing_result(value: Mapping[str, Any]) -> dict[str, Any]

copy_checkpoint (method)

AgentRecallDelivery.copy_checkpoint(value: object, info) -> AgentRecallCheckpoint

validate_processing_mode (method)

AgentRecallDelivery.validate_processing_mode(value: object) -> AgentRecallCheckpointMode

validate_staged_at (method)

AgentRecallDelivery.validate_staged_at(value: datetime) -> datetime

validate_processing_authority (method)

AgentRecallDelivery.validate_processing_authority() -> AgentRecallDelivery

from_processing_result (method)

AgentRecallDelivery.from_processing_result(result: AgentRecallProcessingResult, *, delivery_id: str, expected_checkpoint_revision: int | None, staged_by: str, staged_at: datetime) -> AgentRecallDelivery

materialized_result (method)

AgentRecallDelivery.materialized_result() -> AgentRecallProcessingResult

key (method)

AgentRecallDelivery.key() -> AgentRecallCheckpointKey

fingerprint (method)

AgentRecallDelivery.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentRecallDeliveryAcknowledgement

from cayu import AgentRecallDeliveryAcknowledgement

Durable downstream handoff evidence; not provider-exposure evidence.

Bases: _WorkContextModel.

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_delivery_acknowledgement.v1']	AGENT_RECALL_DELIVERY_ACKNOWLEDGEMENT_SCHEMA_VERSION
acknowledgement_id	str	required
delivery_id	str	required
processing_result_sha256	str	required
claim_id	str	required
worker_id	str	required
attempt	int	required
evidence_kind	AgentRecallDeliveryEvidenceKind	required
evidence_ref	str	required
acknowledged_at	datetime	required

model_copy (method)

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

validate_identity (method)

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

validate_result_digest (method)

AgentRecallDeliveryAcknowledgement.validate_result_digest(value: str) -> str

validate_evidence_kind (method)

AgentRecallDeliveryAcknowledgement.validate_evidence_kind(value: object) -> AgentRecallDeliveryEvidenceKind

validate_attempt (method)

AgentRecallDeliveryAcknowledgement.validate_attempt(value: int) -> int

validate_acknowledged_at (method)

AgentRecallDeliveryAcknowledgement.validate_acknowledged_at(value: datetime) -> datetime

Release source · Runtime guarantees · Capability guides

AgentRecallDeliveryClaim

from cayu import AgentRecallDeliveryClaim

Lease-fenced authority over one staged delivery.

Bases: _WorkContextModel.

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_delivery_claim.v1']	AGENT_RECALL_DELIVERY_CLAIM_SCHEMA_VERSION
delivery_id	str	required
processing_result_sha256	str	required
claim_id	str	required
worker_id	str	required
attempt	int	required
state_revision	int	required
claimed_at	datetime	required
lease_expires_at	datetime	required

model_copy (method)

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

validate_identity (method)

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

validate_result_digest (method)

AgentRecallDeliveryClaim.validate_result_digest(value: str) -> str

validate_attempt (method)

AgentRecallDeliveryClaim.validate_attempt(value: int) -> int

validate_state_revision (method)

AgentRecallDeliveryClaim.validate_state_revision(value: int) -> int

validate_time (method)

AgentRecallDeliveryClaim.validate_time(value: datetime, info) -> datetime

validate_lease (method)

AgentRecallDeliveryClaim.validate_lease() -> AgentRecallDeliveryClaim

Release source · Runtime guarantees · Capability guides

AgentRecallDeliveryConflict

from cayu import AgentRecallDeliveryConflict

A staged-delivery operation lost or reused exact transition authority.

Bases: RuntimeError.

init (method)

AgentRecallDeliveryConflict.__init__(code: str) -> None

Release source · Runtime guarantees · Capability guides

AgentRecallDeliveryEvidenceKind

from cayu import AgentRecallDeliveryEvidenceKind

Kind of durable downstream evidence that accepted a staged result.

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
RECALL_RECEIPT	class attribute	'recall_receipt'
CONTEXT_EXPOSURE	class attribute	'context_exposure'
APPLICATION_HANDOFF	class attribute	'application_handoff'

Release source · Runtime guarantees · Capability guides

AgentRecallDeliveryRecord

from cayu import AgentRecallDeliveryRecord

Current delivery state plus its immutable staged payload and acknowledgement.

Bases: _WorkContextModel.

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_delivery_record.v1']	AGENT_RECALL_DELIVERY_RECORD_SCHEMA_VERSION
delivery	AgentRecallDelivery	required
state	AgentRecallDeliveryState	AgentRecallDeliveryState.PENDING
state_revision	int	0
attempt	int	0
claim	AgentRecallDeliveryClaim | None	None
release	AgentRecallDeliveryRelease | None	None
acknowledgement	AgentRecallDeliveryAcknowledgement | None	None
updated_at	datetime	required

model_copy (method)

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

copy_delivery (method)

AgentRecallDeliveryRecord.copy_delivery(value: object, info) -> AgentRecallDelivery

validate_state (method)

AgentRecallDeliveryRecord.validate_state(value: object) -> AgentRecallDeliveryState

validate_nonnegative_counter (method)

AgentRecallDeliveryRecord.validate_nonnegative_counter(value: int, info) -> int

copy_claim (method)

AgentRecallDeliveryRecord.copy_claim(value: object, info) -> AgentRecallDeliveryClaim | None

copy_release (method)

AgentRecallDeliveryRecord.copy_release(value: object, info) -> AgentRecallDeliveryRelease | None

copy_acknowledgement (method)

AgentRecallDeliveryRecord.copy_acknowledgement(value: object, info) -> AgentRecallDeliveryAcknowledgement | None

validate_updated_at (method)

AgentRecallDeliveryRecord.validate_updated_at(value: datetime) -> datetime

validate_lifecycle (method)

AgentRecallDeliveryRecord.validate_lifecycle() -> AgentRecallDeliveryRecord

Release source · Runtime guarantees · Capability guides

AgentRecallDeliveryRelease

from cayu import AgentRecallDeliveryRelease

Immutable evidence that one claim returned its stage for retry.

Bases: _WorkContextModel.

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_delivery_release.v1']	AGENT_RECALL_DELIVERY_RELEASE_SCHEMA_VERSION
release_id	str	required
delivery_id	str	required
processing_result_sha256	str	required
claim_id	str	required
worker_id	str	required
attempt	int	required
claim_state_revision	int	required
reason	str	required
released_at	datetime	required

model_copy (method)

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

validate_identity (method)

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

validate_result_digest (method)

AgentRecallDeliveryRelease.validate_result_digest(value: str) -> str

validate_positive_counter (method)

AgentRecallDeliveryRelease.validate_positive_counter(value: int, info) -> int

validate_reason (method)

AgentRecallDeliveryRelease.validate_reason(value: str) -> str

validate_released_at (method)

AgentRecallDeliveryRelease.validate_released_at(value: datetime) -> datetime

fingerprint (method)

AgentRecallDeliveryRelease.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentRecallDeliveryState

from cayu import AgentRecallDeliveryState

Durable handoff state; acknowledgement is not provider exposure.

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	class attribute	'pending'
CLAIMED	class attribute	'claimed'
ACKNOWLEDGED	class attribute	'acknowledged'

Release source · Runtime guarantees · Capability guides

AgentRecallSubscription

from cayu import AgentRecallSubscription

One immutable revision of an idle-task recall subscription.

Bases: _WorkContextModel.

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_subscription.v1']	AGENT_RECALL_SUBSCRIPTION_SCHEMA_VERSION
subscription_id	str	required
agent_id	str	required
task_id	str	required
knowledge_namespace	str	required
access_policy_sha256	str	required
work_context_revision	int	required
work_context_sha256	str	required
query	str | None	None
scope_ids	tuple[str, ...]	()
entity_ids	tuple[str, ...]	()
artifact_ids	tuple[str, ...]	()
repository_paths	tuple[str, ...]	()
code_symbols	tuple[str, ...]	()
planned_action_ids	tuple[str, ...]	()
admission_policy	Mapping[str, Any]	required
admission_policy_sha256	str	required
priority	int	0
minimum_interval_seconds	float	required
expires_at	datetime	required
status	AgentRecallSubscriptionStatus	required
revision	int	required
operation_id	str	required
published_by	str	required
published_at	datetime	required

model_copy (method)

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

validate_identity (method)

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

validate_digest (method)

AgentRecallSubscription.validate_digest(value: str, info) -> str

validate_revision (method)

AgentRecallSubscription.validate_revision(value: int, info) -> int

validate_query (method)

AgentRecallSubscription.validate_query(value: str | None) -> str | None

validate_filter_collections (method)

AgentRecallSubscription.validate_filter_collections(value: object, info) -> tuple[str, ...]

validate_priority (method)

AgentRecallSubscription.validate_priority(value: int) -> int

copy_admission_policy (method)

AgentRecallSubscription.copy_admission_policy(value: object) -> dict[str, Any]

freeze_admission_policy (method)

AgentRecallSubscription.freeze_admission_policy(value: Mapping[str, Any]) -> Mapping[str, Any]

serialize_admission_policy (method)

AgentRecallSubscription.serialize_admission_policy(value: Mapping[str, Any]) -> dict[str, Any]

validate_minimum_interval (method)

AgentRecallSubscription.validate_minimum_interval(value: float) -> float

validate_datetime (method)

AgentRecallSubscription.validate_datetime(value: datetime, info) -> datetime

validate_status (method)

AgentRecallSubscription.validate_status(value: object) -> AgentRecallSubscriptionStatus

validate_authority (method)

AgentRecallSubscription.validate_authority() -> AgentRecallSubscription

create (method)

AgentRecallSubscription.create(*, subscription_id: str, agent_id: str, work_context: AgentWorkContext, knowledge_namespace: str, access_policy_sha256: str, admission_policy: Any, minimum_interval_seconds: float, expires_at: datetime, revision: int, operation_id: str, published_by: str, published_at: datetime, query: str | None=None, scope_ids: Sequence[str]=(), entity_ids: Sequence[str]=(), artifact_ids: Sequence[str]=(), repository_paths: Sequence[str]=(), code_symbols: Sequence[str]=(), planned_action_ids: Sequence[str]=(), priority: int=0, status: AgentRecallSubscriptionStatus=AgentRecallSubscriptionStatus.ACTIVE) -> AgentRecallSubscription

checkpoint_key (method)

AgentRecallSubscription.checkpoint_key() -> AgentRecallCheckpointKey

checkpoint_stream_id (method)

AgentRecallSubscription.checkpoint_stream_id() -> str

Return the cursor identity for this subscription’s retrieval definition.

policy (method)

AgentRecallSubscription.policy()

retrieval_query (method)

AgentRecallSubscription.retrieval_query() -> str

facet_aspect_groups (method)

AgentRecallSubscription.facet_aspect_groups() -> tuple[tuple[str, ...], ...]

Return OR-within/AND-across indexed aspect groups for this subscription.

recall_situation (method)

AgentRecallSubscription.recall_situation(access_scope: Any, *, current_time: datetime)

Build the exact recurring processor input for this subscription.

situation_sha256 (method)

AgentRecallSubscription.situation_sha256() -> str

fingerprint (method)

AgentRecallSubscription.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionClaim

from cayu import AgentRecallSubscriptionClaim

One store-clock lease over a due subscription revision.

Bases: _WorkContextModel.

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_subscription_claim.v1']	AGENT_RECALL_SUBSCRIPTION_CLAIM_SCHEMA_VERSION
subscription_id	str	required
subscription_revision	int	required
subscription_sha256	str	required
claim_id	str	required
runner_id	str	required
attempt	int	required
state_revision	int	required
claimed_at	datetime	required
lease_expires_at	datetime	required

model_copy (method)

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

validate_identity (method)

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

validate_revision (method)

AgentRecallSubscriptionClaim.validate_revision(value: int, info) -> int

validate_sha256 (method)

AgentRecallSubscriptionClaim.validate_sha256(value: str) -> str

validate_datetime (method)

AgentRecallSubscriptionClaim.validate_datetime(value: datetime, info) -> datetime

validate_lease (method)

AgentRecallSubscriptionClaim.validate_lease() -> AgentRecallSubscriptionClaim

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionConflict

from cayu import AgentRecallSubscriptionConflict

A subscription operation lost or reused exact transition authority.

Bases: RuntimeError.

init (method)

AgentRecallSubscriptionConflict.__init__(code: str) -> None

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionEvaluation

from cayu import AgentRecallSubscriptionEvaluation

Immutable evidence for one atomic subscription evaluation commit.

Bases: _WorkContextModel.

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_subscription_evaluation.v1']	AGENT_RECALL_SUBSCRIPTION_EVALUATION_SCHEMA_VERSION
evaluation_id	str	required
request_sha256	str	required
subscription_id	str	required
subscription_revision	int	required
subscription_sha256	str	required
claim_id	str	required
runner_id	str	required
attempt	int	required
claim_state_revision	int	required
processing_id	str	required
processing_operation_id	str	required
processing_result_sha256	str	required
contribution_sha256	str | None	required
outcome	AgentRecallSubscriptionEvaluationOutcome	required
checkpoint_sha256	str | None	None
checkpoint_revision	int | None	None
delivery_id	str | None	None
committed_at	datetime	required
next_evaluation_at	datetime	required

model_copy (method)

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

validate_identity (method)

AgentRecallSubscriptionEvaluation.validate_identity(value: str | None, info) -> str | None

validate_digest (method)

AgentRecallSubscriptionEvaluation.validate_digest(value: str | None, info) -> str | None

validate_positive (method)

AgentRecallSubscriptionEvaluation.validate_positive(value: int, info) -> int

validate_optional_revision (method)

AgentRecallSubscriptionEvaluation.validate_optional_revision(value: int | None) -> int | None

validate_outcome (method)

AgentRecallSubscriptionEvaluation.validate_outcome(value: object) -> AgentRecallSubscriptionEvaluationOutcome

validate_datetime (method)

AgentRecallSubscriptionEvaluation.validate_datetime(value: datetime, info) -> datetime

validate_outcome_evidence (method)

AgentRecallSubscriptionEvaluation.validate_outcome_evidence() -> AgentRecallSubscriptionEvaluation

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionEvaluationOutcome

from cayu import AgentRecallSubscriptionEvaluationOutcome

Durable result of one bounded subscription evaluation.

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
NO_WORK	class attribute	'no_work'
SILENT	class attribute	'silent'
WAKE	class attribute	'wake'

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionPublicationReceipt

from cayu import AgentRecallSubscriptionPublicationReceipt

Immutable idempotency evidence for one subscription revision.

Bases: _WorkContextModel.

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_subscription_publication_receipt.v1']	AGENT_RECALL_SUBSCRIPTION_PUBLICATION_SCHEMA_VERSION
operation_id	str	required
request_sha256	str	required
expected_revision	int | None	required
subscription	AgentRecallSubscription	required
committed_at	datetime	required

model_copy (method)

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

validate_operation_id (method)

AgentRecallSubscriptionPublicationReceipt.validate_operation_id(value: str) -> str

validate_request_sha256 (method)

AgentRecallSubscriptionPublicationReceipt.validate_request_sha256(value: str) -> str

validate_expected_revision (method)

AgentRecallSubscriptionPublicationReceipt.validate_expected_revision(value: int | None) -> int | None

copy_subscription (method)

AgentRecallSubscriptionPublicationReceipt.copy_subscription(value: object, info) -> AgentRecallSubscription

validate_committed_at (method)

AgentRecallSubscriptionPublicationReceipt.validate_committed_at(value: datetime) -> datetime

validate_publication (method)

AgentRecallSubscriptionPublicationReceipt.validate_publication() -> AgentRecallSubscriptionPublicationReceipt

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionRecord

from cayu import AgentRecallSubscriptionRecord

Current scheduling state for one immutable subscription head.

Bases: _WorkContextModel.

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_subscription_record.v1']	AGENT_RECALL_SUBSCRIPTION_RECORD_SCHEMA_VERSION
subscription	AgentRecallSubscription	required
run_state	AgentRecallSubscriptionRunState	AgentRecallSubscriptionRunState.DUE
state_revision	int	0
attempt	int	0
claim	AgentRecallSubscriptionClaim | None	None
release	AgentRecallSubscriptionRelease | None	None
next_evaluation_at	datetime	required
last_evaluation_id	str | None	None
updated_at	datetime	required

model_copy (method)

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

copy_subscription (method)

AgentRecallSubscriptionRecord.copy_subscription(value: object, info) -> AgentRecallSubscription

validate_run_state (method)

AgentRecallSubscriptionRecord.validate_run_state(value: object) -> AgentRecallSubscriptionRunState

validate_counter (method)

AgentRecallSubscriptionRecord.validate_counter(value: int, info) -> int

copy_claim (method)

AgentRecallSubscriptionRecord.copy_claim(value: object, info) -> AgentRecallSubscriptionClaim | None

copy_release (method)

AgentRecallSubscriptionRecord.copy_release(value: object, info) -> AgentRecallSubscriptionRelease | None

validate_datetime (method)

AgentRecallSubscriptionRecord.validate_datetime(value: datetime, info) -> datetime

validate_optional_identity (method)

AgentRecallSubscriptionRecord.validate_optional_identity(value: str | None) -> str | None

validate_lifecycle (method)

AgentRecallSubscriptionRecord.validate_lifecycle() -> AgentRecallSubscriptionRecord

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionRelease

from cayu import AgentRecallSubscriptionRelease

Immutable evidence returning an evaluation claim for retry.

Bases: _WorkContextModel.

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_subscription_release.v1']	AGENT_RECALL_SUBSCRIPTION_RELEASE_SCHEMA_VERSION
release_id	str	required
subscription_id	str	required
subscription_revision	int	required
subscription_sha256	str	required
claim_id	str	required
runner_id	str	required
attempt	int	required
claim_state_revision	int	required
reason	str	required
released_at	datetime	required

model_copy (method)

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

validate_identity (method)

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

validate_revision (method)

AgentRecallSubscriptionRelease.validate_revision(value: int, info) -> int

validate_sha256 (method)

AgentRecallSubscriptionRelease.validate_sha256(value: str) -> str

validate_reason (method)

AgentRecallSubscriptionRelease.validate_reason(value: str) -> str

validate_released_at (method)

AgentRecallSubscriptionRelease.validate_released_at(value: datetime) -> datetime

fingerprint (method)

AgentRecallSubscriptionRelease.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionRunState

from cayu import AgentRecallSubscriptionRunState

Whether one active subscription is available or runner-claimed.

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
DUE	class attribute	'due'
CLAIMED	class attribute	'claimed'

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionStatus

from cayu import AgentRecallSubscriptionStatus

Application-owned subscription lifecycle.

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
ACTIVE	class attribute	'active'
PAUSED	class attribute	'paused'
CANCELLED	class attribute	'cancelled'

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionWake

from cayu import AgentRecallSubscriptionWake

Independent scheduler handoff state beside one exact staged delivery.

Bases: _WorkContextModel.

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_subscription_wake.v1']	AGENT_RECALL_SUBSCRIPTION_WAKE_SCHEMA_VERSION
wake_id	str	required
subscription	AgentRecallSubscription	required
evaluation	AgentRecallSubscriptionEvaluation	required
delivery	AgentRecallDelivery	required
state	AgentRecallSubscriptionWakeState	AgentRecallSubscriptionWakeState.PENDING
state_revision	int	0
attempt	int	0
claim	AgentRecallSubscriptionWakeClaim | None	None
release	AgentRecallSubscriptionWakeRelease | None	None
acknowledgement	AgentRecallSubscriptionWakeAcknowledgement | None	None
updated_at	datetime	required

model_copy (method)

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

validate_wake_id (method)

AgentRecallSubscriptionWake.validate_wake_id(value: str) -> str

validate_state (method)

AgentRecallSubscriptionWake.validate_state(value: object) -> AgentRecallSubscriptionWakeState

validate_counter (method)

AgentRecallSubscriptionWake.validate_counter(value: int, info) -> int

validate_updated_at (method)

AgentRecallSubscriptionWake.validate_updated_at(value: datetime) -> datetime

validate_linkage_and_lifecycle (method)

AgentRecallSubscriptionWake.validate_linkage_and_lifecycle() -> AgentRecallSubscriptionWake

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionWakeAcknowledgement

from cayu import AgentRecallSubscriptionWakeAcknowledgement

Evidence that an application scheduler accepted one wake request.

Bases: _WorkContextModel.

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_subscription_wake_acknowledgement.v1']	AGENT_RECALL_SUBSCRIPTION_WAKE_ACKNOWLEDGEMENT_SCHEMA_VERSION
acknowledgement_id	str	required
wake_id	str	required
delivery_id	str	required
claim_id	str	required
runner_id	str	required
attempt	int	required
acknowledged_at	datetime	required

model_copy (method)

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

validate_identity (method)

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

validate_attempt (method)

AgentRecallSubscriptionWakeAcknowledgement.validate_attempt(value: int) -> int

validate_acknowledged_at (method)

AgentRecallSubscriptionWakeAcknowledgement.validate_acknowledged_at(value: datetime) -> datetime

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionWakeClaim

from cayu import AgentRecallSubscriptionWakeClaim

Store-clock lease over one pending task-scheduler wake signal.

Bases: _WorkContextModel.

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_subscription_wake_claim.v1']	AGENT_RECALL_SUBSCRIPTION_WAKE_CLAIM_SCHEMA_VERSION
wake_id	str	required
delivery_id	str	required
claim_id	str	required
runner_id	str	required
attempt	int	required
state_revision	int	required
claimed_at	datetime	required
lease_expires_at	datetime	required

model_copy (method)

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

validate_identity (method)

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

validate_revision (method)

AgentRecallSubscriptionWakeClaim.validate_revision(value: int, info) -> int

validate_datetime (method)

AgentRecallSubscriptionWakeClaim.validate_datetime(value: datetime, info) -> datetime

validate_lease (method)

AgentRecallSubscriptionWakeClaim.validate_lease() -> AgentRecallSubscriptionWakeClaim

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionWakeRelease

from cayu import AgentRecallSubscriptionWakeRelease

Immutable evidence returning one scheduler wake for retry.

Bases: _WorkContextModel.

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_subscription_wake_release.v1']	AGENT_RECALL_SUBSCRIPTION_WAKE_RELEASE_SCHEMA_VERSION
release_id	str	required
wake_id	str	required
delivery_id	str	required
claim_id	str	required
runner_id	str	required
attempt	int	required
claim_state_revision	int	required
reason	str	required
released_at	datetime	required

model_copy (method)

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

validate_identity (method)

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

validate_revision (method)

AgentRecallSubscriptionWakeRelease.validate_revision(value: int, info) -> int

validate_reason (method)

AgentRecallSubscriptionWakeRelease.validate_reason(value: str) -> str

validate_released_at (method)

AgentRecallSubscriptionWakeRelease.validate_released_at(value: datetime) -> datetime

fingerprint (method)

AgentRecallSubscriptionWakeRelease.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentRecallSubscriptionWakeState

from cayu import AgentRecallSubscriptionWakeState

Independent task-scheduler handoff state for one admitted wake.

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	class attribute	'pending'
CLAIMED	class attribute	'claimed'
ACKNOWLEDGED	class attribute	'acknowledged'

Release source · Runtime guarantees · Capability guides

AgentWorkContext

from cayu import AgentWorkContext

One immutable numbered revision of application-owned task state.

Bases: _AgentWorkContextContent.

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
task_id	str	required
goal	str	required
scope_ids	tuple[str, ...]	()
workflow_id	str | None	None
workflow_phase	str | None	None
workflow_iteration	int | None	None
entity_ids	tuple[str, ...]	()
artifact_ids	tuple[str, ...]	()
repository_paths	tuple[str, ...]	()
code_symbols	tuple[str, ...]	()
planned_action_ids	tuple[str, ...]	()
schema_version	Literal['cayu.agent_work_context.v1']	AGENT_WORK_CONTEXT_SCHEMA_VERSION
revision	int	required
content_sha256	str	required
operation_id	str	required
published_by	str	required
published_at	datetime	required

model_copy (method)

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

validate_task_id (method)

AgentWorkContext.validate_task_id(value: str) -> str

validate_goal (method)

AgentWorkContext.validate_goal(value: str) -> str

validate_collections (method)

AgentWorkContext.validate_collections(value: object, info) -> tuple[str, ...]

validate_optional_value (method)

AgentWorkContext.validate_optional_value(value: str | None, info) -> str | None

validate_workflow_iteration (method)

AgentWorkContext.validate_workflow_iteration(value: int | None) -> int | None

validate_workflow_fields (method)

AgentWorkContext.validate_workflow_fields() -> _AgentWorkContextContent

content_fingerprint (method)

AgentWorkContext.content_fingerprint() -> str

validate_revision (method)

AgentWorkContext.validate_revision(value: int) -> int

validate_content_sha256 (method)

AgentWorkContext.validate_content_sha256(value: str) -> str

validate_publication_identity (method)

AgentWorkContext.validate_publication_identity(value: str, info) -> str

validate_published_at (method)

AgentWorkContext.validate_published_at(value: datetime) -> datetime

validate_content_identity (method)

AgentWorkContext.validate_content_identity() -> AgentWorkContext

create (method)

AgentWorkContext.create(*, task_id: str, goal: str, revision: int, operation_id: str, published_by: str, published_at: datetime, scope_ids: Sequence[str]=(), workflow_id: str | None=None, workflow_phase: str | None=None, workflow_iteration: int | None=None, entity_ids: Sequence[str]=(), artifact_ids: Sequence[str]=(), repository_paths: Sequence[str]=(), code_symbols: Sequence[str]=(), planned_action_ids: Sequence[str]=()) -> AgentWorkContext

fingerprint (method)

AgentWorkContext.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentWorkContextConflict

from cayu import AgentWorkContextConflict

A publication or checkpoint could not satisfy its exact authority tuple.

Bases: RuntimeError.

init (method)

AgentWorkContextConflict.__init__(code: str) -> None

Release source · Runtime guarantees · Capability guides

AgentWorkContextPublicationReceipt

from cayu import AgentWorkContextPublicationReceipt

Immutable evidence for one changed or semantic no-change publication.

Bases: _WorkContextModel.

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_work_context_publication_receipt.v1']	AGENT_WORK_CONTEXT_PUBLICATION_SCHEMA_VERSION
operation_id	str	required
request_sha256	str	required
expected_revision	int | None	required
requested_content_sha256	str	required
changed	bool	required
context	AgentWorkContext	required
committed_at	datetime	required

model_copy (method)

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

validate_operation_id (method)

AgentWorkContextPublicationReceipt.validate_operation_id(value: str) -> str

validate_sha256 (method)

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

validate_expected_revision (method)

AgentWorkContextPublicationReceipt.validate_expected_revision(value: int | None) -> int | None

validate_changed (method)

AgentWorkContextPublicationReceipt.validate_changed(value: object) -> bool

validate_committed_at (method)

AgentWorkContextPublicationReceipt.validate_committed_at(value: datetime) -> datetime

validate_result (method)

AgentWorkContextPublicationReceipt.validate_result() -> AgentWorkContextPublicationReceipt

fingerprint (method)

AgentWorkContextPublicationReceipt.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

AgentWorkContextStore

from cayu import AgentWorkContextStore

Narrow durable store for work contexts and freshness checkpoints.

Bases: ABC.

publish_work_context (method)

async AgentWorkContextStore.publish_work_context(context: AgentWorkContext, *, expected_revision: int | None) -> AgentWorkContextPublicationReceipt

Create, append, or record an idempotent semantic no-change.

load_work_context (method)

async AgentWorkContextStore.load_work_context(task_id: str, *, revision: int | None=None) -> AgentWorkContext | None

Load the current or one exact immutable task-context revision.

load_work_context_publication (method)

async AgentWorkContextStore.load_work_context_publication(operation_id: str) -> AgentWorkContextPublicationReceipt | None

Load immutable idempotency evidence for a context publication.

advance_recall_checkpoint (method)

async AgentWorkContextStore.advance_recall_checkpoint(checkpoint: AgentRecallCheckpoint, *, expected_revision: int | None) -> AgentRecallCheckpoint

Advance one exact processing frontier through compare-and-swap.

load_recall_checkpoint (method)

async AgentWorkContextStore.load_recall_checkpoint(key: AgentRecallCheckpointKey, *, revision: int | None=None) -> AgentRecallCheckpoint | None

Load the current or one exact immutable checkpoint revision.

stage_recall_delivery (method)

async AgentWorkContextStore.stage_recall_delivery(delivery: AgentRecallDelivery) -> AgentRecallDeliveryRecord

Atomically stage exact materialized recall and advance its checkpoint.

load_recall_delivery (method)

async AgentWorkContextStore.load_recall_delivery(delivery_id: str) -> AgentRecallDeliveryRecord | None

Load one exact staged delivery and its current handoff state.

claim_recall_delivery (method)

async AgentWorkContextStore.claim_recall_delivery(key: AgentRecallCheckpointKey, *, claim_id: str, worker_id: str, lease_seconds: float) -> AgentRecallDeliveryRecord | None

Claim the oldest unacknowledged delivery for one exact checkpoint key.

renew_recall_delivery (method)

async AgentWorkContextStore.renew_recall_delivery(claim: AgentRecallDeliveryClaim, *, lease_seconds: float) -> AgentRecallDeliveryRecord

Renew one exact live delivery claim.

release_recall_delivery (method)

async AgentWorkContextStore.release_recall_delivery(claim: AgentRecallDeliveryClaim, *, release_id: str, reason: str, released_at: datetime) -> AgentRecallDeliveryRecord

Release one exact delivery claim for deterministic retry.

acknowledge_recall_delivery (method)

async AgentWorkContextStore.acknowledge_recall_delivery(claim: AgentRecallDeliveryClaim, *, acknowledgement_id: str, evidence_kind: AgentRecallDeliveryEvidenceKind, evidence_ref: str, acknowledged_at: datetime) -> AgentRecallDeliveryRecord

Acknowledge durable downstream acceptance without claiming exposure.

publish_recall_subscription (method)

async AgentWorkContextStore.publish_recall_subscription(subscription: AgentRecallSubscription, *, expected_revision: int | None) -> AgentRecallSubscriptionPublicationReceipt

Create or replace one exact idle-task subscription revision.

load_recall_subscription (method)

async AgentWorkContextStore.load_recall_subscription(subscription_id: str, *, revision: int | None=None) -> AgentRecallSubscription | None

Load the current or one exact immutable subscription revision.

claim_due_recall_subscription (method)

async AgentWorkContextStore.claim_due_recall_subscription(key: AgentRecallCheckpointKey, *, claim_id: str, runner_id: str, lease_seconds: float) -> AgentRecallSubscriptionRecord | None

Claim the oldest due subscription in one authorized checkpoint scope.

renew_recall_subscription (method)

async AgentWorkContextStore.renew_recall_subscription(claim: AgentRecallSubscriptionClaim, *, lease_seconds: float) -> AgentRecallSubscriptionRecord

Renew one exact live subscription-evaluation claim.

release_recall_subscription (method)

async AgentWorkContextStore.release_recall_subscription(claim: AgentRecallSubscriptionClaim, *, release_id: str, reason: str, released_at: datetime) -> AgentRecallSubscriptionRecord

Release one exact evaluation claim without advancing recall progress.

commit_recall_subscription_evaluation (method)

async AgentWorkContextStore.commit_recall_subscription_evaluation(claim: AgentRecallSubscriptionClaim, result: AgentRecallProcessingResult, *, evaluation_id: str, delivery_id: str | None, staged_by: str, evaluated_at: datetime) -> AgentRecallSubscriptionEvaluation

Atomically commit silent progress or progress plus one staged wake.

load_recall_subscription_evaluation (method)

async AgentWorkContextStore.load_recall_subscription_evaluation(evaluation_id: str) -> AgentRecallSubscriptionEvaluation | None

Load immutable subscription evaluation evidence.

claim_recall_subscription_wake (method)

async AgentWorkContextStore.claim_recall_subscription_wake(key: AgentRecallCheckpointKey, *, claim_id: str, runner_id: str, lease_seconds: float) -> AgentRecallSubscriptionWake | None

Claim the oldest pending task-scheduler wake created by a subscription.

load_recall_subscription_wake (method)

async AgentWorkContextStore.load_recall_subscription_wake(wake_id: str) -> AgentRecallSubscriptionWake | None

Load one scheduler wake without claiming its staged delivery.

renew_recall_subscription_wake (method)

async AgentWorkContextStore.renew_recall_subscription_wake(claim: AgentRecallSubscriptionWakeClaim, *, lease_seconds: float) -> AgentRecallSubscriptionWake

Renew one exact live scheduler-wake claim.

release_recall_subscription_wake (method)

async AgentWorkContextStore.release_recall_subscription_wake(claim: AgentRecallSubscriptionWakeClaim, *, release_id: str, reason: str, released_at: datetime) -> AgentRecallSubscriptionWake

Release a scheduler wake for retry without changing its delivery.

acknowledge_recall_subscription_wake (method)

async AgentWorkContextStore.acknowledge_recall_subscription_wake(claim: AgentRecallSubscriptionWakeClaim, *, acknowledgement_id: str, acknowledged_at: datetime) -> AgentRecallSubscriptionWake

Record scheduler acceptance and make the staged delivery claimable.

close (method)

async AgentWorkContextStore.close() -> None

Release store-owned resources, if any.

Release source · Runtime guarantees · Capability guides

DEFAULT_AGENT_RECALL_CHECKPOINT_STREAM_ID

from cayu import DEFAULT_AGENT_RECALL_CHECKPOINT_STREAM_ID

DEFAULT_AGENT_RECALL_CHECKPOINT_STREAM_ID = 'cayu.agent_recall.inline.v1'

Release source · Runtime guarantees · Capability guides

InMemoryAgentWorkContextStore

from cayu import InMemoryAgentWorkContextStore

Copy-safe reference implementation of the durable contract.

Bases: AgentWorkContextStore.

publish_work_context (method)

async InMemoryAgentWorkContextStore.publish_work_context(context: AgentWorkContext, *, expected_revision: int | None) -> AgentWorkContextPublicationReceipt

load_work_context (method)

async InMemoryAgentWorkContextStore.load_work_context(task_id: str, *, revision: int | None=None) -> AgentWorkContext | None

load_work_context_publication (method)

async InMemoryAgentWorkContextStore.load_work_context_publication(operation_id: str) -> AgentWorkContextPublicationReceipt | None

advance_recall_checkpoint (method)

async InMemoryAgentWorkContextStore.advance_recall_checkpoint(checkpoint: AgentRecallCheckpoint, *, expected_revision: int | None) -> AgentRecallCheckpoint

load_recall_checkpoint (method)

async InMemoryAgentWorkContextStore.load_recall_checkpoint(key: AgentRecallCheckpointKey, *, revision: int | None=None) -> AgentRecallCheckpoint | None

stage_recall_delivery (method)

async InMemoryAgentWorkContextStore.stage_recall_delivery(delivery: AgentRecallDelivery) -> AgentRecallDeliveryRecord

load_recall_delivery (method)

async InMemoryAgentWorkContextStore.load_recall_delivery(delivery_id: str) -> AgentRecallDeliveryRecord | None

claim_recall_delivery (method)

async InMemoryAgentWorkContextStore.claim_recall_delivery(key: AgentRecallCheckpointKey, *, claim_id: str, worker_id: str, lease_seconds: float) -> AgentRecallDeliveryRecord | None

renew_recall_delivery (method)

async InMemoryAgentWorkContextStore.renew_recall_delivery(claim: AgentRecallDeliveryClaim, *, lease_seconds: float) -> AgentRecallDeliveryRecord

release_recall_delivery (method)

async InMemoryAgentWorkContextStore.release_recall_delivery(claim: AgentRecallDeliveryClaim, *, release_id: str, reason: str, released_at: datetime) -> AgentRecallDeliveryRecord

acknowledge_recall_delivery (method)

async InMemoryAgentWorkContextStore.acknowledge_recall_delivery(claim: AgentRecallDeliveryClaim, *, acknowledgement_id: str, evidence_kind: AgentRecallDeliveryEvidenceKind, evidence_ref: str, acknowledged_at: datetime) -> AgentRecallDeliveryRecord

publish_recall_subscription (method)

async InMemoryAgentWorkContextStore.publish_recall_subscription(subscription: AgentRecallSubscription, *, expected_revision: int | None) -> AgentRecallSubscriptionPublicationReceipt

load_recall_subscription (method)

async InMemoryAgentWorkContextStore.load_recall_subscription(subscription_id: str, *, revision: int | None=None) -> AgentRecallSubscription | None

claim_due_recall_subscription (method)

async InMemoryAgentWorkContextStore.claim_due_recall_subscription(key: AgentRecallCheckpointKey, *, claim_id: str, runner_id: str, lease_seconds: float) -> AgentRecallSubscriptionRecord | None

renew_recall_subscription (method)

async InMemoryAgentWorkContextStore.renew_recall_subscription(claim: AgentRecallSubscriptionClaim, *, lease_seconds: float) -> AgentRecallSubscriptionRecord

release_recall_subscription (method)

async InMemoryAgentWorkContextStore.release_recall_subscription(claim: AgentRecallSubscriptionClaim, *, release_id: str, reason: str, released_at: datetime) -> AgentRecallSubscriptionRecord

commit_recall_subscription_evaluation (method)

async InMemoryAgentWorkContextStore.commit_recall_subscription_evaluation(claim: AgentRecallSubscriptionClaim, result: AgentRecallProcessingResult, *, evaluation_id: str, delivery_id: str | None, staged_by: str, evaluated_at: datetime) -> AgentRecallSubscriptionEvaluation

load_recall_subscription_evaluation (method)

async InMemoryAgentWorkContextStore.load_recall_subscription_evaluation(evaluation_id: str) -> AgentRecallSubscriptionEvaluation | None

claim_recall_subscription_wake (method)

async InMemoryAgentWorkContextStore.claim_recall_subscription_wake(key: AgentRecallCheckpointKey, *, claim_id: str, runner_id: str, lease_seconds: float) -> AgentRecallSubscriptionWake | None

load_recall_subscription_wake (method)

async InMemoryAgentWorkContextStore.load_recall_subscription_wake(wake_id: str) -> AgentRecallSubscriptionWake | None

renew_recall_subscription_wake (method)

async InMemoryAgentWorkContextStore.renew_recall_subscription_wake(claim: AgentRecallSubscriptionWakeClaim, *, lease_seconds: float) -> AgentRecallSubscriptionWake

release_recall_subscription_wake (method)

async InMemoryAgentWorkContextStore.release_recall_subscription_wake(claim: AgentRecallSubscriptionWakeClaim, *, release_id: str, reason: str, released_at: datetime) -> AgentRecallSubscriptionWake

acknowledge_recall_subscription_wake (method)

async InMemoryAgentWorkContextStore.acknowledge_recall_subscription_wake(claim: AgentRecallSubscriptionWakeClaim, *, acknowledgement_id: str, acknowledged_at: datetime) -> AgentRecallSubscriptionWake

close (method)

async InMemoryAgentWorkContextStore.close() -> None

Release store-owned resources, if any.

init (method)

InMemoryAgentWorkContextStore.__init__(*, clock=None) -> None

Release source · Runtime guarantees · Capability guides

MAX_AGENT_RECALL_DELIVERY_BYTES

from cayu import MAX_AGENT_RECALL_DELIVERY_BYTES

MAX_AGENT_RECALL_DELIVERY_BYTES = 2000000

Release source · Runtime guarantees · Capability guides

MAX_AGENT_RECALL_DELIVERY_LEASE_SECONDS

from cayu import MAX_AGENT_RECALL_DELIVERY_LEASE_SECONDS

MAX_AGENT_RECALL_DELIVERY_LEASE_SECONDS = 86400.0

Release source · Runtime guarantees · Capability guides

MAX_AGENT_RECALL_SUBSCRIPTION_BYTES

from cayu import MAX_AGENT_RECALL_SUBSCRIPTION_BYTES

MAX_AGENT_RECALL_SUBSCRIPTION_BYTES = 512000

Release source · Runtime guarantees · Capability guides

MAX_AGENT_RECALL_SUBSCRIPTION_INTERVAL_SECONDS

from cayu import MAX_AGENT_RECALL_SUBSCRIPTION_INTERVAL_SECONDS

MAX_AGENT_RECALL_SUBSCRIPTION_INTERVAL_SECONDS = 604800.0

Release source · Runtime guarantees · Capability guides

MAX_AGENT_RECALL_SUBSCRIPTION_PRIORITY

from cayu import MAX_AGENT_RECALL_SUBSCRIPTION_PRIORITY

MAX_AGENT_RECALL_SUBSCRIPTION_PRIORITY = 1000

Release source · Runtime guarantees · Capability guides

MAX_AGENT_RECALL_SUBSCRIPTION_QUERY_BYTES

from cayu import MAX_AGENT_RECALL_SUBSCRIPTION_QUERY_BYTES

MAX_AGENT_RECALL_SUBSCRIPTION_QUERY_BYTES = 8192

Release source · Runtime guarantees · Capability guides

MAX_AGENT_WORK_CONTEXT_BYTES

from cayu import MAX_AGENT_WORK_CONTEXT_BYTES

MAX_AGENT_WORK_CONTEXT_BYTES = 256000

Release source · Runtime guarantees · Capability guides

MAX_AGENT_WORK_CONTEXT_GOAL_BYTES

from cayu import MAX_AGENT_WORK_CONTEXT_GOAL_BYTES

MAX_AGENT_WORK_CONTEXT_GOAL_BYTES = 32000

Release source · Runtime guarantees · Capability guides

MAX_AGENT_WORK_CONTEXT_ID_BYTES

from cayu import MAX_AGENT_WORK_CONTEXT_ID_BYTES

MAX_AGENT_WORK_CONTEXT_ID_BYTES = 512

Release source · Runtime guarantees · Capability guides

MAX_AGENT_WORK_CONTEXT_REVISION

from cayu import MAX_AGENT_WORK_CONTEXT_REVISION

MAX_AGENT_WORK_CONTEXT_REVISION = 2147483647

Release source · Runtime guarantees · Capability guides

MAX_AGENT_WORK_CONTEXT_VALUE_BYTES

from cayu import MAX_AGENT_WORK_CONTEXT_VALUE_BYTES

MAX_AGENT_WORK_CONTEXT_VALUE_BYTES = 4096

Release source · Runtime guarantees · Capability guides

MAX_AGENT_WORK_CONTEXT_VALUES

from cayu import MAX_AGENT_WORK_CONTEXT_VALUES

MAX_AGENT_WORK_CONTEXT_VALUES = 128

Release source · Runtime guarantees · Capability guides