BasicField Interface

Package:
com.azure.search.documents.indexes
Maven Artifact:
com.azure:azure-search-documents:12.0.0

Implements

Annotation

public interface BasicField
implements Annotation

Annotation used to create SearchField using buildSearchFields(Class<?> model) or buildSearchFields(Class<?> model).

Only fields or methods annotated with this annotation or ComplexField will be used to create 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 BooleanHelper isFacetable()

Indicates if the field or method should generate as a facetable SearchField.
abstract BooleanHelper isFilterable()

Indicates if the field or method should generate as a filterable SearchField.
abstract BooleanHelper isHidden()

Deprecated

Use isRetrievable() instead and flip the boolean value.

Indicates if the field or method should generate as a hidden SearchField.
abstract BooleanHelper isKey()

Indicates if the field or method should generate as a key SearchField.
abstract BooleanHelper isRetrievable()

Indicates if the field or method should generate as a retrievable SearchField.
abstract BooleanHelper isSearchable()

Indicates whether the field can be searched against.
abstract BooleanHelper isSensitivityLabel()

Indicates if the field or method should be used for sensitivity label filtering.
abstract BooleanHelper isSortable()

Indicates if the field or method should generate as a sortable SearchField.
abstract BooleanHelper isStored()

Indicates if whether the field will be persisted separately on disk to be returned in a search result.
abstract String name()

The getName() used in the SearchIndex.
abstract String normalizerName()

A LexicalNormalizerName to associate as the normalizer for the SearchField.
abstract String permissionFilter()

Indicates if the field or method should be used as a permission filter SearchField.
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 BasicField.BooleanHelper 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 BasicField.BooleanHelper 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

@Deprecated
public abstract BasicField.BooleanHelper isHidden()

Deprecated

Use isRetrievable() instead and flip the boolean value.

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

When building fields, unless BooleanHelper#NULL is set, this must have the opposite value of isRetrievable().

Returns:

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

isKey

public abstract BasicField.BooleanHelper 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.

isRetrievable

public abstract BasicField.BooleanHelper isRetrievable()

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

When building fields, unless BooleanHelper#NULL is set, this must have the opposite value of isHidden().

Returns:

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

isSearchable

public abstract BasicField.BooleanHelper isSearchable()

Indicates whether the field can be searched against.

Returns:

Indicates whether the field can be searched against.

isSensitivityLabel

public abstract BasicField.BooleanHelper isSensitivityLabel()

Indicates if the field or method should be used for sensitivity label filtering. This enables document-level filtering based on Microsoft Purview sensitivity labels.

Returns:

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

isSortable

public abstract BasicField.BooleanHelper 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 BasicField.BooleanHelper 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.

name

public abstract String name()

The getName() used in the SearchIndex.

Returns:

The name of the field.

normalizerName

public abstract String normalizerName()

A LexicalNormalizerName to associate as the normalizer for the SearchField.

Returns:

The LexicalNormalizerName that will be associated as the normalizer for the SearchField.

permissionFilter

public abstract String permissionFilter()

Indicates if the field or method should be used as a permission filter SearchField.

Returns:

A flag indicating if the field or method should generate as a filterable 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.

Applies to