Dataset Results¶

Dataset Multi Search Result¶

class citrination_client.search.dataset.result.dataset_multi_search_result.DatasetMultiSearchResult(took=None, results=None, **kwargs)¶

Bases: pypif.util.serializable.Serializable

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

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

Constructor.

Parameters

took – Number of milliseconds that the query took to execute.
results – List of DatasetMultiSearchResultElement objects.

results¶

took¶

Dataset Multi Search Result Element¶

class citrination_client.search.dataset.result.dataset_multi_search_result_element.DatasetMultiSearchResultElement(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 DatasetSearchResult object with the query results.
status – ‘SUCCESS’, ‘ERROR’, or ‘NOT_EXECUTED’.

result¶

status¶

Dataset Search Hit¶

class citrination_client.search.dataset.result.dataset_search_hit.DatasetSearchHit(id=None, score=None, is_featured=None, name=None, description=None, owner=None, email=None, num_pifs=None, updated_at=None, **kwargs)¶

Bases: pypif.util.serializable.Serializable

Class to store a single dataset search hit.

__init__(id=None, score=None, is_featured=None, name=None, description=None, owner=None, email=None, num_pifs=None, updated_at=None, **kwargs)¶

Constructor.

Parameters

id – String with the ID of the record.
score – Score with the relevancy of the result.
is_featured – Whether the dataset is a featured one.
name – Name of the dataset.
description – Description of the dataset.
owner – Name of the owner of the dataset.
email – Email address of the owner of the dataset.
num_pifs – Number of PIFs in the dataset.
updated_at – String with the last time that the dataset was updated.

description¶

email¶

id¶

is_featured¶

name¶

num_pifs¶

owner¶

score¶

updated_at¶

Dataset Search Result¶

class citrination_client.search.dataset.result.dataset_search_result.DatasetSearchResult(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 dataset 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 DatasetSearchHit objects.