Skip to main content

Change a document group.​

Path Parameters
  • project_id integer required

    ID of the project

  • group_id integer required

    ID of the document group

Request Body required
  • name string

    The document group's name.

  • document_ids integer[]

    IDs of documents that should be added to the group

  • documents object[]

    Documents that should be added to the group

  • created date-time
  • document_count integer

    Total of documents

  • id integer

    The ID of the document group.

  • name string

    The document group's name.

  • project_id integer

    The ID of the project that the document group belongs to.

  • source string

    Possible values: [ANALYSIS, UPLOAD, ANNOTATIONS]

    The source of the documents for that group

  • status string

    Possible values: [PROCESSING, CREATED, DELETING, FAILED]

    The document group's status.

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...