CLOVA OCR APIの呼び出し方法
CLOVA OCRビルダーでテンプレートの登録が完了した後、テスト及びサービスのリリースが完了すると
REST APIを用いてCLOVA OCRサービスを利用できます。
この文書では、Text OCR APIで画像を入力して認識値に変換する方法を説明します。
Step 1. APIの環境設定を行う
OCRビルダーにより作成されたドメインには固有のInvoke URLが存在します。 このInvoke URLは、安全なサービスを提供するために、外部サービスに直接公開されないようにしています。また、セキュリティ及びサービス処理水準を向上させるために、API Gateway商品と連携して使用できるように設計されています。
Step 2. API Gatewayとの自動連携を行う
API Gatewayとの連携方法には自動と手動があり、「自動」を選択すると数回クリックするだけでAPI Gatewayとの連携を簡単に完了できます。
このステップでは、Secret KeyとOCR Invoke URLを作成します。
Text OCRを使用する
Secret Keyを作成します。
「API Gatewayとの自動連携」ボタンをクリックします。
API Gatewayサービスの利用申請が完了していない場合は、まず利用申請を行う必要があります。
API Gatewayの連携が完了しました。
大切な情報である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が作成されています。
Stagesタブをクリックすると、Chatbotビルダー画面のAPI Gateway Invoke URLと同じURLを確認できます。
ここまで正常に表示されたら、API呼び出しの準備は完了です。
Step 4. PostmanでAPIを呼び出す(Text OCR)
Text OCR APIを実行すると、アップロードされた画像からテキストを抽出できます。
OCR APIリファレンスには、呼び出しのためのspecについて詳しく説明されています。[CLOVA OCR APIリファレンスに移動する]
Postmanで新しいAPIを作成し、呼び出しメソッドはPOSTに設定します。
Invoke URLアドレスにOCRで作成したAPI Gateway Invoke URLを入力します。
X-OCR-SECRET情報をHeader項目に次のように入力します。
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": ,
"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スタートガイド