Struct PyArcAgiClient 

pub struct PyArcAgiClient { /* private fields */ }

Available on crate feature python only.

An HTTP client for interacting with the ARC-AGI-3 REST API.

Construct with ArcAgiClient() for a zero-configuration default that reads credentials from the ARC_API_KEY and ARC_BASE_URL environment variables, or supply keyword arguments to configure them explicitly. All network methods are synchronous from Python’s perspective; they drive an internal single-threaded Tokio runtime for each call.

See Also

• ARC-AGI-3 Reference

Implementations

impl PyArcAgiClient

pub fn new( api_key: Option<String>, base_url: Option<String>, cookie_store: bool, proxy: Option<String>, ) -> PyResult<Self>

Create a new ArcAgiClient.

Args: api_key: Optional API key string. Falls back to ARC_API_KEY environment variable and then to an empty string. base_url: Optional server base URL. Falls back to ARC_BASE_URL environment variable and then to "https://three.arcprize.org". cookie_store: Enable cookie persistence across requests (default False). proxy: Optional proxy URL, e.g. "socks5://127.0.0.1:9050".

Raises: RuntimeError: If the proxy URL is invalid or the HTTP client cannot be constructed.

pub fn get_anonymous_key(&self) -> PyResult<String>

Retrieve an anonymous API key from the server.

Returns: The anonymous API key string.

Raises: RuntimeError: On network or HTTP failure.

pub fn list_environments(&self) -> PyResult<Vec<PyEnvironmentInfo>>

Return the list of all available game environments.

Returns: A list of :class:EnvironmentInfo objects.

Raises: RuntimeError: On network or HTTP failure.

pub fn get_environment(&self, game_id: String) -> PyResult<PyEnvironmentInfo>

Return metadata for a single game environment.

Args: game_id: The game identifier (e.g. "ls20").

Returns: An :class:EnvironmentInfo object.

Raises: RuntimeError: If the game is not found or on network failure.

pub fn open_scorecard( &self, source_url: Option<String>, tags: Option<Vec<String>>, competition_mode: Option<bool>, ) -> PyResult<String>

Create a new scorecard and return its ID.

Args: source_url: Optional URL linking to the agent being evaluated. tags: Optional list of classification tag strings. competition_mode: When True, enables one-way competition semantics.

Returns: The card_id string of the newly created scorecard.

Raises: RuntimeError: On network or HTTP failure.

pub fn get_scorecard(&self, card_id: String) -> PyResult<PyEnvironmentScorecard>

Retrieve an existing scorecard by its ID.

Args: card_id: The scorecard identifier.

Returns: An :class:EnvironmentScorecard object.

Raises: RuntimeError: If the scorecard is not found or on network failure.

pub fn close_scorecard( &self, card_id: String, ) -> PyResult<PyEnvironmentScorecard>

Close and finalise a scorecard.

Args: card_id: The scorecard identifier.

Returns: An :class:EnvironmentScorecard with the final scores.

Raises: RuntimeError: If the scorecard is not found or on network failure.

pub fn reset( &self, game_id: String, scorecard_id: String, guid: Option<String>, seed: u32, ) -> PyResult<PyFrameData>

Reset (or start) a game environment.

Args: game_id: The game identifier. scorecard_id: The scorecard to record this run under. guid: Optional existing run GUID to re-use. seed: Random seed for reproducible level ordering (default 0).

Returns: A :class:FrameData object with the initial game state.

Raises: RuntimeError: On network or HTTP failure.

pub fn step( &self, game_id: String, scorecard_id: String, guid: String, action_id: u32, data: Option<&Bound<'_, PyDict>>, reasoning: Option<&Bound<'_, PyDict>>, ) -> PyResult<PyFrameData>

Send one game action and receive the resulting frame.

Args: game_id: The game identifier. scorecard_id: The scorecard identifier. guid: The run GUID from a prior :meth:reset call. action_id: Numeric action ID (0 = RESET). data: Optional dict of action data (e.g. {"x": 3, "y": 4}). reasoning: Optional dict of freeform reasoning.

Returns: A :class:FrameData object with the updated game state.

Raises: RuntimeError: On network or HTTP failure.

pub fn __repr__(&self) -> String

Trait Implementations

impl<'py> IntoPyObject<'py> for PyArcAgiClient

type Target = PyArcAgiClient

The Python output type

type Output = Bound<'py, <PyArcAgiClient as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PyArcAgiClient

const NAME: &str = "ArcAgiClient"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyArcAgiClient

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// An HTTP client for interacting with the ARC-AGI-3 REST API. /// /// Construct with ``ArcAgiClient()`` for a zero-configuration default that /// reads credentials from the ``ARC_API_KEY`` and ``ARC_BASE_URL`` environment /// variables, or supply keyword arguments to configure them explicitly. All /// network methods are **synchronous** from Python's perspective; they drive /// an internal single-threaded Tokio runtime for each call. /// /// # See Also /// /// - [ARC-AGI-3 Reference](https://arcprize.org/arc-agi/3)

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<PyArcAgiClient as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyArcAgiClient>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for PyArcAgiClient

const TEXT_SIGNATURE: &'static str = "(api_key=None, base_url=None, cookie_store=False, proxy=None)"

impl PyMethods<PyArcAgiClient> for PyClassImplCollector<PyArcAgiClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyArcAgiClient

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for PyArcAgiClient

impl ExtractPyClassWithClone for PyArcAgiClient