NameDescriptionTypeAdditional information
analysisLanguageId

The language ID of the analysis, one of the language identifiers obtained by querying the Languages resource.
This is the language that will be used for text analytics.

string

Required
sentimentProcessorVersion

The version of the sentiment processor to use.
If this value is 2, the second generation sentiment processor is used.
If null or a value other than 2, the first generation sentiment processor is used.

integer

None.
commentLanguageId

Optional. The language ID of the submitted comments, one of the language identifiers obtained by querying the Languages/translate resource.
If provided and the analysisLanguageId differs from this value, the comments will be translated from this language to the language specified by analysisLanguageId.

string

None.
ruleSetKey

Optional. The key of the rule set to apply to the analysis.
If specified, must be one of the keys returned by querying the RuleSets resource.

integer

None.
taxonomyKey

Optional. The key of the taxonomy to use to group Topics.
If specified, must be one of the taxonomy keys returned by querying the Taxonomies resource.

integer

None.
noTopicAnalysis

If true no topic analysis will be performed. Topic analysis typically requires more time than sentiment analysis.

boolean

None.
syntheticTopics

If true, topics will be created for comments in which no topic was found.

boolean

None.
noSentimentAnalysis

If true no sentiment analysis will be performed.

boolean

None.
transactionTrackingId

Optional. The key of a study which will be used for tracking transactions.

string

Max length: 30
comments

The comments to analyze.

Collection of Comment

Required