cayu.sessions.Session
Part of cayu.sessions.base. Read the Python API overview and install the required extra.
from cayu.sessions import SessionBases: 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 |
|---|---|---|
id |
str |
Field(default_factory=lambda: str(uuid4())) |
instance_id |
str |
Field(default_factory=lambda: str(uuid4()), frozen=True) |
agent_name |
str |
required |
provider_name |
str |
required |
model |
str |
required |
parent_session_id |
str | None |
None |
causal_budget_id |
str |
required |
runtime_name |
str |
'cayu' |
runtime_version |
str | None |
None |
environment_name |
str | None |
None |
status |
SessionStatus |
SessionStatus.PENDING |
created_at |
datetime |
Field(default_factory=lambda: datetime.now(UTC)) |
updated_at |
datetime |
Field(default_factory=lambda: datetime.now(UTC)) |
last_activity_at |
datetime |
Field(default_factory=lambda: datetime.now(UTC)) |
run_epoch |
StrictInt |
Field(default=0, ge=0, le=MAX_DURABLE_JSON_INTEGER) |
invocation |
SessionInvocation |
Field(frozen=True) |
labels |
dict[str, str] |
Field(default_factory=dict) |
metadata |
dict[str, Any] |
Field(default_factory=dict) |
execution_deadline (property)
Section titled “execution_deadline (property)”Session.execution_deadline() -> ExecutionDeadlinedefault_causal_budget_id (method)
Section titled “default_causal_budget_id (method)”Session.default_causal_budget_id(value: Any) -> Anycopy_metadata (method)
Section titled “copy_metadata (method)”Session.copy_metadata(value: dict[str, Any]) -> dict[str, Any]copy_labels (method)
Section titled “copy_labels (method)”Session.copy_labels(value) -> dict[str, str]validate_nonblank_fields (method)
Section titled “validate_nonblank_fields (method)”Session.validate_nonblank_fields(value: str, info) -> strvalidate_id (method)
Section titled “validate_id (method)”Session.validate_id(value: str, info) -> strvalidate_instance_id (method)
Section titled “validate_instance_id (method)”Session.validate_instance_id(value: str) -> strvalidate_optional_nonblank_fields (method)
Section titled “validate_optional_nonblank_fields (method)”Session.validate_optional_nonblank_fields(value: str | None, info) -> str | Nonevalidate_profile_build_provenance (method)
Section titled “validate_profile_build_provenance (method)”Session.validate_profile_build_provenance() -> Sessiontool_capability_ceiling (property)
Section titled “tool_capability_ceiling (property)”Session.tool_capability_ceiling() -> ToolCapabilityCeilingReturn the session’s required durable application-tool authority.
runtime_build_provenance (property)
Section titled “runtime_build_provenance (property)”Session.runtime_build_provenance() -> RuntimeBuildProvenanceLoad exact build provenance without attributing legacy work to this process.
runtime_build_fingerprint (property)
Section titled “runtime_build_fingerprint (property)”Session.runtime_build_fingerprint() -> str | Noneruntime_source_revision (property)
Section titled “runtime_source_revision (property)”Session.runtime_source_revision() -> str | None