PrioritizedFields.java

  1. // Copyright (c) Microsoft Corporation. All rights reserved.
  2. // Licensed under the MIT License.
  3. //
  4. // Code generated by Microsoft (R) AutoRest Code Generator.
  5. // Changes may cause incorrect behavior and will be lost if the code is
  6. // regenerated.

  8. package com.azure.search.documents.indexes.models;

  10. import com.azure.core.annotation.Fluent;
  11. import com.fasterxml.jackson.annotation.JsonProperty;
  12. import java.util.List;

  14. /**
  15.  * Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers.
  16.  */
  17. @Fluent
  18. public final class PrioritizedFields {
  19.     /*
  20.      * Defines the title field to be used for semantic ranking, captions,
  21.      * highlights, and answers. If you don't have a title field in your index,
  22.      * leave this blank.
  23.      */
  24.     @JsonProperty(value = "titleField")
  25.     private SemanticField titleField;

  27.     /*
  28.      * Defines the content fields to be used for semantic ranking, captions,
  29.      * highlights, and answers. For the best result, the selected fields should
  30.      * contain text in natural language form. The order of the fields in the
  31.      * array represents their priority. Fields with lower priority may get
  32.      * truncated if the content is long.
  33.      */
  34.     @JsonProperty(value = "prioritizedContentFields")
  35.     private List<SemanticField> prioritizedContentFields;

  37.     /*
  38.      * Defines the keyword fields to be used for semantic ranking, captions,
  39.      * highlights, and answers. For the best result, the selected fields should
  40.      * contain a list of keywords. The order of the fields in the array
  41.      * represents their priority. Fields with lower priority may get truncated
  42.      * if the content is long.
  43.      */
  44.     @JsonProperty(value = "prioritizedKeywordsFields")
  45.     private List<SemanticField> prioritizedKeywordsFields;

  47.     /**
  48.      * Get the titleField property: Defines the title field to be used for semantic ranking, captions, highlights, and
  49.      * answers. If you don't have a title field in your index, leave this blank.
  50.      *
  51.      * @return the titleField value.
  52.      */
  53.     public SemanticField getTitleField() {
  54.         return this.titleField;
  55.     }

  57.     /**
  58.      * Set the titleField property: Defines the title field to be used for semantic ranking, captions, highlights, and
  59.      * answers. If you don't have a title field in your index, leave this blank.
  60.      *
  61.      * @param titleField the titleField value to set.
  62.      * @return the PrioritizedFields object itself.
  63.      */
  64.     public PrioritizedFields setTitleField(SemanticField titleField) {
  65.         this.titleField = titleField;
  66.         return this;
  67.     }

  69.     /**
  70.      * Get the prioritizedContentFields property: Defines the content fields to be used for semantic ranking, captions,
  71.      * highlights, and answers. For the best result, the selected fields should contain text in natural language form.
  72.      * The order of the fields in the array represents their priority. Fields with lower priority may get truncated if
  73.      * the content is long.
  74.      *
  75.      * @return the prioritizedContentFields value.
  76.      */
  77.     public List<SemanticField> getPrioritizedContentFields() {
  78.         return this.prioritizedContentFields;
  79.     }

  81.     /**
  82.      * Set the prioritizedContentFields property: Defines the content fields to be used for semantic ranking, captions,
  83.      * highlights, and answers. For the best result, the selected fields should contain text in natural language form.
  84.      * The order of the fields in the array represents their priority. Fields with lower priority may get truncated if
  85.      * the content is long.
  86.      *
  87.      * @param prioritizedContentFields the prioritizedContentFields value to set.
  88.      * @return the PrioritizedFields object itself.
  89.      */
  90.     public PrioritizedFields setPrioritizedContentFields(List<SemanticField> prioritizedContentFields) {
  91.         this.prioritizedContentFields = prioritizedContentFields;
  92.         return this;
  93.     }

  95.     /**
  96.      * Get the prioritizedKeywordsFields property: Defines the keyword fields to be used for semantic ranking, captions,
  97.      * highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of
  98.      * the fields in the array represents their priority. Fields with lower priority may get truncated if the content is
  99.      * long.
  100.      *
  101.      * @return the prioritizedKeywordsFields value.
  102.      */
  103.     public List<SemanticField> getPrioritizedKeywordsFields() {
  104.         return this.prioritizedKeywordsFields;
  105.     }

  107.     /**
  108.      * Set the prioritizedKeywordsFields property: Defines the keyword fields to be used for semantic ranking, captions,
  109.      * highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of
  110.      * the fields in the array represents their priority. Fields with lower priority may get truncated if the content is
  111.      * long.
  112.      *
  113.      * @param prioritizedKeywordsFields the prioritizedKeywordsFields value to set.
  114.      * @return the PrioritizedFields object itself.
  115.      */
  116.     public PrioritizedFields setPrioritizedKeywordsFields(List<SemanticField> prioritizedKeywordsFields) {
  117.         this.prioritizedKeywordsFields = prioritizedKeywordsFields;
  118.         return this;
  119.     }
  120. }
Created with JaCoCo 0.8.7.202105040129