SearchableField Interface

Package:

com.azure.search.documents.indexes

Maven Artifact:

com.azure:azure-search-documents:11.7.4

Implements

Annotation

public interface SearchableField
implements Annotation

An annotation that directs buildSearchFields(Class<?> model, FieldBuilderOptions options) to turn the field or method into a searchable SearchField.

Method Summary

Modifier and Type	Method and Description
abstract String	analyzerName() A LexicalAnalyzerName to associate as the search and index analyzer for the SearchField.
abstract String	indexAnalyzerName() A LexicalAnalyzerName to associate as the index analyzer for the SearchField.
abstract boolean	isFacetable() Indicates if the field or method should generate as a facetable SearchField.
abstract boolean	isFilterable() Indicates if the field or method should generate as a filterable SearchField.
abstract boolean	isHidden() Indicates if the field or method should generate as a hidden SearchField.
abstract boolean	isKey() Indicates if the field or method should generate as a key SearchField.
abstract boolean	isSortable() Indicates if the field or method should generate as a sortable SearchField.
abstract boolean	isStored() Indicates if whether the field will be persisted separately on disk to be returned in a search result.
abstract String	searchAnalyzerName() A LexicalAnalyzerName to associate as the search analyzer for the SearchField.
abstract String[]	synonymMapNames() A list of SynonymMap names to be associated with the SearchField.
abstract String	vectorEncodingFormat() A VectorEncodingFormat to be associated with the SearchField.
abstract int	vectorSearchDimensions() The dimensionality of the vector field.
abstract String	vectorSearchProfileName() The name of the vector search profile that specifies the parameters for searching the vector field.

Method Details

analyzerName

public abstract String analyzerName()

A LexicalAnalyzerName to associate as the search and index analyzer for the SearchField.

Returns:

The LexicalAnalyzerName that will be associated as the search and index analyzer for the SearchField.

indexAnalyzerName

public abstract String indexAnalyzerName()

A LexicalAnalyzerName to associate as the index analyzer for the SearchField.

Returns:

The LexicalAnalyzerName that will be associated as the index analyzer for the SearchField.

isFacetable

public abstract boolean isFacetable()

Indicates if the field or method should generate as a facetable SearchField.

Returns:

A flag indicating if the field or method should generate as a facetable SearchField.

isFilterable

public abstract boolean isFilterable()

Indicates if the field or method should generate as a filterable SearchField.

Returns:

A flag indicating if the field or method should generate as a filterable SearchField.

isHidden

public abstract boolean isHidden()

Indicates if the field or method should generate as a hidden SearchField.

Returns:

A flag indicating if the field or method should generate as a hidden SearchField.

isKey

public abstract boolean isKey()

Indicates if the field or method should generate as a key SearchField.

Returns:

A flag indicating if the field or method should generate as a key SearchField.

isSortable

public abstract boolean isSortable()

Indicates if the field or method should generate as a sortable SearchField.

Returns:

A flag indicating if the field or method should generate as a sortable SearchField.

isStored

public abstract boolean isStored()

Indicates if whether the field will be persisted separately on disk to be returned in a search result.

Returns:

A flag indicating if the field or method should generate as a stored SearchField.

searchAnalyzerName

public abstract String searchAnalyzerName()

A LexicalAnalyzerName to associate as the search analyzer for the SearchField.

Returns:

The LexicalAnalyzerName that will be associated as the search analyzer for the SearchField.

synonymMapNames

public abstract String[] synonymMapNames()

A list of SynonymMap names to be associated with the SearchField.

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. The synonym map attribute may be changed on existing fields.

Currently, only one synonym map per field is supported.

Returns:

The SynonymMap names that will be associated with the SearchField.

vectorEncodingFormat

public abstract String vectorEncodingFormat()

A VectorEncodingFormat to be associated with the SearchField.

If the value is empty, the field won't have a getVectorEncodingFormat() value.

Returns:

The VectorEncodingFormat that will be associated with the SearchField.

vectorSearchDimensions

public abstract int vectorSearchDimensions()

The dimensionality of the vector field.

If the value is negative or 0, the field won't have a getVectorSearchDimensions() value.

Returns:

The dimensionality of the vector SearchField.

vectorSearchProfileName

public abstract String vectorSearchProfileName()

The name of the vector search profile that specifies the parameters for searching the vector field.

If the value is empty, the field won't have a getVectorSearchProfileName() ()} value.

Returns:

The name of the vector search profile that specifies the parameters for searching the vector SearchField.