POST Batches/analyze
Start the analysis of a Batch.
The Batch must contain at least one respondent.
This method adds the data in the Batch to the Inspection, and starts text analysis of the specified variables.
Request Information
URI Parameters
None.
Body Parameters
The parameters for beginning text analysis of the Batch.
AnalyzeBatchRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| AnalysisLanguageCode |
The language to be used for text analysis. If the variables specified for analysis are not in this language, they will be translated to this language before text analysis is performed. The value of this field must be one of the language codes returned by a query to the Languages resource, e.g. "en". |
string |
Required |
| VariablesToAnalyze |
The ID's of the variables in the batch that should be processed by the text analytics engine. This variable may not be null or empty, and each of the items in the collection must be found among the variables in the batch. |
Collection of string |
Required |
| BatchKey |
The Batch key. |
integer |
Required |
| InspectionKey |
The Inspection key. |
integer |
Required |
| RuleSetKey |
The key for the RuleSet to apply to the analysis |
integer |
None. |
| TaxonomyKey |
The key for the Taxonomy to be applied to the analysis. If not specified or NULL, it will use AutoGrouping. |
integer |
None. |
Response Information
Start the analysis of a Batch.
The Batch must contain at least one respondent.
This method adds the data in the Batch to the Inspection, and starts text analysis of the specified variables.
| Name | Description | Type | Additional information |
|---|---|---|---|
| InspectionKey |
The key of the Inspection. |
integer |
Required |
| BatchKey |
The key of the Batch. |
integer |
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. |