Field | Type | Required | Default | Description | Examples | ||||
---|---|---|---|---|---|---|---|---|---|
| Literal['or', 'and'] | or | Default operator to use when the relationship, between 2 operands is ambiguous
| "or", "and" | |||||
| List[str] OR Dict[str, float] OR List[QPLField] OR str | Fields to be use used when match term, phrases, spans, ... In the string formats you can add the boots boost by adding ^ and the amount to bootsboost factor, e.g. ^2 or ^0.5 | As string:
As a List:
As a Dictionary:
as a List of QPLFields:
| ||||||
| List[str] OR Dict[str, float] OR List[QPLField] OR str | [ ] | Fields to be use used when date ranges, if no range queries are In the string formats you can add the boots boost by adding ^ and the amount to bootsboost factor, e.g. ^2 or ^0.5 | As string:
As a List:
As a Dictionary:
as a List of QPLFields:
| |||||
| List[str] OR Dict[str, float] OR List[QPLField] OR str | [ ] | Fields to be use used when ranges In the string formats you can add the boots boost by adding ^ and the amount to bootsboost factor, e.g. ^2 or ^0.5 | As string:
As a List:
As a Dictionary:
as a List of QPLFields:
| |||||
| str | Date format used to convert date values in the query.
| |||||||
| str | Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC.
| |||||||
| number | 10 | Slop value used for the NEAR operator | ||||||
| number | 2 | Slop value used for the BEFORE operator | ||||||
| number | 0 | Slop value used for the ADJ operator | ||||||
| number | 0 | Slop value used for the SPAN NOT operator | ||||||
| bool | False | Use wildcard operators
| ||||||
| 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 | ||||||
| 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
|
| |||||
| Func[] | Function returning requested synonyms for the specified string
|
|
Saga QPLOptions is a super set of QPLOptions, plus the options to couple with Saga
...same as QPLOptions, plus:
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
Boots to be used on each synonym added to the query.
saga_special_case
Dict[str, Callable[LexItem, str]