cayu.configuration
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.
CayuConfig
Section titled “CayuConfig”from cayu.configuration import CayuConfigSmall, immutable root configuration for one CayuApp.
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 |
|---|---|---|
run |
RunDefaults |
Field(default_factory=RunDefaults) |
tool_execution |
ToolExecutionConfig |
Field(default_factory=ToolExecutionConfig) |
operations |
OperationsConfig |
Field(default_factory=OperationsConfig) |
evals |
EvalConfig |
Field(default_factory=EvalConfig) |
detach_run_defaults (method)
Section titled “detach_run_defaults (method)”CayuConfig.detach_run_defaults(value: RunDefaults) -> RunDefaultsdetach_tool_execution_config (method)
Section titled “detach_tool_execution_config (method)”CayuConfig.detach_tool_execution_config(value: ToolExecutionConfig) -> ToolExecutionConfigdetach_evals (method)
Section titled “detach_evals (method)”CayuConfig.detach_evals(value: EvalConfig) -> EvalConfigdetach_operations_config (method)
Section titled “detach_operations_config (method)”CayuConfig.detach_operations_config(value: OperationsConfig) -> OperationsConfigRelease source · Runtime guarantees · Capability guides
CayuConfigSource
Section titled “CayuConfigSource”from cayu.configuration import CayuConfigSourceCayuConfigSource = Literal['framework', 'application', 'explicit']Release source · Runtime guarantees · Capability guides
copy_cayu_config
Section titled “copy_cayu_config”from cayu.runtime import copy_cayu_configReturn a detached, validated application configuration.
copy_cayu_config(config: CayuConfig | None) -> CayuConfigRelease source · Runtime guarantees · Capability guides
DEFAULT_MAX_ENVIRONMENT_LIFECYCLE_OWNERS
Section titled “DEFAULT_MAX_ENVIRONMENT_LIFECYCLE_OWNERS”from cayu.runtime import DEFAULT_MAX_ENVIRONMENT_LIFECYCLE_OWNERSDEFAULT_MAX_ENVIRONMENT_LIFECYCLE_OWNERS = 256Release source · Runtime guarantees · Capability guides
DEFAULT_MAX_PARALLEL_TOOL_CALLS
Section titled “DEFAULT_MAX_PARALLEL_TOOL_CALLS”from cayu.runtime import DEFAULT_MAX_PARALLEL_TOOL_CALLSDEFAULT_MAX_PARALLEL_TOOL_CALLS = 4Release source · Runtime guarantees · Capability guides
DEFAULT_MAX_STEPS
Section titled “DEFAULT_MAX_STEPS”from cayu.runtime import DEFAULT_MAX_STEPSDEFAULT_MAX_STEPS = 64Release source · Runtime guarantees · Capability guides
EvalConfig
Section titled “EvalConfig”from cayu.configuration import EvalConfigDefaults for new evaluation runs without an explicit suite policy.
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 |
|---|---|---|
max_concurrency |
StrictInt |
Field(default=1, ge=1, le=EVAL_SUITE_MAX_CONCURRENCY) |
Release source · Runtime guarantees · Capability guides
MAX_STEPS
Section titled “MAX_STEPS”from cayu.runtime import MAX_STEPSMAX_STEPS = 2 ** 53 - 1Release source · Runtime guarantees · Capability guides
OperationsConfig
Section titled “OperationsConfig”from cayu.configuration import OperationsConfigApplication-wide bounds for Runtime-owned operational work.
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 |
|---|---|---|
max_environment_lifecycle_owners |
StrictInt |
Field(default=DEFAULT_MAX_ENVIRONMENT_LIFECYCLE_OWNERS, ge=1) |
recovery_cleanup_policy |
RecoveryCleanupPolicy |
Field(default_factory=RecoveryCleanupPolicy) |
detach_recovery_cleanup_policy (method)
Section titled “detach_recovery_cleanup_policy (method)”OperationsConfig.detach_recovery_cleanup_policy(value: RecoveryCleanupPolicy) -> RecoveryCleanupPolicyRelease source · Runtime guarantees · Capability guides
RunDefaults
Section titled “RunDefaults”from cayu.configuration import RunDefaultsDefaults applied when one run or resume request omits an override.
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 |
|---|---|---|
max_steps |
StrictInt |
Field(default=DEFAULT_MAX_STEPS, ge=1, le=MAX_STEPS) |
limits |
RunLimits |
Field(default_factory=RunLimits) |
retry_policy |
RetryPolicy |
Field(default_factory=RetryPolicy) |
thinking |
ThinkingConfig | None |
None |
detach_limits (method)
Section titled “detach_limits (method)”RunDefaults.detach_limits(value: RunLimits) -> RunLimitsdetach_retry_policy (method)
Section titled “detach_retry_policy (method)”RunDefaults.detach_retry_policy(value: RetryPolicy) -> RetryPolicydetach_thinking (method)
Section titled “detach_thinking (method)”RunDefaults.detach_thinking(value: ThinkingConfig | None) -> ThinkingConfig | Nonecopy_limits (method)
Section titled “copy_limits (method)”RunDefaults.copy_limits() -> RunLimitsReturn ordinary mutable request limits detached from this config.
Release source · Runtime guarantees · Capability guides
ToolExecutionConfig
Section titled “ToolExecutionConfig”from cayu.configuration import ToolExecutionConfigApplication-wide attachment and tool-execution defaults.
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 |
|---|---|---|
max_file_attachment_bytes |
StrictInt |
Field(default=DEFAULT_MAX_FILE_ATTACHMENT_BYTES, ge=1) |
max_total_file_attachment_bytes |
StrictInt |
Field(default=DEFAULT_MAX_TOTAL_FILE_ATTACHMENT_BYTES, ge=1) |
max_file_attachments_per_request |
StrictInt |
Field(default=DEFAULT_MAX_FILE_ATTACHMENTS_PER_REQUEST, ge=1) |
image_max_frame_bytes |
StrictInt |
Field(default=64 * 1024 * 1024, ge=1) |
image_max_total_bytes |
StrictInt |
Field(default=256 * 1024 * 1024, ge=1) |
image_max_frames |
StrictInt |
Field(default=1024, ge=1) |
tool_timeout_seconds |
float | None |
None |
max_parallel_tool_calls |
StrictInt |
Field(default=DEFAULT_MAX_PARALLEL_TOOL_CALLS, ge=1) |
validate_tool_timeout_seconds (method)
Section titled “validate_tool_timeout_seconds (method)”ToolExecutionConfig.validate_tool_timeout_seconds(value: Any) -> float | None