116 строки
11 KiB
YAML
116 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions"
|
|
fullName: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions"
|
|
name: "AnalyzeSentimentOptions"
|
|
nameWithType: "AnalyzeSentimentOptions"
|
|
summary: "The `AnalyzeSentimentOptions` model."
|
|
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 **AnalyzeSentimentOptions**</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.AnalyzeSentimentOptions.AnalyzeSentimentOptions()"
|
|
fullName: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.AnalyzeSentimentOptions()"
|
|
name: "AnalyzeSentimentOptions()"
|
|
nameWithType: "AnalyzeSentimentOptions.AnalyzeSentimentOptions()"
|
|
summary: "Constructs a `AnalyzeSentimentOptions` model."
|
|
syntax: "public AnalyzeSentimentOptions()"
|
|
desc: "Constructs a `AnalyzeSentimentOptions` model."
|
|
methods:
|
|
- uid: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.isIncludeOpinionMining()"
|
|
fullName: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.isIncludeOpinionMining()"
|
|
name: "isIncludeOpinionMining()"
|
|
nameWithType: "AnalyzeSentimentOptions.isIncludeOpinionMining()"
|
|
summary: "Gets the value of `includeOpinionMining`."
|
|
syntax: "public boolean isIncludeOpinionMining()"
|
|
desc: "Gets the value of `includeOpinionMining`. The boolean indicator to include opinion mining data in the returned result. If this flag is specified, you'll get a `opinions` property on SentenceSentiment. It is provided by service v3.1 and later."
|
|
returns:
|
|
description: "The value of <code>includeOpinionMining</code>."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.setIncludeOpinionMining(boolean)"
|
|
fullName: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.setIncludeOpinionMining(boolean includeOpinionMining)"
|
|
name: "setIncludeOpinionMining(boolean includeOpinionMining)"
|
|
nameWithType: "AnalyzeSentimentOptions.setIncludeOpinionMining(boolean includeOpinionMining)"
|
|
summary: "Sets the value of `includeOpinionMining`."
|
|
parameters:
|
|
- description: "The boolean indicator to include opinion mining data in the returned result."
|
|
name: "includeOpinionMining"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AnalyzeSentimentOptions setIncludeOpinionMining(boolean includeOpinionMining)"
|
|
desc: "Sets the value of `includeOpinionMining`. The boolean indicator to include opinion mining data in the returned result. If this flag is specified, you'll get a `opinions` property on SentenceSentiment. It is provided by service v3.1 and later."
|
|
returns:
|
|
description: "The <code>AnalyzeSentimentOptions</code> object itself."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.AnalyzeSentimentOptions?alt=com.azure.ai.textanalytics.models.AnalyzeSentimentOptions&text=AnalyzeSentimentOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.setIncludeStatistics(boolean)"
|
|
fullName: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.setIncludeStatistics(boolean includeStatistics)"
|
|
name: "setIncludeStatistics(boolean includeStatistics)"
|
|
nameWithType: "AnalyzeSentimentOptions.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 AnalyzeSentimentOptions 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>AnalyzeSentimentOptions</code> object itself."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.AnalyzeSentimentOptions?alt=com.azure.ai.textanalytics.models.AnalyzeSentimentOptions&text=AnalyzeSentimentOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.setModelVersion(java.lang.String)"
|
|
fullName: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.setModelVersion(String modelVersion)"
|
|
name: "setModelVersion(String modelVersion)"
|
|
nameWithType: "AnalyzeSentimentOptions.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 AnalyzeSentimentOptions 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>AnalyzeSentimentOptions</code> object itself."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.AnalyzeSentimentOptions?alt=com.azure.ai.textanalytics.models.AnalyzeSentimentOptions&text=AnalyzeSentimentOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.setServiceLogsDisabled(boolean)"
|
|
fullName: "com.azure.ai.textanalytics.models.AnalyzeSentimentOptions.setServiceLogsDisabled(boolean disableServiceLogs)"
|
|
name: "setServiceLogsDisabled(boolean disableServiceLogs)"
|
|
nameWithType: "AnalyzeSentimentOptions.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 AnalyzeSentimentOptions setServiceLogsDisabled(boolean disableServiceLogs)"
|
|
desc: "Sets the value of service logs disable status."
|
|
returns:
|
|
description: "The <code>AnalyzeSentimentOptions</code> object itself."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.AnalyzeSentimentOptions?alt=com.azure.ai.textanalytics.models.AnalyzeSentimentOptions&text=AnalyzeSentimentOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The `AnalyzeSentimentOptions` model."
|
|
metadata: {}
|
|
package: "com.azure.ai.textanalytics.models"
|
|
artifact: com.azure:azure-ai-textanalytics:5.5.1
|