Documentation Index

Fetch the complete documentation index at: https://guide.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

Domain

Prev Next

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

Domainでは、ドメインの作成・管理ができます。ドメインは CLOVA OCRサービスの基準となる単位です。例えば、「告知書」 OCRを作成する場合、認識対象になるすべての告知書テンプレートを含む単位がドメインになります。そのため、テンプレートの作成からチャンネル連携、統計情報まで一つのドメインを基準に動作し、管理されます。
ドメインのサービスタイプには、General、Template、Documentがあります。ここでは、ドメインサービスタイプ別の共通内容の Domain画面の構成、外部連携のための API Gateway連携方法を紹介し、ドメインの作成・管理方法を簡単に説明します。サービスタイプ別にドメインを作成・管理する方法の詳細は、以下のガイドをご参照ください。

  • サービスタイプが Generalのドメイン: テキスト/表を抽出する OCR
    • 作成・管理する方法: General
  • サービスタイプが Templateのドメイン: 判読領域を直接指定して認識値を抽出した後にテストと結果を転送できるテンプレートビルダをサポートする OCR
  • サービスタイプが Documentのドメイン: 機械学習に基づいて文書の意味的構造を理解する特化モデルエンジンが実装され、入力情報(key-value)を自動抽出する OCR

Domain画面

Domainを利用するための基本的な説明は、次の通りです。

clovaocr-domain_01_250327_ko.png

領域 説明
① メニュー名 現在確認中のメニューの名前
② 基本機能 ドメイン作成、特化モデル設定、サービスの詳細情報の確認、画面の更新
③ 作成後の機能 ドメイン削除、コピー、検索
④ ドメインリスト ドメインリストと基本情報の確認、動作の設定

ドメインリストの確認

ドメインリストで、ドメイン別情報を確認できます。確認する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、Menu > All Services > AI Services > CLOVA OCRメニューを順にクリックします。
  2. Domainメニューをクリックします。
  3. ドメインリストが表示されたら、基本情報を確認します。
    • ドメイン ID: ドメインを識別する固有の ID
    • ドメイン名: ドメインを識別する固有の名前
    • ドメインコード: ドメインを識別する固有のコード
    • サポート言語: ドメインでサポートする言語の種類。韓国語、日本語、台湾語(中国語繁体字)があり、英語は表示がなくても基本的にサポート
    • 認識モデル: サービスタイプが Templateまたは Documentのドメインに適用された認識率レベルか、認識対象の種類
      認識モデル Basic Premium 説明
      モデル認識率 活字体・筆記体を認識 活字体・筆記体を認識 主なビジネスへの活用に最適化した高性能 OCR認識モデルを提供
      適合文書 証明書、固定フォーム様式 手書き申請書登録様式、金融文書など -
      認識テンプレートのレイアウト 提供する 提供する 認識領域を設定
      マルチボックス 提供しない 提供する シングルボックスのテンプレートを組み合わせて番号認識領域などを制御
      チェックボックス 提供しない 提供する チェックボックス型の認識を提供
      フィールドタイプ 提供しない 提供する 認識値を数字のみで認識するようにタイプを設定
      認識対象外 提供しない 提供する 一般フィールドに指定し、フィールド内の特定の領域をマスキング
      判読結果の結合 提供しない 提供する 個々のフィールドの結果を結合して「新しい値」として出力
      チェックボックス認識結果の文字変換 提供しない 提供する チェックボックスの戻り値を特定の文字に置換
      • サービスタイプが Templateのドメインの場合
        • Basicモデル: 基本エンジンを実装してテンプレートのレイアウトなど基本的な認識機能を提供
        • Premiumモデル: テンプレートのレイアウト、マルチボックス、フィールド入力値の Value type設定、筆記体の認識を含むなど、より精巧で様々な認識機能を提供する Premiumモデル
      • サービスタイプが Documentのドメインの場合
        • ドメインで認識する特化モデルの種類
    • サービスプラン: ドメインに適用された料金プランの種類
    • テンプレート数: 登録されたテンプレート数
    • 登録されたテンプレート: 登録されたテンプレート名。全リストを確認するには、 [テンプレートビルダ] ボタンをクリック
    • ドメインの作成日: ドメインを作成した日付
    • 最終更新日: ドメインを最後に変更した日付
    • 動作: サービスタイプ別ドメインを管理して設定できる画面に移動
参考

Domainリストでドメイン情報を入力または設定することで、目的のドメインを検索できます。
clovaocr-domain_02_ko

ドメイン作成

ドメインを作成する方法は、サービスタイプ別に多少異なります。サービスタイプ別の作成方法は、以下のガイドをご参照ください。

  • サービスタイプが Generalのドメインを作成・管理する方法: General
  • サービスタイプが Templateのドメインを作成・管理する方法: Template
  • サービスタイプが documentのドメインを作成・管理する方法: Document
注意

サービスタイプが Generalのドメインはリージョン当たり1つのみ作成できます。

ドメイン削除

ドメインを削除する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、Menu > All Services > AI Services > CLOVA OCRメニューを順にクリックします。
  2. Domainメニューをクリックします。
  3. 削除するドメインをクリックし、 [ドメイン削除] ボタンをクリックします。
  4. ドメイン削除のポップアップが表示されたら、 [削除] ボタンをクリックします。
  5. [確認] ボタンをクリックします。

ドメインコピー

作成済みのドメインをコピーして新しいドメインを作成できます。コピー後に認識モデルを変更できます。Premiumから Basicに変更する場合、Premium機能はコピーされず、Basic機能のみコピーされます。ドメインをコピーして作成する方法は、次の通りです。

参考

サービスタイプが Generalのドメインはリージョン当たり1つのみ作成できるので、コピーによる追加作成は行えません。

  1. NAVERクラウドプラットフォームコンソールで、Menu > All Services > AI Services > CLOVA OCRメニューを順にクリックします。
  2. Domainメニューをクリックします。
  3. コピーするドメインをクリックし、 [ドメインコピー] ボタンをクリックします。
  4. ドメイン作成のポップアップが表示されたら、必要な情報を入力します。
    • コピーするドメインのそれと同じ情報が自動入力されている
    • ドメインの名前とコードは、ドメイン別に固有の値なので、新たに入力が必要
  5. [ドメイン作成] ボタンをクリックします。

API Gateway連携

CLOVA OCRはユーザーのアプリケーションから CLOVA OCRを呼び出して使用できるように、外部連携のための InvokeURLを提供します。InvokeURLは各ドメインの固有の値で、安全なサービスのために外部サービスに直接公開されていません。また、セキュリティとサービス処理レベルを高めるために、必ず NAVERクラウドプラットフォームの API Gatewayと連携して使用するように設計されています。API Gatewayと連携してサービスを処理する流れをまとめると、次の通りです。

ドメインの OCR InvokeURLを確認 → API Gatewayの Endpointで接続 → 外部連携

ユーザーが作成した OCR認識呼び出し Endpointは、ドメインの invokeURLになります。この APIを介して画像を入力すると認識値が返されます。このような API Gateway連携方法には、自動と手動とがあります。手動連携は自動連携に比べユーザーが直接細かい設定を行えるという特徴がありますが、基本的に同じ機能を提供するので、より簡単な自動連携を使用することをお勧めします。

注意

API Gatewayご利用の申し込みを行うと、別途料金が発生します。API Gatewayの紹介と料金プランについての説明は、NAVERクラウドプラットフォームポータルの サービス > Application Services > API Gateway メニューをご参照ください。

自動連携

自動連携は、ドメインの OCR Invoke URLと API Gateway Endpointの接続を自動で行います。自動連携方法は、次の通りです。

  1. ドメインを作成し、自動連携の設定画面に移動します。
    • General: [API Gateway連携] ボタンをクリック
      clovaocr-domain_03_230530_ko
    • Template: [テンプレートビルダ] ボタンをクリックし、API Gateway連携タブメニューで [連携] ボタンをクリック
      clovaocr-domain_04_230530_ko
    • Document: [API Gateway連携] ボタンをクリック
      clovaocr-domain_05_ko
  2. Invoke URLの呼び出しに必要な Secret Keyを発行するために、 [作成] ボタンをクリックします。
    • [コピー] ボタン: クリックすると Secret Keyの値をコピー
  3. [確認] ボタンをクリックします。
  4. APIGW自動連携[自動連携] ボタンをクリックします。
  5. [確認] ボタンをクリックします。
  6. Invoke URLを使用するために APIGW Invoke URL[アドレスコピー] ボタンをクリックします。
    clovaocr-domain_09_ko
参考

1.で Documentの認識モデルが身分証明書の場合、身分証明書およびパスポート(Global)を認識するための Invoke URLをそれぞれ提供します。
6.で APIGW自動連携[変更する] ボタンをクリックし、Invoke URLを作成し直します。作成し直す際は、CLOVA OCRへの接続がしばらく中断される場合があります。

手動連携

手動連携は、ドメインの OCR Invoke URLと API Gateway Endpointの接続をユーザーが直接設定できます。手動連携方法は、次の通りです。

  1. ドメインを作成し、手動連携の設定画面に移動します。
    • General: [API Gateway連携] ボタンをクリックし、API Gateway手動連携をクリック
      clovaocr-domain_06_230530_ko
    • Template: [テンプレートビルダ] ボタンをクリックし、API Gateway連携タブメニューで [連携] ボタンをクリックした後に API Gateway手動連携をクリック
      clovaocr-domain_07_230530_ko
    • Document: [API Gateway連携] ボタンをクリックし、API Gateway手動連携をクリック
      clovaocr-domain_08_ko
  2. 手動連携に必要な2つの情報を用意します。
    • CLOVA OCR Invoke URL: [アドレスをコピー] ボタンをクリックしてコピー
    • API Gatewayの設定情報: APIGW Configuration[ダウンロード] ボタンをクリック
  3. NAVERクラウドプラットフォームコンソールで、Menu > All Services > Application Services > API Gatewayメニューを順にクリックします。
  4. My Productsメニューをクリックして Productを作成します。
  5. 作成した Productの APIsをクリックして APIを作成します。
    • 作成方法: Swaggerからインポートをクリックして選択
    • アップロードする jsonファイル: 2.でダウンロードしたファイル
  6. [Stage] タブメニューで Stage APIを作成します。
    • Endpointドメイン: 2.でコピーした CLOVA OCR Invoke URLの値を入力
    • OCRビルダと連携するには、作成した Stageの Invoke URLをコピーして保存
  7. 作成した APIをリリースするために [Resource] タブメニューで [APIリリース] ボタンをクリックします。
  8. Invoke URLを使用するために [Stage] タブメニューで [アドレスコピー] ボタンをクリックします。
    clovaocr-domain_10_ko
参考

API Gatewayのご利用方法に関する詳細は、API Gateway ご利用ガイドをご参照ください。