Skip to content
Voicebot

Save classifier content

PUT
/v1/adapters/ids/classifier/{id}
curl --request PUT \
  --url https://example.com/v1/adapters/ids/classifier/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "model_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "description": "example", "intent": { "intents": [ { "id": "example", "description": "example", "phrase": { "phrases": [ "example" ] } } ] } }'

Records the supplied training-relevant content as the next version of the classifier and queues training for it (201). Content identical to a version the classifier already holds resolves to that version instead and trains nothing (200), which is what keeps a publish from triggering a mass retrain. Recorded versions are immutable, so this never alters an existing one. Queueing is never refused, however much an account already has waiting: training capacity is shared out when a run starts, not here.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Classifier id (UUID).

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

Training-relevant content of a classifier.

object
model_id
required
string format: uuid
description
string
<= 1024 characters
intent
required
object
intents
required
Array<object>
object
id
required
string
<= 36 characters
description
string
<= 1024 characters
phrase
required
object
phrases
required
Array<string>
>= 1 items
Examplegenerated
{
  "model_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "description": "example",
  "intent": {
    "intents": [
      {
        "id": "example",
        "description": "example",
        "phrase": {
          "phrases": [
            "example"
          ]
        }
      }
    ]
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Content resolved to a version the classifier already holds

Media typeapplication/json

One immutable version of a classifier, addressed by the account, the classifier id and the version number.

object
id
required
string
version
required

Version number. 0 is an ordinary version like any other — the first one a classifier gets, and the one existing scenario bricks name.

integer
account_sid
required
string
model_id
required
string
description
required
string
intent
required
object
intents
required
Array<object>
object
id
required
string
<= 36 characters
description
string
<= 1024 characters
phrase
required
object
phrases
required
Array<string>
>= 1 items
content_hash
required

Identity of this version’s training-relevant content. Two versions of one classifier can never carry the same value; it is what lets identical content resolve to an existing version instead of training again.

string
state
required
string
Allowed values: new training fail success unknown
training

Why the last training run of this version ended as it did. Present on a single-version read; absent from list entries.

object
error

Why the last training run failed. Absent unless it failed.

string
created_at

When the training run was queued. Absent if none was ever queued.

string format: date-time
updated_at

When the training run last changed state. Absent if none was ever queued.

string format: date-time
Example
{
  "state": "new"
}

201

Section titled “201”

Version recorded and queued for training

Media typeapplication/json

One immutable version of a classifier, addressed by the account, the classifier id and the version number.

object
id
required
string
version
required

Version number. 0 is an ordinary version like any other — the first one a classifier gets, and the one existing scenario bricks name.

integer
account_sid
required
string
model_id
required
string
description
required
string
intent
required
object
intents
required
Array<object>
object
id
required
string
<= 36 characters
description
string
<= 1024 characters
phrase
required
object
phrases
required
Array<string>
>= 1 items
content_hash
required

Identity of this version’s training-relevant content. Two versions of one classifier can never carry the same value; it is what lets identical content resolve to an existing version instead of training again.

string
state
required
string
Allowed values: new training fail success unknown
training

Why the last training run of this version ended as it did. Present on a single-version read; absent from list entries.

object
error

Why the last training run failed. Absent unless it failed.

string
created_at

When the training run was queued. Absent if none was ever queued.

string format: date-time
updated_at

When the training run last changed state. Absent if none was ever queued.

string format: date-time
Example
{
  "state": "new"
}

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
}

409

Section titled “409”

Concurrent writers kept taking the version this save was going to record. The save is safe to repeat.

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)