QPL Option is the object which will decided the behaviour of our QPL query, from the default operator to the Saga coupling and the synonym injection
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 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:
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 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:
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 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:
As a List:
As a Dictionary:
as a List of QPLFields:
| |
| str | Date format used to convert date values in the query. The format to use must be compatible with the engine specific query | |||
| str | Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC. The timezone to use must be compatible with the engine specific query | |||
| 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# We recommend that before starting to make a new grammar, consult with the development team | 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 | A more detailed use of the custom operators can be found on Custom Operator page | |
| Func[] | Function returning requested synonyms for the specified string | A more detailed use of the synonym expansion can be found on Synonym Expansion page |
Saga QPLOptions is a super set of QPLOptions, plus the options to couple with Saga
Field | Type | Required | Default | Description | Examples |
---|---|---|---|---|---|
| |||||
|
| [] | Saga tags to be normalize as QPL keywords. The display of the tag will use to replace the tag. | A more detail use of the Saga QLPOptions can be found on Saga Coupling page | |
|
| [] | 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. | ||
|
| 0.8 | Boots to be used on each synonym added to the query. | ||
|
| {} | 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. |