Skip to main content
POST
/
ai
/
async-prediction
/
keyword-extraction
/
{MODEL_ID}
Keyword extraction use case
import requests

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

payload = {
    "batch": [{ "text": "Joseph Robinette Biden Jr.is an American politician who is the 46th and current president of the United States. Ideologically a moderate member of the Democratic Party, he previously served as the 47th vice president from 2009 to 2017 under President Barack Obama and represented Delaware in the United States Senate from 1973 to 2009.Born in Scranton, Pennsylvania, Biden moved with his family to Delaware in 1953. He studied at the University of Delaware before earning his law degree from Syracuse University. He was elected to the New Castle County Council in 1970 and to the U.S. Senate in 1972. As a senator, Biden drafted and led the effort to pass the Violent Crime Control and Law Enforcement Act and the Violence Against Women Act. He also oversaw six U.S. Supreme Court confirmation hearings, including the contentious hearings for Robert Bork and Clarence Thomas. Biden ran unsuccessfully for the Democratic presidential nomination in 1988 and 2008. In 2008, Obama chose Biden as his running mate, and Biden was a close counselor to Obama during his two terms as vice president. In the 2020 presidential election, Biden and his running mate, Kamala Harris, defeated incumbents Donald Trump and Mike Pence. Biden is the second Catholic president in U.S. history (after John F. Kennedy), and his politics have been widely described as profoundly influenced by Catholic social teaching." }],
    "useCaseConfig": { "maxKeywords": 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]"
    }
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)
{
  "predictionId": "b90656aa-5c20-42cb-af02-358da99e34a1",
  "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
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
UseCaseConfigKeywordExtraction · 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 predictionId are returned successfully when the GET request was sent.

Example:

"SUBMITTED"