If no errors occurred, the message contains `"OK"`. If errors occurred, then the message contains the error description.

Identifier submitted by the caller to track their own requests, returned if and as it was provided.

Current status of the requested job. `"pending"` denotes that the job is still pending, and `"success"` denotes that the job has completed.

Kensho announced the release of NERD in 2021....The LEGO Group posted earnings in August....Nairobi was the top destination....the AU made the decision...

Knowledge bases to disambiguate to, e.g., `["capiq"]`, `["wikimedia"]`, or `["capiq", "wikimedia"]`.

Specifies the Capital IQ ID of the company issuing the source document. For example, the company whose earnings call transcript or 10K filing is passed through NERD would be the originating entity for that document. Used only when submitting documents for linking to the Capital IQ knowledge base. If there isn't an appropriate originating entity for a document, such as in the case of a news article, simply enter `"0"` or omit the field.

Optional identifier submitted by the caller to track their own requests. If provided, it is returned in the response as it was submitted.

Whether to tag people on a CapIQ request. Requires access to people tagging.

Ending offset of the entity mention in the source document.

Identifier in the chosen knowledge base of the entity that this span was linked to. If no link was found (but the model determined that this span is an entity), this field is returned null.

Name in the chosen knowledge base of the entity that this span was linked to. If no link was found (but the model determined that this span is an entity), this field is returned null.

Predicted entity type in the chosen knowledge base of the entity that this span was linked to. If no link was found (but the model determined that this span is an entity), this field is returned null. Entities linked to the Capital IQ knowledge base will always be of type "ORG" (organization). Entities linked to the Wikimedia knowledge base may be of several types, including "PERSON", "COMPANY", "NGO", and "GOVERNMENT". Wikimedia does not publish entity types, so for Wikimedia annotated entities, this field is merely a prediction and should not be taken as ground truth.

Score the denotes the NERD model's confidence in the link between the entity mention and the entry in the knowledge base (i.e., the entity_kb_id). If no link was found (but the model determined that this span is an entity), this field is returned null.

Score that denotes how confident the NERD model is that the span’s text refers to an entity.

Predicted entity type for the text span corresponding to this annotation. This field is independent of both `entity_type` and `entity_kb_id` and denotes the type of entity that the NERD model predicted for the text span. The value of this field is always "ORG" for Capital IQ NERD and one of {"EVENT", "FAC", "GPE", "LAW", "LOC", "NORP", "ORG", "PERSON", "PRODUCT", "WORK_OF_ART"} for Wikimedia NERD.

Starting offset of the entity mention in the source document text.

Text of the entity mention identified by NERD.

kensho_nerd_token

This page contains the full API reference for Kensho NERD.

NERD Service API

This endpoint deletes the results of a NERD annotations job. The endpoint expects the `job_id` to be specified as the query parameter. The response contains a status and message

Job identifier used to obtain the annotations. Corresponds to the `job_id` returned from a POST request to the async annotations endpoint.

job_id

Indicates the request was successfully received and processed. Annotated data is returned in the response.

Indicates a bad request due to a missing or invalid `job_id`

Indicates that the authentication information is missing or invalid.

Indicates that the authorization information is missing or invalid.

Indicates that the job was not found in the system.

Indicates that the job is pending and therefore cannot be deleted.

Indicates that user request rate has been exceeded.

Indicates that an unexpected error occurred and should be further investigated.

Delete annotations for the specified `job_id`

This endpoint returns the results of a NERD annotations job. The endpoint expects the `job_id` to be specified as the query parameter. The response contains a status, message, and the annotation results.

Indicates a bad request due to 1) missing knowledge base; 2) missing document text; or 3) missing `job_id`.

Indicates that user rate has been exceeded.

Get annotations for the specified `job_id`

Submit a document to NERD to kick off an annotation job that will be processed asynchronously. Endpoint users submit a text document and at least one knowledge base to be used to annotate the detected entities. There are two available knowledge bases, the Wikimedia knowledge base and the Capital IQ knowledge base, denoted `"wikimedia"` and `"capiq"`, respectively.

Indicates the job request was successfully received. `job_id` is returned in the response.

Indicates a bad request because at least one knowledge base and document text must be specified.

This endpoint allows users to submit a text document and at least one knowledge base to be used to annotate the detected entities. There are two available knowledge bases, the Wikimedia knowledge base and the Capital IQ knowledge base, denoted `"wikimedia"` and `"capiq"`, respectively.

Indicates a bad request because no knowledge base or document text was specified.

Annotate named entities for the specifed text

Returns information about the authenticated user.

Indicates that user information was successfully obtained and returned.

Indicates that an invalid authorization occurred or that user data was not found.