Skip to main content
POST
/
ai
/
async-prediction
/
summarization
/
{MODEL_ID}
Summarization use case
curl --request POST \
  --url https://application_id.applications.lucidworks.com/ai/async-prediction/summarization/{MODEL_ID} \
  --header 'Content-Type: application/json' \
  --data '{
  "batch": [
    {
      "text": "Nearly ten years had passed since the Dursleys had woken up to find their nephew on the front step, but Privet Drive had hardly changed at all. The sun rose on the same tidy front gardens and lit up the brass number four on the Dursleys'\'''\'''\'' front door; it crept into their living room, which was almost exactly the same as it had been on the night when Mr. Dursley had seen that fateful news report about the owls. Only the photographs on the mantelpiece really showed how much time had passed. Ten years ago, there had been lots of pictures of what looked like a large pink beach ball wearing different-colored bonnets - but Dudley Dursley was no longer a baby, and now the photographs showed a large blond boy riding his first bicycle, on a carousel at the fair, playing a computer game with his father, being hugged and kissed by his mother. The room held no sign at all that another boy lived in the house, too."
    }
  ],
  "useCaseConfig": {
    "maxWords": 100
  },
  "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
batch
object[]

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

Maximum length: 32
useCaseConfig
object
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"

I