AFaffinda
Annotations

Create a annotation

Changed on

Create a annotation

post/v3/annotations

Request

Request body

documentstring required

Unique identifier for the document

pageIndexinteger nullable required

The page number within the document, starting from 0.

dataPointstring

Data point's identifier

fieldstring nullable

Field's identifier

rawstring nullable

Raw data extracted from the before any post-processing

isClientVerifiedboolean

Indicates whether the data has been validated by a human

parentinteger nullable

The parent annotation's ID

Example request

{
  "rectangles": [
    {
      "pageIndex": 1,
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32
    }
  ],
  "validationResults": [
    {
      "created": [
        {
          "id": 1,
          "annotations": [
            1,
            2,
            3
          ],
          "passed": true,
          "ruleSlug": "supplier-name-is-alphanumeric",
          "message": "Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*"
        }
      ],
      "updated": [
        {
          "id": 1,
          "annotations": [
            1,
            2,
            3
          ],
          "passed": true,
          "ruleSlug": "supplier-name-is-alphanumeric",
          "message": "Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*"
        }
      ],
      "deleted": [
        {
          "id": 1,
          "annotations": [
            1,
            2,
            3
          ],
          "passed": true,
          "ruleSlug": "supplier-name-is-alphanumeric",
          "message": "Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*"
        }
      ]
    }
  ]
}

Response

Successfully created a annotation.

idinteger required

Annotation's ID

documentstring required

Unique identifier for the document

pageIndexinteger nullable required

The page number within the document, starting from 0.

rawstring nullable required

Raw data extracted from the before any post-processing

confidencenumber nullable required

The overall confidence that the model's prediction is correct

classificationConfidencenumber nullable required

The model's confidence that the text has been classified correctly

textExtractionConfidencenumber nullable required

If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model

isVerifiedboolean required

Indicates whether the data has been validated, either by a human using our validation tool or through auto-validation rules

isClientVerifiedboolean required

Indicates whether the data has been validated by a human

isAutoVerifiedboolean required

Indicates whether the data has been auto-validated

dataPointstring

Data point's identifier

fieldstring nullable

Field's identifier

contentType'text' | 'integer' | 'float' | 'decimal' | 'date' | 'datetime' | 'daterange' | 'boolean' | 'enum' | 'location' | 'phonenumber' | 'json' | 'table' | 'expectedremuneration' | 'jobtitle' | 'language' | 'skill' | 'yearsexperience' | 'group' | 'table_deprecated' | 'url' | 'image' | 'docclf' required

The different data types of annotations

parentinteger nullable

The parent annotation's ID

Example response

{
  "id": 1,
  "rectangle": {
    "pageIndex": 1,
    "x0": 2.43,
    "y0": 4.55,
    "x1": 4.56,
    "y1": 6.32
  },
  "rectangles": [
    {
      "pageIndex": 1,
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32
    }
  ],
  "confidence": 0.86,
  "classificationConfidence": 0.95,
  "textExtractionConfidence": 0.9,
  "validationResults": [
    {
      "id": 1,
      "annotations": [
        1,
        2,
        3
      ],
      "passed": true,
      "ruleSlug": "supplier-name-is-alphanumeric",
      "message": "Expected 'ThisInputShouldMatch' to match regex pattern '[0-9]*"
    }
  ]
}

Changes

  • 978cf99a2ac0Revision changes
    • info

      api tag Annotations added

    • info

      api tag Document API - Annotation removed

  • 0913ed9391cbRevision changes
    • breaking

      the response property //// became optional for the status

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the optional property //// to the response with the status