Skip to content

cayu.tools.structured_commands

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.

RUN_COMMAND_RESULT_SCHEMA

Section titled “RUN_COMMAND_RESULT_SCHEMA”
from cayu.tools import RUN_COMMAND_RESULT_SCHEMA
RUN_COMMAND_RESULT_SCHEMA = 'cayu.run_command_result.v1'

Release source · Runtime guarantees · Capability guides

RunCommandTool

Section titled “RunCommandTool”
from cayu.tools import RunCommandTool

Run one bounded structured command selected from an admitted toolchain profile.

Bases: Tool.

init (method)

Section titled “init (method)”
RunCommandTool.__init__(*, toolchain_profile: DockerCodingToolchainProfile) -> None

name (property)

Section titled “name (property)”
RunCommandTool.name() -> str

execution_profile_identity (property)

Section titled “execution_profile_identity (property)”
RunCommandTool.execution_profile_identity() -> ExecutionProfileBehaviorIdentity | None

Return the stable behavior declaration frozen with this tool’s spec.

retain_arguments_for_model (property)

Section titled “retain_arguments_for_model (property)”
RunCommandTool.retain_arguments_for_model() -> bool

Retain bounded redacted original inputs privately for the same profile.

Independent of audit publication; oversized and compacted-away inputs may be omitted. This does not grant knowledge read or activation rights.

description (property)

Section titled “description (property)”
RunCommandTool.description() -> str

schema (property)

Section titled “schema (property)”
RunCommandTool.schema() -> dict[str, Any]

run (method)

Section titled “run (method)”
async RunCommandTool.run(ctx: ToolContext, args: dict) -> ToolResult

toolchain_profile (property)

Section titled “toolchain_profile (property)”
RunCommandTool.toolchain_profile() -> DockerCodingToolchainProfile

selectors (property)

Section titled “selectors (property)”
RunCommandTool.selectors() -> tuple[DockerCodingCommandAuthority, ...]

command_policy (property)

Section titled “command_policy (property)”
RunCommandTool.command_policy() -> CommandPolicy

Return the exact identity-bearing policy for the complete selector catalogue.

reconcile_durable_tool_call (method)

Section titled “reconcile_durable_tool_call (method)”
async RunCommandTool.reconcile_durable_tool_call(*, parent_session_id: str, parent_run_epoch: int, execution_profile_fingerprint: str | None, environment_name: str | None, environment_allocation_fingerprint: str | None, model_step_id: str, model_attempt_id: str, tool_round_id: str, tool_call_id: str, idempotency_key: str, arguments: dict[str, Any], started: bool, load_operation: Callable[[str], Awaitable[dict[str, Any] | None]], recovery_authority: DurableToolRecoveryAuthority | None=None) -> DurableToolRecoveryEvidence | None

Reconcile durable command evidence without ever replaying the command.

inspect_durable_tool_call (method)

Section titled “inspect_durable_tool_call (method)”
async RunCommandTool.inspect_durable_tool_call(*, identity: DurableToolRecoveryIdentity, load_operation, observe_receipt) -> bool

Release source · Runtime guarantees · Capability guides

STRUCTURED_COMMAND_TOOL_POLICY_SCHEMA

Section titled “STRUCTURED_COMMAND_TOOL_POLICY_SCHEMA”
from cayu.tools import STRUCTURED_COMMAND_TOOL_POLICY_SCHEMA
STRUCTURED_COMMAND_TOOL_POLICY_SCHEMA = 'cayu.structured_command_tool_policy.v1'

Release source · Runtime guarantees · Capability guides

StructuredCommandToolPolicy

Section titled “StructuredCommandToolPolicy”
from cayu.tools import StructuredCommandToolPolicy

Resolve structured commands before runtime policy and durable approval.

Bases: ToolPolicy.

execution_profile_identity (property)

Section titled “execution_profile_identity (property)”
StructuredCommandToolPolicy.execution_profile_identity() -> ExecutionProfileBehaviorIdentity | None

authorize (method)

Section titled “authorize (method)”
async StructuredCommandToolPolicy.authorize(request: ToolPolicyRequest) -> ToolPolicyResult

init (method)

Section titled “init (method)”
StructuredCommandToolPolicy.__init__(*, toolchain_profile: DockerCodingToolchainProfile, base_policy: ToolPolicy | None=None) -> None

Release source · Runtime guarantees · Capability guides