Skip to main content

Retrieve an analysis

Retrieve an Analysis.

Path Parameters
  • analysis_id integer required

    ID of the analysis_id to get

Responses

OK


Schema
  • created date-time

    The date and time the analysis was started

  • finished date-time

    The date and time the analysis has finished.

  • document_count integer

    Total of documents

  • uuid uuid

    The UUID of the analysis.

  • id integer

    The ID of the analysis.

  • name string

    The name of the analysis.

  • progress float

    The progress of the analysis.

  • model_id integer

    The ID of the model used by that analysis.

  • status string

    Possible values: [CREATED, QUEUED, STARTED, ANALYZING, FAILED, FINISHED]

    The status of the analysis.

  • type string

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

    The classification type of the analysis.

  • description string

    The description of the analysis.

  • classes object[]

    All classes that belong to the analysis.

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

  • id integer

    The ID of the label

  • name string

    The label's name.

  • documents object[]

    List of documents of the analysis.

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

Loading...