Skip to main content
POST
/
ai
/
async-prediction
/
ner
/
{MODEL_ID}
Named Entity Recognition (NER) use case
import requests

url = "https://application_id.applications.lucidworks.com/ai/async-prediction/ner/{MODEL_ID}"

payload = {
    "batch": [{ "text": "Mahatma Gandhi, born on October 2, 1869, in Porbandar, India, led a life that profoundly shaped the course of history. Inspired by his principles of non-violence, truth, and civil disobedience, Gandhi became a pivotal figure in India's struggle for independence from British rule. His journey began as a lawyer in South Africa, where he experienced racial discrimination and injustice, sparking his commitment to social justice. Returning to India, he became the face of the nonviolent resistance movement, employing methods like peaceful protests, fasting, and marches. The iconic Salt March of 1930 exemplified his philosophy as thousands followed him in the defiance of salt taxes imposed by the British. Gandhi's ascetic lifestyle, clad in simple attire and practicing self-sufficiency, endeared him to the masses. Despite facing imprisonment multiple times, he remained steadfast in his pursuit of India's freedom. Tragically, Gandhi was assassinated on January 30, 1948, but his legacy endures globally as a symbol of peace, tolerance, and the transformative power of nonviolent resistance" }],
    "useCaseConfig": { "entityTypeMap": { "Location": ["India", "South Africa"] } }
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "predictionId": "b90656aa-5c20-42cb-af02-358da99e34a1",
  "status": "SUBMITTED"
}

Headers

​
Authorization
string
required

Bearer token used for authentication. Format: Authorization: Bearer ACCESS_TOKEN.

​
Content-Type
string

application/json

Example:

"application/json"

Path Parameters

​
MODEL_ID
string
required

Unique identifier for the model.

Body

application/json
​
batch
object[]

The batch of key:value pairs used as inputs in the prediction. Up to 32 inputs per request are allowed.

Maximum array length: 32
​
useCaseConfig
UseCaseConfigNer · object
​
modelConfig
ModelConfig · object

Provides fields and values that specify ranges for tokens. Fields used for specific use cases and models are specified. The default values are used if other values are not specified.

Response

OK

This is the response to the POST prediction request submitted for a specific useCase and modelId.

​
predictionId
string<uuid>

The universal unique identifier (UUID) returned in the POST request. This UUID is required in the GET request to retrieve results.

​
status
string

The current status of the prediction. Allowed values are:

  • SUBMITTED - The POST request was successful and the response has returned the predictionId and status that is used by the GET request.

  • ERROR - An error was generated when the GET request was sent.

  • READY - The results associated with the predictionId are available and ready to be retrieved.

  • RETRIEVED - The results associated with the predicitonId are returned successfully when the GET request was sent.

Example:

"SUBMITTED"