メインコンテンツへスキップ
抽出データのレイアウトを返します。

​
HTTP リクエスト

GET https://api-{location-id}.flexicapture.com/v2/training/layout/{taskId}/{fileId}
{location-id} をお使いのサポート対象のロケーションに置き換えてください。

​
パスパラメーター

パラメーター型説明
taskIdpath, string必須。タスクID。
fileIdpath, 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_idstring必須。タスクID。
file_idstring必須。ファイル ID。
pagesArray[PageViewModel]任意。文書ページの一覧。
fieldsArray[FieldViewModel]必須。抽出されたフィールドの一覧。
tablesArray[TableViewModel]任意。抽出されたテーブルの一覧。

​
PageViewModel

Field型説明
idinteger($int32)省略可。読み取り専用。内部ページ ID。
numberinteger($int32)省略可。読み取り専用。ページ番号。
resolutioninteger($int32)省略可。読み取り専用。ページ画像の DPI。
heightinteger($int32)省略可。読み取り専用。ページ画像の高さ。
widthinteger($int32)省略可。読み取り専用。ページ画像の幅。

​
FieldViewModel

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

​
TableViewModel

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

​
RectangleViewModel

Field型説明
page_idinteger($int32)必須。内部ページ ID。
x1integer($int32)必須。x1 の座標。
y1integer($int32)必須。y1 の座標。
x2integer($int32)必須。x2 の座標。
y2integer($int32)必須。y2 の座標。

​
CellReferenceViewModel

Field型説明
table_namestring必須。参照先のテーブル名。
row_numberinteger($int32)必須。参照先の行番号。
column_namestring必須。参照先の列名。

​
RegionViewModel

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

​
ColumnViewModel

Field型説明
leftinteger($int32)必須。列の左境界。
rightinteger($int32)必須。列の右境界。