Retrieve Classifier Label

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

Retrieves a single label on a classifier. Requires the Starter plan or above.

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

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

200

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

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

classifierIdstringRequired
The unique identifier of the classifier.
labelIdstringRequired
The unique identifier of the label.

Response

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- labelobject
  One label a classifier can apply.
  Show 6 propertiesHide 6 properties
  - idstring
    The unique identifier of the label.
  - namestring
    The label's name.
  - descriptionstring
    When this label applies. This is the instruction the classifying model reads, so it should describe the condition rather than restate 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 this label is good, bad, or neither, for trend reporting.
    Show 3 enum valuesHide 3 enum values
    HIGHER_IS_BETTER
    LOWER_IS_BETTER
    NEUTRAL
linkstring
A link to the workflows page.

Built byConfident AI