> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Layout

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

<div id="http-request">
  ## HTTP リクエスト
</div>

```http theme={null}
GET https://api-{location-id}.flexicapture.com/v2/training/layout/{taskId}/{fileId}
```

`{location-id}` をお使いの[サポート対象のロケーション](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api#icaas-supported-countries)に置き換えてください。

<div id="path-parameters">
  ## パスパラメーター
</div>

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

<div id="response">
  ## レスポンス
</div>

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

```json theme={null}
{
  "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
          ]
        }
      ]
    }
  ]
}
```

<div id="trainingdataviewmodel">
  ### TrainingDataViewModel
</div>

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

<div id="pageviewmodel">
  ### PageViewModel
</div>

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

<div id="fieldviewmodel">
  ### FieldViewModel
</div>

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

<div id="tableviewmodel">
  ### TableViewModel
</div>

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

<div id="rectangleviewmodel">
  ### RectangleViewModel
</div>

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

<div id="cellreferenceviewmodel">
  ### CellReferenceViewModel
</div>

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

<div id="regionviewmodel">
  ### RegionViewModel
</div>

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

<div id="columnviewmodel">
  ### ColumnViewModel
</div>

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