Response

Sample response:

@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"
}
"category_list":[
0:{
"code":
"Quality>SpeedAgility"
"label":
"Speed and agility"
"abs_relevance":
"2"
"relevance":
"100"
}
1:{
"code":
"CustomerService>AccessibilityCommunication"
"label":
"Accessibility and communication"
"abs_relevance":
"1"
"relevance":
"100"
}
2:{
"code":
"Satisfaction>Negative"
"label":
"Negative"
"abs_relevance":
"1"
"relevance":
"100"
}
]
}

Response object:

NameDescription
statusDescribes the request outcome in terms of success or failure.
status.codeNumerical value of result code. Refer to the error code catalog.
status.msgHuman-readable error code, if any, orOK.
status.credits

Credits consumed by the request. A credit corresponds to a bucket of 500 words.

Did you know...?

Only successful requests consume credits.

status.remaining_creditsCredits left to reach the usage limit.
category_listContains list of categories in which the input text is classified.
category_list[].codecategory code
category_list[].labelcategory description
category_list[].abs_relevanceabsolute relevance value of the category. Categories will be ordered by this value.
category_list[].relevancerelative relevance value of the category, a number in the 0-100% range. It's computed with respect to the top ranked result (for generic models) and with respect to the top ranked result in the same dimension (for dimension models).
category_list[].polaritypolarity associated to the category. It will only appear in the response when the polarity parameter is enabled.
category_list[].term_listlist of the relevant terms of the category. It will only appear when the verbose parameter is enabled (and the category is triggered by terms). Each term contains the value of the term, a numeric value of how the term affects the abs_relevance of the category and a list of offsets (offset_list field), i.e. the starting and ending positions of each mention of the term within the text (inip and endp fields).
category_list[].debugcontains information that will help in debugging user defined models. It will contain a list of the rules that were triggered for the classification. It will only appear when the debug parameter is enabled and the model used is user-defined. Each rule contains the following fields:
  • rule, with the definition of the rule.
  • line, with the line of the model where the rule is located.
  • weight, with the weight assigned to the rule.
  • type, which specifies the type of rule. Currently, only expression is supported.