aito.client.responses.query_api_response.PredictResponse¶
-
class
aito.client.responses.query_api_response.
PredictResponse
(*args, **kwds)¶ Bases:
aito.client.responses.query_api_response._GenericHitsResponse
Response of the Predict query
- Parameters
json (Dict) – the original JSON response
Methods
create a class object from a JSON deserialized object
from_json_string
(json_string, **kwargs)create an class object from a JSON string
the JSON schema of the class
json_schema_validate
(obj)Validate an object with the class json_schema Returns the object if validation success, else raise
JsonValidationError
json_schema_validate_with_schema
(obj, schema)Validate an object with the given schema
convert the object to an object that can be serialized to a JSON formatted string
to_json_string
(**kwargs)convert the object to a JSON string
Attributes
return the first hit
the class of the hit
the returned hits
the original JSON response of the request
the number of hits that is skipped
return a list of predictions in descending order of the estimated probability
return the prediction with the highest probability
the total number of hits
-
property
first_hit
¶ return the first hit
- Return type
HitType
-
classmethod
from_deserialized_object
(obj: Any)¶ create a class object from a JSON deserialized object
-
classmethod
from_json_string
(json_string: str, **kwargs)¶ create an class object from a JSON string
- Parameters
json_string (str) – the JSON string
kwargs – the keyword arguments for json.loads method
-
property
hit_cls
¶ the class of the hit
- Return type
Type[HitType]
-
property
hits
¶ the returned hits
- Return type
List[HitType]
-
property
json
¶ the original JSON response of the request
- Return type
Dict
-
classmethod
json_schema
()¶ the JSON schema of the class
- Return type
Dict
-
classmethod
json_schema_validate
(obj: Any)¶ Validate an object with the class json_schema Returns the object if validation success, else raise
JsonValidationError
- Parameters
obj (Any) – the object to be validated
- Returns
the object if validation succeed
- Return type
Any
-
json_schema_validate_with_schema
(obj: Any, schema: Dict)¶ Validate an object with the given schema
- Parameters
obj (Any) – the object to be validated
schema (Dict) – the schema to be validate against
- Returns
the object if validation succeed
- Return type
Any
-
property
offset
¶ the number of hits that is skipped
- Return type
int
-
property
predictions
¶ return a list of predictions in descending order of the estimated probability
- Returns
- Return type
-
to_json_serializable
()¶ convert the object to an object that can be serialized to a JSON formatted string
-
to_json_string
(**kwargs)¶ convert the object to a JSON string
- Parameters
kwargs – the keyword arguments for json.dumps method
- Return type
str
-
property
top_prediction
¶ return the prediction with the highest probability
- Return type
Dict
-
property
total
¶ the total number of hits
- Return type
int