Annotation Type SearchableField

@Target({FIELD,METHOD}) @Retention(RUNTIME) public @interface SearchableField
An annotation that directs SearchIndexAsyncClient.buildSearchFields(Class, FieldBuilderOptions) to turn the field or method into a searchable field.

  • Element Details

    • isKey

      boolean isKey
      Indicates if the field or method should generate as a key field.
      Returns:
      A flag indicating if the field or method should generate as a key field.
      Default:
      false

    • isHidden

      boolean isHidden
      Indicates if the field or method should generate as a hidden field.
      Returns:
      A flag indicating if the field or method should generate as a hidden field.
      Default:
      false

    • isFacetable

      boolean isFacetable
      Indicates if the field or method should generate as a facetable field.
      Returns:
      A flag indicating if the field or method should generate as a facetable field.
      Default:
      false

    • permissionFilter

      String permissionFilter
      Indicates if the field or method should be used as a permission filter field.
      Returns:
      A flag indicating if the field or method should generate as a filterable field.
      Default:
      ""

    • isSensitivityLabel

      boolean 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 field.
      Default:
      false

    • isSortable

      boolean isSortable
      Indicates if the field or method should generate as a sortable field.
      Returns:
      A flag indicating if the field or method should generate as a sortable field.
      Default:
      false

    • isStored

      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 field.
      Default:
      true

    • isFilterable

      boolean isFilterable
      Indicates if the field or method should generate as a filterable field.
      Returns:
      A flag indicating if the field or method should generate as a filterable field.
      Default:
      false

    • analyzerName

      String analyzerName
      A LexicalAnalyzerName to associate as the search and index analyzer for the field.
      Returns:
      The LexicalAnalyzerName that will be associated as the search and index analyzer for the field.
      Default:
      ""

    • searchAnalyzerName

      String searchAnalyzerName
      A LexicalAnalyzerName to associate as the search analyzer for the field.
      Returns:
      The LexicalAnalyzerName that will be associated as the search analyzer for the field.
      Default:
      ""

    • indexAnalyzerName

      String indexAnalyzerName
      A LexicalAnalyzerName to associate as the index analyzer for the field.
      Returns:
      The LexicalAnalyzerName that will be associated as the index analyzer for the field.
      Default:
      ""

    • normalizerName

      String normalizerName
      A LexicalNormalizerName to associate as the normalizer for the field.
      Returns:
      The LexicalNormalizerName that will be associated as the normalizer for the field.
      Default:
      ""

    • synonymMapNames

      String[] synonymMapNames
      A list of SynonymMap names to be associated with the field.

      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 field.
      Default:
      {}

    • vectorSearchDimensions

      int vectorSearchDimensions
      The dimensionality of the vector field.

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

      Returns:
      The dimensionality of the vector field.
      Default:
      -1

    • vectorSearchProfileName

      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 SearchField.getVectorSearchProfileName() ()} value.

      Returns:
      The name of the vector search profile that specifies the parameters for searching the vector field.
      Default:
      ""

    • vectorEncodingFormat

      String vectorEncodingFormat
      A VectorEncodingFormat to be associated with the field.

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

      Returns:
      The VectorEncodingFormat that will be associated with the field.
      Default:
      ""