SearchField.IsFilterable Property

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SearchField.cs
Source:
SearchField.cs

Gets or sets a value indicating whether the field can be referenced in $filter queries. The default is null. This property must be null for complex fields, but can be set on simple fields within a complex field.

public bool? IsFilterable { get; set; }
member this.IsFilterable : Nullable<bool> with get, set
Public Property IsFilterable As Nullable(Of Boolean)

Property Value

Nullable<Boolean>

Remarks

Filterable differs from searchable in how strings are handled. Fields of type String or "Collection(DataType.String)" that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will.

This field must be set according to constraints described in the summary, or the server may respond with an error. Instead, consider using the SimpleField, SearchableField, VectorSearchField and ComplexField classes to help you more easily create a SearchIndex.

Applies to