POST Analyze

Analyze comments as a synchronous operation.
The comments will be analyzed and the results returned in the response message.
Neither the comments nor the text analytics results are persisted on the Ascribe servers.
You may optionally specify a Rule Set to provide your own processing logic, and/or a Taxonomy to group topics.
If you do not specify a Taxonomy the topics will be automatically grouped, but this is effective only if the number of topics found is fairly large. Hence the auto grouping is useful only if you submit a large number of comments to analyze, or a smaller number of lengthly comments.

Request Information

URI Parameters

None.

Body Parameters

The comments to analyze.

SynchronousAnalyzeRequest

Name	Description	Type	Additional 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

Response Information

SynchronousAnalyzeResponse

Name	Description	Type	Additional information
milliseconds	Processing time in milliseconds.	integer	Required
analysisLanguageId	The ID of the language used for text analysis.	string	Required
sentimentProcessorVersion	The version of the sentiment processor used for text analysis. 1 = original sentiment processor, 2 = second generation sentiment processor.	integer	Required
commentLanguageId	The ID of the language of the submitted comments. If this field is not null and differs from the analysisLanguageId, the comments have been translated from this language to the language specified by analysisLanguageId.	string	None.
ruleSetKey	The key of the rule set to applied to the analysis.	integer	None.
taxonomyKey	The key of the taxonomy used to group Topics.	integer	None.
commentFindings	The comments that produced text analytics findings. The order of CommentFindings in this array is not necessarily the order in the request.	Collection of CommentFindings	Required
errors	If null the request was processed without error. If not null errors occurred while processing the request. The array contains the error messages.	Collection of string	None.