Package com.azure.ai.textanalytics.models

Class AbstractiveSummaryOptions

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

  • Constructor Details

    • AbstractiveSummaryOptions

      public AbstractiveSummaryOptions()
      Constructs a AbstractiveSummaryOptions model.

  • Method Details

    • setModelVersion

      public AbstractiveSummaryOptions 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 AbstractiveSummaryOptions object itself.

    • setIncludeStatistics

      public AbstractiveSummaryOptions 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 AbstractiveSummaryOptions object itself.

    • setServiceLogsDisabled

      public AbstractiveSummaryOptions 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 AbstractiveSummaryOptions object itself.

    • getDisplayName

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

    • setDisplayName

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

    • getSentenceCount

      public Integer getSentenceCount()
      Get the sentenceCount property: It controls the approximate number of sentences in the output summaries.
      Returns:
      the sentenceCount value.

    • setSentenceCount

      public AbstractiveSummaryOptions setSentenceCount(Integer sentenceCount)
      Set the sentenceCount property: It controls the approximate number of sentences in the output summaries.
      Parameters:
      sentenceCount - the sentenceCount value to set.
      Returns:
      The AbstractiveSummaryOptions object itself.