Skip to navigation
API ReferenceFull Library ReferenceNemo GymNemo GymWeb

nemo_gym.web.api_models

View as MarkdownOpen in Claude

Backend-neutral HTTP models for stateful web resource servers.

These models live in the dependency-light web protocol package so agents do not import a concrete browser or computer-control backend. Resource servers may re-export them for compatibility, but all backends must preserve this wire contract.

Module Contents

Classes

API

class nemo_gym.web.api_models.WebCloseResponse()

Bases: BaseModel

closed
bool
failure_kind
str | None = None
failure_reason
str | None = None
recording_artifacts
list[WebArtifactRef] = Field(default_factory=list)
session_id
Optional[str] = None
class nemo_gym.web.api_models.WebEvaluateRequest()

Bases: BaseModel

final_answer
Optional[str] = None
class nemo_gym.web.api_models.WebEvaluateResponse()

Bases: BaseModel

result
WebVerifierResult
class nemo_gym.web.api_models.WebResetRequest()

Bases: BaseModel

task
WebTask
class nemo_gym.web.api_models.WebSeedSessionRequest()

Bases: WebSessionIdentity, BaseSeedSessionRequest

model_config
= ConfigDict(extra='allow')
task
WebTask
class nemo_gym.web.api_models.WebSeedSessionResponse()

Bases: BaseSeedSessionResponse

info
dict[str, Any] = Field(default_factory=dict)
observation
WebObservation
session_id
str
status
str
task_id
str
class nemo_gym.web.api_models.WebSessionIdentity()

Bases: BaseModel

Caller-owned identity for retrying seed and closing without a cookie.

Field aliases follow the proposed core session lifecycle contract. The capability never belongs in policy messages, rollout results or logs. Legacy cookie-only clients may omit both fields.

close_token
SecretStr | None
session_identity
str | None
nemo_gym.web.api_models.WebSessionIdentity.require_identity_pair() -> 'WebSessionIdentity'
class nemo_gym.web.api_models.WebSessionStatusResponse()

Bases: BaseModel

benchmark
str
browser_lease_id
Optional[str] = None
browser_provider
Optional[str] = None
browser_transport
Optional[str] = None
created_at
float
last_access_at
float
session_id
str
site_lease_id
str
status
str
task_id
str
class nemo_gym.web.api_models.WebStepRequest()

Bases: BaseModel

action
WebAction
operation_id
str
class nemo_gym.web.api_models.WebStepResponse()

Bases: WebStepResult

operation_id
str
class nemo_gym.web.api_models.WebVerifyRequest()

Bases: BaseVerifyRequest

final_answer
Optional[str] = None
model_config
= ConfigDict(extra='allow')
class nemo_gym.web.api_models.WebVerifyResponse()

Bases: BaseVerifyResponse

cleanup_failure_kind
str | None = None
cleanup_failure_reason
str | None = None
failure_kind
Optional[str] = None
mask_sample
bool = False
model_config
= ConfigDict(extra='allow')
raw_score
float = 0.0
task_success
bool = False