Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SentimentAnalysisBatchAction

Package version

Options for a sentiment analysis batch action.

Hierarchy

Index

Properties

Optional actionName

actionName: undefined | string

The name of the action.

Optional disableServiceLogs

disableServiceLogs: undefined | false | true

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.

Optional includeOpinionMining

includeOpinionMining: undefined | false | true

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, SentenceSentiment.opinions will contain the results of this analysis. See the service documentation for more information.

kind

kind: "SentimentAnalysis"

The kind of the action.

Optional modelVersion

modelVersion: undefined | string

The version of the model to be used by the action.

Optional stringIndexType

stringIndexType: 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".

Generated using TypeDoc