POST
/
ai
/
async-prediction
/
ner
/
{MODEL_ID}
Named Entity Recognition (NER) use case
curl --request POST \
  --url https://application_id.applications.lucidworks.com/ai/async-prediction/ner/{MODEL_ID} \
  --header 'Content-Type: application/json' \
  --data '{
  "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": {
      "entity": [
        "example1, example2"
      ]
    }
  },
  "modelConfig": {
    "temperature": 0.8,
    "topP": 1,
    "topK": -1,
    "presencePenalty": 2,
    "frequencyPenalty": 1,
    "maxTokens": 1,
    "apiKey": "API key specific to use case and model",
    "azureDeployment": "DEPLOYMENT_NAME",
    "azureEndpoint": "https://azure.endpoint.com",
    "googleProjectId": "[GOOGLE_PROJECT_ID]",
    "googleRegion": "[GOOGLE_PROJECT_REGION_OF_MODEL_ACCESS]"
  }
}'
{
  "predictionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "SUBMITTED"
}

Headers

Authorization: Bearer ACCESS_TOKEN
string

The authentication and authorization access token.

Content-Type
string

application/json

Example:

"application/json"

Path Parameters

MODEL_ID
string
required

Unique identifier for the model.

Example:

"6a092bd4-5098-466c-94aa-40bf6829430\""

Body

application/json

Response

200
application/json

OK

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