メインコンテンツまでスキップ

Conversion Document API

概要: 完了した文書変換ジョブの結果を取得するAPIです。構造化されたテキストデータとレイアウト情報、座標データを含む詳細な解析結果を返却します。

GET /v1/user/conversions/{conversion_id}/document​

ジョブの実行結果を返却します。

まだ完了していない場合は、202を返します。

GET /v1/user/conversions/{conversion_id}/document

Headers​

  • api-key : string(required) - rokadoc APIキー
必須パラメータ​
  • conversion_id : string(required) - 変換ID（パスパラメータ）
オプショナルパラメータ
  • space_id : string(optional) - スペース機能を利用する場合はスペースIDを指定

Request Example​

curl -X 'GET' \
"https://beta-api.rokadoc.ntt.com/v1/user/conversions/${CONVERSION_ID}/document?space_id=${SPACE_ID}" \
-H "api-key: ${ROKADOC_API_KEY}"

Response​

200 OK - ジョブの実行結果​
{
    "code": 200,
    "data": {
        "conversion_id": "your_conversion_id_here",
        "document_name": "sample.pdf"
    },
    "roka_response": {
      "meta": {
        "separate_method": "page"
      },
      "units": [
        {
          "unit": 1,
          "title": "",
          "body": "",
          "elements": [
            {
              "type": "title",
              "coordinates": [[305.0, 254.0],[802.0, 343.0]],
              "text": "<ここにタイトルが入ります>",
              "page": 1,
              "reading_order": 1
            },
            {
              "type": "text",
              "coordinates": [[303.0, 522.0],[2044.0, 593.0]],
              "text": "<ここにテキストが入ります>",
              "page": 1,
              "reading_order": 2
            }
          ],
          "description": "<elementsが統合された全量テキスト>",
          "width": 2481,
          "height": 3508
      ]
    }
  }
}
  • code : integer - ステータスコード
  • data.status : string - ジョブのステータス
  • data.conversion_id : string - 変換ID
  • data.document_name : string - ドキュメント名
  • data.roka_response : object - rokadocによるドキュメント解析結果
    • meta : object - ドキュメント解析時のメタ情報
      • separate_method : string - 分割方法（現在はpageのみ）
    • units : array - ページもしくは文節単位のユニット情報
      • unit : integer - 1から始まるユニット番号
      • title : string - elementsに集約したため、現在不使用
      • body : string - elementsに集約したため、現在不使用
      • elements : array - ドキュメントに含まれるレイアウト情報
        • type : string - 要素のタイプ（title, text, table, image）
        • coordinates : array - 要素の左上基準の座標情報 [[x1, y1], [x2, y2]]形式
        • text : string - 抽出したテキスト
        • page : integer - 要素が存在するページ番号
        • reading_order : integer - 1から始まる読み順
      • description : string - elementsが統合された全量テキスト
      • width : integer - PDFを画像化したときのページの幅
      • height : integer - PDFを画像化したときのページの高さ
202 処理中 - 非同期で実行されているジョブの結果待ち​
{
  "code": 202,
  "data": {
    "status": "Running",
    "conversion_id": "xxxx",
    "document_name": "sample.pdf",
    "roka_response": null
  }
}
422 Validation Error​
{
    "detail": [
        {
            "loc": ["path", "conversion_id"],
            "msg": "Field required",
            "type": "missing"
        }
    ]
}

注意事項​

  • ジョブが完了していない場合は202 処理中が返されます
  • 変換IDが存在しない場合は404エラーが返されます
  • 自身のUserIDに関連しない変換結果は取得できません
  • スペース機能を利用している場合は適切なspace_idを指定してください