Introduction

This API is used to extract events of specified types and related entities from natural language text and generate structured data.

Five event types are supported, including conference, appointment, resignation, stock overweight, and stock underweight as well as related elements in financial notices.

This API is free of charge and can be called twice per second.

URI

• URI format

  POST /v1/{project_id}/nlp-fundamental/event-extraction

• Parameter description

  Table 1 URI parameters

  Parameter	Mandatory	Description
  project_id	Yes	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

Table 2 describes the request parameters.

Response

Table 3 describes the response parameters.

Example

• Example request

  POST https://{endpoint}/v1/{project_id}/nlp-fundamental/event-extraction
  
  Request Header:
      Content-Type: application/json
      X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  
  Request Body:
  {
  "text":"At the first meeting of the fifth Board of Directors of China XXX Co., Ltd. (hereinafter referred to as "the Company"), it was agreed to elect Huang XX as a member of the Audit Committee. The term of office of the Audit Committee shall be consistent with that of the current Board of Directors."
  }
  

• Example response
  • Successful example response

    {
    "events": [
              {
                 "argument": [
                         {
                          "role": "ORG",
                          "span": [0,11],
                          "word": "China XXX Co., Ltd."
                          },
                         {
                          "role": "Person",
                          "span": [40,43],
                          "word": "Huang XX"
                          },
                         {
                          "role": "Job",
                          "span": [44,51],
                          "word": "member of the Audit Committee"
                          },
                         {
                         "role": "Time-Period",
                         "span": [57,69],
                         "word": "The term of office of the Audit Committee shall be consistent with that of the current Board of Directors."
                          }
                   ],
                  "event_trigger": "elect",
                 "event_type": "Appointment",
                  "trigger_span": [36,38]
            }
        ]
    }

  • Failed example response

    {
       "error_code": "NLP.0301",
       "error_msg": "text should be between 1 to 256."
    }

Status Code

For details about status codes, see Status Code.

Error Code

For details about error codes, see Error Code.