Skip to main content
POST
/
ai
/
async-prediction
/
rag
/
{MODEL_ID}
RAG use case
import requests

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

payload = { "batch": [
        {
            "text": "Why did I go to Germany?",
            "documents": [
                {
                    "body": "I'm off to Germany to go to the Oktoberfest!",
                    "source": "http://example.com/112",
                    "title": "Off to Germany!",
                    "date": "2022-01-31T19:31:34Z"
                }
            ]
        }
    ] }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)
{
  "predictionId": "266fd643-794b-4491-a0b2-cca6b2acbb7a",
  "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
BatchRag · object[]
​
useCaseConfig
UseCaseConfigRagChat · 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"