Layout

抽出データのレイアウトを返します。

​

HTTP リクエスト

GET https://api-{location-id}.flexicapture.com/v2/training/layout/{taskId}/{fileId}

{location-id} をお使いのサポート対象のロケーションに置き換えてください。

​

パスパラメーター

パラメーター	型	説明
taskId	path, string	必須。タスクID。
fileId	path, string	必須。ソースファイル ID。

​

レスポンス

成功した場合、レスポンスの本文には TrainingDataViewModel のインスタンスが含まれます。

{
  "task_id": "string",
  "file_id": "string",
  "pages": [
    {
      "id": 0,
      "number": 0,
      "resolution": 0,
      "height": 0,
      "width": 0
    }
  ],
  "fields": [
    {
      "name": "string",
      "value": "string",
      "rectangles": [
        {
          "page_id": 0,
          "x1": 0,
          "y1": 0,
          "x2": 0,
          "y2": 0
        }
      ],
      "cell": {
        "table_name": "string",
        "row_number": 0,
        "column_name": "string"
      }
    }
  ],
  "tables": [
    {
      "name": "string",
      "regions": [
        {
          "rectangles": [
            {
              "page_id": 0,
              "x1": 0,
              "y1": 0,
              "x2": 0,
              "y2": 0
            }
          ],
          "columns": [
            {
              "left": 0,
              "right": 0
            }
          ],
          "horizontal_separators": [
            0
          ]
        }
      ]
    }
  ]
}

​

TrainingDataViewModel

フィールド	型	説明
task_id	string	必須。タスクID。
file_id	string	必須。ファイル ID。
pages	Array[PageViewModel]	任意。文書ページの一覧。
fields	Array[FieldViewModel]	必須。抽出されたフィールドの一覧。
tables	Array[TableViewModel]	任意。抽出されたテーブルの一覧。

​

PageViewModel

Field	型	説明
id	integer($int32)	省略可。読み取り専用。内部ページ ID。
number	integer($int32)	省略可。読み取り専用。ページ番号。
resolution	integer($int32)	省略可。読み取り専用。ページ画像の DPI。
height	integer($int32)	省略可。読み取り専用。ページ画像の高さ。
width	integer($int32)	省略可。読み取り専用。ページ画像の幅。

​

FieldViewModel

Field	型	説明
name	string	必須。Field名。
value	string	任意。抽出された値。
rectangles[]	object(RectangleViewModel)	必須。Fieldの矩形。
cell	object(CellReferenceViewModel)	任意。テーブル内のセルの位置。

​

TableViewModel

Field	型	説明
name	string	必須。テーブル名。
regions[]	object(RegionViewModel)	必須。テーブル領域。

​

RectangleViewModel

Field	型	説明
page_id	integer($int32)	必須。内部ページ ID。
x1	integer($int32)	必須。x1 の座標。
y1	integer($int32)	必須。y1 の座標。
x2	integer($int32)	必須。x2 の座標。
y2	integer($int32)	必須。y2 の座標。

​

CellReferenceViewModel

Field	型	説明
table_name	string	必須。参照先のテーブル名。
row_number	integer($int32)	必須。参照先の行番号。
column_name	string	必須。参照先の列名。

​

RegionViewModel

Field	型	説明
rectangles[]	object(RectangleViewModel)	必須。field の矩形領域。
columns[]	object(ColumnViewModel)	必須。テーブルの列。
horizontal_separators[]	integer($int32)	必須。水平のテーブル区切り線。

​

ColumnViewModel

Field	型	説明
left	integer($int32)	必須。列の左境界。
right	integer($int32)	必須。列の右境界。