List all documents from a labeling session

List all documents from a labeling session.

Path Parameters

project_id integer required
ID of the project
annotation_id integer required
ID of the session

Query Parameters

details string
Possible values: [segments, meta, tags]
Which details should return. Values might be any combination of 'segments', 'meta' and 'tags'.
- segments: Show segments of a document
- meta: Show all the additional attributes that were originally given as the document was uploaded
- tags: Show tags of a document
offset integer
An offset is simply the number of records you wish to skip before selecting records.
limit integer
Limit of entries that should be returned.

Responses

All documents of a labeling session

application/json

Schema
Example (from schema)

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 object[]
All classes that belong to the session
name string
The class's name.
example string
A usage example.
description string
The class's description to help the annotator.
id integer
The ID of the label
labels object[]
All labels that belong to the session
id integer
The ID of the label
name string
The label's name.
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.

{
  "created": "2023-11-02",
  "finished": "2023-11-02",
  "document_count": 100,
  "document_group_id": 87,
  "organization_id": 1,
  "user_id": 1,
  "project_id": 1,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": 120,
  "name": "This is my first labeling session",
  "progress": 87.7,
  "model_id": 10,
  "status": "CREATED",
  "mode": "ANNOTATION",
  "type": "ABSA",
  "description": "string",
  "classes": [
    {
      "name": "Comfort",
      "example": "This is a good example",
      "description": "This is a good description",
      "id": 1
    }
  ],
  "labels": [
    {
      "id": 1,
      "name": "POS"
    }
  ],
  "documents": [
    {
      "text": "Document 1",
      "segments": [
        {
          "text": "Segment 1",
          "span": [
            0,
            9
          ],
          "tags": [
            {
              "class": "Comfort",
              "label": "POS"
            }
          ]
        }
      ]
    }
  ]
}

List all documents from a labeling session​

List all documents from a labeling session