Class Options

Options for a Search or Match request

Inheritance

System.Object

Options

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Textkernel.Tx.Models.API.MatchV2.Request

Assembly: Textkernel.Tx.SDK.dll

Syntax

public class Options

Properties

| Improve this Doc View Source

DocumentType

Allows for users to specify what type of document is being passed to the match process. Document ID must be specifed and the match process needs to know if the documentId is of type candidate or job.

Declaration

public DocumentType DocumentType { get; set; }

Property Value

Type	Description
DocumentType

| Improve this Doc View Source

FacetCounts

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

Declaration

public bool? FacetCounts { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

| Improve this Doc View Source

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.

Declaration

public bool? Highlight { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

| Improve this Doc View Source

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.

Declaration

public bool? MergeOverLappingSynonyms { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

| Improve this Doc View Source

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.

Declaration

public int? PageSize { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

| Improve this Doc View Source

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.

Declaration

public string[] ResultFields { get; set; }

Property Value

Type	Description
System.String[]

| Improve this Doc View Source

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.

Declaration

public int? ResultOffset { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

| Improve this Doc View Source

Roles

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

Declaration

public IEnumerable<string> Roles { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.String>

| Improve this Doc View Source

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 SearchAfter returned from the previous page query.

Declaration

public string[] SearchAfter { get; set; }

Property Value

Type	Description
System.String[]

| Improve this Doc View Source

Sorting

Optional sorting definition.

Declaration

public Sorting[] Sorting { get; set; }

Property Value

Type	Description
Sorting[]

| Improve this Doc View Source

SupressCorrection

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

Declaration

public bool? SupressCorrection { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

| Improve this Doc View Source

SupressResultList

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

Declaration

public bool? SupressResultList { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

| Improve this Doc View Source

SynonymExpansionMode

Optional setting for synonym expansion mode.

Declaration

public SynonymExpansionMode? SynonymExpansionMode { get; set; }

Property Value

Type	Description
System.Nullable<SynonymExpansionMode>

| Improve this Doc View Source

SynonymLanguages

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

Declaration

public string[] SynonymLanguages { get; set; }

Property Value

Type	Description
System.String[]