Package com.azure.search.documents.indexes.models

Class PrioritizedFields

java.lang.Object
com.azure.search.documents.indexes.models.PrioritizedFields
public final class PrioritizedFields extends Object
Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers.

  • Constructor Details

    • PrioritizedFields

      public PrioritizedFields()

  • Method Details

    • getTitleField

      public SemanticField getTitleField()
      Get the titleField property: Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank.
      Returns:
      the titleField value.

    • setTitleField

      public PrioritizedFields setTitleField(SemanticField titleField)
      Set the titleField property: Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank.
      Parameters:
      titleField - the titleField value to set.
      Returns:
      the PrioritizedFields object itself.

    • getPrioritizedContentFields

      public List<SemanticField> getPrioritizedContentFields()
      Get the prioritizedContentFields property: Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long.
      Returns:
      the prioritizedContentFields value.

    • setPrioritizedContentFields

      public PrioritizedFields setPrioritizedContentFields(List<SemanticField> prioritizedContentFields)
      Set the prioritizedContentFields property: Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long.
      Parameters:
      prioritizedContentFields - the prioritizedContentFields value to set.
      Returns:
      the PrioritizedFields object itself.

    • getPrioritizedKeywordsFields

      public List<SemanticField> getPrioritizedKeywordsFields()
      Get the prioritizedKeywordsFields property: Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long.
      Returns:
      the prioritizedKeywordsFields value.

    • setPrioritizedKeywordsFields

      public PrioritizedFields setPrioritizedKeywordsFields(List<SemanticField> prioritizedKeywordsFields)
      Set the prioritizedKeywordsFields property: Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long.
      Parameters:
      prioritizedKeywordsFields - the prioritizedKeywordsFields value to set.
      Returns:
      the PrioritizedFields object itself.