Skip to content
Voicebot

Classify a phrase against one version

POST
/v1/adapters/ids/classifier/{id}/version/{version}/classify
curl --request POST \
  --url https://example.com/v1/adapters/ids/classifier/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/version/1/classify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "phrase": "example" }'

Classifies a phrase using the trained artefact of the addressed version, so a caller that pinned a version keeps getting that version’s behavior while another version is being trained. Classification is bound to a short deadline; exceeding it yields 504, a client cancellation 499.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Classifier id (UUID).

version
required
integer

Classifier version. Version 0 is the one every classifier created before versioning occupies.

Header Parameters

Section titled “Header Parameters”
X-Account-Sid
string

Target account for principals broader than one account (tenant / account API key); account-scoped principals use their own.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
phrase
required
string
Examplegenerated
{
  "phrase": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
intents
required
object
key
additional properties
number format: float
Examplegenerated
{
  "intents": {
    "additionalProperty": 1
  }
}

400

Section titled “400”

Bad request

Media typeapplication/json
object
name
required
string
message
required
string
code
required
integer
status
required
integer
Examplegenerated
{
  "name": "example",
  "message": "example",
  "code": 1,
  "status": 1
}

401

Section titled “401”

Unauthorized

403

Section titled “403”

Forbidden

404

Section titled “404”

Not found

Media typeapplication/json
object
name
required
string
message
required
string
code
required
integer
status
required
integer
Examplegenerated
{
  "name": "example",
  "message": "example",
  "code": 1,
  "status": 1
}

500

Section titled “500”

Internal server error

Media typeapplication/json
object
name
required
string
message
required
string
code
required
integer
status
required
integer
Examplegenerated
{
  "name": "example",
  "message": "example",
  "code": 1,
  "status": 1
}

502

Section titled “502”

Bad gateway (upstream adapter error)

504

Section titled “504”

Classification deadline exceeded

Media typeapplication/json
object
name
required
string
message
required
string
code
required
integer
status
required
integer
Examplegenerated
{
  "name": "example",
  "message": "example",
  "code": 1,
  "status": 1
}