How searches read one field. Every capability is off unless its object is present; an empty object turns it on with the engine defaults.
Example
{
"interpret": {},
"suggest": {},
"values": [
{
"value": "S",
"order": 1,
"labels": {
"en": "Small",
"sv": "Liten"
}
}
]
}
Properties
interpretInterpretUsage
Reads the values the field holds out of the query text of a search in user mode, as a filter on the field. The field must be a string field with filter and facet and without hierarchy; otherwise the request returns settings:fields:interpret_unsupported. Carries no options. See Reading the values of a field.
Example
{}
valuesDeclaredValue[]
Values of the field with a declared order and labels per locale. A facet with "order": "declared" answers these values first, by order, and every other value after them by count. A facet answers each value's label in the locale of the search, a prefix search of the facet matches labels as well as values, and a search in user mode with interpret on the field reads a typed label as its value. The field must be a string field with facet and without hierarchy; otherwise the request returns settings:fields:values_unsupported. At most 10000 values per field. See Field settings.
Example
{
"value": "S",
"order": 1,
"labels": {
"en": "Small",
"sv": "Liten"
}
}
3 properties
valuestring
The value as the field stores it, which is what a facet counts and a filter matches. Required and unique within the field; otherwise the request returns settings:fields:values_invalid.
Example
"S"
orderinteger
Where the value sits in a facet ordered by declared, lower first; values sharing an order are sorted by count. If omitted, the value is ordered by count after every value that has an order, so labels can be declared without an order.
Format
int32
Example
1
labelsmap of string
What a person reads instead of the value, keyed by BCP-47 tag in canonical form (sv, en-GB). A search answers the label of its locale, matched as closely as the tags tell apart, and the label of the field's default locale where its own has none. A tag that is not canonical, or a blank label, returns settings:fields:values_invalid.
1 property
<key>string
suggestSuggest
Suggests the values the field holds while a search is typed, through POST /v1alpha1/indexes/{name}/suggest. The field must be a string field with facet and without hierarchy; otherwise the request returns settings:fields:suggest_unsupported. Carries no options. See Suggesting what to search for.
Example
{}
Endpoints
Endpoints where the request or responses uses this type.