QPLOptions
| Field | Type | Required | Default | Description | Examples |
|---|---|---|---|---|---|
| Literal['or', 'and'] |  | or | Default operator to use when the relationship, between 2 operands is ambiguous Applicable only to the parser | "or", "and" |
| List[str] OR Dict[str, float] OR List[QPLField] OR str |
| Fields to be used when match term, phrases, spans, ... In the string formats you can add the boost by adding ^ and the boost 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 used when date ranges, if no range queries are In the string formats you can add the boost by adding ^ and the boost 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 used when ranges In the string formats you can add the boost by adding ^ and the boost 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. 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 Applicable only to the parser | |
| 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 Applicable only to the parser | 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 Applicable only to the parser | A more detailed use of the custom operators can be found on Custom Operator page |
| Func[] | | Function returning requested synonyms for the specified string Applicable only to the parser | A more detailed use of the synonym expansion can be found on Synonym Expansion page |
Overview
Content Tools