Spaces:
Sleeping
Sleeping
File size: 2,559 Bytes
4a0d140 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | # 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.
"""SOC Incident Response Environment Client."""
from typing import Dict
from openenv.core import EnvClient
from openenv.core.client_types import StepResult
from openenv.core.env_server.types import State
from .models import SOCAction, SOCObservation
class SOCEnv(EnvClient[SOCAction, SOCObservation, State]):
"""
Client for the SOC Incident Response Environment.
Maintains a persistent WebSocket connection to the environment server.
Example (local server):
>>> with SOCEnv(base_url="http://localhost:8000") as env:
... obs = env.reset()
... print(obs.alert_type)
... result = env.step(SOCAction(decision="investigate"))
... print(result.observation.feedback)
Example (Docker):
>>> env = SOCEnv.from_docker_image("soc-env:latest")
>>> try:
... obs = env.reset()
... result = env.step(SOCAction(decision="block_account"))
... finally:
... env.close()
"""
def _step_payload(self, action: SOCAction) -> Dict:
payload = {"decision": action.decision}
if action.reasoning:
payload["reasoning"] = action.reasoning
return payload
def _parse_result(self, payload: Dict) -> StepResult[SOCObservation]:
obs_data = payload.get("observation", {})
observation = SOCObservation(
alert_type=obs_data.get("alert_type", ""),
severity=obs_data.get("severity", "low"),
signals=obs_data.get("signals", []),
context=obs_data.get("context", {}),
available_actions=obs_data.get("available_actions", []),
phase=obs_data.get("phase", "detection"),
feedback=obs_data.get("feedback", ""),
score=obs_data.get("score", 0.0),
step=obs_data.get("step", 0),
max_steps=obs_data.get("max_steps", 8),
done=payload.get("done", False),
reward=payload.get("reward", 0.0),
)
return StepResult(
observation=observation,
reward=payload.get("reward", 0.0),
done=payload.get("done", False),
)
def _parse_state(self, payload: Dict) -> State:
return State(
episode_id=payload.get("episode_id"),
step_count=payload.get("step_count", 0),
) |