Python API

Environment sessions

The host-safe boundary exposes public observations and supervised execution. RoboTwin, LIBERO / LIBERO-Pro, RoboDojo, RoboCasa365 and RoboLab implement it in isolated simulator workers.

from ora.environment.contracts import EnvironmentSession
from ora.environment.session import DescribedEnvironmentSession

EnvironmentSession

class EnvironmentSession(LegacyEnvironmentSession, Protocol)

describe

describe() -> Mapping[str, Any]

Return only the registered, policy-safe runtime descriptor.

DescribedEnvironmentSession

class DescribedEnvironmentSession
Attribute Type Default Description
delegate EnvironmentSession
planned_descriptor EnvironmentRuntimeDescriptor
runtime_config Mapping[str, Any]
action_codec str | None None
is_terminal bool

describe

describe() -> Mapping[str, Any]

start

start() -> Mapping[str, Any]

restart_round

restart_round(round_index: int, *, seed: int | None = None) -> Mapping[str, Any]

observe

observe(destination: Path) -> tuple[dict[str, Any], list[Path]]

begin_action_sequence

begin_action_sequence(action: Mapping[str, Any]) -> None

end_action_sequence

end_action_sequence(action_id: str) -> None

execute

execute(action: Mapping[str, Any]) -> dict[str, Any]

align_plan

align_plan(request: Mapping[str, Any]) -> dict[str, Any]

Forward the read-only inverse-kinematics reachability extension.

probe_motion

probe_motion(request: Mapping[str, Any]) -> dict[str, Any]

Forward the opt-in read-only motion-planning extension.

operator_view

operator_view() -> dict[str, Any] | None

The backend's optional operator view (base.validate_operator_view), or None without one.

status

status() -> Mapping[str, Any]

abort

abort(reason: str) -> None

persist_official_verdict

persist_official_verdict() -> dict[str, Any]

finalize_operator_video

finalize_operator_video() -> dict[str, Any] | None

close

close() -> None

See backend authoring for observation privacy, descriptor registration, action dispatch, and official-verdict requirements.

Source: docs/api/environment.md