v1

latestOpenAPI 3.0.32026-07-2659199427.5 KB

Create predictions

Named Entity Recognition (NER) use case

In the Named Entity Recognition (NER) use case, the LLM ingests text and entities to extract and return a JSON response that contains a list of entities extracted from the text. No options can be configured.

This use case can be used to extract nouns and proper nouns such as Brand, Date, Company, Places, and Category in order to guide and refine searches.

The POST request obtains and indexes prediction information related to the specified use case, and returns a unique predictionId and status of the request. The predictionId can be used later in the GET request to retrieve the results.

post/ai/async-prediction/ner/{MODEL_ID}

Headers

Authorizationstring required

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

Content-Typestring

Example:application/json

application/json

Request body

Example request

{
  "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": {
    "vectorQuantizationMethod": "min-max",
    "dimReductionSize": 256
  }
}

Response

chunkingIdstring uuid

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

statusstring

The current status of the request. Allowed values are:

SUBMITTED - The POST request was successful and the response has returned the chunkingId 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 chunkingId are available and ready to be retrieved.
RETRIEVED - The results associated with the chunkingId are returned successfully when the GET request was sent.

Example response

{
  "chunkingId": "441eb3be-7de6-470a-8141-e416a15c7db1",
  "status": "SUBMITTED"
}