CLOVA OCRの概要

Prev Next

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

CLOVA OCR(Optical Character Recognition)は、転送した文書や画像を認識して、ユーザーが指定した領域からテキストやデータを正確に抽出する NAVERクラウドプラットフォームのサービスです。画像の全テキストの認識、ドメインにデプロイされたテンプレートを含む画像のテキスト認識、テンプレート内で必要な文字だけを素早く抽出する機能関連の APIを RESTful形式で提供します。

CLOVA OCRの共通設定

CLOVA OCR APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

CLOVA OCRビルダで作成された API Gatewayの固有の Invoke URL
参考

Invoke URLの確認方法の詳細は、CLOVA OCRご利用ガイドをご参照ください。

リクエストヘッダ

ヘッダの説明は次の通りです。

フィールド 必須の有無 説明
X-OCR-SECRET Required NAVERクラウドプラットフォームドメイン(Domain)で API Gateway連携時に作成した Client Secret
Content-Type Required リクエストデータの形式
  • application/json | multipart/form-data

レスポンス

共通レスポンス形式を説明します。

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
400 0001 URL is invalid. 無効な呼び出し URLを入力
  • 呼び出した POST URLが正確かどうか確認
401 0002 Secret key validate failed. 入力した Secret Keyが検証できない
  • X-OCR-SECRET:{Client Secret}の値が正確かどうか確認
400 0011 Request body invalid. 入力されたリクエストボディが無効である
400 0021 Protocol version not support. サポートしない APIバージョン
400 0022 Request domain invalid. 入力したリクエストドメインが無効である
400 0023 API request count reach the upper limit. API呼び出し制限に到達
400 0025 Calls to this api have exceeded the rate limit. API呼び出し数が料金制限(Rate Limit)を超えている
400 0028 Table detection disabled: Please activate the table extractor button. 表を抽出するかどうかを OFFにした状態で enableTableDetection: trueで呼び出す
500 0500 Unknown service error. 不明なサービスエラーが発生
500 0501 OCR service error. OCRサービスエラーが発生
500 1021 Not found deploy information. Please confirm the template is released. Templateデプロイ履歴が見つからない
  • NAVERクラウドプラットフォームコンソールのドメインにテンプレートがデプロイされているか確認が必要
500 1022 Service is blocked. サービス一時停止
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

CLOVA OCR API

CLOVA OCRサービスで提供する APIの説明は次の通りです。

API 説明
General OCR 一般のテキストと表を抽出する OCR
Template OCR Template OCR
Document OCR > 名刺 名刺情報 OCR
Document OCR > 事業者登録証 事業者登録証情報 OCR
Document OCR > クレジットカード クレジットカード情報 OCR
Document OCR > 領収証 レシート情報 OCR
Document OCR > 身分証明書 > パスポート パスポート情報 OCR
Document OCR > 身分証明書 > 外国人登録証 外国人登録証情報 OCR
Document OCR > 身分証明書 > 運転免許証 運転免許証情報 OCR
Document OCR > 身分証明書 > 住民登録証 住民登録証情報 OCR

CLOVA OCR関連リソース

CLOVA OCR APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。