Skip to main content

Update a labeling session​

Update a labeling session

Path Parameters
  • project_id integer required

    ID of the project

  • annotation_id integer required

    ID of the labeling session to changed

Request Body required
  • name string

    Name of the labeling session

  • document_ids integer[]
  • documents object[]
  • text string

    The document text

  • segments object[]

    list of segments

  • text string

    The segment text

  • span integer[]

    The interval at which the segment occurs in the original document

  • tags object[]

    A list of tags

  • class string

    The class's name.

  • label string

    The label's name.

  • classes string[]

    Classes contained in that session.

  • labels string[]

    Labels contained in that session.

Responses

Session was changed

Schema
  • created date-time

    When the session was started.

  • finished date-time

    When the session was finished.

  • document_count integer

    Total of documents

  • document_group_id integer

    ID of the document group related to the session, if any

  • organization_id integer

    ID of the organization to which the session belongs.

  • user_id integer

    ID of the user to which the session belongs.

  • project_id integer

    ID of the project to which the session belongs.

  • uuid uuid

    The unique ID of the session.

  • id integer

    The ID of the session.

  • name string

    The session's name.

  • progress float

    The session's progress.

  • model_id integer

    The ID of the model used by that session. This property only makes sense for correction sessions

  • status string

    Possible values: [CREATED, STARTED, ANNOTATING, FAILED, FINISHED, SAMPLING, PREDICTING, DELETING]

    The session's status.

  • mode string

    Possible values: [ANNOTATION, CORRECTION]

    The session's mode.

  • type string

    Possible values: [ABSA, CLASS, LABEL, CLASSLABEL]

    The session's classification type.

  • description string

    The session's description.

  • classes string[]

    All classes that belong to the session

  • labels string[]

    All labels that belong to the session

Loading...