Listing all available text analytics models and entity types
Use the D_pxTopicsInModel, D_pxTopicsInTextAnalyzer and D_pxListModelsInTextAnalyzerByType API to list all available text analytics models, and the D_pzEntityTypesInTextAnalyzer and D_pzGetEntityTypesForModel APIs to list all available entity types.
D_pxTopicsInModel
The D_pxTopicsInModel API produces a data page with a list of Text Analyzer topics per language. If you save this data page, you can also use it to update the topic list.
This API has the following input properties:
D_pxTopicsInModel API input properties
| Parameter | Description |
| Purpose | The purpose of the text analyzer. |
| AppliesTo | The applicable class of the text analyzer. |
| Languages | A comma-separated list of languages. If left empty, the API provides the list of all topics in all languages in the model. |
The following list provides the output model of the D_pxTopicsInModel API:
- pxTopics(ENGLISH) {DataNLP-Taxonomy}
- pxResults(1) {Data-NLP-TaxonomyRule}
- pyCategory
- pyName
- pyTopicDisplayName
- pxResults(1)
{data-NLP-TaxonomyRule}
- pyCategory
- pyName
- pyTopicDisplayName
- pyShouldWords (If present)
- pyNotWords (If present)
- pyAndWords (If present)
- pxResults(1) …
- pxResults(1)
{data-NLP-TaxonomyRule}
- pxResults(1) {Data-NLP-TaxonomyRule}
When you invoke the data page with the list of parameters, a tree structure lists the available topics at the language level. To update a topic value, edit the data page and save it. If you leave the Languages parameter empty, then the API lists all the languages available in the model. If the text analyzer is in a blocked ruleset, then that text analyzer is saved in the next available ruleset.
D_pxTopicsInTextAnalyzer
The D_pxTopicsInTextAnalyzer API provides a list of all topics in the text analyzer.
This API has the following input properties:
D_pxTopicsInTextAnalyzer API input properties
| Parameter | Description |
| Purpose | The purpose of the text analyzer. |
| AppliesTo | The applicable class of the text analyzer. |
The D_pxTopicsInTextAnalyzer API returns a Page List property that contains a list of text analyzer models and their types.
D_pxListModelsInTextAnalyzerByType
The D_pxListModelsInTextAnalyzerByType API lists all models in a text analyzer in a Page List property.
This API has the following input properties:
D_pxListModelsInTextAnalyzerByType API input properties
| Parameter | Description |
| Purpose | The purpose of the text analyzer. |
| AppliesTo | The applicable class of the text analyzer. |
D_pzEntityTypesInTextAnalyzer
Use the D_pzEntityTypesInTextAnalyzer API to list the entity types in a text analyzer. The output of this entity is a Page List property that contains all of the configured entity types in a text analyzer.
This API has the following input properties:
D_pzEntityTypesInTextAnalyzer API input properties
| Parameter | Description |
| Purpose | The purpose of the text analyzer. |
| ClassName | The applicable class of the text analyzer. |
D_pzGetEntityTypesForModel
Use the D_pzGetEntityTypesForModel API to list the entity types in a model. The output of this entity is a Page List property that contains entity types from all languages in a model.
This API has the following input properties:
D_pzGetEntityTypesForModel API input properties
| Parameter | Description |
| ModelName | The model name. |
| ModelClass | The applicable class of the model. |
Previous topic Returning model analysis and specifying the repository for model training data Next topic Managing business changes