The output contains information about the status of the request and the categories extracted. The information provided is the same for the different output formats and the naming convention used for all fields is lowercase_separated_by_underscore.
These are the fields included in the response document.
Name | Description |
---|---|
status |
Contains information about the extraction process and whether it has finished successfully. It is formed by a status code ( You can find all the possible status codes returned by the API with an explanation and tips on how to manage them in our error codes catalog. A request is any HTTP request done to the API to analyze less than 125 words. If the text sent is longer than that, then it will be considered that more than a request is made, more specifically, as many requests as we would need if the text were divided in chunks of 125 words. For instance, an HTTP request with 1013 words, will count as nine requests, so 9 credits will be consumed; an HTTP request with a text 25648 words long would count as 25648/125 = 205.184 => 206 credits, and so on. Did you know...?Only the successful requests to the API will consume credits. In other words, the |
category_list |
List of categories in which the input text is classified. Each category (
|
The format in which this information will be shown will be in JSON.
"@AskCiti it's been almost 3 months since I requested account change of ownership and I have heard nothing from you guys."
{ status: { code: "0", msg: "OK", credits: "1", remaining_credits: "1179999" }, category_list: [ { code: "Quality>SpeedAgility", label: "Speed and agility", abs_relevance: "2", relevance: "100" }, { code: "Company>Citibank", label: "Citibank", abs_relevance: "1", relevance: "100" }, { code: "CustomerService>AccessibilityCommunication", label: "Accessibility and communication", abs_relevance: "1", relevance: "100" }, { code: "Operation>Participants", label: "Participants", abs_relevance: "1", relevance: "100" }, { code: "Satisfaction>Negative", label: "Negative", abs_relevance: "1", relevance: "100" } ] }