Standalone query rewriter

import requests

url = "https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}"

payload = {
    "batch": [{ "text": "Is it a framework?" }],
    "useCaseConfig": { "memoryUuid": "d253039f-6a19-4a75-bfef-4f2347e71ccb" }
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

HttpResponse<String> response = Unirest.post("https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"batch\": [\n    {\n      \"text\": \"Is it a framework?\"\n    }\n  ],\n  \"useCaseConfig\": {\n    \"memoryUuid\": \"d253039f-6a19-4a75-bfef-4f2347e71ccb\"\n  }\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    batch: [{text: 'Is it a framework?'}],
    useCaseConfig: {memoryUuid: 'd253039f-6a19-4a75-bfef-4f2347e71ccb'}
  })
};

fetch('https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"batch\": [\n    {\n      \"text\": \"Is it a framework?\"\n    }\n  ],\n  \"useCaseConfig\": {\n    \"memoryUuid\": \"d253039f-6a19-4a75-bfef-4f2347e71ccb\"\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}"

	payload := strings.NewReader("{\n  \"batch\": [\n    {\n      \"text\": \"Is it a framework?\"\n    }\n  ],\n  \"useCaseConfig\": {\n    \"memoryUuid\": \"d253039f-6a19-4a75-bfef-4f2347e71ccb\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'batch' => [
        [
                'text' => 'Is it a framework?'
        ]
    ],
    'useCaseConfig' => [
        'memoryUuid' => 'd253039f-6a19-4a75-bfef-4f2347e71ccb'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

curl --request POST \
  --url https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "batch": [
    {
      "text": "Is it a framework?"
    }
  ],
  "useCaseConfig": {
    "memoryUuid": "d253039f-6a19-4a75-bfef-4f2347e71ccb"
  }
}
'

{
  "predictionId": "632781ce-0fbd-49c3-96bf-12e1cb90379d",
  "status": "SUBMITTED"
}

{
  "predictionId": "fd110486-f168-47c0-a419-1518a4840589",
  "status": "READY",
  "message": "<string>"
}

POST

async-prediction

standalone-query-rewriter

{MODEL_ID}

Standalone query rewriter

import requests

url = "https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}"

payload = {
    "batch": [{ "text": "Is it a framework?" }],
    "useCaseConfig": { "memoryUuid": "d253039f-6a19-4a75-bfef-4f2347e71ccb" }
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

HttpResponse<String> response = Unirest.post("https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"batch\": [\n    {\n      \"text\": \"Is it a framework?\"\n    }\n  ],\n  \"useCaseConfig\": {\n    \"memoryUuid\": \"d253039f-6a19-4a75-bfef-4f2347e71ccb\"\n  }\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    batch: [{text: 'Is it a framework?'}],
    useCaseConfig: {memoryUuid: 'd253039f-6a19-4a75-bfef-4f2347e71ccb'}
  })
};

fetch('https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"batch\": [\n    {\n      \"text\": \"Is it a framework?\"\n    }\n  ],\n  \"useCaseConfig\": {\n    \"memoryUuid\": \"d253039f-6a19-4a75-bfef-4f2347e71ccb\"\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}"

	payload := strings.NewReader("{\n  \"batch\": [\n    {\n      \"text\": \"Is it a framework?\"\n    }\n  ],\n  \"useCaseConfig\": {\n    \"memoryUuid\": \"d253039f-6a19-4a75-bfef-4f2347e71ccb\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'batch' => [
        [
                'text' => 'Is it a framework?'
        ]
    ],
    'useCaseConfig' => [
        'memoryUuid' => 'd253039f-6a19-4a75-bfef-4f2347e71ccb'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

curl --request POST \
  --url https://{APPLICATION_ID}.applications.lucidworks.com/ai/async-prediction/standalone-query-rewriter/{MODEL_ID} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "batch": [
    {
      "text": "Is it a framework?"
    }
  ],
  "useCaseConfig": {
    "memoryUuid": "d253039f-6a19-4a75-bfef-4f2347e71ccb"
  }
}
'

{
  "predictionId": "632781ce-0fbd-49c3-96bf-12e1cb90379d",
  "status": "SUBMITTED"
}

{
  "predictionId": "fd110486-f168-47c0-a419-1518a4840589",
  "status": "READY",
  "message": "<string>"
}

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

Show child attributes

useCaseConfig

UseCaseConfigStandalone · object

Show child attributes

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.

Show child attributes

Response

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"

Authentication

Async Chunking

Async Prediction

Commerce Studio Rules & Rewrites

Platform Signals

Prediction

Prompt Preview

Tokenization

Use Case

Typeahead

Standalone query rewriter

Headers

Path Parameters

Body

Response