aito.client.responses.query_api_response.ScoredHit

class aito.client.responses.query_api_response.ScoredHit(json: Dict)

Bases: aito.client.responses.query_api_response._BaseScoredHit

ResponseHit that contains a score

Parameters

json (Dict) – the content of the hit

Methods

from_deserialized_object(obj)	create a class object from a JSON deserialized object
from_json_string(json_string, **kwargs)	create an class object from a JSON string
json_schema()	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
score_aliases()	The aliases of the score.
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

Attributes

explanation	returns the explanation of how the score was calculated
json	the content of the hit
score	returns the score

property explanation

returns the explanation of how the score was calculated

Return type

Dict

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 json

the content of the hit

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 score

returns the score

Return type

float

classmethod score_aliases() → list

The aliases of the score. For example, a predict hit can have both $score and $p

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