aito.client.v2.responses.V2EstimateResponse

class aito.client.v2.responses.V2EstimateResponse(json: Dict)

Bases: V2Response

An estimate response — a single predicted numeric value

Parameters:

json (Dict) – the parsed JSON response

Methods

Attributes

data	the unwrapped payload
engine	which engine answered, if the client requested meta
json	the raw JSON response
kind	the result kind this response class represents
meta	the response metadata, empty unless the client was built with meta=True
value	the estimated value
warnings	the non-fatal notes the engine attached to this response
why	the explanation of how the estimate was computed, when why was selected

property data: Dict

the unwrapped payload

Return type:

Dict

property engine: str | None

which engine answered, if the client requested meta

Return type:

Optional[str]

property json: Dict

the raw JSON response

Return type:

Dict

kind: str = 'estimate'

the result kind this response class represents

property meta: Dict

the response metadata, empty unless the client was built with meta=True

Currently carries engine — v2 for a collection served by the rep2 engine, v1 for a legacy table served by the compatibility shim.

Return type:

Dict

property value: float

the estimated value

v2 names the scalar value; the rep1 compatibility shim still names it estimate. Both are read here so the property works on a collection and on a legacy table alike.

Raises:

KeyError – the payload carries neither key

Return type:

float

property warnings: List[V2Warning]

the non-fatal notes the engine attached to this response

Empty for the great majority of responses. Worth checking when a result is unexpectedly broad or unexpectedly empty — the engine reports a where it could not apply here rather than failing the request.

Return type:

List[V2Warning]

property why: Dict | None

the explanation of how the estimate was computed, when why was selected

Return type:

Optional[Dict]