Knowledge Graph

KG entities bulk

Generate keywords and context for multiple Entities. To use as input to the analyze/dataset/bulk route request.

POST
https://api.textreveal.com/api/2.0/kg/entities/bulk

Request

Request Body

  • entities_idsstring[]
    Example: ["apple"]
  • properties_liststring[]

    The properties to look for in the KG.

    If source is corporate_kg, defaults to [ "chief_executive_officer", "domain", "founders", "legal_name", "subsidiaries", "ticker" ]

    If source is general_kg, defaults to the full list of properties corresponding to the entity provided.

    Example: ["chief_executive_officer"]
  • sourcestring (enum)

    The knowledge graph source.

    Default: "corporate_kg"Values: "general_kg", "corporate_kg"
  • uuidboolean

    Whether to return company uuid or not.

    Default: falseExample: false
  • uuidsuuid[]

    Array of companies uuids to look for.

    Example: ["923e84d9-f307-0b5e-c8f8-2696b7c4a320"]
Request
{
  "entities_ids": [
    "apple",
    "sesamm"
  ],
  "language": "english",
  "properties_list": [
    "chief_executive_officer",
    "domain",
    "founders",
    "legal_name",
    "subsidiaries",
    "ticker"
  ],
  "source": "corporate_kg",
  "uuids": []
}

Response

Response - 200

Entities Bulk Response

  • entitiesobject[]
  • not_foundstring[]
    Example: []
Response
{
  "entities": [
    {
      "context": "Apple is a technology company that designs, manufactures, and markets consumer electronics, personal computers, and software.",
      "entity_of_interest": "apple",
      "keywords": [
        "FileMaker",
        "Apple",
        "Braeburn Capital",
        "AC Wellness",
        "Ron Wayne",
        "Tim Cook",
        "Steve Jobs",
        "AAPL",
        "Steve Wozniak",
        "Apple Inc.",
        "David Pakman",
        "Apple Computer",
        "apple.com"
      ]
    },
    {
      "context": "SESAMm is a fintech company that specializes in big data and artificial intelligence for investment.",
      "entity_of_interest": "sesamm",
      "keywords": [
        "Sylvain Forté",
        "Pierre Rinaldi",
        "Florian Aubry",
        "SESAMm",
        "SESAMm SAS",
        "sesamm.com"
      ]
    }
  ],
  "not_found": []
}