File Results

File Multi Search Result

class citrination_client.search.file.result.file_multi_search_result.FileMultiSearchResult(took=None, results=None, **kwargs)

Bases: pypif.util.serializable.Serializable

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

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

Constructor.

Parameters

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

  • results – List of FileMultiSearchResultElement objects.

results
took

File Multi Search Result Element

class citrination_client.search.file.result.file_multi_search_result_element.FileMultiSearchResultElement(result=None, status=None, **kwargs)

Bases: pypif.util.serializable.Serializable

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

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

Constructor.

Parameters

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

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

result
status

File Search Hit

class citrination_client.search.file.result.file_search_hit.FileSearchHit(dataset_id=None, dataset_version=None, id=None, score=None, name=None, updated_at=None, highlights=None, **kwargs)

Bases: pypif.util.serializable.Serializable

Class to store a single file search hit.

__init__(dataset_id=None, dataset_version=None, id=None, score=None, name=None, updated_at=None, highlights=None, **kwargs)

Constructor.

Parameters

  • dataset_id – String with the ID of the dataset.

  • dataset_version – Long with the version of the dataset.

  • id – String with the ID of the record.

  • score – Score with the relevancy of the result.

  • name – Name of the dataset.

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

  • highlights – List of strings with the highlighted results.

dataset_id
dataset_version
highlights
id
name
score
updated_at

File Search Result

class citrination_client.search.file.result.file_search_result.FileSearchResult(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 file 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 FileSearchHit objects.