Adding model feedback
Use the pxCaptureTAFeedback, pxUpdateModels and pxCopyNLPFeedback to provide feedback to text analytics models.
pxCaptureTAFeedback
Use the pxCaptureTAFeedback API to capture and store feedback data for a text analytics model. The output of the API is the ID number of the feedback record that is stored for the specified model.
This API has the following input properties:
pxCaptureTAFeedback API input properties
| Parameter | Description |
| ModelName | The name of the new model. |
| ClassName | The applicable class of the model. |
| ModelType | Available values:
|
| Language | The language of the model. |
| Text | Feedback text. Use this field for text extraction analysis. Paste annotated text with both the corrected and previously correct entities. |
| ActualResult | The expected category assignment of the analyzed text. Use this field for intent, sentiment, and topic detection. |
| MachineOutcome | The prediction that the model made. |
| TASummaryID | The ID number of the summary, if enabled. |
| FeedbackID | This value returns an ID of the feedback record. |
| IsTest | Marks if the feedback record is for test purposes. If true, the model does not include the record in the feedback. Available values:
|
pxUpdateModels
Use the pxUpdateModels API to retrain a model with the recorded feedback. The API outputs the operation status, and a status message if the operation fails.
This API has the following input properties:
pxUpdateModels API input properties
| Parameter | Description |
| Purpose | The purpose of the text analyzer. |
| AppliesTo | The applicable class of the text analyzer. |
| ClassName | The applicable class of the model. |
| Language | The model language. |
| Status | Returns the operation status. |
| StatusMsg | Returns the error message if the operation fails. |
pxCopyNLPFeedback
Use the pxCopyNLPFeedback API to feedback records between models in the same system.
This API has the following input properties:
pxCopyNLPFeedback API input properties
| Parameter | Description |
| SourceModelName | The name of the model that is the source of feedback data. |
| SourceAppliesToClass | The applicable class of the source model. |
| SourceRuleSet | The ruleset of the source model. |
| TargetModelName | The name of the model to which you want to copy the feedback data. |
| TargetAppliesToClass | The applicable class of the model to which you want to copy the feedback data. |
| TargetRuleSet | The ruleset of the model to which you want to copy the feedback data. |
Previous topic Adding and deleting languages from models Next topic Creating new models