Microsoft Text Analytics Variables
(Available from version 7.2 onwards.)
Create Microsoft Text Analytics response variables in which to capture the response from Microsoft Text Analytics methods. Some of the properties of these variables include subtypes.
A complex variable is also needed to store your Microsoft client credentials.
For instructions on how to create a complex variable, see here.
Microsoft Text Analytics Response Variables
MS Entity Response
Stores the response provided for a single entity returned by the method MS Entity Recognition.
Properties
|
Property |
Input Type |
Description |
|---|---|---|
|
Entities |
List of MS Entity |
Information on each of the entities identified in the text |
|
Errors |
List of Text |
Errors and warnings received from MS Text Analytics |
MS Sentiment Response
Stores the response returned by the method MS Sentiment Analysis.
Properties
|
Property |
Input Type |
Description |
|---|---|---|
| Errors | List of Text | Errors and warnings received from MS Text Analytics |
| Score | Decimal | Indicates whether the sentiment of the text is positive (closer to 1) or negative (closer to 0) |
MS Key Phrase Response
Stores the response returned by the method MS Key Phrase Extraction.
Properties
|
Property |
Input Type |
Description |
|---|---|---|
|
Errors |
List of Text |
Errors and warnings received from MS Text Analytics |
|
Key Phrases |
List of Text |
List of key phrases identified in the text |
Microsoft Text Analytics Client Credential Variable
MS Client Credential
Stores the client information required when submitting a request to Microsoft Text Analytics.
Properties
|
Property |
Input Type |
Description |
|---|---|---|
| Key | Text | Your API key for the MS Text Analytics service |
| Endpoint | Text | Your end point for the MS Text Analytics service |
| Timeout | Number | After how long the request to MS Text Analytics should be timed out, in seconds |
Microsoft Text Analytics Response Variable Subtypes
MS Entity
Information on one entity identified in a text
Properties
|
Property |
Input Type |
Description |
|---|---|---|
| Entity SubType | Text | The subtype of the entity, for example Number and Currency are subtypes of Quantity |
| Entity Type | Text | The type of the entity, for example Quantity or Person |
| Match Records | List of MS Match Record | Information on each match of the entity within the text, where the entity match text might be in a different form than the main name of the entity identified |
| Name | Text | The name of the entity |
| Wikipedia ID | Text | The ID of the entity in Wikipedia |
| Wikipedia Language | Text | The language of the Wikipedia entry for the entity |
| Wikipedia URL | Text | The URL of the Wikipedia entry for the entity |
MS Match Record
Information on one match of an entity in a text
Properties
|
Property |
Input Type |
Description |
|---|---|---|
| Entity Type Score | Decimal | The level of confidence that the entity type assigned to the entity is appropriate for the entity match text |
| Length | Number | The length of the entity match text |
| Offest | Number | The zero-based character offset within the text at which the entity match text begins |
| Text | Text | The entity match text |
|
Wikipedia Score |
Decimal |
The level of confidence that the Wikipedia entry provided for the entity is relevant to the entity match text |
