Response

Sample response:

{
    "status": {
        "code": "0",
        "msg": "OK",
        "credits": "5"
    },
    "category_list": [
        {
            "code": "01021001",
            "label": "arts, culture and entertainment - entertainment (general) - entertainment award",
            "abs_relevance": "0.48236102",
            "relevance": "100"
        },
        {
            "code": "08006000",
            "label": "human interest - award and prize",
            "abs_relevance": "0.28744578",
            "relevance": "60"
        }
    ]
}

Response fields:

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.creditsCredits consumed by the request.
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
category_list[].relevancerelative relevance value of the category, a number in the 0-100% range, and computed with respect to the top ranked result
category_list[].term_listlist of the relevant terms of the category. Each term contains the value of the term and a numeric value of how the term affects the abs_relevance of the category, as well as how many times it matched in the text (abs_frequency).
category_list[].debugthis element is only available when the parameter debug is enabled, and it's only show for user classification models. It contains a list of the rules triggered in the rule-based classification with the rule as well as the weight they add.