Extracts entities from a document and links them to a knowledge base. | Babel Street

curl -X POST https://analytics.babelstreet.com/rest/v1/entities \
     -H "X-BabelStreetAPI-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "content": "The Securities and Exchange Commission today announced the leadership of the agency’s trial unit.  Bridget Fitzpatrick has been named Chief Litigation Counsel of the SEC and David Gottesman will continue to serve as the agency’s Deputy Chief Litigation Counsel. Since December 2016, Ms. Fitzpatrick and Mr. Gottesman have served as Co-Acting Chief Litigation Counsel.  In that role, they were jointly responsible for supervising the trial unit at the agency’s Washington D.C. headquarters as well as coordinating with litigators in the SEC’s 11 regional offices around the country."
}'

{
  "entitiesResponse": [
    {
      "type": "string",
      "mention": "string",
      "normalized": "string",
      "count": 1,
      "mentionOffsets": [
        {
          "startOffset": 1,
          "endOffset": 1
        }
      ],
      "entityId": "string",
      "confidence": 1.1,
      "linkingConfidence": 1.1,
      "DPediaTypes": [
        {
          "DPpediaType": "string"
        }
      ],
      "permId": "string",
      "salience": 1.1
    }
  ]
}

Returns each entity extracted from the input. The response is a list of extracted entities. Each entity includes an entityId (Wikidata QID or temporary ID), mention (entity text in the input), normalized text (complete form of the entity in the input), the count (number of mentions of entity in the input), the salience [optional] (floating point number 0.0 or 1.0), the confidence [optional] (floating point number between 0 and 1), the linking confidence [optional] (floating point number between 0 and 1), and the PermID [optional] (ID to PermID knowledge base).

Authentication

X-BabelStreetAPI-Keystring

API Key authentication via header

X-RosetteAPI-Keystring

API Key authentication via header

Query parameters

outputstringOptional

When set to Rosette, output is ADM format. Required to see entity mentions from indoc coref.

Request

This endpoint expects an object.

languagestringOptional

3 letter code of language.

optionsobjectOptional

Response

entitiesResponselist of objectsOptional

list of extracted entities