implicit_operator

Literal['or', 'and']

or

Default operator to use when the relationship, between 2 operands is ambiguous

"or", "and"

fields

List[str] OR Dict[str, float]

OR List[QPLField] OR str

Fields to be use when match term, phrases, spans, ...

In the string formats you can add the boots by adding ^ and the amount to boots, e.g. ^2 or ^0.5

As string:

"field"

As a List:

["field1", "field2^2", "field3^3"]

As a Dictionary:

{"field1": 1, "field2" : 2, "field3": 3.0}

as a List of QPLFields:

[{"name":"field1", "boost": 1}, {"name":"field2", "boost": 2}, {"name":"field3", "boost": 3}]

date_fields

List[str] OR Dict[str, float]

OR List[QPLField] OR str

[ ]

Fields to be use when date ranges, if no range queries are 

In the string formats you can add the boots by adding ^ and the amount to boots, e.g. ^2 or ^0.5

As string:

"field"

As a List:

["field1", "field2^2", "field3^3"]

As a Dictionary:

{"field1": 1, "field2" : 2, "field3": 3.0}

as a List of QPLFields:

[{"name":"field1", "boost": 1}, {"name":"field2", "boost": 2}, {"name":"field3", "boost": 3}]

range_fields

List[str] OR Dict[str, float]

OR List[QPLField] OR str

[ ]

Fields to be use when ranges

In the string formats you can add the boots by adding ^ and the amount to boots, e.g. ^2 or ^0.5

As string:

"field"

As a List:

["field1", "field2^2", "field3^3"]

As a Dictionary:

{"field1": 1, "field2" : 2, "field3": 3.0}

as a List of QPLFields:

[{"name":"field1", "boost": 1}, {"name":"field2", "boost": 2}, {"name":"field3", "boost": 3}]

date_format

str

Date format used to convert date values in the query. 

timezone

str

Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC.

slop_near

number

10

Slop value used for the NEAR operator

slop_before

number

2

Slop value used for the BEFORE operator

slop_adj

number

0

Slop value used for the ADJ operator

slop_span_not

number

0

Slop value used for the SPAN NOT operator

wildcard

bool

False

Use wildcard operators

grammar

File Path Or str

File path to the grammar or the actual raw grammar in string, in case you need to parse text to QPL with custom operators. QPL parser uses a Lalr parser implemented with Lark library, for more information check https://lark-parser.readthedocs.io/en/latest/grammar.html#

For more detail on how to build a grammar please check Grammar Composition from the Lark documentation

custom_operators

Dict[str, Operand]

{}

Dictionary with the name type of the custom operator as keys, and the class with their logic as values. All classes must inherit from Operator

synonyms_call

Func[]

Function returning requested synonyms for the specified string

saga_keywords

List[str]

[]

Saga tags to be normalize as QPL keywords. The display of the tag will use to replace the tag.
Example: "This {tag} here", where {tag}'s display is OR, will be normalized to "This OR here".

saga_synonyms

List[str]

[]

Saga tags marked as synonyms, For each entity in the matched tag, the list of patterns within the entity, will be used as the synonyms to replace the matched text.

saga_synonyms_boost

float

0.8

Boots to be used on each synonym added to the query.

saga_special_case

Dict[str, Callable[LexItem, str]

{}

Dictionary with tags as per keys, where each key has a function assigned, which will receive a LexItem and transformed it into a suitable query statement.