Text OCR API 呼び出し

Prev Next

Classic/VPC環境で利用できます。

CLOVA OCRビルダでテンプレートの登録を完了し、テストおよびサービスリリースが完了すると、REST APIを使用して CLOVA OCRを利用できます。ここでは、TEXT OCR APIで画像を入力し、認識値を変換して受け取る方法とユースケースをご案内します。

参考
  • テンプレート OCRも同じ方法で APIを呼び出しできます。
  • API呼び出しに関する詳細は、CLOVA OCR APIガイドをご参照ください。

TEXT OCR APIで画像を入力し変換する手順と各手順ごとの説明は、次の通りです。

1.API環境設定

TEXT OCRを APIで制御するには、まず最初に NAVERクラウドプラットフォームコンソールの CLOVA OCRでドメインを作成する必要があります。OCRビルダでドメインを作成すると、固有の InvokeURLが割り当てられます。InvokeURLはセキュリティのため外部サービスに直接公開されず、セキュリティおよびサービス処理レベルを高めるために API Gatewayと連携して使用するよう設計されています。

2.API Gateway自動連携

InvokeURLを使用するために API Gatewayを連携します。API Gatewayとの連携方法には自動と手動があり、自動連携を選択すると数回のクリックで API Gateway連携を簡単に完了できます。このユースケースでは自動連携の方法をご紹介します。自動連携方法は、次の通りです。

  1. OCRビルダで Secret Keyを作成するために、 [作成] ボタンをクリックします。
    image-20191217135217405_ko
  2. API Gatewayを自動連携するために、 [自動連携] ボタンをクリックします。
  3. API Gatewayをご利用でない場合、自動連携のポップアップが表示されたら [確認] ボタンをクリックしてご利用を申し込みます。
    image-20191217135507352_ko
  4. 連携が完了したら、API呼び出しに必要な Secret Keyと OCR呼び出し URLの値をコピーします。
    image-20191217135557688_ko
    • Secret Key: {X-OCR-SECRET}
    • OCR Invoke URL: {OCR Invoke URL}

3.API Gateway作成 URLの確認

NAVERクラウドプラットフォームコンソールの API Gatewayに移動し、API Gateway作成 URLを確認する必要があります。OCR_CUSTOM_API_KRという Productが正常に作成された場合、API呼び出しの準備が完了したことになります。API Gateway作成 URLを確認する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > AI Services > CLOVA OCRメニューを順にクリックします。
  2. My Productsメニューをクリックします。
  3. OCR_CUSTOM_API_KRという Productが作成されているか確認します。
    image-20191217144827615_ko
    • 正常に作成された場合、API呼び出しの準備が完了したことになります。

4.Postmanでの API呼び出し

Text OCR APIを実行すると、アップロードされた画像からテキストを抽出できます。画像認識結果は json形式で返され、返された結果値をユーザーのサービスで活用できます。Text OCR APIを呼び出す方法は、次の通りです。

参考

Text OCR APIの呼び出しでは、抽出方法を簡潔に説明しています。詳細な方法が気になる場合は、CLOVA OCR APIガイドをご参照ください。

  1. Postmanで新しい APIを作成し、呼び出し方法を POSTに設定します。
  2. Invoke URLアドレスに、OCRで作成した API Gatewayの InvokeURLを入力します。
    image-20191217171936809_ko
  3. Header項目に X-OCR-SECRET情報を入力します。
    image-20191217172419810_ko
    • Content-Type : application/json
    • X-OCR-SECRET : {X-OCR-SECRET }
  4. TEXT OCR呼び出し BODYを画像認識リクエスト BODYの形式で追加します。
    image-20191217172912524_ko
    {
    "images": [
      {
        "format": "png",
        "name": "medium",
        "data": null,
        "url": "https://kr.object.ncloudstorage.com/ocr-img/OCR_ko(1)REAN_ko(1).png"
      }
    ],
    "lang": "ko",
    "requestId": "string",
    "resultType": "string",
    "timestamp": {{$timestamp}},
    "version": "V1"
}
  5. レスポンス結果を確認するために、 [SEND] ボタンをクリックします。
    image-20191217173003063_ko
  6. レスポンス結果を確認します。
    {
"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"}}
    ]
}
  7. レスポンス結果をサービスに活用してください。