cayu.sessions definitions

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.

`ActiveInvocationExecutionProfile`

from cayu.runtime import ActiveInvocationExecutionProfile

Durable profile authority for one active interaction and run epoch.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
`record_type`	`Literal['cayu.active-invocation-execution-profile']`	`_ACTIVE_INVOCATION_EXECUTION_PROFILE_RECORD_TYPE`
`schema_version`	`Literal[1]`	`_ACTIVE_INVOCATION_EXECUTION_PROFILE_SCHEMA_VERSION`
`session_id`	`str`	`required`
`interaction_id`	`str`	`required`
`run_epoch`	`StrictInt`	`Field(ge=1, le=MAX_DURABLE_JSON_INTEGER)`
`profile`	`ExecutionProfileIdentity`	`required`

validate_identity (method)

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

copy_profile (method)

ActiveInvocationExecutionProfile.copy_profile(value: object) -> ExecutionProfileIdentity

Release source · Runtime guarantees · Capability guides

`AdmitInvocationCommand`

from cayu.runtime import AdmitInvocationCommand

Bases: _InvocationCommandModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`INVOCATION_LIFECYCLE_COMMAND_VERSION`
`session_id`	`str`	`required`
`expected_session_instance_id`	`str`	`required`
`kind`	`Literal[InvocationLifecycleCommandKind.ADMIT]`	`InvocationLifecycleCommandKind.ADMIT`
`expected_statuses`	`tuple[SessionStatus, ...]`	`required`
`expected_run_epoch`	`StrictInt`	`Field(ge=0)`
`expected_checkpoint_sha256`	`str`	`required`
`target_active_profile`	`ActiveInvocationExecutionProfile`	`required`
`checkpoint_patch`	`InvocationCheckpointPatch`	`Field(default_factory=InvocationCheckpointPatch)`
`interaction_source_messages`	`tuple[Message, ...]`	`()`
`tool_capability_ceiling`	`ToolCapabilityCeiling`	`required`
`interaction_started_event`	`Event \| None`	`None`
`continued_interaction_id`	`str \| None`	`None`
`defer_interaction_source`	`StrictBool`	`False`
`model_transition`	`SessionModelTransition \| None`	`None`
`execution_profile_decision`	`ExecutionProfileDecision \| None`	`None`
`adopted_runtime_identity`	`SessionRuntimeIdentity \| None`	`None`
`expected_active_profile`	`ActiveInvocationExecutionProfile \| None`	`None`
`allow_pending_initial_interaction`	`StrictBool`	`False`
`participant_permit_operation`	`str \| None`	`None`
`participant_permit_commitment`	`str \| None`	`None`
`temporary_service_operation_key`	`str \| None`	`None`

validate_identity (method)

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

validate_session_instance_id (method)

AdmitInvocationCommand.validate_session_instance_id(value: str) -> str

copy_statuses (method)

AdmitInvocationCommand.copy_statuses(value: object) -> tuple[SessionStatus, ...]

copy_messages (method)

AdmitInvocationCommand.copy_messages(value: object) -> tuple[Message, ...]

validate_checkpoint_digest (method)

AdmitInvocationCommand.validate_checkpoint_digest(value: str) -> str

copy_ceiling (method)

AdmitInvocationCommand.copy_ceiling(value: ToolCapabilityCeiling) -> ToolCapabilityCeiling

copy_optional_event (method)

AdmitInvocationCommand.copy_optional_event(value: Event | None) -> Event | None

copy_optional_runtime_identity (method)

AdmitInvocationCommand.copy_optional_runtime_identity(value: object) -> SessionRuntimeIdentity | None

validate_continued_interaction (method)

AdmitInvocationCommand.validate_continued_interaction(value: str | None) -> str | None

validate_admission_authority (method)

AdmitInvocationCommand.validate_admission_authority() -> AdmitInvocationCommand

Release source · Runtime guarantees · Capability guides

`AdmittedInvocationBinding`

from cayu.runtime import AdmittedInvocationBinding

Immutable durable authority projected from an admitted session.

Decorators: @dataclass(frozen=True, slots=True).

Fields and attributes

Name	Type	Default
`session_id`	`str`	`required`
`session_instance_id`	`str`	`required`
`interaction_id`	`str`	`required`
`run_epoch`	`int`	`required`
`agent_name`	`str`	`required`
`provider_name`	`str`	`required`
`model`	`str`	`required`
`runtime_name`	`str`	`required`
`runtime_version`	`str \| None`	`required`
`environment_name`	`str \| None`	`required`
`runtime_build_provenance`	`RuntimeBuildProvenance`	`dataclass_field(default_factory=legacy_runtime_build_provenance)`

Release source · Runtime guarantees · Capability guides

`ContinuationConflict`

from cayu.collaboration import ContinuationConflict

A continuation key was reused with different authority or state.

Bases: ValueError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

`ContinuationConsumption`

from cayu.runtime import ContinuationConsumption

One durable handoff from a ready latch to one invocation.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`CONTINUATION_SCHEMA_VERSION`
`ticket`	`ContinuationTicket`	`required`
`latch`	`ContinuationLatch`	`required`
`continuation_id`	`StrictStr`	`Field(min_length=1, max_length=256)`
`mode`	`Literal['inline', 'queued']`	`required`
`input_digest`	`StrictStr`	`required`
`profile_digest`	`StrictStr`	`required`
`budget_digest`	`StrictStr`	`required`
`service_digest`	`StrictStr \| None`	`Field(default=None, pattern='^[0-9a-f]{64}$')`
`admission_command_digest`	`StrictStr`	`required`
`admission_expected_run_epoch`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`admission_claimed`	`StrictBool`	`False`
`admission_claim_id`	`StrictStr \| None`	`Field(default=None, min_length=1, max_length=128)`
`receipt_stage`	`Literal['prepared', 'admitted', 'excluded']`	`required`
`accepted_at`	`StrictStr`	`required`

bounded_input (method)

ContinuationConsumption.bounded_input(value: object) -> Any

immutable_fields (method)

ContinuationConsumption.immutable_fields() -> ContractValue

validate_digest (method)

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

validate_accepted_at (method)

ContinuationConsumption.validate_accepted_at(value: str) -> str

validate_match (method)

ContinuationConsumption.validate_match() -> ContinuationConsumption

Release source · Runtime guarantees · Capability guides

`ContinuationLatch`

from cayu.runtime import ContinuationLatch

Immutable readiness proof, independent of ticket lifecycle revision.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`unordered_fields`	`class attribute`	`frozenset({'selected_manifest'})`
`schema_version`	`Literal[1]`	`CONTINUATION_SCHEMA_VERSION`
`ticket`	`ContinuationTicket`	`required`
`wait_receipt_digest`	`StrictStr`	`required`
`outcome_kind`	`Literal['success', 'settled', 'failure', 'unavailable']`	`required`
`selected_manifest`	`tuple[ObjectRef, ...]`	`Field(max_length=CONTINUATION_MAX_TARGETS)`
`disclosure_digest`	`StrictStr`	`required`
`latch_key`	`StrictStr`	`Field(min_length=1, max_length=256)`
`outcome_digest`	`StrictStr`	`required`
`accepted_at`	`StrictStr`	`required`
`wait_operation`	`OperationRef \| None`	`None`

bounded_input (method)

ContinuationLatch.bounded_input(value: object) -> Any

immutable_fields (method)

ContinuationLatch.immutable_fields() -> ContractValue

validate_digest (method)

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

validate_accepted_at (method)

ContinuationLatch.validate_accepted_at(value: str) -> str

validate_ticket_identity (method)

ContinuationLatch.validate_ticket_identity() -> ContinuationLatch

Release source · Runtime guarantees · Capability guides

`ContinuationLatchReceiver`

from cayu.runtime import ContinuationLatchReceiver

Qualified receiving boundary for wait evidence.

Bases: Protocol.

authenticate_continuation_latch (method)

async ContinuationLatchReceiver.authenticate_continuation_latch(latch: ContinuationLatch) -> ContinuationLatch

Release source · Runtime guarantees · Capability guides

`ContinuationNamespace`

from cayu.runtime import ContinuationNamespace

Store-owned namespace binding for one session incarnation.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`session_id`	`Identifier`	`required`
`session_instance_id`	`Identifier`	`required`
`owner`	`OwnerRef`	`required`
`namespace_id`	`Identifier`	`required`
`generation`	`Literal[1]`	`1`

bounded_input (method)

ContinuationNamespace.bounded_input(value: object) -> Any

immutable_fields (method)

ContinuationNamespace.immutable_fields() -> ContractValue

exact_namespace (method)

ContinuationNamespace.exact_namespace() -> ContinuationNamespace

Release source · Runtime guarantees · Capability guides

`ContinuationPreparation`

from cayu.runtime import ContinuationPreparation

Exact receiving command; structural validity does not grant authority.

Bases: ExpectedOperation[ContinuationTicket].

Fields and attributes

Name	Type	Default
`operation`	`OperationRef`	`required`
`kind`	`Literal['session.continuation.prepare']`	`'session.continuation.prepare'`
`schema_version`	`Literal[1]`	`1`
`mode`	`Literal['wait']`	`'wait'`
`source`	`OwnerRef`	`required`
`destination`	`OwnerRef`	`required`
`initiator`	`InitiatorBinding`	`required`
`receipt_stage`	`Literal['prepared']`	`'prepared'`
`intent`	`IntentT`	`required`
`registration`	`HandoffIntent[ContinuationTicket]`	`required`

bounded_input (method)

ContinuationPreparation.bounded_input(value: object) -> Any

immutable_fields (method)

ContinuationPreparation.immutable_fields() -> ContractValue

operation_scope (method)

ContinuationPreparation.operation_scope() -> ExpectedOperation[IntentT]

consistent_ticket (method)

ContinuationPreparation.consistent_ticket() -> ContinuationPreparation

Release source · Runtime guarantees · Capability guides

`ContinuationRecord`

from cayu.collaboration import ContinuationRecord

One atomic aggregate for ticket, latch, consumption and retirement.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`CONTINUATION_SCHEMA_VERSION`
`namespace`	`ContinuationNamespace`	`required`
`preparation`	`ContinuationPreparation`	`required`
`ticket`	`ContinuationTicket`	`required`
`latch`	`ContinuationLatch \| None`	`None`
`consumption`	`ContinuationConsumption \| None`	`None`
`retirement`	`ContinuationRetirement \| None`	`None`
`released_retirement`	`ContinuationReleasedExecution \| None`	`None`
`retirement_acknowledged`	`StrictBool`	`False`
`recovery_writer`	`ContinuationRecoveryWriter \| None`	`Field(default=None, exclude_if=lambda value: value is None)`
`events`	`tuple[ContinuationEvent, ...]`	`Field(default=(), max_length=CONTINUATION_MAX_EVENTS)`
`services`	`tuple[ContinuationServiceReference, ...]`	`Field(default=(), max_length=CONTINUATION_MAX_SERVICES)`

bounded_input (method)

ContinuationRecord.bounded_input(value: object) -> Any

immutable_fields (method)

ContinuationRecord.immutable_fields() -> ContractValue

validate_aggregate (method)

ContinuationRecord.validate_aggregate() -> ContinuationRecord

Release source · Runtime guarantees · Capability guides

`ContinuationRetirement`

from cayu.runtime import ContinuationRetirement

Explicit, separately keyed retirement authority.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`CONTINUATION_SCHEMA_VERSION`
`ticket`	`ContinuationTicket`	`required`
`control_id`	`StrictStr`	`Field(min_length=1, max_length=256)`
`reason`	`Literal['cancelled', 'expired', 'failed', 'superseded', 'unavailable']`	`required`
`retired_at`	`StrictStr`	`required`

bounded_input (method)

ContinuationRetirement.bounded_input(value: object) -> Any

immutable_fields (method)

ContinuationRetirement.immutable_fields() -> ContractValue

validate_retired_at (method)

ContinuationRetirement.validate_retired_at(value: str) -> str

validate_reserved_capacity (method)

ContinuationRetirement.validate_reserved_capacity() -> ContinuationRetirement

Release source · Runtime guarantees · Capability guides

`ContinuationService`

from cayu.collaboration import ContinuationService

Exact host-selected continuation, independent of automatic scheduling.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`ticket`	`ContinuationTicket`	`required`
`latch`	`ContinuationLatch`	`required`
`continuation_id`	`StrictStr`	`Field(min_length=1, max_length=256)`
`mode`	`Literal['inline', 'queued']`	`required`
`accepted_at`	`StrictStr`	`required`

bounded_input (method)

ContinuationService.bounded_input(value: object) -> Any

immutable_fields (method)

ContinuationService.immutable_fields() -> ContractValue

validate_accepted_at (method)

ContinuationService.validate_accepted_at(value: str) -> str

validate_wait (method)

ContinuationService.validate_wait() -> ContinuationService

Release source · Runtime guarantees · Capability guides

`ContinuationTicket`

from cayu.runtime import ContinuationTicket

Immutable wait identity plus its mutable lifecycle revision.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`unordered_fields`	`class attribute`	`frozenset({'targets'})`
`schema_version`	`Literal[1]`	`CONTINUATION_SCHEMA_VERSION`
`namespace`	`ContinuationNamespace`	`required`
`session_id`	`StrictStr`	`required`
`session_instance_id`	`StrictStr`	`required`
`owner`	`OwnerRef`	`required`
`registration_key`	`StrictStr`	`Field(min_length=1, max_length=256)`
`targets`	`tuple[ObjectRef, ...]`	`Field(min_length=1, max_length=CONTINUATION_MAX_TARGETS)`
`predicate_kind`	`Literal['ALL_SUCCESS', 'ALL_SETTLED', 'ANY_SUCCESS', 'QUORUM_SUCCESS']`	`required`
`predicate_version`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`threshold`	`StrictInt \| None`	`Field(default=None, ge=1, le=CONTINUATION_MAX_TARGETS)`
`deadline`	`StrictStr \| None`	`required`
`failure_policy`	`StrictStr`	`Field(min_length=1, max_length=128)`
`service_policy`	`StrictStr`	`Field(min_length=1, max_length=128)`
`wait_edge_revision`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`interaction_id`	`StrictStr`	`required`
`writer_generation`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`purpose`	`StrictStr`	`Field(min_length=1, max_length=256)`
`execution_admission_sha256`	`StrictStr \| None`	`Field(default=None, pattern='^[0-9a-f]{64}$')`
`collaboration_wait_sha256`	`StrictStr \| None`	`Field(default=None, pattern='^[0-9a-f]{64}$')`
`state`	`Literal['ARMING', 'WAITING', 'SERVICING', 'CONSUMED', 'RETIRED']`	`required`
`revision`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`

bounded_input (method)

ContinuationTicket.bounded_input(value: object) -> Any

immutable_fields (method)

ContinuationTicket.immutable_fields() -> ContractValue

validate_deadline (method)

ContinuationTicket.validate_deadline(value: str | None) -> str | None

validate_text (method)

ContinuationTicket.validate_text(value: str, info) -> str

validate_authority (method)

ContinuationTicket.validate_authority() -> ContinuationTicket

Release source · Runtime guarantees · Capability guides

`ContinuationUnavailable`

from cayu.collaboration import ContinuationUnavailable

The exact continuation cannot be positively reconstructed.

Bases: RuntimeError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

`ContinuationWait`

from cayu.runtime import ContinuationWait

Caller wait intent, excluding runtime-generated session and namespace identity.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`unordered_fields`	`class attribute`	`frozenset({'targets'})`
`registration_key`	`Identifier`	`Field(max_length=256)`
`targets`	`tuple[ObjectRef, ...]`	`Field(min_length=1, max_length=CONTINUATION_MAX_TARGETS)`
`predicate_kind`	`Literal['ALL_SUCCESS', 'ALL_SETTLED', 'ANY_SUCCESS', 'QUORUM_SUCCESS']`	`required`
`predicate_version`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`threshold`	`StrictInt \| None`	`Field(default=None, ge=1, le=CONTINUATION_MAX_TARGETS)`
`deadline`	`StrictStr \| None`	`required`
`failure_policy`	`StrictStr`	`Field(min_length=1, max_length=128)`
`service_policy`	`StrictStr`	`Field(min_length=1, max_length=128)`
`wait_edge_revision`	`StrictInt`	`Field(ge=1, le=MAX_PORTABLE_JSON_INTEGER)`
`purpose`	`StrictStr`	`Field(min_length=1, max_length=256)`
`execution_admission_sha256`	`StrictStr \| None`	`Field(default=None, pattern='^[0-9a-f]{64}$')`
`collaboration_wait_sha256`	`StrictStr \| None`	`Field(default=None, pattern='^[0-9a-f]{64}$')`

bounded_input (method)

ContinuationWait.bounded_input(value: object) -> Any

immutable_fields (method)

ContinuationWait.immutable_fields() -> ContractValue

validate_execution_commitments (method)

ContinuationWait.validate_execution_commitments() -> ContinuationWait

Release source · Runtime guarantees · Capability guides

`copy_invocation_lifecycle_command`

from cayu.runtime import copy_invocation_lifecycle_command

Revalidate and detach one command before any store receives it.

copy_invocation_lifecycle_command(command: object) -> InvocationLifecycleCommand

Release source · Runtime guarantees · Capability guides

`CreateInvocationCommand`

from cayu.runtime import CreateInvocationCommand

Bases: _InvocationCommandModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`INVOCATION_LIFECYCLE_COMMAND_VERSION`
`session_id`	`str`	`required`
`expected_session_instance_id`	`str`	`required`
`kind`	`Literal[InvocationLifecycleCommandKind.CREATE]`	`InvocationLifecycleCommandKind.CREATE`
`request`	`RunRequest`	`required`
`identity`	`SessionIdentity`	`required`
`active_profile`	`ActiveInvocationExecutionProfile`	`required`
`interaction_started_event`	`Event`	`required`
`interaction_source_messages`	`tuple[Message, ...]`	`required`
`checkpoint_patch`	`InvocationCheckpointPatch`	`Field(default_factory=InvocationCheckpointPatch)`
`tool_discovery_initialization`	`ToolDiscoveryViewInitialization \| None`	`None`

validate_identity (method)

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

validate_session_instance_id (method)

CreateInvocationCommand.validate_session_instance_id(value: str) -> str

copy_request (method)

CreateInvocationCommand.copy_request(value: RunRequest) -> RunRequest

copy_identity (method)

CreateInvocationCommand.copy_identity(value: SessionIdentity) -> SessionIdentity

copy_event (method)

CreateInvocationCommand.copy_event(value: Event) -> Event

copy_messages (method)

CreateInvocationCommand.copy_messages(value: object) -> tuple[Message, ...]

validate_create_authority (method)

CreateInvocationCommand.validate_create_authority() -> CreateInvocationCommand

Release source · Runtime guarantees · Capability guides

`EXECUTION_PROFILE_METADATA_KEY`

from cayu import EXECUTION_PROFILE_METADATA_KEY

EXECUTION_PROFILE_METADATA_KEY = 'cayu:execution_profile'

Release source · Runtime guarantees · Capability guides

`INVOCATION_LIFECYCLE_COMMAND_VERSION`

from cayu.runtime import INVOCATION_LIFECYCLE_COMMAND_VERSION

INVOCATION_LIFECYCLE_COMMAND_VERSION = 1

Release source · Runtime guarantees · Capability guides

`InvocationCheckpointPatch`

from cayu.runtime import InvocationCheckpointPatch

A bounded root-level CAS patch that cannot address invocation authority.

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`mutation`	`RuntimePublicationMutation`	`Field(default_factory=RuntimePublicationMutation)`

copy_mutation (method)

InvocationCheckpointPatch.copy_mutation(value: object) -> RuntimePublicationMutation

reject_authority_operations (method)

InvocationCheckpointPatch.reject_authority_operations() -> InvocationCheckpointPatch

Release source · Runtime guarantees · Capability guides

`InvocationLifecycleCommand`

from cayu.runtime import InvocationLifecycleCommand

InvocationLifecycleCommand: TypeAlias = Annotated[CreateInvocationCommand | AdmitInvocationCommand | RebindInvocationCommand | RejectInvocationCommand | SettleInvocationCommand | ReleaseInvocationCommand, Field(discriminator='kind')]

Release source · Runtime guarantees · Capability guides

`InvocationLifecycleCommandConflict`

from cayu.runtime import InvocationLifecycleCommandConflict

A stable lifecycle command identity names different authority.

Bases: ValueError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

`InvocationLifecycleCommandKind`

from cayu.runtime import InvocationLifecycleCommandKind

Closed command family understood by lifecycle command version 1.

Bases: StrEnum.

Fields and attributes

Name	Type	Default
`CREATE`	`class attribute`	`'create'`
`ADMIT`	`class attribute`	`'admit'`
`REBIND`	`class attribute`	`'rebind'`
`REJECT`	`class attribute`	`'reject'`
`SETTLE`	`class attribute`	`'settle'`
`RELEASE`	`class attribute`	`'release'`

Release source · Runtime guarantees · Capability guides

`InvocationLifecycleResult`

from cayu.runtime import InvocationLifecycleResult

InvocationLifecycleResult: TypeAlias = InvocationMutationResult | InvocationReleaseResult | ExecutionProfileRejectionResult | InteractionTransitionResult

Release source · Runtime guarantees · Capability guides

`InvocationMutationResult`

from cayu.runtime import InvocationMutationResult

One admitted or rebound invocation and its exact active authority.

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`session`	`Session`	`required`
`active_profile`	`ActiveInvocationExecutionProfile`	`required`
`replayed`	`StrictBool`	`False`

copy_result_session (method)

InvocationMutationResult.copy_result_session(value: Session) -> Session

validate_result_authority (method)

InvocationMutationResult.validate_result_authority() -> InvocationMutationResult

Release source · Runtime guarantees · Capability guides

`InvocationReleaseResult`

from cayu.runtime import InvocationReleaseResult

Exact durable result of releasing one invocation run epoch.

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`session`	`Session`	`required`
`active_profile`	`ActiveInvocationExecutionProfile`	`required`
`replayed`	`StrictBool`	`required`

copy_result_session (method)

InvocationReleaseResult.copy_result_session(value: Session) -> Session

validate_release_result (method)

InvocationReleaseResult.validate_release_result() -> InvocationReleaseResult

Release source · Runtime guarantees · Capability guides

`ParticipantSessionCursor`

from cayu.collaboration import ParticipantSessionCursor

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`participant`	`ParticipantRef`	`required`
`after`	`Identifier`	`required`

bounded_input (method)

ParticipantSessionCursor.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantSessionCursor.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

`ParticipantSessionReference`

from cayu.collaboration import ParticipantSessionReference

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`participant`	`ParticipantRef`	`required`
`creation_key`	`Identifier`	`required`
`session_id`	`Identifier`	`required`
`session_instance_id`	`Identifier`	`required`
`receipt_commitment`	`Identifier`	`required`

bounded_input (method)

ParticipantSessionReference.bounded_input(value: object) -> Any

immutable_fields (method)

ParticipantSessionReference.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

`PreparedInvocationBinding`

from cayu.runtime import PreparedInvocationBinding

A store target fixed before one invocation is durably admitted.

Decorators: @dataclass(frozen=True, slots=True).

Fields and attributes

Name	Type	Default
`session_id`	`str`	`required`
`session_instance_id`	`str`	`required`
`interaction_id`	`str`	`required`
`run_epoch`	`int`	`required`
`agent_name`	`str`	`required`
`provider_name`	`str`	`required`
`model`	`str`	`required`
`runtime_name`	`str`	`required`
`runtime_version`	`str \| None`	`required`
`environment_name`	`str \| None`	`required`
`runtime_build_provenance`	`RuntimeBuildProvenance`	`dataclass_field(default_factory=legacy_runtime_build_provenance)`

Release source · Runtime guarantees · Capability guides

`RebindInvocationCommand`

from cayu.runtime import RebindInvocationCommand

Bases: _InvocationCommandModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`INVOCATION_LIFECYCLE_COMMAND_VERSION`
`session_id`	`str`	`required`
`expected_session_instance_id`	`str`	`required`
`kind`	`Literal[InvocationLifecycleCommandKind.REBIND]`	`InvocationLifecycleCommandKind.REBIND`
`expected_statuses`	`tuple[SessionStatus, ...]`	`required`
`expected_run_epoch`	`StrictInt`	`Field(ge=0)`
`expected_session_sha256`	`str`	`required`
`expected_checkpoint_sha256`	`str`	`required`
`expected_active_profile`	`ActiveInvocationExecutionProfile`	`required`
`target_active_profile`	`ActiveInvocationExecutionProfile`	`required`
`target_status`	`SessionStatus \| None`	`None`
`checkpoint_patch`	`InvocationCheckpointPatch`	`Field(default_factory=InvocationCheckpointPatch)`

validate_identity (method)

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

validate_session_instance_id (method)

RebindInvocationCommand.validate_session_instance_id(value: str) -> str

copy_statuses (method)

RebindInvocationCommand.copy_statuses(value: object) -> tuple[SessionStatus, ...]

validate_source_digest (method)

RebindInvocationCommand.validate_source_digest(value: str, info) -> str

validate_rebind_authority (method)

RebindInvocationCommand.validate_rebind_authority() -> RebindInvocationCommand

Release source · Runtime guarantees · Capability guides

`RecipientContinuationSelection`

from cayu.collaboration import RecipientContinuationSelection

Bounded identity data, not continuation admission or current authorization.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`schema_version`	`VersionOne`	`1`
`session_id`	`Identifier`	`required`
`session_instance_id`	`Identifier`	`required`
`participant`	`ParticipantRef`	`required`
`run_epoch`	`Annotated[StrictInt, Field(ge=1, le=MAX_DURABLE_JSON_INTEGER)]`	`required`
`participant_binding_sha256`	`Digest`	`required`
`checkpoint_sha256`	`Digest`	`required`
`release_identity`	`Annotated[StrictStr, Field(min_length=1, max_length=1024)]`	`required`
`release_sha256`	`Digest`	`required`
`interaction_id`	`Identifier`	`required`
`model_step_id`	`Identifier`	`required`
`completion_event_id`	`Identifier`	`required`
`transcript_end_cursor`	`Cursor`	`required`
`execution_profile_json`	`StrictStr`	`required`

bounded_input (method)

RecipientContinuationSelection.bounded_input(value: object) -> Any

immutable_fields (method)

RecipientContinuationSelection.immutable_fields() -> ContractValue

profile_snapshot (method)

RecipientContinuationSelection.profile_snapshot(value: str) -> str

Release source · Runtime guarantees · Capability guides

`RejectInvocationCommand`

from cayu.runtime import RejectInvocationCommand

Bases: _InvocationCommandModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`INVOCATION_LIFECYCLE_COMMAND_VERSION`
`session_id`	`str`	`required`
`expected_session_instance_id`	`str`	`required`
`kind`	`Literal[InvocationLifecycleCommandKind.REJECT]`	`InvocationLifecycleCommandKind.REJECT`
`expected_statuses`	`tuple[SessionStatus, ...]`	`required`
`expected_run_epoch`	`StrictInt`	`Field(ge=0)`
`expected_profile`	`ExecutionProfileIdentity`	`required`
`candidate_profile`	`ExecutionProfileIdentity`	`required`
`event`	`Event`	`required`
`decision`	`ExecutionProfileDecision \| None`	`None`
`expected_active_profile`	`ActiveInvocationExecutionProfile \| None`	`None`

validate_identity (method)

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

validate_session_instance_id (method)

RejectInvocationCommand.validate_session_instance_id(value: str) -> str

copy_statuses (method)

RejectInvocationCommand.copy_statuses(value: object) -> tuple[SessionStatus, ...]

copy_rejection_event (method)

RejectInvocationCommand.copy_rejection_event(value: Event) -> Event

validate_rejection_authority (method)

RejectInvocationCommand.validate_rejection_authority() -> RejectInvocationCommand

Release source · Runtime guarantees · Capability guides

`ReleaseInvocationCommand`

from cayu.runtime import ReleaseInvocationCommand

Bases: _InvocationCommandModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`INVOCATION_LIFECYCLE_COMMAND_VERSION`
`session_id`	`str`	`required`
`expected_session_instance_id`	`str`	`required`
`kind`	`Literal[InvocationLifecycleCommandKind.RELEASE]`	`InvocationLifecycleCommandKind.RELEASE`
`expected_run_epoch`	`StrictInt`	`Field(ge=1)`
`expected_active_profile`	`ActiveInvocationExecutionProfile`	`required`
`settlement_transition`	`InteractionTransitionSpec \| None`	`None`
`recovery_claim_id`	`str \| None`	`None`
`terminal_session_event`	`Event \| None`	`None`

validate_identity (method)

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

validate_session_instance_id (method)

ReleaseInvocationCommand.validate_session_instance_id(value: str) -> str

validate_recovery_claim_id (method)

ReleaseInvocationCommand.validate_recovery_claim_id(value: object) -> str | None

copy_terminal_session_event (method)

ReleaseInvocationCommand.copy_terminal_session_event(value: Event | None) -> Event | None

validate_release_authority (method)

ReleaseInvocationCommand.validate_release_authority() -> ReleaseInvocationCommand

Release source · Runtime guarantees · Capability guides

`SettleInvocationCommand`

from cayu.runtime import SettleInvocationCommand

Bases: _InvocationCommandModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal[1]`	`INVOCATION_LIFECYCLE_COMMAND_VERSION`
`session_id`	`str`	`required`
`expected_session_instance_id`	`str`	`required`
`kind`	`Literal[InvocationLifecycleCommandKind.SETTLE]`	`InvocationLifecycleCommandKind.SETTLE`
`expected_run_epoch`	`StrictInt`	`Field(ge=1)`
`expected_active_profile`	`ActiveInvocationExecutionProfile`	`required`
`expected_authority_state`	`Literal['active', 'released']`	`'active'`
`recovery_claim_id`	`str \| None`	`None`
`terminalization_only`	`StrictBool`	`False`
`terminalization_plan_ownership`	`DurableOperationOwnership \| None`	`None`
`transition`	`InteractionTransitionSpec`	`required`

validate_identity (method)

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

validate_session_instance_id (method)

SettleInvocationCommand.validate_session_instance_id(value: str) -> str

validate_settlement_authority (method)

SettleInvocationCommand.validate_settlement_authority() -> SettleInvocationCommand

Release source · Runtime guarantees · Capability guides