Get Label

GEThttps://api.confident-ai.com/v2/classifiers/{classifierId}/labels/{labelId}

Retrieves a single label on a classifier, with the description the classifying model matches against and the polarity trend reporting uses. Requires the Starter plan or above.

GET/v2/classifiers/{classifierId}/labels/{labelId}

curl -X GET "https://api.confident-ai.com/v2/classifiers/{classifierId}/labels/{labelId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "id": "<CLASSIFIER-LABEL-ID>",
    "name": "Positive",
    "description": "User expresses satisfaction, gratitude, or positive sentiment.",
    "enabled": true,
    "status": "RECOMMENDED",
    "polarity": "HIGHER_IS_BETTER"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/workflows",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

classifierIdstringRequired
The id of the classifier the label belongs to.
labelIdstringRequired
The id of the label.

Response

Get Label succeeded.

successboolean
Indicates if the request was successful.
dataobject
One label a classifier can apply to what it classifies.
Show 6 propertiesHide 6 properties
- idstring
  The id of the label, generated by Confident AI.
- namestring
  The name of the label, unique within the classifier.
- descriptionstring
  When this label applies. This is the instruction the classifying model reads, so it states the condition rather than restating the name.
- enabledboolean
  Whether the label can be applied.
- statusenum
  ACTIVE labels are in use; RECOMMENDED ones are generated suggestions awaiting review.
  Show 2 enum valuesHide 2 enum values
  - RECOMMENDED
  - ACTIVE
- polarityenum
  Whether more of a signal is good, bad, or neither, for trend reporting.
  Show 3 enum valuesHide 3 enum values
  - HIGHER_IS_BETTER
  - LOWER_IS_BETTER
  - NEUTRAL
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI