SentimentAnalysisBatchAction interface
Options for a sentiment analysis batch action.
- Extends
Properties
kind | The kind of the action. |
Inherited Properties
action |
The name of the action. |
disable |
If set to true, you opt-out of having your text input logged for troubleshooting. By default, Cognitive Language Service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true, disables in logging and may limit our ability to remediate issues that occur. Default is false. |
include |
Enables performing opinion mining on the input documents, a more granular analysis around the aspects of a product or service (also known as aspect-based sentiment analysis). If set to true, opinions will contain the results of this analysis. See the service documentation for more information. |
model |
The version of the model to be used by the action. |
string |
Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see KnownStringIndexType. The default is the JavaScript's default which is "Utf16CodeUnit". |
Property Details
kind
The kind of the action.
kind: "SentimentAnalysis"
Property Value
"SentimentAnalysis"
Inherited Property Details
actionName
The name of the action.
actionName?: string
Property Value
string
Inherited From AnalyzeBatchActionCommon.actionName
disableServiceLogs
If set to true, you opt-out of having your text input logged for troubleshooting. By default, Cognitive Language Service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true, disables in logging and may limit our ability to remediate issues that occur.
Default is false.
disableServiceLogs?: boolean
Property Value
boolean
Inherited From SentimentAnalysisAction.disableServiceLogs
includeOpinionMining
Enables performing opinion mining on the input documents, a more granular analysis around the aspects of a product or service (also known as aspect-based sentiment analysis). If set to true, opinions will contain the results of this analysis. See the service documentation for more information.
includeOpinionMining?: boolean
Property Value
boolean
Inherited From SentimentAnalysisAction.includeOpinionMining
modelVersion
The version of the model to be used by the action.
modelVersion?: string
Property Value
string
Inherited From SentimentAnalysisAction.modelVersion
stringIndexType
Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see KnownStringIndexType.
The default is the JavaScript's default which is "Utf16CodeUnit".
stringIndexType?: string
Property Value
string
Inherited From SentimentAnalysisAction.stringIndexType
Azure SDK for JavaScript