Domain
    • PDF

    Domain

    • PDF

    Article Summary

    Available in Classic and VPC

    In Domain, you can create and manage domains. A CLOVA OCR service is created based on a domain. For example, when you create a "bill" OCR, a domain is the unit that includes all bill templates that become the target of recognition. In this way, the creation of templates, integration of channels, and statistical information are operated and managed based on a single domain.
    The service types of domains are General, Template, and Document. This guide introduces the Domain page configuration, which is the common content for each domain service type, and API Gateway integration method for external connection, and briefly describes domain creation and management methods. For more details on how to create and manage domains for each service type, see the following guides.

    • Domains whose service type is General: OCR that extracts text/tables
      • Creation and management methods: General
    • Domains whose service type is Template: OCR that supports template builder, which can directly specify analysis areas, extract recognized values, test them, and then transfer results
      • Creation and management methods: Template
    • Domains whose service type is Document: OCR equipped with a specialized model engine that understands document's semantic structure based on machine learning, and automatically extracts key values
      • Creation and management methods: Document

    Domain screen

    The basics of using Domain are as follows:

    clovaocr-domain_01_230530_ko

    AreaDescription
    ① Menu nameName of the menu currently being viewed
    ② Basic featuresCreate domain, set specialized model, view service details, refresh page
    ③ Post-creation featuresDelete, copy, and search domains
    ④ List of domainsCheck domain list and basic information, set actions

    Check domain list

    You can check the information for each domain from the domain list. The following describes how to view the information.

    1. From the NAVER Cloud Platform console's Region menu, click and select the region you're using.
    2. From the Platform menu, click to select between VPC and Classic.
    3. Click the Services > AI Services > CLOVA OCR menu in order.
    4. Click the Domain menu.
    5. When the domain list appears, check the basic information.
      • Domain ID: unique ID that identifies domains

      • Domain name: unique name that identifies domains

      • Domain code: unique code that identifies domains

      • Supported language: types of languages supported by the domain. It includes Korean, Japanese, Taiwanese (Simplified Chinese), and English is supported by default even if it is not indicated.

      • Recognition model: recognition rate level or recognition target type applied to the domain whose service type is Template or Document

        Recognition modelBasicPremiumDescription
        Model recognition rateTypeface and handwriting recognitionTypeface and handwriting recognitionProvides a high-performance OCR recognition model optimized for major business purposes
        Appropriate documentsCertificates, documents with a fixed formHandwritten request forms, sign-up forms, financial documents, etc.-
        Recognition template layoutProvidedProvidedSets recognition area
        Multi-boxNot providedProvidedCombines single box templates to control number recognition area, etc.
        CheckboxNot providedProvidedProvides recognition in the checkbox format
        Field typeNot providedProvidedSets the type to recognize recognition values only as numbers
        Not recognizedNot providedProvidedMasks specific areas within the field after specifying the general field
        Combine analysis resultNot providedProvidedCombines results of individual fields and prints them as "new values"
        Text conversion of checkbox recognition resultNot providedProvidedSubstitutes returned values of checkboxes into specific characters
        • If the service type of the domain is Template
          • Basic model: it provides basic recognition features such as template layouts, with the basic engine.
          • Premium model: the Premium model provides more sophisticated and diverse recognition features such as template layouts, multi-boxes, Value type settings for field input values, and handwriting recognition.
        • If the service type of the domain is Document
          • Types of specialized models recognized by the domain
      • Service plan: type of pricing plan applied to the domain

      • Number of templates: number of registered templates

      • Registered template: name of the registered template. Click the [Template builder] button to view the entire list.

      • Domain creation date: the date the domain was created

      • Edited date: the date the domain was last edited

      • Action: directs to the page where domains by service type can be managed and set

    Note

    You can search for the desired domain by entering or setting the domain information in the Domain list.
    clovaocr-domain_02_ko

    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
    Caution

    You can only create 1 domain whose service type is General per Region.

    Delete domain

    The following describes how to delete a domain.

    1. From the NAVER Cloud Platform console's Region menu, click and select the region you're using.
    2. From the Platform menu, click to select between VPC and Classic.
    3. Click the Services > AI Services > CLOVA OCR menu in order.
    4. Click the Domain menu.
    5. Click the domain you want to delete, and then click the [Delete domain] button.
    6. When the Delete domain pop-up window appears, click the [Delete] button.
    7. Click the [OK] button.

    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. The following describes how to create a domain by copying.

    Note

    Since only 1 domain whose service type is General can be created per Region, additional creation by copying is not possible.

    1. From the NAVER Cloud Platform console's Region menu, click and select the region you're using.
    2. From the Platform menu, click to select between VPC and Classic.
    3. Click the Services > AI Services > CLOVA OCR menu in order.
    4. Click the Domain menu.
    5. Click the domain you want to copy, and then click the [Copy domain] button.
    6. When the Create domain pop-up window 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.
    7. Click the [Create domain] button.

    Integrating with API Gateway

    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 integration, which is more convenient, since they basically provide the same features.

    Caution

    Additional fees apply when you subscribe to API Gateway. For an introduction to API Gateway and a description of pricing plans, see the Services > Application Services > API Gateway menu on the NAVER Cloud Platform website.

    Automatic integration

    Automatic integration provides automatic connection of the OCR Invoke URL of the domain and the API Gateway Endpoint. The following describes how you can set up an automatic integration.

    1. After creating a domain, go to the Set automatic integration page.
      • General: click the [API Gateway integration] button
        clovaocr-domain_03_230530_ko
      • Template: click the [Template builder] button, and then click the [Integrate] button from the API Gateway integration tab menu
        clovaocr-domain_04_230530_ko
      • Document: click the [API Gateway integration] button
        clovaocr-domain_05_ko
    2. To issue the Secret Key required for calling the Invoke URL, click the [Create] button.
      • [Copy] button: copies the Secret Key value when clicked
    3. Click the [OK] button.
    4. Click the [Automatic integration] button of APIGW automatic integration.
    5. Click the [OK] button.
    6. To use the Invoke URL, click the [Copy address] button from APIGW Invoke URL.
      clovaocr-domain_09_ko
    Note

    In step 1, if the recognition model for Document is ID, provide the Invoke URLs for recognizing ID and passport (Global), respectively.
    By clicking the [Edit] button of APIGW automatic integration in step 6, you can create the Invoke URL again. When creating it again, the connection to CLOVA OCR may be temporarily disrupted.

    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. The following describes how you can set up a manual integration.

    1. After creating a domain, go to the Set manual integration page.
      • General: click the [API Gateway integration] button, and then click the API Gateway manual integration
        clovaocr-domain_06_230530_ko
      • Template: click the [Template builder] button, click the [Integrate] button from the API Gateway integration tab menu, and then click API Gateway manual integration
        clovaocr-domain_07_230530_ko
      • Document: click the [API Gateway integration] button, and then click the API Gateway manual integration
        clovaocr-domain_08_ko
    2. Prepare two types of information required for manual integration.
      • CLOVA OCR Invoke URL: click the [Copy address] button to copy the address.
      • API Gateway settings information: click the [Download] button in APIGW Configuration.
    3. In the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
    4. Click the My Products menu to create a Product.
    5. Click APIs for the created Product to create an API.
      • Creation method: click to select Import from Swagger.
      • Json file to be uploaded: the file downloaded from step 2.
    6. From the Stage tab menu, create a Stage API.
      • Endpoint domain: enter the CLOVA OCR Invoke URL value copied from step 2.
      • To integrate with the OCR builder, copy and save the Invoke URL of the created Stage.
    7. To deploy the created API, click the [Deploy API] button from the Resource tab menu.
    8. To use the Invoke URL, click the [Copy address] button from the Stage tab menu.
      clovaocr-domain_10_ko
    Note

    For a detailed description of how to use API Gateway, see the API Gateway guide.


    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.