Package com.azure.ai.textanalytics.models

Class ExtractiveSummaryOptions

java.lang.Object
com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions
com.azure.ai.textanalytics.models.ExtractiveSummaryOptions
public final class ExtractiveSummaryOptions extends TextAnalyticsRequestOptions
Configurations that allow callers to specify details about how to execute an extractive summarization in a set of documents.

  • Constructor Details

    • ExtractiveSummaryOptions

      public ExtractiveSummaryOptions()
      Constructs a ExtractiveSummaryOptions model.

  • Method Details

    • setModelVersion

      public ExtractiveSummaryOptions setModelVersion(String modelVersion)
      Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". If a model-version is not specified, the API will default to the latest, non-preview version.
      Overrides:
      setModelVersion in class TextAnalyticsRequestOptions
      Parameters:
      modelVersion - The model version.
      Returns:
      The ExtractiveSummaryOptions object itself.

    • setIncludeStatistics

      public ExtractiveSummaryOptions setIncludeStatistics(boolean includeStatistics)
      Sets the value of includeStatistics. The default value is false by default. If set to true, indicates that the service should return document and document batch statistics with the results of the operation.
      Overrides:
      setIncludeStatistics in class TextAnalyticsRequestOptions
      Parameters:
      includeStatistics - If a boolean value was specified in the request this field will contain information about the document payload.
      Returns:
      The ExtractiveSummaryOptions object itself.

    • setServiceLogsDisabled

      public ExtractiveSummaryOptions setServiceLogsDisabled(boolean disableServiceLogs)
      Sets the value of service logs disable status.
      Overrides:
      setServiceLogsDisabled in class TextAnalyticsRequestOptions
      Parameters:
      disableServiceLogs - The default value of this property is 'false', except for methods like 'beginAnalyzeHealthcareEntities' and 'recognizePiiEntities'. This means, Text Analytics service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this property to true, disables input logging and may limit our ability to investigate issues that occur.
      Returns:
      The ExtractiveSummaryOptions object itself.

    • getDisplayName

      public String getDisplayName()
      Gets display name of the operation.
      Returns:
      Display name of the operation.

    • setDisplayName

      public ExtractiveSummaryOptions setDisplayName(String displayName)
      Sets display name of the operation.
      Parameters:
      displayName - Display name of the operation.
      Returns:
      The ExtractiveSummaryOptions object itself.

    • getMaxSentenceCount

      public Integer getMaxSentenceCount()
      Gets the maximum extractive summarization sentences number to be returned in the response. If 'null' or not specified, a default value of 3 will be used as the maximum sentences number in the service side.
      Returns:
      The maximum extractive summarization sentences number to be returned in the response.

    • setMaxSentenceCount

      public ExtractiveSummaryOptions setMaxSentenceCount(Integer maxSentenceCount)
      Sets the maximum extractive summarization sentences number to be returned in the response. If 'null' or not specified, a default value of 3 will be used as the maximum sentences number in the service side.
      Parameters:
      maxSentenceCount - The maximum extractive summarization sentences number to be returned in the response.
      Returns:
      The ExtractiveSummaryOptions object itself.

    • getOrderBy

      public ExtractiveSummarySentencesOrder getOrderBy()
      Gets the order in which the summary sentences will be presented by.
      Returns:
      The order in which the summary sentences will be presented by.

    • setOrderBy

      public ExtractiveSummaryOptions setOrderBy(ExtractiveSummarySentencesOrder orderBy)
      Sets the order in which the summary sentences will be presented by. Defaults to ExtractiveSummarySentencesOrder.OFFSET if not specified.
      Parameters:
      orderBy - The type of summary sentences order. Defaults to ExtractiveSummarySentencesOrder.OFFSET if not specified.
      Returns:
      The ExtractiveSummaryOptions object itself.