Skip to main content
POST
/
ai
/
prediction
/
classification
/
{MODEL_ID}
Classification use case
import requests

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

payload = {
    "batch": [{ "text": "Not all those who wander are lost." }],
    "useCaseConfig": { "labels": ["Harry Potter", "Lord of the Rings"] }
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)
{
  "predictions": [
    {
      "tokensUsed": {
        "inputTokens": 10,
        "labelsTokens": 26
      },
      "labels": {
        "Lord of the Rings": 0.40380859375,
        "Harry Potter": 0.3681640625
      },
      "response": "Lord of the Rings: 0.40, Harry Potter: 0.37"
    }
  ]
}

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
UseCaseConfigClassification · object

Response

200 - application/json

OK

The response is of type object.