Skip to content

cayu.runtime.session_steering

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.

SessionSteeringConflict

Section titled “SessionSteeringConflict”
from cayu import SessionSteeringConflict

The named interaction or its previously accepted request conflicts.

Bases: ValueError.

init (method)

Section titled “init (method)”
SessionSteeringConflict.__init__() -> None

Release source · Runtime guarantees · Capability guides

SessionSteeringReceipt

Section titled “SessionSteeringReceipt”
from cayu import SessionSteeringReceipt

Durable acceptance evidence; does not claim the execution has stopped.

Bases: BaseModel.

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] 1
request StopAfterCurrentToolRoundRequest required
execution_profile_fingerprint StrictStr Field(pattern='^[0-9a-f]{64}$')

validate_schema_version (method)

Section titled “validate_schema_version (method)”
SessionSteeringReceipt.validate_schema_version(value: object) -> int

copy_request (method)

Section titled “copy_request (method)”
SessionSteeringReceipt.copy_request(value: object) -> StopAfterCurrentToolRoundRequest

Release source · Runtime guarantees · Capability guides

StopAfterCurrentToolRoundRequest

Section titled “StopAfterCurrentToolRoundRequest”
from cayu import StopAfterCurrentToolRoundRequest

Request a cooperative stop of exactly one current interaction.

The caller observes these identities before requesting control. A changed run epoch before acceptance is a conflict, not permission to stop its replacement. An accepted request follows recovery of the same interaction.

Bases: BaseModel.

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
session_id StrictStr Field(min_length=1, max_length=512)
session_instance_id StrictStr Field(min_length=1, max_length=512)
interaction_id StrictStr Field(min_length=1, max_length=512)
expected_run_epoch StrictInt Field(ge=1, le=MAX_DURABLE_JSON_INTEGER)
idempotency_key StrictStr Field(min_length=1, max_length=512)

validate_identity (method)

Section titled “validate_identity (method)”
StopAfterCurrentToolRoundRequest.validate_identity(value: str, info) -> str

Release source · Runtime guarantees · Capability guides