DocumentReader-web-openapi/rt-text-data.yml at develop · regulaforensics/DocumentReader-web-openapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
openapi: 3.0.4
components:
  schemas:
    DocVisualExtendedInfoItem:
      title: "DocVisualExtendedInfoItem"
      type: object
      required:
        - DocVisualExtendedInfo
      properties:
        DocVisualExtendedInfo:
          $ref: "#/components/schemas/DocVisualExtendedInfo"

    DocVisualExtendedInfo:
      title: "DocVisualExtendedInfo"
      type: object
      description: "Container for extracted text fields. Fields are identified by type and language"
      required:
        - nFields
        - pArrayFields
      properties:
        nFields:
          description: "Number of pArrayFields array elements"
          type: number
        pArrayFields:
          type: array
          items:
            $ref: "#/components/schemas/DocVisualExtendedField"

    DocVisualExtendedField:
      title: "DocVisualExtendedField"
      type: object
      allOf:
        - $ref: "./common.yml#/components/schemas/VisualExtendedFieldItem"
        - $ref: "#/components/schemas/DocVisualExtendedFieldItem"

    DocVisualExtendedFieldItem:
      title: "DocVisualExtendedFieldItem"
      type: object
      required:
        - FieldRect
      properties:
        FieldRect: # Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.
          $ref: "./common.yml#/components/schemas/RectangleCoordinates"