Create a Batch Analysis

Create a new Batch Analysis by providing the necessary information to analyze the documents. Optionally, you can also provide a file_id and column if you want to create the analysis using a previously uploaded file.

application/json

Request Body required

documents object[]
List of documents of the analysis.
text string
The document text
id integer
The ID of the document.
name string
Name of the analysis.
file_id uuid
Id of file that belongs of to the analysis.
column integer
The index of the column of the file that should be used as source to the analysis.
column_name string
Name of the column of the file or property that contains data to be analyzed.
split boolean
Whether documents should be split into sentences.
header_first boolean
Whether the first line should be used as the file header.

Responses

Analysis was created

application/json

Schema
Example (from schema)

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.

{
  "created": "2023-11-02",
  "finished": "2023-11-02",
  "document_count": 100,
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "id": 1,
  "name": "This is my first analysis",
  "progress": 87.7,
  "model_id": 10,
  "status": "CREATED",
  "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"
            }
          ]
        }
      ]
    }
  ]
}

Create a Batch Analysis​

Create a Batch Analysis