Class SearchableFieldAttribute

Attributes a simple field using a primitive type or a collection of a primitive type.

Inheritance
System.Attribute
SimpleFieldAttribute
SearchableFieldAttribute
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Search.Documents.dll
Syntax
[System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field, AllowMultiple=false, Inherited=true)]
public class SearchableFieldAttribute : Azure.Search.Documents.Indexes.SimpleFieldAttribute

Constructors

SearchableFieldAttribute()

Declaration
public SearchableFieldAttribute ();

Properties

AnalyzerName

Gets or sets the name of the language analyzer. This property cannot be set when either SearchAnalyzerName or IndexAnalyzerName are set. Once the analyzer is chosen, it cannot be changed for the field in the index.

Declaration
public string AnalyzerName { get; set; }
Property Value
System.String

String values from LexicalAnalyzerName.Values, or the name of a custom analyzer previously uploaded.

IndexAnalyzerName

Gets or sets the name of the language analyzer for indexing. This property must be set together with SearchAnalyzerName, and cannot be set when AnalyzerName is set. This property cannot be set to the name of a language analyzer; use the AnalyzerName property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field in the index.

Declaration
public string IndexAnalyzerName { get; set; }
Property Value
System.String

String values from LexicalAnalyzerName.Values, or the name of a custom analyzer previously uploaded.

SearchAnalyzerName

Gets or sets the name of the language analyzer for searching. This property must be set together with IndexAnalyzerName, and cannot be set when AnalyzerName is set. This property cannot be set to the name of a language analyzer; use the AnalyzerName property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field in the index.

Declaration
public string SearchAnalyzerName { get; set; }
Property Value
System.String

String values from LexicalAnalyzerName.Values, or the name of a custom analyzer previously uploaded.

SynonymMapNames

Gets or sets a list of names of synonym maps to associate with this field. Currently, only one synonym map per field is supported.

Declaration
public string[] SynonymMapNames { get; set; }
Property Value
System.String[]

Remarks

Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map.

This attribute can be changed on existing fields.

VectorSearchConfiguration

The name of the vector search algorithm configuration that specifies the algorithm and optional parameters for searching the vector field.

Declaration
public string VectorSearchConfiguration { get; set; }
Property Value
System.String

VectorSearchDimensions

The dimensionality of the vector field.

Declaration
public string VectorSearchDimensions { get; set; }
Property Value
System.String