Default query settings
Learn about how the search query is configured for each project type by default.
When you submit a search from the product user interface, your text is passed as a natural language query value to the Query API. Other parameters that you can define when you use the API are assigned default values for queries that are made from the user interface. The following tables explain which values are specified by default for each project type. For more information about the Query API, see Query reference.
You can override some of the default values by using improvement tools in the user interface. For example, you can use the Search results tool to change parameters such as passages.enabled
. For more information, see Changing the result content.
The enrichments that are applied to your data autmoatically differ by project type. For more information, see Default project settings.
Default query settings
Query default | Document Retrieval | Document Retrieval for Contracts |
---|---|---|
aggregation |
[term(enriched_text.entities.text,name:entities)] |
[term(enriched_html.contract. elements.categories.label,count:25,name:categories)] |
count |
10 |
10 |
highlight |
false |
false |
passages.characters |
200 |
200 |
passages.count |
10 |
10 |
passages.enabled |
true |
true |
passages.fields |
["text", "title"] |
["text", "title"] |
passages.find_answers |
false |
false |
passages.max_answers_per_passage |
1 |
1 |
passages.max_per_document |
1 |
1 |
passages.per_document |
true |
true |
return |
[] |
[] |
spelling_suggestions |
false |
true |
sort |
"" |
"" |
table_results.count |
10 |
10 |
table_results.enabled |
false |
true |
table_results.per_document |
0 |
0 |
Default query settings continued
Query default | Conversational Search | Content Mining | Custom |
---|---|---|---|
aggregation |
[ ] |
[ ] |
[ ] |
count |
10 |
10 |
10 |
highlight |
false |
false |
false |
passages.characters |
200 |
200 |
200 |
passages.count |
10 |
10 |
10 |
passages.enabled |
true |
false |
true |
passages.fields |
["text", "title"] |
["text", "title"] |
["text", "title"] |
passages.find_answers |
false |
false |
false |
passages.max_answers_per_passage |
1 |
1 |
1 |
passages.max_per_document |
1 |
1 |
1 |
passages.per_document |
true |
true |
true |
return |
[] |
[] |
[] |
spelling_suggestions |
false |
true |
true |
sort |
"" |
"" |
"" |
table_results.count |
10 |
10 |
10 |
table_results.enabled |
false |
false |
false |
table_results.per_document |
0 |
0 |
0 |
Project component settings
Default | Document Retrieval | Document Retrieval for Contracts |
---|---|---|
Aggregations | See table | See table |
autocomplete |
true |
true |
fields_shown.body.field |
"" |
"" |
fields_shown.body.use_passage |
true |
true |
fields_shown.title.field |
"title" |
"title" |
results_per_page |
5 |
5 |
structured_search |
false |
false |
Project component settings continued
The Custom project type has no project component default settings.
Default | Conversational search | Content Mining |
---|---|---|
Aggregations | [] |
[] |
autocomplete |
false |
true |
fields_shown.body.field |
"" |
text |
fields_shown.body.use_passage |
true |
false |
fields_shown.title.field |
"title" |
"document_id" |
results_per_page |
0 |
0 |
structured_search |
false |
false |
Document Retrieval project aggregations
aggregations.name | aggregations.label | aggregations.multiple_selections_allowed |
---|---|---|
"name": "entities" |
"label": "Top Entities" |
"multiple_selections_allowed": false |
"name": "_system_collections" |
"label": "Collections" |
"multiple_selections_allowed": true |
Document Retrieval for Contracts project aggregations
aggregations.name | aggregations.label | aggregations.multiple_selections_allowed |
---|---|---|
"name": "categories" |
"label": "Category" |
"multiple_selections_allowed": true |
"name": "natures" |
"label": "Nature" |
"multiple_selections_allowed": false |
"name": "contract_terms" |
"label": "Contract Term" |
"multiple_selections_allowed": false |
"name": "contract_payment_terms" |
"label": "Contract Payment Term" |
"multiple_selections_allowed": false |
"name": "contract_types" |
"label": "Contract Type" |
"multiple_selections_allowed": false |
"name": "contract_currencies" |
"label": "Contract Currency" |
"multiple_selections_allowed": false |
"name": "invoice_buyers" |
"label": "Invoice Buyer" |
"multiple_selections_allowed": false |
"name": "invoice_suppliers" |
"label": "Invoice Supplier" |
"multiple_selections_allowed": false |
"name": "invoice_currencies" |
"label": "Invoice Currency" |
"multiple_selections_allowed": false |
"name": "po_payment_terms" |
"label": "Purchase Order Payment Term" |
"multiple_selections_allowed": false |
"name": "po_buyers" |
"label": "Purchase Order Buyer" |
"multiple_selections_allowed": false |
"name": "po_suppliers" |
"label": "Purchase Order Supplier" |
"multiple_selections_allowed": false |
"name": "po_currencies" |
"label": "Purchase Order Currency" |
"multiple_selections_allowed": false |