Package software.amazon.awscdk.services.kendra

Class CfnIndex.RelevanceProperty.Builder

java.lang.Object
software.amazon.awscdk.services.kendra.CfnIndex.RelevanceProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIndex.RelevanceProperty>
Enclosing interface:
CfnIndex.RelevanceProperty
@Stability(Stable) public static final class CfnIndex.RelevanceProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnIndex.RelevanceProperty>
A builder for CfnIndex.RelevanceProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • duration

      @Stability(Stable) public CfnIndex.RelevanceProperty.Builder duration(String duration)
      Sets the value of CfnIndex.RelevanceProperty.getDuration()
      Parameters:
      duration - Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.

      Only applies to DATE fields.

      Returns:
      this

    • freshness

      @Stability(Stable) public CfnIndex.RelevanceProperty.Builder freshness(Boolean freshness)
      Sets the value of CfnIndex.RelevanceProperty.getFreshness()
      Parameters:
      freshness - Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. Only applies to DATE fields.
      Returns:
      this

    • freshness

      @Stability(Stable) public CfnIndex.RelevanceProperty.Builder freshness(IResolvable freshness)
      Sets the value of CfnIndex.RelevanceProperty.getFreshness()
      Parameters:
      freshness - Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. Only applies to DATE fields.
      Returns:
      this

    • importance

      @Stability(Stable) public CfnIndex.RelevanceProperty.Builder importance(Number importance)
      Sets the value of CfnIndex.RelevanceProperty.getImportance()
      Parameters:
      importance - The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
      Returns:
      this

    • rankOrder

      @Stability(Stable) public CfnIndex.RelevanceProperty.Builder rankOrder(String rankOrder)
      Sets the value of CfnIndex.RelevanceProperty.getRankOrder()
      Parameters:
      rankOrder - Determines how values should be interpreted. When the RankOrder field is ASCENDING , higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

      When the RankOrder field is DESCENDING , lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

      Only applies to LONG fields.

      Returns:
      this

    • valueImportanceItems

      @Stability(Stable) public CfnIndex.RelevanceProperty.Builder valueImportanceItems(IResolvable valueImportanceItems)
      Sets the value of CfnIndex.RelevanceProperty.getValueImportanceItems()
      Parameters:
      valueImportanceItems - An array of key-value pairs for different boosts when they appear in the search result list. For example, if you want to boost query terms that match the "department" field in the result, query terms that match this field are boosted in the result. You can add entries from the department field to boost documents with those values higher.

      For example, you can add entries to the map with names of departments. If you add "HR", 5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document.

      Returns:
      this

    • valueImportanceItems

      @Stability(Stable) public CfnIndex.RelevanceProperty.Builder valueImportanceItems(List<? extends Object> valueImportanceItems)
      Sets the value of CfnIndex.RelevanceProperty.getValueImportanceItems()
      Parameters:
      valueImportanceItems - An array of key-value pairs for different boosts when they appear in the search result list. For example, if you want to boost query terms that match the "department" field in the result, query terms that match this field are boosted in the result. You can add entries from the department field to boost documents with those values higher.

      For example, you can add entries to the map with names of departments. If you add "HR", 5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document.

      Returns:
      this

    • build

      @Stability(Stable) public CfnIndex.RelevanceProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnIndex.RelevanceProperty>
      Returns:
      a new instance of CfnIndex.RelevanceProperty
      Throws:
      NullPointerException - if any required attribute was not provided