client.py

# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.

"""
Agterm Environment HTTP Client.

This module provides the client for connecting to a Agterm Environment server
over HTTP.
"""

from typing import Any, Dict

from openenv_core.client_types import StepResult
from openenv_core.env_server.types import State
from openenv_core.http_env_client import HTTPEnvClient

from .models import agtermAction, agtermObservation


class agtermEnv(HTTPEnvClient[agtermAction, agtermObservation]):
    """
    HTTP client for the agterm Environment.

    This client connects to a agtermEnvironment HTTP server and provides
    methods to interact with it: reset(), step(), and state access.

    Example:
        >>> # Connect to a running server
        >>> client = agtermEnv(base_url="http://localhost:8000")
        >>> result = client.reset()
        >>> print(result.observation.result)
        >>>
        >>> # Send a message
        >>> result = client.step(agtermAction(message="Hello!"))
        >>> print(result.observation.result)
        >>> print(result.reward)

    Example with Docker:
        >>> # Automatically start container and connect
        >>> client = agtermEnv.from_docker_image("agterm-env:latest")
        >>> result = client.reset()
        >>> result = client.step(agtermAction(message="Test"))
    """

    def _step_payload(self, action: agtermAction) -> Dict:
        """
        Convert agtermAction to JSON payload for step request.

        Args:
            action: agtermAction instance

        Returns:
            Dictionary representation suitable for JSON encoding
        """
        return {
            "message": action.message,
        }

    def _parse_result(self, payload: Dict) -> StepResult[agtermObservation]:
        """
        Parse server response into StepResult[agtermObservation].

        Args:
            payload: JSON response from server

        Returns:
            StepResult with agtermObservation
        """
        obs_data = payload.get("observation", {})
        observation = agtermObservation(
            result=obs_data.get("result", ""),
            done=payload.get("done", False),
            reward=payload.get("reward"),
            metadata=obs_data.get("metadata", {}),
        )

        return StepResult(
            observation=observation,
            reward=payload.get("reward"),
            done=payload.get("done", False),
        )

    def _parse_state(self, payload: Dict) -> State:
        """
        Parse server response into State object.

        Args:
            payload: JSON response from /state endpoint

        Returns:
            State object with episode_id and step_count
        """
        return State(
            episode_id=payload.get("episode_id"),
            step_count=payload.get("step_count", 0),
        )