Confirm a tag

Confirm a tag

Path Parameters

• project_id integer required

  ID of the project

• correction_id integer required

  ID of the correction session

• document_id integer required

  ID of the document

• segment_id integer required

  ID of the segment

• tag_id integer required

  ID of the tag

application/json

Request Body required

• status string required

  Possible values: [READY, CORRECTING]

  Tag is either ready to be used or in correction

Responses

• 200
• 401
• 403
• 404
• 409
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• segment object

  Contains either a date, if segment is confirmed, or null

  annotated date-time

  When the segment was confirmed.

• predicted_score integer

  The projected new score

• progress integer

  The progress of the session

• tag object

  Representation of a tag for classlabel tasks

  class string

  The class's name.

  label string

  The label's name.

{
  "segment": {
    "annotated": "2023-11-02"
  },
  "predicted_score": 0,
  "progress": 98,
  "tag": {
    "class": "Comfort",
    "label": "POS"
  }
}

User is not authenticated. This means token is either not present or invalid

User is read-only or does not have the minimal required project role "ANNOTATOR"

The correction session, the document, the segment or the project was not found

Invalid action. Check the returned error for more information.

Something is wrong with the API.

Loading...