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

Response

The output contains information about the status of the request and it divides the text into fragments indicating the reputation associated to the different relevant entities (in this case, organizations and people) detected in each fragment. To do that, it will indicate in which category (or categories) or dimmension/s the fragment is classified according a reputation model for business — that is, which categories affect the reputation of the set of detected entities — and the sentiment associated to each entity in those categories. Information about irony and subjectivity is obtained too.

The information provided is the same for the different output formats and the naming convention used for all fields is lowercase_separated_by_underscore.

Sample response:

{
    "status": {
        "code": "0",
        "msg": "OK",
        "credits": "0"
    },
    "fragment_list": [
        {
            "text": "Apple lanza el 'mayor adelanto' en la historia del iPhone: http://bit.ly/1tHYVgY",
            "inip": "0",
            "endp": "79",
            "info_list": [
                {
                    "entity": "Apple",
                    "type": "Top>Organization>Company>TechnologyCompany",
                    "category": "Innovación y flexibilidad - Innovación",
                    "relevance": "100",
                    "sentiment": "P+",
                    "subjectivity": "OBJECTIVE",
                    "irony": "NONIRONIC"
                }
            ]
        }
    ],
    "category_list": [
        {
            "category": "Innovación y flexibilidad - Innovación"
        }
    ],
    "entity_list": [
        {
            "entity": "Apple",
            "type": "Top>Organization>Company>TechnologyCompany"
        }
    ]
}

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.
fragment_list

List of fragments in which the text is divided. Each fragment is represented by an element fragment.

fragment_list[].inipInitial position of the fragment, starting from 0.
fragment_list[].endpEnd position of the fragment.
fragment_list[].info_listDetailed information from the fragment listed by entity and category. Each piece of information contains the following fields:
fragment_list[].info_list.entityMain form of the entity.
fragment_list[].info_list.typeType classification hierarchy of the entity.
fragment_list[].info_list.categoryMain form of the category in which the input text is classified.
fragment_list[].info_list.relevanceRelative relevance value of the category, represented by a number in the 0-100% range, and computed with respect to the top ranked result.
fragment_list[].info_list.sentiment

This value will provide the sentiment analysis associated to the entity in the category. If no entities are found, this value will represent the sentiment in that fragment. If no categories are found, this value will represent the sentiment regardless of the category.

Possible values for this field are the following tags:

  • P+: strong positive
  • P: positive
  • NEU: neutral
  • N: negative
  • N+: strong negative
  • NONE: no sentiment found
fragment_list[].info_list.subjectivity

This field marks the subjectivity of the fragment it refers to. It has two possible values:

  • OBJECTIVE: the text does not have any subjectivity marks
  • SUBJECTIVE: the text has subjective marks
fragment_list[].info_list.irony

This field indicates the irony of the fragment it refers to. It has two possible values:

  • NONIRONIC: the text does not have ironic marks
  • SUBJECTIVE: the text has ironic marks
category_list

List of categories in which the input text is classified. Each category contains the a field category, with its main form.

entity_list

List of entities of type organization or person, identified in the text. Each one will be represented by an element entity, which will contain the following fields:

entity_list[].entityMain form of the entity.
entity_list[].typeType classification hierarchy of the entity.