Classify a given text array input using the LLM classifier
POST
/llm/classify-text
Request Authorization
In your request headers, pass authorization: Bearer <<token>>
.
If you're self-hosting Sombra, also add the request header x-sombra-authorization: Bearer <<sombraInternalKey>>
. You can read more about request authorization here.
Request Parameters
Header Parameters
authorization string An API key generated from the Transcend dashboard: https://app.transcend.io/infrastructure/api-keys. |
x-sombra-authorization string The Sombra internal key. This header is only needed for self-hosted Sombra gateways. See https://docs.transcend.io/docs/dsr-automation/api-integration/authentication#authenticating-to-sombra |
content-type string Specifying content-type: application/json for a JSON response from the Transcend API. |
Request Body
application/json
inputList array<string> (required) List of inputs to classify |
labels array<string> (required) The list of labels to classify against |
Request Body Example
Basic Example:
{ "inputList": [ "+141562712314", "user@gmail.com", "transcend user ID" ], "labels": [ "Personal Identifier", "Medical", "Generic Personal Information" ] }
Response
200 (OK)
application/json
Input was classified successfully. Responds with the classification result from the LLM classifier for each input.
The list of classifications for each input
Response Body Example
The result of passing in two inputs for classification:
[ [ { "type": "Personal Identifier", "confidence": 0.99, "classifierVersion": "2.0.0", "confidenceLabel": "HIGH", "classificationMethod": "TRANSCEND_LLM_CLASSIFY" }, { "type": "Generic Personal Information", "confidence": 0.5, "classifierVersion": "2.0.0", "confidenceLabel": "MEDIUM", "classificationMethod": "TRANSCEND_LLM_CLASSIFY" }, { "type": "Personal Identifier - User ID", "confidence": 0.11, "classifierVersion": "2.0.0", "confidenceLabel": "LOW", "classificationMethod": "TRANSCEND_LLM_CLASSIFY" } ], [ { "type": "Medical", "confidence": 0.96, "classifierVersion": "2.0.0", "confidenceLabel": "HIGH", "classificationMethod": "TRANSCEND_LLM_CLASSIFY" }, { "type": "Personal Identifier - User ID", "confidence": 0.97, "classifierVersion": "2.0.0", "confidenceLabel": "HIGH", "classificationMethod": "TRANSCEND_LLM_CLASSIFY" }, { "type": "Not Personal Data", "confidence": 0.8, "classifierVersion": "2.0.0", "confidenceLabel": "MEDIUM", "classificationMethod": "TRANSCEND_LLM_CLASSIFY" } ] ]
400 (Bad Request)
application/json
While this request passed authentication, the input is malformed. Please double-check that your code conforms to our API specification.
401 (Unauthorized)
application/json
There was a problem authenticating your request. This may be an issue with the Transcend API key ("authorization" header), or the Sombra API key ("x-sombra-authorization" header used for self-hosted gateways only).
409 (Conflict)
application/json
You're attempting to modify a DSR that is not in a modifiable state. For example, the DSR may have already completed, or been revoked.
413 (Request Entity Too Large)
application/json
The request body is too large. JSON and raw bodies must be less than 50MB. URL encoded bodies must be less than 30MB.
429 (Too Many Requests)
application/json
You are sending requests too quickly and have hit our rate limit. If you hit this, you'll need to throttle your request velocity or try again later.
500 (Internal Server Error)
application/json
A 5xx error means there is either an issue with your self-hosted gateway, or a Transcend server is having issues. You check our system status at status.transcend.io. Please reach out to Transcend support if you're experiencing this error.
502 (Bad Gateway)
application/json
An upstream service on Transcend's side is having issues. You check our system status at status.transcend.io. Please reach out to Transcend support if you're experiencing this error.