PIF Result

PIF Multi Search Result

class citrination_client.search.pif.result.pif_multi_search_result.PifMultiSearchResult(took=None, results=None, **kwargs)

Bases: pypif.util.serializable.Serializable

Class to store the results of a PIF multi-query.

__init__(took=None, results=None, **kwargs)

Constructor.

Parameters

  • took – Number of milliseconds that the query took to execute.

  • results – List of PifMultiSearchResultElement objects.

results
took

PIF Multi Search Result Element

class citrination_client.search.pif.result.pif_multi_search_result_element.PifMultiSearchResultElement(result=None, status=None, **kwargs)

Bases: pypif.util.serializable.Serializable

A single search result as a part of a pif multi-query.

__init__(result=None, status=None, **kwargs)

Constructor.

Parameters

  • result – A single PifSearchResult object with the query results.

  • status – ‘SUCCESS’, ‘ERROR’, or ‘NOT_EXECUTED’.

result
status

PIF Search Hit

class citrination_client.search.pif.result.pif_search_hit.PifSearchHit(id=None, dataset=None, dataset_version=None, score=None, updated_at=None, system=None, extracted=None, extracted_path=None, **kwargs)

Bases: pypif.util.serializable.Serializable

Class to store a single PIF search hit.

__init__(id=None, dataset=None, dataset_version=None, score=None, updated_at=None, system=None, extracted=None, extracted_path=None, **kwargs)

Constructor.

Parameters

  • id – String with the ID of the record.

  • dataset – Integer with the dataset of the record.

  • dataset_version – Integer with the dataset version of the record.

  • score – Score with the relevancy of the result.

  • updated_at – String with the last time that the record was updated.

  • system – Pif System object that matched.

  • extracted – Dictionary with a map of extracted property names to values.

  • extracted_path – Dictionary with a map of extracted property names to paths in a PIF.

dataset
dataset_version
extracted
extracted_path
id
score
system
updated_at

PIF Search Result

class citrination_client.search.pif.result.pif_search_result.PifSearchResult(took=None, total_num_hits=None, max_score=None, hits=None, **kwargs)

Bases: citrination_client.search.core.result.base_search_result.BaseSearchResult

Class to store the results of a PIF query.

__init__(took=None, total_num_hits=None, max_score=None, hits=None, **kwargs)

Constructor.

Parameters

  • took – Number of milliseconds that the query took to execute.

  • total_num_hits – Total number of hits.

  • max_score – The maximum score.

  • hits – List of PifSearchHit objects.