Class CaptionResult

java.lang.Object
com.azure.search.documents.models.CaptionResult

public final class CaptionResult extends Object
Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'..
  • Constructor Details

    • CaptionResult

      public CaptionResult()
  • Method Details

    • getText

      public String getText()
      Get the text property: A representative text passage extracted from the document most relevant to the search query.
      Returns:
      the text value.
    • getHighlights

      public String getHighlights()
      Get the highlights property: Same text passage as in the Text property with highlighted phrases most relevant to the query.
      Returns:
      the highlights value.
    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Get the additionalProperties property: Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'..
      Returns:
      the additionalProperties value.
    • setAdditionalProperties

      public CaptionResult setAdditionalProperties(Map<String,Object> additionalProperties)
      Set the additionalProperties property: Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'..
      Parameters:
      additionalProperties - the additionalProperties value to set.
      Returns:
      the CaptionResult object itself.