API differences
APIs
Here is a brief overview of the differences in the APIs.
URL REST API
Minimalistic and simple to use. We recognized that many users are only intrested in classifying a single text at a time, therefore we have introduced an API that is as simple as possible to use. All parameters are passed in the URL (readKey and text) and the response has been stripped down to a dictionary with only the class names and probabilities.
Use case: Classify texts, passing one at a time and receive a single JSON dictionary in the response.
JSON REST API
uClassify provides a modern JSON REST API that supports all types of operations. Since the REST principle works on one resource/classififer (specified in the endpoint) it doesn't support making calls to multiple classifiers in the same request. However, you can batch multiple texts to a single classifier. For most users this is sufficient.
Use case: Classify texts, extract keywords, create and train classifiers. Batching texts to a single classifier in the same request.
XML API
The XML API was the first API that uClassify exposed back in 2008. The XML API is the core API used internally by uClassify and it supports all types of operations and allows making calls to different classifiers in the same request.
Use case: Classify texts, extract keywords, create and train classifiers. Batching texts to multiple classifiers in the same request.
API Overview
| Feature | URL REST API | JSON REST API | XML API |
|---|---|---|---|
| Free | |||
| Classify | |||
| Extract keywords | |||
| Write calls (creating and training classifiers) | |||
| Batch texts to single classifier | |||
| Batch texts to multiple classifiers | |||
| Max text size | 16 KB | 3 MB | 3 MB |