CLOVA OCR APIの呼び出し方法

CLOVAOCRビルダーでテンプレート登録を完了後、テストとサービス配布が完了すると

REST APIを用いてCLOVA OCRサービスを利用できます。

この文書では、TEXT OCR APIで画像を入力して認識値を変換する方法を説明します。

Step 1. APIの環境設定を行う

OCRビルダーで作成したドメインには固有のInvokeURLがあります。 このInvokeURLは、安全なサービスを提供するために外部サービスに直接公開されません。そして、セキュリティとサービス処理のレベルを向上させるために、API Gateway商品と連携して使用するように設計されています。

Step 2. API Gatewayと自動連携する

API Gatewayと連携する方法には自動と手動があり、自動連携機能を選択すると数回のクリックで簡単にAPI Gateway連携を完了できます。

この段階ではSecret KeyとOCR Invoke URLを作成します。

• Text OCRを使用する

  

• Secret Keyを作成します。

• APIGW自動連携ボタンをクリックします。

  

API Gatewayサービスの利用が申請されていない場合、まず申請を完了する必要があります。

APIGW連携が完了しました。

大事な情報であるSecret KeyとOCR Invoke URL値をコピーしておきます。

• Secret Key : {X-OCR-SECRET}
• OCR Invoke URL : {OCR Invoke URL}

Step 3. API Gateway作成URLを確認する

コンソールからAPI Gateway商品に移動します。

My ProductsにOCR_CUSTOM_API_KRというProductが作成されています。

Stageタブをクリックすると、Chatbotビルダー画面に表示されたAPIGateway Invoke URLが同じく表示されています。

ここまで正常に表示されると、API呼び出し準備が完了したことになります。

Step 4. PostmanでAPIを呼び出してみる(TEXT OCR)

Text OCR APIを実行すると、アップロードされた画像からテキストを抽出できます。

CLOVA OCR APIリファレンスには、呼び出しのためのspecが詳しく説明されています。[CLOVA OCR APIリファレンスに移動]

Postmanで新しいAPIを作成し、呼び出し方式をPOSTに設定します。POST로 설정합니다.

Invoke URLアドレスにOCRで作成したAPI GatewayのInvokeURLを入力します。

Header項目に以下のようにX-OCR-SECRET情報を入力します。

Content-Type : application/json

X-OCR-SECRET : {X-OCR-SECRET }

TEXT OCR呼び出しBODYは、画像認識リクエストBODYの形式で入力します。

詳しい画像認識リクエスト形式は、APIリファレンスを確認してください。

Request Body:

{
    "images": [
      {
        "format": "png",
        "name": "medium",
        "data": null,
        "url": "https://kr.object.ncloudstorage.com/ocr-img/OCR_KOREAN.PNG"
      }
    ],
    "lang": "ko",
    "requestId": "string",
    "resultType": "string",
    "timestamp": {{$timestamp}},
    "version": "V1"
}

SENDボタンを押してレスポンスを確認します。

レスポンス結果は次のとおりです。

Response Body:

{
"version":"V1",
"requestId":"string",
"timestamp":1576569034247,
"images":[
  {
    "uid":"9fd73a6aacad4025b3099a36ee55aacd",
    "name":"medium","inferResult":"SUCCESS","message":"SUCCESS",
    "fields":[
        {"inferText":"我","inferConfidence":0.9967288},
        {"inferText":"天に","inferConfidence":0.9998919},
        {"inferText":"帰ろう","inferConfidence":0.9999104},
        {"inferText":"美しい","inferConfidence":0.99992156},
        {"inferText":"この","inferConfidence":0.99958915},
        {"inferText":"世の","inferConfidence":0.9998707},
        {"inferText":"逍遥を","inferConfidence":0.9988277},
        {"inferText":"終える","inferConfidence":0.9999253},
        {"inferText":"日","inferConfidence":0.99908936},
        {"inferText":"行って","inferConfidence":0.99974936},
        {"inferText":"美しかったと","inferConfidence":0.9997728},
        {"inferText":"語ろう","inferConfidence":0.9993808}
        ],
    "validationResult":{"result":"NO_REQUESTED"}}
    ]
}

画像認識結果がjson形式で返却され、この値を顧客のサービスで活用できます。

Template OCRも同じ方法でAPIの呼び出しができます。

詳しい内容はCLOVA OCR APIリファレンスを確認してください。

• CLOVA OCRスタートガイド
  • CLOVA OCR使用ガイド
  • CLOVA OCR API連携ガイド
  • CLOVA OCR API呼び出しガイド
  • CLOVA OCR Custom API Spec.