aito.client.responses.query_api_response.SimilarityResponse

class aito.client.responses.query_api_response.SimilarityResponse(json)

Bases: _GenericHitsResponse[ScoredHit]

Response of the Similarity query

Parameters:

json (Dict) – the original JSON response

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
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

first_hit	return the first hit
hit_cls	the class of the hit
hits	the returned hits
json	the original JSON response of the request
most_similar_entry	return the most similar entry
offset	the number of hits that is skipped
similar_entries	return a list of similar entries in descending order of the similarity score
total	the total number of hits

property first_hit: HitType

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: Type[HitType]

the class of the hit

Return type:

Type[HitType]

property hits: List[HitType]

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 most_similar_entry: ScoredHit

return the most similar entry

Return type:

Dict

property offset: int

the number of hits that is skipped

Return type:

int

property similar_entries: List[ScoredHit]

return a list of similar entries in descending order of the similarity score

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 total: int

the total number of hits

Return type:

int