Text Clustering API version 1.1

Do you have any questions? Write us an email or ask us through the feedback section.

Response

Sample response:

{
    "status": {
        "code": "0",
        "msg": "OK",
        "credits": "1"
    },
    "cluster_list": [
        {
            "title": "Girl",
            "size": "2",
            "score": "0.16",
            "document_list": {
                "2": "the girl",
                "3": "the girl and the giraffes"
            }
        },
        {
            "title": "Giraffe",
            "size": "2",
            "score": "0.13",
            "document_list": {
                "1": "the giraffe",
                "3": "the girl and the giraffes"
            }
        }
    ]
}

Response fields:

Name	Description
`status`	Describes the request outcome in terms of success or failure.
`status`.`code`	Numerical value of result code. Refer to the error code catalog.
`status`.`msg`	Human-readable error code, if any, or`OK`.
`status`.`credits`	Credits consumed by the request.
`status`.`remaining_credits`	Credits left to reach the usage limit.
`cluster_list`	list of cluster objects that have been detected for the set of documents sent. Each cluster, cluster, will have the following fields:
`cluster_list[]`.`title`	contains the title assigned to the cluster. If more than one term is assigned, they will be separated by commas.
`cluster_list[]`.`size`	contains the number of documents included in the cluster.
`cluster_list[]`.`score`	relevance value assigned to the cluster.
`cluster_list[]`.`document_list`	list of documents assigned to the cluster. Each document is identified by its corresponding ID. In the case where no explicit ID has been given, the ID will be the number of the position in which the text was input. That is, the ID for the first text will be 1, etc.