140 строки
12 KiB
YAML
140 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions"
|
|
fullName: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions"
|
|
name: "AbstractiveSummaryOptions"
|
|
nameWithType: "AbstractiveSummaryOptions"
|
|
summary: "Configurations that allow callers to specify details about how to execute an abstractive summarization in a set of documents."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions?alt=com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions&text=TextAnalyticsRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.getModelVersion()?alt=com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.getModelVersion&text=getModelVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.isIncludeStatistics()?alt=com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.isIncludeStatistics&text=isIncludeStatistics\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.isServiceLogsDisabled()?alt=com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.isServiceLogsDisabled&text=isServiceLogsDisabled\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.setIncludeStatistics(boolean)?alt=com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.setIncludeStatistics&text=setIncludeStatistics\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.setModelVersion(java.lang.String)?alt=com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.setModelVersion&text=setModelVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.setServiceLogsDisabled(boolean)?alt=com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.setServiceLogsDisabled&text=setServiceLogsDisabled\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **AbstractiveSummaryOptions**</br> extends <xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions?alt=com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions&text=TextAnalyticsRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.AbstractiveSummaryOptions()"
|
|
fullName: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.AbstractiveSummaryOptions()"
|
|
name: "AbstractiveSummaryOptions()"
|
|
nameWithType: "AbstractiveSummaryOptions.AbstractiveSummaryOptions()"
|
|
summary: "Constructs a `AbstractiveSummaryOptions` model."
|
|
syntax: "public AbstractiveSummaryOptions()"
|
|
desc: "Constructs a `AbstractiveSummaryOptions` model."
|
|
methods:
|
|
- uid: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.getDisplayName()"
|
|
fullName: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.getDisplayName()"
|
|
name: "getDisplayName()"
|
|
nameWithType: "AbstractiveSummaryOptions.getDisplayName()"
|
|
summary: "Gets display name of the operation."
|
|
syntax: "public String getDisplayName()"
|
|
desc: "Gets display name of the operation."
|
|
returns:
|
|
description: "Display name of the operation."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.getSentenceCount()"
|
|
fullName: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.getSentenceCount()"
|
|
name: "getSentenceCount()"
|
|
nameWithType: "AbstractiveSummaryOptions.getSentenceCount()"
|
|
summary: "Get the sentence<wbr>Count property: It controls the approximate number of sentences in the output summaries."
|
|
syntax: "public Integer getSentenceCount()"
|
|
desc: "Get the sentenceCount property: It controls the approximate number of sentences in the output summaries."
|
|
returns:
|
|
description: "the sentenceCount value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.setDisplayName(java.lang.String)"
|
|
fullName: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.setDisplayName(String displayName)"
|
|
name: "setDisplayName(String displayName)"
|
|
nameWithType: "AbstractiveSummaryOptions.setDisplayName(String displayName)"
|
|
summary: "Sets display name of the operation."
|
|
parameters:
|
|
- description: "Display name of the operation."
|
|
name: "displayName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AbstractiveSummaryOptions setDisplayName(String displayName)"
|
|
desc: "Sets display name of the operation."
|
|
returns:
|
|
description: "The <code>AbstractiveSummaryOptions</code> object itself."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.AbstractiveSummaryOptions?alt=com.azure.ai.textanalytics.models.AbstractiveSummaryOptions&text=AbstractiveSummaryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.setIncludeStatistics(boolean)"
|
|
fullName: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.setIncludeStatistics(boolean includeStatistics)"
|
|
name: "setIncludeStatistics(boolean includeStatistics)"
|
|
nameWithType: "AbstractiveSummaryOptions.setIncludeStatistics(boolean includeStatistics)"
|
|
summary: "Sets the value of `includeStatistics`."
|
|
overridden: "com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.setIncludeStatistics(boolean)"
|
|
parameters:
|
|
- description: "If a boolean value was specified in the request this field will contain\n information about the document payload."
|
|
name: "includeStatistics"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AbstractiveSummaryOptions setIncludeStatistics(boolean includeStatistics)"
|
|
desc: "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."
|
|
returns:
|
|
description: "The <code>AbstractiveSummaryOptions</code> object itself."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.AbstractiveSummaryOptions?alt=com.azure.ai.textanalytics.models.AbstractiveSummaryOptions&text=AbstractiveSummaryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.setModelVersion(java.lang.String)"
|
|
fullName: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.setModelVersion(String modelVersion)"
|
|
name: "setModelVersion(String modelVersion)"
|
|
nameWithType: "AbstractiveSummaryOptions.setModelVersion(String modelVersion)"
|
|
summary: "Sets the model version."
|
|
overridden: "com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.setModelVersion(java.lang.String)"
|
|
parameters:
|
|
- description: "The model version."
|
|
name: "modelVersion"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AbstractiveSummaryOptions setModelVersion(String modelVersion)"
|
|
desc: "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."
|
|
returns:
|
|
description: "The <code>AbstractiveSummaryOptions</code> object itself."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.AbstractiveSummaryOptions?alt=com.azure.ai.textanalytics.models.AbstractiveSummaryOptions&text=AbstractiveSummaryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.setSentenceCount(java.lang.Integer)"
|
|
fullName: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.setSentenceCount(Integer sentenceCount)"
|
|
name: "setSentenceCount(Integer sentenceCount)"
|
|
nameWithType: "AbstractiveSummaryOptions.setSentenceCount(Integer sentenceCount)"
|
|
summary: "Set the sentence<wbr>Count property: It controls the approximate number of sentences in the output summaries."
|
|
parameters:
|
|
- description: "the sentenceCount value to set."
|
|
name: "sentenceCount"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public AbstractiveSummaryOptions setSentenceCount(Integer sentenceCount)"
|
|
desc: "Set the sentenceCount property: It controls the approximate number of sentences in the output summaries."
|
|
returns:
|
|
description: "The <code>AbstractiveSummaryOptions</code> object itself."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.AbstractiveSummaryOptions?alt=com.azure.ai.textanalytics.models.AbstractiveSummaryOptions&text=AbstractiveSummaryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.setServiceLogsDisabled(boolean)"
|
|
fullName: "com.azure.ai.textanalytics.models.AbstractiveSummaryOptions.setServiceLogsDisabled(boolean disableServiceLogs)"
|
|
name: "setServiceLogsDisabled(boolean disableServiceLogs)"
|
|
nameWithType: "AbstractiveSummaryOptions.setServiceLogsDisabled(boolean disableServiceLogs)"
|
|
summary: "Sets the value of service logs disable status."
|
|
overridden: "com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions.setServiceLogsDisabled(boolean)"
|
|
parameters:
|
|
- description: "The default value of this property is 'false', except for methods like\n 'beginAnalyzeHealthcareEntities' and 'recognizePiiEntities'. This means, Text Analytics service logs\n your input text for 48 hours, solely to allow for troubleshooting issues. Setting this property to true,\n disables input logging and may limit our ability to investigate issues that occur."
|
|
name: "disableServiceLogs"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AbstractiveSummaryOptions setServiceLogsDisabled(boolean disableServiceLogs)"
|
|
desc: "Sets the value of service logs disable status."
|
|
returns:
|
|
description: "The <code>AbstractiveSummaryOptions</code> object itself."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.AbstractiveSummaryOptions?alt=com.azure.ai.textanalytics.models.AbstractiveSummaryOptions&text=AbstractiveSummaryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Configurations that allow callers to specify details about how to execute an abstractive summarization in a set of documents."
|
|
metadata: {}
|
|
package: "com.azure.ai.textanalytics.models"
|
|
artifact: com.azure:azure-ai-textanalytics:5.5.3
|