Get predictions

Part Number Detection use case

The Part Number Detection use case of the LWAI Prediction API detects part numbers in order to help with query routing and classification, and uses the embedding model to ingest text and return a JSON response of true if the input is a part number, or false if the input is not a part number.

post/ai/prediction/part-number-detection/{CUSTOM_DEPLOYMENT_ID}

Request

Base URL
https://commerce_studio_id.experiencemanager.lucidworks.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/lucidworks/apis/rules-rewrites-api/docs/ai/prediction/part-number-detection/:CUSTOM_DEPLOYMENT_ID/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

CUSTOM_DEPLOYMENT_IDstring required

Unique deployment ID for the model. This use case is only supported with a custom-trained embedding model trained with the Part Number Classification data schema option.

Headers

Authorizationstring required

Bearer token used for authentication with machinelearning.predict scope.

Request body

Example request

{
  "batch": [
    {
      "text": "54956gf-98796v"
    }
  ],
  "modelConfig": {
    "lowercaseInput": true
  }
}

Response

Example response

{
  "predictions": [
    {
      "response": "true: 0.64"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.