Available Boolean Field Options

This article contains detailed information about each boolean option you can set when creating or modifying a field in a Coveo Cloud organization (see Creating Fields).

Option Description Default value Name in the Coveo Cloud administration console
facet

Whether Group By operations can be performed on this field.

You must set the Facet option to true on a STRING type field if you want to use the Coveo JavaScript Search Framework to instantiate a Facet or SimpleFilter component based on that field.

  • false for STRING type fields
  • true for all other types of fields.

Cannot be set to false on a non-STRING type field.

Facet
includeInQuery

Whether this field can be referred to in Coveo Cloud query syntax expressions (e.g., @myfield=myvalue).

SeveralCoveo JavaScript Search Framework components (DistanceResources, Facet, FieldSuggestion, Tab, etc.) rely on the fact that most fields can normally be referred to in advanced query expressions (aq).

Therefore, explicitly setting this option to false on a field is not recommended, unless you do not want that field to be usable in queries at all (e.g., if you only want that field to be usable for sorting query results)

true Search operator
includeInResults

Whether this field can be included in the raw property of each query result.

The Search API allows you to explicitly specify which fields you want to include in (or exclude from) the raw property of each result at query time.

Moreover, the index can only include a given field in the raw property of a query result if this field has a non-null value for this particular result.

Therefore, explicitly setting this option to false on a field is not recommended, unless you want to completely override this behavior and ensure that this field can never be included in the raw property of any query result.

true Displayable in results
mergeWithLexicon

Whether the value of this field can make an item match the query.

In a public web site, a user submits the Incredible Productbasic query expression from a search box.

The search box sends an HTTP request to the Search API to execute the query against the index of a certain Coveo Cloud organization.

In the target organization, the productname field has its mergeWithLexicon option set to true.

In the index of that same organization, in a public source, the body of item X has no mention of any of the original query expression keywords.

Assuming that no Coveo Cloud query pipeline process (such as Coveo Machine Learning (Coveo ML)) is boosting the ranking of item X, this item would normally not match the query.

However, since the productname field value of item X happens to be Incredible Product the item matches the query.

false

Can only be set to true on a STRING type field.

Free text search
multiValueFacet

Whether this field contains multiple values separated by a certain character (see the multiValueFacetTokenizers option).

If you set the multiValueFacet option to true when creating a field, you must also specify a value for the multiValueFacetTokenizers option (typically, you should use ;)

false

Cannot be set to true on a non-STRING type field.

Multi-value facet
multiValueFacetTokenizers

The character to use as a value separator, if the field contains multiple values.

Typically, you should set this option to ; if multiValueFacet is true.

While it is possible to use this options to specify any custom character to use as a value separator (e.g.,,), doing so is not recommended because the Coveo JavaScript Search Framework will then be unable to parse those values correctly.

null

Must be specified if multiValueFacet is true.

ranking

Whether to use this field in result ranking calculation.

Setting this option to true on many fields can have an adverse effect on query performance

false

Can only be set to true on a STRING type field.

Ranking
smartDateFacet

Whether to transform incoming date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900.

If you set this option to true on a DATE type field, the field itself will be populated by the number of milliseconds since Unix epoch corresponding to the parsed date and time string, as usual.

However, the index will also automatically create a new field, and populate it with the smart date data.

You create the mydate field in your index and set the smartDateFacet option to true on that field.

The index processes a source item whose mydate metadata value is 2017-11-20T19:58:55.126Z. The mydate metadata is mapped to the mydate field in that source.

The index populates the mydate field with the corresponding number of milliseconds since Unix epoch (i.e., 1511207935000). It also creates a mydatesmartfacet field and populates it with the smart date data (i.e., D43057;W6151;M1414;Q471;Y117).

false

Can only be set to true on a DATE type field.

sort

Whether query results can be sorted based on this field.

Having lots of sortable STRING type fields in a Coveo Cloud organization can have an adverse effect on its index size and performance.

Therefore, explicitly setting this option to true on a STRING type field is not recommended, unless you are absolutely certain that this feature will be useful for that field (e.g., if you are planning to use the field as a sortCriteria in the Sort component of a search page made with the Coveo JavaScript Search Framework).

  • false for STRING type fields.
  • true for all other types of fields.

Cannot be set to false on a non-STRING type field.

Sortable
stemming

Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords.

Setting this option to true on many fields can have an adverse effect on query performance.

false

Can only be set to true on a STRING type field.

Stemming
system Whether this field is a standard Coveo field.

false

Must always be left to false when creating a new field.

useCacheForComputedFacet

Whether to read computed field results involving this field from cache.

Setting this option to true on a field can greatly speed up query function expressions referencing this field.

false

Cannot be set to true on a STRING type field.

Use cache for computed fields
useCacheForNestedQuery

Whether to store and read nested query results involving this field in cache.

Setting this option to true on a field also speeds query performance for expressions that compare the value of this field using regex (/=), wildcards (*=), phonetic match (%=), or fuzzy match (~=) query operators (see Coveo Cloud Query Syntax Reference).

false

Can be set to true on a STRING type field, only when the facet option or the multiValueFacet option is also true for that field.

Use cache for nested queries
useCacheForNumericQuery Whether to store and read numeric operation results involving this field in cache.

false

Cannot be set to true on a STRING type field.

Use cache for numeric queries
useCacheForSort Whether to store and read this entire field in cache to allow faster sorting.

false

Cannot be set to true on a STRING type field, unless the sort option is also true for that field.

Use cache for sort