GET/paperon/projects/{projectId}/files/{fileId}/extraction-result

OCR による読み取り結果を JSON で取得する。
ダウンロード可能なファイルステータス (approved または completed) のファイルのみ取得できる。 プロジェクトの OCR モデルが 全文/表認識(General OCR) の場合には、テキスト (txt) セグメントとテーブル (csv/xlsx) セグメントが contents 配列に含まれる。
プロジェクトの OCR モデルが 全文/表認識(General OCR) 以外の場合 (テンプレートを含む) には、単一の csv または xlsx セグメントが contents に含まれる。

参考

  • レスポンスの contents 項目は、場合によりスキーマが異なる。
  • format が txt の場合には content (文字列)、csv または xlsx の場合には headers と rows を参照する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

paperon
paperon.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/paperon/projects/{projectId}/files/{fileId}/extraction-result

Path Parameters

ParameterTypeDescription
projectId string 

プロジェクト ID


required
example : 550e8400-e29b-41d4-a716-446655440000 
fileId string 

ファイル ID


required
example : 550e8400-e29b-41d4-a716-446655440000 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK - ファイルの読み取り結果 (JSON)

PropertyTypeDescription
contents array (undefined) 

読み取り結果のセグメントリスト。プロジェクトの OCR モデルに応じて、txt セグメントとテーブル (csv/xlsx) セグメントが含まれる。
全文/表認識(General OCR) モデルの場合には、テキスト (txt) の後に テーブル (csv/xls) の順でセグメントが含まれる。
全文/表認識(General OCR) 以外のモデルの場合 (テンプレートを含む) には、csv/xlsx セグメントが 1 件だけ含まれる。


required 

Response Example

csvOnly

1{2  "contents": [3    {4      "format": "csv",5      "headers": [6        "column1",7        "column2",8        "column3"9      ],10      "rows": [11        [12          "value1",13          "value2",14          "value3"15        ],16        [17          "value4",18          "value5",19          "value6"20        ]21      ]22    }23  ]24}

txtAndCsv

1{2  "contents": [3    {4      "format": "txt",5      "content": "fields から読み取ったテキスト全体"6    },7    {8      "format": "csv",9      "headers": [10        "column1",11        "column2"12      ],13      "rows": [14        [15          "value1",16          "value2"17        ],18        [19          "value3",20          "value4"21        ]22      ]23    }24  ]25}