SearchableField Interface
Implements
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 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 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:
indexAnalyzerName
public abstract String indexAnalyzerName()
A LexicalAnalyzerName to associate as the index analyzer for the SearchField.
Returns:
isFacetable
public abstract boolean isFacetable()
Indicates if the field or method should generate as a facetable SearchField.
Returns:
isFilterable
public abstract boolean isFilterable()
Indicates if the field or method should generate as a filterable SearchField.
Returns:
isHidden
public abstract boolean isHidden()
Indicates if the field or method should generate as a hidden SearchField.
Returns:
isKey
public abstract boolean isKey()
Indicates if the field or method should generate as a key SearchField.
Returns:
isSortable
public abstract boolean isSortable()
Indicates if the field or method should generate as a sortable SearchField.
Returns:
searchAnalyzerName
public abstract String searchAnalyzerName()
A LexicalAnalyzerName to associate as the search analyzer for the SearchField.
Returns:
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:
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:
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:
Applies to
Azure SDK for Java
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour