Domain

Available in Classic and VPC

In Domain, you can create and manage domains. A domain is the basic unit of the CLOVA OCR service. For instance, when creating an OCR for "bills," a domain is the functional unit containing all relevant bill templates. This means that template creation, channel linking, and analytics are all managed and executed on a per-domain basis.
Domains support three service types: General, Template, and Document. This section introduces the elements common to all domain service types, including the Domain interface layout and how to integrate API Gateway for external connections, and briefly explains how to create and manage domains. For detailed instructions on creating and managing domains by service type, see the guides below.

• Domains with the General service type: OCR that extracts text and tables.
  • How to create and manage: General
• Domains with the Template service type: OCR that supports a template builder, allowing you to define recognition areas, extract values, test results, and send outputs.
  • How to create and manage: Template
• Domains with the Document service type OCR that uses a machine learning–based specialized model engine to understand the semantic structure of documents and automatically extract input information (key–value pairs).
  • How to create and manage: Document

Domain interface

The basics of using Domain are as follows:

Check domain list

You can check the information for each domain from the domain list. To view:

1. In the NAVER Cloud Platform console, navigate to > Services > AI Services > CLOVA OCR.
2. Click the Domain menu.
3. When the domain list appears, check the basic information.
   • Domain ID: A unique identifier for the domain.
   • Domain name: A unique name that identifies the domain.
   • Domain code: A unique code that identifies the domain.
   • Supported languages: The languages supported by the domain. Korean, Japanese, and Taiwanese (Traditional Chinese) are supported. English is also supported by default even if it is not explicitly displayed.
   • Recognition model: The recognition accuracy level or the type of content recognized, applied to domains whose service type is Template or Document.

     Recognition model	Basic	Premium	Description
     	Model recognition rate	Typeface and handwriting recognition	Typeface and handwriting recognition
     	Appropriate documents	Certificates, documents with a fixed form	Handwritten request forms, sign-up forms, financial documents, etc.
     	Recognition template layout	Provided	Provided
     	Multi-box	Not provided	Provided
     	Checkbox	Not provided	Provided
     	Field type	Not provided	Provided
     	Not recognized	Not provided	Provided
     	Combine analysis result	Not provided	Provided
     	Text conversion of checkbox recognition result	Not provided	Provided

     • If the service type of the domain is Template
       • Basic model: Provides basic recognition capabilities, such as template layouts, by using the default engine
       • Premium model: A premium model that provides more advanced and diverse recognition features, including template layouts, multi-box support, field input value type settings, and handwritten text recognition.
     • If the service type of the domain is Document
       • Types of specialized models recognized by the domain
   • Service plan: The pricing plan applied to the domain
   • Number of templates: The number of registered templates
   • Registered templates: The names of the registered templates. Click [Template builder] to view the full list.
   • Domain creation date: The date when the domain was created
   • Last modified date: The date when the domain was last modified
   • Actions: Moves to the interface where you can manage and configure the domain by service type

Create domain

The domain creation method differs slightly by service type. For the creation method for each service type, see the following guides.

• Creating and managing domains whose service type is General: General
• Creating and managing domains whose service type is Template: Template
• Creating and managing domains whose service type is Document: Document

Delete domain

To delete a domain:

1. In the NAVER Cloud Platform console, navigate to > Services > AI Services > CLOVA OCR.
2. Click the Domain menu.
3. Select the domain you want to delete, then click [Delete domain].
4. When the Delete domain popup appears, click [Delete].
5. Click [OK].

Copy domain

You can copy a domain that has already been created and use it to create a new domain. You can change the recognition model after copying, and when changing from Premium to Basic, the Premium features are not copied and only the Basic features are copied. To create a domain by copying:

1. In the NAVER Cloud Platform console, navigate to > Services > AI Services > CLOVA OCR.
2. Click the Domain menu.
3. Click the domain you want to copy, and then click [Copy domain].
4. When the Create domain popup appears, enter the required information.
   • It is automatically filled in with the same information as the domain you are copying.
   • Since the domain name and code are unique values for each domain, you need to enter a new name and code.
5. Click [Create domain].

API Gateway integration

CLOVA OCR provides InvokeURLs for external connection, so that CLOVA OCR can be called and used from the user's application. The InvokeURL is a unique value for each domain and is not disclosed directly to external services for the provision of secure service, and it is designed to be integrated with API Gateway of NAVER Cloud Platform to increase the level of security and service processing. The flow of processing services in integration with API Gateway is summarized as follows:

Check OCR InvokeURL of the domain → Connect to the Endpoint of API Gateway → Connect externally

The Endpoint of OCR recognition calls that the user created is the InvokeURL of the domain. You can enter images and get recognition values returned through this API. Such API Gateway integration can be done automatically or manually. While manual integration offers a feature that enables the user to directly perform detailed settings, it is recommended to use automatic integrations, which is more convenient, since they basically provide the same features.

Automatic integration

Automatic integration provides automatic connection of the OCR Invoke URL of the domain and the API Gateway Endpoint. To set up an automatic integration:

1. After creating a domain, go to the Set automatic integration interface.
   • General: Click [API Gateway integration].
     
   • Template: Click [Template builder] and on the API Gateway integrations tab, click [Integrate].
     
   • Document: Click [API Gateway integration].
     
2. To issue the Secret Key required for calling the Invoke URL, click [Create].
   • [Copy] : Click to copy the Secret Key value.
3. Click [OK].
4. Click APIGW automatic integrations of [Automatic integrations].
5. Click [OK].
6. To use the Invoke URL, click APIGW Invoke URL from [Copy address].
   

Manual integration

Manual integration enables the users to directly set the connection between the OCR Invoke URL of the domain and the API Gateway Endpoint. To set up a manual integration:

1. After creating a domain, go to the manual integration setting interface.
   • General: Click [API Gateway integrations] and then click API Gateway manual integrations.
     
   • Template: Click [Template builder] and on the API Gateway integrations tab, click [Integrate] and then click API Gateway manual integrations.
     
   • Document: Click [API Gateway integrations] and then click API Gateway manual integrations.
     
2. Prepare two types of information required for manual integrations.
   • CLOVA OCR Invoke URL: Click [Copy address] to copy.
   • API Gateway configuration information: In APIGW Configuration, click [Download].
3. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
4. Click My Products menu to create a Product.
5. Click APIs for the created Product to create an API.
   • To create: Click Import from Swagger to select.
   • JSON file to upload: The file downloaded in step 2.
6. From [Stage] tab menu, create Stage API.
   • Endpoint domain: Enter the CLOVA OCR Invoke URL value copied in step 2.
   • To integrate with the OCR builder, copy and save the Invoke URL of the created Stage.
7. To deploy the created API, on the [Resource] tab menu, click [API deploy].
8. To use the Invoke URL, on the [Stage] tab menu, click [Copy address].