Package com.azure.ai.textanalytics.models

Class ExtractSummaryAction

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

  • Constructor Details

    • ExtractSummaryAction

      public ExtractSummaryAction()

  • Method Details

    • getActionName

      public String getActionName()
      Get the name of action.
      Returns:
      the name of action.

    • setActionName

      public ExtractSummaryAction setActionName(String actionName)
      Set the custom name for the action.
      Parameters:
      actionName - the custom name for the action.
      Returns:
      The ExtractSummaryAction object itself.

    • getModelVersion

      public String getModelVersion()
      Gets the version of the text analytics model used by this operation.
      Returns:
      The model version.

    • setModelVersion

      public ExtractSummaryAction setModelVersion(String modelVersion)
      Set 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.
      Parameters:
      modelVersion - The model version.
      Returns:
      The ExtractSummaryAction object itself.

    • isServiceLogsDisabled

      public boolean isServiceLogsDisabled()
      Gets the value of disableServiceLogs.
      Returns:
      The value of disableServiceLogs. The default value of this property is 'false'. 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.

    • setServiceLogsDisabled

      public ExtractSummaryAction setServiceLogsDisabled(boolean disableServiceLogs)
      Sets the value of disableServiceLogs.
      Parameters:
      disableServiceLogs - The default value of this property is 'false'. 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 ExtractSummaryAction 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 ExtractSummaryAction 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 ExtractSummaryAction object itself.

    • getOrderBy

      public SummarySentencesOrder 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 ExtractSummaryAction setOrderBy(SummarySentencesOrder orderBy)
      Sets the order in which the summary sentences will be presented by. Defaults to SummarySentencesOrder.OFFSET if not specified.
      Parameters:
      orderBy - The type of summary sentences order. Defaults to SummarySentencesOrder.OFFSET if not specified.
      Returns:
      The ExtractSummaryAction object itself.