LLMOCR

APIドキュメント

クイックスタート

APIキーを取得して、数分でドキュメントの変換を開始します。

始める →

Key Information Extraction API

カスタムJSONスキーマを使用して請求書、証明書、フォームから構造化された情報を抽出し、JSON形式で結果を返します

概要

Key Information Extraction APIは、請求書、証明書、フォーム、その他のドキュメントから構造化された情報を抽出します。カスタムJSONスキーマを定義して抽出するフィールドを指定でき、モデルは画像から対応する情報をインテリジェントに識別し、JSON形式で入力します。

統一されたJSONリクエスト形式を使用し、URL参照またはbase64エンコードされた画像データを受け入れます。

認証

APIは以下の認証方法をサポートしています：

  • APIキー: クエリパラメータとしてAPIキーを渡す ?key=YOUR_API_KEY

画像から構造化情報を抽出

カスタムJSONスキーマを使用したインテリジェント認識技術で、画像ファイルから構造化された情報を抽出します。

リクエスト

POST /api/key-information-extraction

パラメータ:

パラメータ型必須説明
documentobjectはいドキュメントオブジェクト
document.typestringはい固定値 "image_url"
document.image_urlstringはい画像URLまたはbase64データ
result_schemaobject/stringはい抽出するフィールドを定義するJSONスキーマ
filenamestringいいえファイル名（base64データの場合推奨）
keystringいいえAPIキー（クエリパラメータ、ログインユーザーにはオプション）

result_schemaの注意事項:

  • JSONオブジェクトまたはJSON文字列のいずれか
  • 最大3レベルのネストをサポート
  • キー（フィールド名）のみを定義し、値は空の文字列のままにする
  • 配列構造をサポート

例:

画像URLを使用:

curl -X POST "https://llmocr.com/api/key-information-extraction?key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document": {
      "type": "image_url",
      "image_url": "https://llmocr.com/invoice.jpg"
    },
    "result_schema": {
      "Seller Name": "",
      "Buyer Name": "",
      "Price Excluding Tax": "",
      "Invoice Code": ""
    }
  }'

Base64画像データを使用:

curl -X POST "https://llmocr.com/api/key-information-extraction?key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document": {
      "type": "image_url",
      "image_url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA..."
    },
    "result_schema": {
      "Name": "",
      "ID Number": "",
      "Address": ""
    },
    "filename": "id-card.jpg"
  }'

レスポンス

パラメータ:

パラメータ型説明
idstringデータベースレコードID
filenamestringファイル名
contentstring抽出された構造化情報（JSON文字列形式）
formatstring出力形式、固定値 "json"
timestampnumber処理完了タイムスタンプ
payloadstringAPIエンドポイントURL

例:

{
  "id": "12345",
  "filename": "invoice.jpg",
  "content": "{\"Seller Name\":\"ABC Company Ltd\",\"Buyer Name\":\"John Doe\",\"Price Excluding Tax\":\"270000.00\",\"Invoice Code\":\"142011726001\"}",
  "format": "json",
  "timestamp": 1640995200000,
  "payload": "https://llmocr.com/api/key-information-extraction?key=YOUR_API_KEY"
}
Key Information Extraction API - LLMOCR Developer Guide