com.textkernel.tx.models.api.matchV2.querying

Class Options

java.lang.Object

com.textkernel.tx.models.api.matchV2.querying.Options

public class Options
extends Object

Options for a Search or Match request

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	FacetCounts Optional.
Boolean	Highlight Optional.
Boolean	MergeOverLappingSynonyms Optional.
Integer	PageSize Optional parameter to specify the number of result items (max 1500).
String[]	ResultFields Optional customization of the fields to be included in the results.
Integer	ResultOffset the result item offset used for pagination.
List<String>	Roles The roles associated with the request.
String[]	SearchAfter Used for pagination within Elastic Search Searcher (ignored for external searchers).
Sorting[]	Sorting Optional sorting definition.
Boolean	SupressCorrection If true then spelling correction on the input query is skipped.
Boolean	SupressResultList If true then no result list is returned.
SynonymExpansionMode	SynonymExpansionMode Optional setting for synonym expansion mode.
String[]	SynonymLanguages Optional List of language codes preferred by the user to filter synonyms by languages.
Boolean	UseNLQS Optional flag indicating that the backend needs to use the Natural Language Query Service (NLQS) to interpret the query String.

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Roles

public List<String> Roles

The roles associated with the request. Defaults to "All" if none are provided.

SupressResultList

public Boolean SupressResultList

If true then no result list is returned. Used for example when only the cloud is needed.

SupressCorrection

public Boolean SupressCorrection

If true then spelling correction on the input query is skipped.

Highlight

public Boolean Highlight

Optional. If true search responses will be highlighted. Note: If a snippet was requested from the searcher as part of the result fields, the snippet can still contain highlighting even when false/null.

PageSize

public Integer PageSize

Optional parameter to specify the number of result items (max 1500). Only use a high number in case you need a list of results for use in follow-up actions. Do not use a high number when presenting results in a user interface. Therefore, the max is 100 when used in combination with pagination parameters (SearchAfter or ResultOffset). When this is larger than 100, facet counts and search term highlighting are not provided (FacetCounts and Highlight are implicitly set to false). If not provided, the pre-configured page size of the searcher will be used. This value is ignored for external searchers.

SearchAfter

public String[] SearchAfter

Used for pagination within Elastic Search Searcher (ignored for external searchers). Represents the sort values of the last item from the previous page. Must contain exactly the SearchResult.SearchAfter returned from the previous page query.

ResultOffset

public Integer ResultOffset

the result item offset used for pagination. For example, a value of 20 will skip the top 20 results and return the subsequent results starting with result 21. This is ignored if SearchAfter is set. ResultOffset + PageSize cannot be more than 10000.

SynonymLanguages

public String[] SynonymLanguages

Optional List of language codes preferred by the user to filter synonyms by languages.

MergeOverLappingSynonyms

public Boolean MergeOverLappingSynonyms

Optional. If true the content of a query part item of type TEXT or LONG_TEXT (its term plus synonyms) that overlaps more than 75% with a previous query part of the same field and condition will be moved into the synonyms of that previous one.

SynonymExpansionMode

public SynonymExpansionMode SynonymExpansionMode

Optional setting for synonym expansion mode.

ResultFields

public String[] ResultFields

Optional customization of the fields to be included in the results. If it consists of a single wildcard field marked by "*" (star) then all available fields will be returned. If empty then the default result field set will be returned. Remark: Reducing the returned fields this way, will not in general improve performance, since Search is optimized to return the standard configured field set. It is not possible to request system fields such as 'roles' or nested sub-fields.

FacetCounts

public Boolean FacetCounts

Optional. If true the search responses will contain facet count. May result in slower response times.

Sorting

public Sorting[] Sorting

Optional sorting definition.

UseNLQS

public Boolean UseNLQS

Optional flag indicating that the backend needs to use the Natural Language Query Service (NLQS) to interpret the query String.

Constructor Detail

Options

public Options()