cayu.collaboration.clarifications

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.

`ClarificationDueCursor`

from cayu.collaboration import ClarificationDueCursor

Stable deadline/operation ordering; not a claim or execution permission.

Bases: ContractValue.

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
`deadline_at_ms`	`Millis`	`required`
`operation`	`OperationRef`	`required`

bounded_input (method)

ClarificationDueCursor.bounded_input(value: object) -> Any

immutable_fields (method)

ClarificationDueCursor.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

`ClarificationPolicy`

from cayu.collaboration import ClarificationPolicy

Explicit registered policy; every ceiling is required and finite.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`reference`	`ObjectRef`	`required`
`max_questions`	`StrictInt`	`Field(ge=1, le=MAX_CLARIFICATION_QUESTIONS)`
`max_depth`	`StrictInt`	`Field(ge=1, le=MAX_CLARIFICATION_DEPTH)`
`max_service_turns`	`StrictInt`	`Field(ge=1, le=MAX_CLARIFICATION_TURNS)`
`max_question_bytes`	`StrictInt`	`Field(ge=1, le=MAX_CLARIFICATION_TEXT_BYTES)`
`max_reply_bytes`	`StrictInt`	`Field(ge=1, le=MAX_CLARIFICATION_TEXT_BYTES)`
`max_content_bytes`	`StrictInt`	`Field(ge=1, le=MAX_CLARIFICATION_CONTENT_BYTES)`
`max_pending`	`StrictInt`	`Field(ge=1, le=MAX_CLARIFICATION_PENDING)`
`service_timeout_ms`	`Millis`	`required`
`max_spend_usd`	`StrictStr`	`Field(min_length=1, max_length=64)`
`failure_policy`	`Literal['return_and_report']`	`required`
`return_policy`	`Literal['original_wait_or_terminal_exclusion']`	`required`

bounded_input (method)

ClarificationPolicy.bounded_input(value: object) -> Any

immutable_fields (method)

ClarificationPolicy.immutable_fields() -> ContractValue

finite_spend (method)

ClarificationPolicy.finite_spend(value: str) -> str

usable_capacity (method)

ClarificationPolicy.usable_capacity() -> ClarificationPolicy

Release source · Runtime guarantees · Capability guides

`ClarificationQuestion`

from cayu.collaboration import ClarificationQuestion

Immutable question intent; foreign receipts must still be authenticated.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`schema_version`	`VersionOne`	`1`
`operation`	`OperationRef`	`required`
`request`	`RequestRef`	`required`
`request_sha256`	`Commitment`	`required`
`admission`	`OperationRef`	`required`
`initiator`	`InitiatorBinding`	`required`
`responder`	`ParticipantRef`	`required`
`receiver`	`ObjectRef`	`required`
`generation`	`Generation`	`required`
`input_revision`	`InputRevision`	`required`
`input_sha256`	`Commitment`	`required`
`lineage`	`OperationRef`	`required`
`parent_question`	`OperationRef \| None`	`required`
`depth`	`StrictInt`	`Field(ge=1, le=MAX_CLARIFICATION_DEPTH)`
`source`	`ClarificationSource`	`required`
`policy`	`ClarificationPolicy`	`required`
`budget_binding`	`ObjectRef`	`required`
`budget_authority_sha256`	`Commitment`	`required`
`deadline_at_ms`	`Millis`	`required`

bounded_input (method)

ClarificationQuestion.bounded_input(value: object) -> Any

immutable_fields (method)

ClarificationQuestion.immutable_fields() -> ContractValue

consistent_scope (method)

ClarificationQuestion.consistent_scope() -> ClarificationQuestion

Release source · Runtime guarantees · Capability guides

`ClarificationSource`

from cayu.collaboration import ClarificationSource

Exact export selection to authenticate through its registered owner.

Bases: ContractValue.

Fields and attributes

Name	Type	Default
`export`	`SessionExportRef`	`required`
`export_receipt_sha256`	`Commitment`	`required`
`producer`	`ObjectRef`	`required`
`content_sha256`	`Commitment`	`required`
`content_bytes`	`StrictInt`	`Field(ge=1, le=MAX_CLARIFICATION_TEXT_BYTES)`
`selection`	`Literal['whole_records', 'assistant_visible_text_v1']`	`required`
`projector`	`ObjectRef`	`required`
`policy`	`ObjectRef`	`required`
`audience`	`ObjectRef`	`required`

bounded_input (method)

ClarificationSource.bounded_input(value: object) -> Any

immutable_fields (method)

ClarificationSource.immutable_fields() -> ContractValue

consistent_scope (method)

ClarificationSource.consistent_scope() -> ClarificationSource

Release source · Runtime guarantees · Capability guides