File Queries

File Query

class citrination_client.search.file.query.file_query.FileQuery(logic=None, weight=None, simple=None, simple_weight=None, id=None, name=None, content=None, updated_at=None, query=None, **kwargs)

Bases: pypif.util.serializable.Serializable

Class to store information about a file query.

__init__(logic=None, weight=None, simple=None, simple_weight=None, id=None, name=None, content=None, updated_at=None, query=None, **kwargs)

Constructor.

Parameters

  • logic – The logic to apply to the query (‘SHOULD’, ‘MUST’, ‘MUST_NOT’, or ‘OPTIONAL’).

  • weight – Weight for the query.

  • simple – String with the simple search to run against all fields.

  • simple_weight – Dictionary of relative paths to their weights for simple queries.

  • id – One or more Filter objects with filters against the id field.

  • name – One or more Filter objects with filters against the name field.

  • content – One or more Filter objects with filters against the content field.

  • updated_at – One or more Filter objects with filters against the time that the dataset was last updated.

  • query – One or more DatasetQuery objects with nested queries.

content
id
logic
name
query
simple
simple_weight
updated_at
weight

File Returning Query

class citrination_client.search.file.query.file_returning_query.FileReturningQuery(query=None, from_index=None, size=None, random_results=None, random_seed=None, score_relevance=None, return_max_score=None, timeout=None, max_content_highlights=None, highlight_pre_tag=None, highlight_post_tag=None, **kwargs)

Bases: citrination_client.search.core.query.base_returning_query.BaseReturningQuery

Query used to return information about files.

__init__(query=None, from_index=None, size=None, random_results=None, random_seed=None, score_relevance=None, return_max_score=None, timeout=None, max_content_highlights=None, highlight_pre_tag=None, highlight_post_tag=None, **kwargs)

Constructor.

Parameters

  • query – One or more DataQuery objects with the queries to run.

  • from_index – Index of the first hit that should be returned.

  • size – Total number of hits the should be returned.

  • random_results – Whether to return a random set of records.

  • random_seed – The random seed to use.

  • score_relevance – Whether to use relevance scoring.

  • return_max_score – Whether to return the maximum score.

  • timeout – The number of milliseconds to wait for the query to execute.

  • max_content_highlights – The maximum number of highlighted results to return.

  • highlight_pre_tag – The tag to use at the beginning of a highlight.

  • highlight_post_tag – The tag to use at the end of a highlight.

highlight_post_tag
highlight_pre_tag
max_content_highlights