Skip to main content

2.14.1. AI Recognition

The AI recognition feature allows you to automatically analyze the content of documents or images. The AI processes the document text, identifies key data, and maps it to the defined attributes of the system.


How does AI recognition differ from IDP?

The platform also supports recognition using IDP (Intelligent Document Processing) technology, which has been available in the system long before AI recognition was introduced. You can review the main differences between these two recognition types in the table below:

CriterionAI RecognitionIDP Recognition
How it worksAnalyzes the document as a single text with understanding of context and semanticsFocuses on document structure, recognizing zones and their content
Document typesWorks with unstructured documents of various formatsOptimized for specific document types
Training requiredDoes not require additional training on document samplesRequires prior training on specific templates
ProvidersOpenAI
Azure OpenAI
DeepSeek
Grok
Gemini
Claude
Azure Form Recognizer
Google

2.14.1.1. Configure AI Recognition

To configure document recognition using artificial intelligence, complete the following steps:

  1. Create an AI model subscription and generate a key — create an account with your preferred AI provider and generate an API key to configure the provider integration with the Nectainium platform.

  2. Add an AI model — configure the provider integration with the Nectainium platform.

  3. Create an AI scenario — the platform includes a System scenario for document recognition — sys_doc_recognize. This scenario is suitable for most standard documents and requires no additional configuration.

    When should you create a custom AI scenario?

    For non-standard cases, you can create your own custom scenario for more accurate recognition. We recommend creating a custom scenario based on a duplicate of the system scenario sys_doc_recognize, as it already contains the required system variables. For example, the docTypes variable passes information about the platform's document types to the scenario. Reproducing this functionality by manually creating variables is complex and not recommended.

  4. Create a recognition template — within the template, you can define which document types you want to recognize.

  5. Configure or create a shortcut for recognition — connect the created recognition template to the shortcut.

  6. Configure document type attributes — add descriptions to attributes to improve recognition results.

2.14.1.1.1. Create an AI Model Subscription and Generate a Key

You can choose one of the following providers:

OpenAI platform
  1. Go to the OpenAI platform website.

  2. Select the Start building button.

    Screenshot
  3. In the Organization name 1 field, enter any organization name, then in the What best describes you 2 field, select Not technical.

  4. Select the Create organization 3 button.

    Screenshot
  5. Select I'll invite my team later.

    Screenshot
  6. In the API key name 1 field, enter any name for the key.

  7. Leave the Project name 2 field unchanged.

  8. Select the Generate API Key 3 button.

    Screenshot
  9. Select the Copy button to copy the generated key.

    Screenshot
  10. Paste this key using Ctrl+V into a safe location, such as a notes app. You will need this key in the subsequent configuration steps.

    Warning:

    After closing this window, for security reasons, you will no longer be able to see this key in the OpenAI platform. If you do not save the key, you will need to generate a new one.

  11. Select the Continue button.

    Screenshot
  12. Select the amount you want to add to your balance 1, then select the Purchase credits 2 button.

    Screenshot
  13. Enter your payment details 1, then select the Add payment method 2 button.

    Screenshot
  14. Proceed to the next configuration step: Add an AI Model.

Azure OpenAI service
  1. Go to the Azure OpenAI Service website.

  2. Select the Create with Azure AI Foundry button.

    Screenshot
  3. Select the Sign in to get started button.

    Screenshot
  4. In the Email 1 field, enter the email address you want to register the account with, then select the Next 2 button.

    Screenshot
  5. Go to your email inbox, open the letter from Microsoft, and copy the confirmation code to verify your email address.

  6. In the Enter code 1 field, paste the code you copied from the email, then select the Next 2 button.

    Screenshot
  7. In the Phone field, enter your phone number 1, then select the Text me 2 button to receive an SMS confirmation.

    Screenshot
  8. In the Verification code 1 field, enter the code from the SMS, then select the Verify code 2 button.

    Screenshot
  9. In the Address line 1 1 field, enter your address, then in the City 2 field, enter the city that will appear on your invoice.

  10. In the Postal code 3 field, enter your postal code that will appear on the invoice.

  11. Select the I represent that I am… 4 checkbox to agree to the terms of service, then select the Next 5 button.

    Screenshot
  12. Enter your bank card details 1 that will be used for future transactions, then select the Next 2 button.

    Screenshot
  13. Select the No technical support… 1 checkbox to decline paid account support services, then select the Sign up 2 button to complete registration.

    Screenshot
  14. Go to the Azure OpenAI Studio website.

  15. In the upper-left corner, select the icon 1, then select Create a resource 2.

    Screenshot
  16. In the search field 1, type Azure openAI, then find the Azure openAI service in the search results and select the Create 2 button.

    Screenshot
  17. Under the Resource group field, select Create new 1.

  18. In the Name 2 field, enter any name, then select the OK 3 button.

    Screenshot
  19. In the Name 1 field, enter any name, then in the Pricing tier 2 field, select Standard S0.

  20. Select the Next 3 button.

    Screenshot
  21. Select the Next button.

    Screenshot
  22. Select the Deployments tab.

    Screenshot
  23. Select the Deploy model 1 button, then select Deploy base model 2.

    Screenshot
  24. Select the Deploy button.

    Screenshot
  25. Select the Screenshot icon to copy the key.

    Screenshot
  26. Paste this key using Ctrl+V into a safe location, such as a notes app. You will need this key in the subsequent configuration steps.

  27. Proceed to the next configuration step: Add an AI Model.

DeepSeek platform
  1. Go to the DeepSeek platform website.

  2. Select the Sign up button to register.

    Screenshot
  3. In the Email address 1 field, enter your email address.

  4. In the Password 2 field, enter your desired password, then in the Confirm password 3 field, enter your password again.

    Screenshot
  5. Select the Send code 1 button to verify your email address. A six-digit code will be sent to the email address you provided.

  6. In the Code 2 field, enter the code sent to your email, then select the Sign up 3 button to complete registration.

    Screenshot
  7. Go to the Top up section.

    Screenshot
  8. In the Amount 1 section, select the amount you want to add to your balance.

  9. Select the Next step 2 button.

    Screenshot
  10. Select one of the available payment methods: PayPal A or bank card B.

    Screenshot
  11. Enter your payment details 1, then select the Pay 2 button.

    Screenshot
  12. Go to the API keys 1 section, then select the Create new API key 2 button.

    Screenshot
  13. In the Name field, enter any name for the key, then select the Create API key button.

    Screenshot
  14. In the Create new API key window, select the Copy button to copy the generated key.

    Screenshot
  15. Paste this key using Ctrl+V into a safe location, such as a notes app. You will need this key in the subsequent configuration steps.

    Warning:

    After closing this window, for security reasons, you will no longer be able to see this key in the DeepSeek platform. If you do not save the key, you will need to generate a new one.

  16. Proceed to the next configuration step: Add an AI Model.

Grok platform
  1. Go to the xAI API console website.

  2. Select Sign up.

    Screenshot
  3. In the Email 1 field, enter your email address, then select the Submit 2 button.

    Screenshot
  4. Fill in the remaining fields to create your profile 1, then select the Continue 2 button.

    Screenshot
  5. Go to your email inbox, open the letter from xAI, then select Validate my email address to verify your email address.

    Screenshot
  6. After verification, you will see the Email verified window. You can close this browser tab and return to the previous tab where you were following the previous steps.

    Screenshot
  7. Select the checkboxes to agree to the terms of use and confirm that you are of legal age 1, then select the Continue 2 button.

    Screenshot
  8. On your profile home page, select the Create an API key button.

    Screenshot
  9. Select the Set up billing button to configure payment for API usage.

    Screenshot
  10. In the Billing address section, select Edit.

    Screenshot
  11. Fill in all required fields for billing 1, then select the Save 2 button.

    Screenshot
  12. In the Payment methods section, select Add method to add a payment method.

    Screenshot
  13. Select a payment method 1, then fill in the payment details 2.

  14. Select the Save card 3 button.

    Screenshot
  15. Select Purchase credits to top up your balance.

    Screenshot
  16. In the Custom amount 1 field, enter the amount you want to add to your balance, then select the Proceed 2 button.

    Screenshot
  17. Select the Purchase credits button to confirm the top-up.

    Screenshot
  18. Open the Screenshot tab 1, then select the Create API key 2 button.

    Screenshot
  19. In the Name 1 field, enter any name for the key, then select the Save 2 button.

    Screenshot
  20. Select the button to copy the API key.

    Screenshot
  21. Paste this key using Ctrl+V into a safe location, such as a notes app. You will need this key in the subsequent configuration steps.

    Warning:

    After closing this window, for security reasons, you will no longer be able to see this key in the platform. If you do not save the key, you will need to generate a new one.

  22. Proceed to the next configuration step: Add an AI Model.

Gemini platform
  1. Go to the Gemini API website.

  2. Select the Get a Gemini API Key button.

    Screenshot
  3. Select the Get API key button.

    Screenshot
  4. Select the I consent to the Google APIs Terms… 1 checkbox, then select the I accept 2 button.

    Screenshot
  5. Select the Create API key button.

    Screenshot
  6. Select the Copy button to copy the API key.

    Screenshot
  7. Paste this key using Ctrl+V into a safe location, such as a notes app. You will need this key in the subsequent configuration steps.

    Warning:

    After closing this window, for security reasons, you will no longer be able to see this key in the platform. If you do not save the key, you will need to generate a new one.

  8. Proceed to the next configuration step: Add an AI Model.

Claude platform
  1. Go to the Anthropic API website.

  2. Select the Start building button.

    Screenshot
  3. In the Email 1 field, enter the email address you want to register the account with, then select the Continue with email 2 button.

    Screenshot
  4. Go to your email inbox, open the letter from Anthropic, then select Sign in to Anthropic Console to verify your email address.

    Screenshot
  5. In the What's your full name 1 field, enter your full name, then in the What should we call you 2 field, enter your first name.

  6. Select the I'm at least 18 years old… 3 checkbox to confirm you are of legal age, then select the Continue 4 button.

    Screenshot
  7. Select your account type, for example Individual, to create a personal account.

    Screenshot
  8. Select the Get API keys tab to generate a key.

    Screenshot
  9. In the Key Name 1 field, edit the key name. You can name the key Nectainium to make its purpose clear.

  10. Select the Create API Key 2 button.

    Screenshot
  11. In the API KEY field, select Copy to copy the generated key.

    Screenshot
  12. Paste this key using Ctrl+V into a safe location, such as a notes app. You will need this key in the subsequent configuration steps.

    Warning:

    After closing this window, for security reasons, you will no longer be able to see this key in the platform. If you do not save the key, you will need to generate a new one.

  13. At this point, your key is ready to use. Your balance already includes a free $5 credit provided upon registration. You can proceed to the next configuration steps or add more funds to your balance.

To top up your balance, complete the following steps:

  1. Select the Continue button.

    Screenshot
  2. Select the Manage API keys button.

    Screenshot
  3. Go to the Billing section.

    Screenshot
  4. Select the Add Credit Card button.

    Screenshot
  5. In the Current Balance 1 field, enter the amount you want to add to your balance.

  6. In the Credit Card 2 section, enter your bank card details to fund the top-up.

  7. Select the Buy credits 3 button to confirm the purchase.

    Screenshot
  8. Proceed to the next configuration step: Add an AI Model.

2.14.1.1.2. Add an AI Model

  1. In the navigation panel, select the Studio 1 workspace.

  2. Select the AI Center 2 shortcut group, then select the AI Models 3 shortcut.

  3. In the toolbar, select Add a model 4.

  4. In the dropdown list, select LLM model 5.

    Screenshot
  5. Select the checkbox of the required data processing provider 1, according to the subscription you set up in the previous step.

  6. Select the I have read and agree to the selected provider's data processing policies 2 checkbox.

  7. Select the Next 3 button.

    Screenshot
  8. Complete the remaining steps according to your selected provider.

Azure OpenAI provider
  1. In the Key 1 field, paste the value from the API key 1 field in the Azure OpenAI resource you created in the Create an Azure OpenAI subscription section (steps 16–21).

  2. In the Key expiry date 2 field, select the date until which this key will be valid.

  3. If you set a date in the previous field, you can also select the Notify the administrator 15 days before the key expires checkbox.

  4. In the URL 1 field, paste the value from the Azure OpenAI endpoint field in the Azure OpenAI resource you created in the Create an Azure OpenAI subscription section (steps 16–21).

  5. In the Deployment ID 2 field, paste the value from the Deployment name field of the deployment you created in the Create an Azure OpenAI subscription section (steps 23–24).

  6. Select the Verify API key button. If the key is valid, the message API key is valid will appear.

  7. Select the I understand that API usage will be charged to my account 1 checkbox. This means that model usage will be billed according to the rates of the provider with whom you set up the subscription.

  8. Select the Next 2 button.

  9. In the Name 1 field, enter a name for the added model.

  10. In the Description 2 field, specify the purpose of the model.

  11. Select the Default model 1 checkbox if you want this model to be used automatically for this provider. If you add another model from the same provider, this model will be selected by default.

  12. Select the Add 2 button.

OpenAI, DeepSeek, Grok, Gemini, Claude providers
  1. In the Key 1 field, paste the API key you generated in the previous step.

  2. In the Key expiry date 2 field, select the date until which this key will be valid.

  3. Select the Notify the administrator 15 days before the key expires 3 checkbox.

  4. Select the Verify API key 4 button. If the key is valid, the message API key is valid will appear.

  5. Select the I understand that API usage will be charged to my account 1 checkbox. This means that all charges will be applied according to the rates of the provider with whom you set up the subscription.

  6. Select the Next 2 button.

  7. In the Model 1 section, select one of the following options:

    • Recommended model: each provider offers multiple models, but the Nectainium platform always recommends the one best suited for document processing. For example: the OpenAI platform includes models such as gpt-5-mini, gpt-5.3, gpt-5.2, gpt-4.1-mini, and many others. The Nectainium platform recommends the gpt-5-mini model.
    • Custom model: if the platform’s recommended model does not suit your needs, you can select any other model available from your provider. When you select this option, the Custom model 2 field will appear, where you can choose one of the models offered by your provider.
  8. Select the Next 3 button.

  9. In the Name 1 field, enter a name for the added model.

  10. In the Description 2 field, enter the purpose of the model.

  11. Select the Default model 3 checkbox if you want this model to be used automatically for this provider. If you add another model from the same provider, this model will be selected by default.

  12. Select the Add 4 button.

2.14.1.1.3. Create a Recognition Template

  1. In the navigation panel, select the Studio 1 workspace.

  2. Select the AI Center 2 shortcut group, then select the AI Document Recognition 3 shortcut group.

  3. Select the Form Recognition Templates 4 shortcut, then in the toolbar select + 5.

    Screenshot
  4. Fill in the fields using the guidance in the table below.

FieldDescription
Code*
  • The code must be unique.
  • The code must be short (typically up to 10 characters).
  • Use only Latin letters and digits.
Name*Enter the template name.
DescriptionIf needed, enter a brief description of the template's purpose.
Recognition method*Select the AI Scenario option.
AI Scenario*Select the required AI scenario from the list. The list will display only AI scenarios of the Document Recognition type. You can also select the system scenario sys_doc_recognize, which is designed to recognize both single and multiple documents at once.
Document typesSelect one of the following options:
  • Allow all types — the user will be able to recognize all document types they have access to.
  • Select types — the template will recognize only the specified document types. When you select this option, a field will appear for choosing the required document types.
  1. In the toolbar, select Save.

2.14.1.1.4. Configure a Shortcut for Recognition

Any platform users can perform recognition if the administrator grants them access to the shortcut and permission to create documents of the types selected in the shortcut.

  1. Create a shortcut or open one of the system shortcuts of the Documents type. During creation, pay attention to the following steps.

    Screenshot
  2. When creating the shortcut, go to the Typed 1 tab.

  3. In the Document types 2 field, select the document types that users will work with in this shortcut.

    For recognition, the platform uses only those document types that are selected in both the shortcut and the recognition template (intersection of lists). If a document type is selected in only one place (either in the shortcut or in the template), it will not appear in the list of types available for recognition.

  4. Select the Configure Actions button 3.

    Screenshot
  5. Select the Recognize document 1 action checkbox.

  6. In the Available recognition templates 2 field, select the required template from the list (for example, the one you created in the previous section).

    Note:

    You can select multiple recognition templates within a single shortcut. This allows users to choose the required template themselves when selecting the recognition icon.

  7. Select the Save 3 button.

    Screenshot
  8. In the toolbar, select Save.

2.14.1.1.5. Configure Document Type Attributes

This step is optional, but can significantly improve recognition quality. Configuring document type attributes is useful when recognition uses:

  • the system scenario sys_doc_recognize
  • custom scenarios that work with the documentTypes variable

The documentTypes variable passes to the LLM not only the Name, Code, and Type of document type attributes, but also the content of the Description field defined when creating or editing an attribute. You can therefore add additional context to the Description field. The LLM uses this description to more accurately understand where to look for values and how to interpret them.

Screenshot

Example:

In this attribute, we want to store address information, so we describe for the LLM where exactly to look for this information in the document:


Usually located on the first page of the document. Written by hand. Located below the "Floor" and "Location" fields.

2.14.1.2. Recognize a Document Using AI

You can recognize a document using artificial intelligence. This helps identify the document content and map it to the corresponding system attributes. Before recognizing a document using AI, make sure you have configured AI recognition.

Method 1: via system shortcut

In this scenario, only the platform administrator can perform recognition.

  1. In the navigation panel, select the Studio 1 workspace, select the AI Center 2 shortcut group, then select the AI Document Recognition 3 shortcut group.

  2. Select the Recognition Log 4 shortcut, then in the toolbar select + 5.

    Screenshot
  1. In the Recognition Template 1 field, select the required recognition template.

  2. Select the Automatically create document 2 checkbox if you want a document to be created automatically from the recognized data after recognition is complete. If this checkbox is not selected, you will be able to review the recognition result and manually confirm document creation.

    Warning:

    If the recognized data does not meet the attribute validation rules, the system will highlight the attribute in red in the preview window (available when automatic document creation is disabled) — you can correct the value manually before creating the document. If you enabled automatic document creation, the document will not be created because the system cannot automatically fix the validation error.

  3. In the toolbar of the File field, select +. You can upload multiple files at once.

    Note:

    The file must match the document type you configured in the shortcut and the recognition template.

    Example: if you added the document type Leave Request to the shortcut and template, you will most likely need to upload a specific employee's request: Leave Request of Ivan Honchar.

    Note:

    If you uploaded multiple files, you can use the bottom menu to switch between the uploaded files.

  4. Select the Recognize button.

  5. The next steps depend on whether you selected the With preview option:

Option 1: you did not select Automatically create document
  1. You will see your uploaded document and the recognition result. If needed, you can edit the attribute values 1, then select Create document 2 to confirm saving the result.

  2. If the recognition result does not suit you and you do not want to save it — simply close the tab.

Note:

If you uploaded multiple files and selected the With preview checkbox, a page will open with the following details: the overall recognition progress A, and the status of each individual document B.

If errors occurred during recognition, the corresponding records will be additionally grouped in the Errors tab 1 for easy review. In this tab, you can open the document that caused the error 2, view the error details 3, and, if needed, retry the recognition 4.

After the recognition process is complete, you can select any recognized document from the list 1, edit the recognition result if needed 2, and then select Create document 3 to confirm saving the result.

Option 2: you selected Automatically create document
  1. You will receive a notification from the platform about the start of the recognition process.

  2. If recognition is completed successfully, you will receive an additional notification. In the notification text, select Details to view the recognition result, or Created document to open the created document directly.

    The uploaded file will be displayed on the left A, and its attributes with the recognized data on the right B.

  3. Select Open document if you want to view the created document and edit the attribute values if needed.

Note:

If you uploaded multiple files, a page will open with the following details: the overall recognition progress A, and the status of each individual document B.

If errors occurred during recognition, the corresponding records will be additionally grouped in the Errors tab 1 for easy review. In this tab, you can open the document that caused the error 2, view the error details 3, and, if needed, retry the recognition 4.

After the recognition process is complete, you can select any recognized document from the list 1, then select Open document 2 to view the created document and edit the attribute values if needed.

Method 2: via user shortcut

In this scenario, any platform users granted access to the shortcut by the administrator can perform recognition.

  1. Go to the shortcut where the Recognize Document action is enabled and configured. (See section Configure a Shortcut for Recognition)

  2. In the toolbar, select the recognition icon.

    Screenshot
  1. In the Recognition Template 1 field, select the required recognition template.

  2. Select the Automatically create document 2 checkbox if you want a document to be created automatically from the recognized data after recognition is complete. If this checkbox is not selected, you will be able to review the recognition result and manually confirm document creation.

    Warning:

    If the recognized data does not meet the attribute validation rules, the system will highlight the attribute in red in the preview window (available when automatic document creation is disabled) — you can correct the value manually before creating the document. If you enabled automatic document creation, the document will not be created because the system cannot automatically fix the validation error.

  3. In the toolbar of the File field, select +. You can upload multiple files at once.

    Note:

    The file must match the document type you configured in the shortcut and the recognition template.

    Example: if you added the document type Leave Request to the shortcut and template, you will most likely need to upload a specific employee's request: Leave Request of Ivan Honchar.

    Note:

    If you uploaded multiple files, you can use the bottom menu to switch between the uploaded files.

  4. Select the Recognize button.

  5. The next steps depend on whether you selected the With preview option:

Option 1: you did not select Automatically create document
  1. You will see your uploaded document and the recognition result. If needed, you can edit the attribute values 1, then select Create document 2 to confirm saving the result.

  2. If the recognition result does not suit you and you do not want to save it — simply close the tab.

Note:

If you uploaded multiple files and selected the With preview checkbox, a page will open with the following details: the overall recognition progress A, and the status of each individual document B.

If errors occurred during recognition, the corresponding records will be additionally grouped in the Errors tab 1 for easy review. In this tab, you can open the document that caused the error 2, view the error details 3, and, if needed, retry the recognition 4.

After the recognition process is complete, you can select any recognized document from the list 1, edit the recognition result if needed 2, and then select Create document 3 to confirm saving the result.

Option 2: you selected Automatically create document
  1. You will receive a notification from the platform about the start of the recognition process.

  2. If recognition is completed successfully, you will receive an additional notification. In the notification text, select Details to view the recognition result, or Created document to open the created document directly.

    The uploaded file will be displayed on the left A, and its attributes with the recognized data on the right B.

  3. Select Open document if you want to view the created document and edit the attribute values if needed.

Note:

If you uploaded multiple files, a page will open with the following details: the overall recognition progress A, and the status of each individual document B.

If errors occurred during recognition, the corresponding records will be additionally grouped in the Errors tab 1 for easy review. In this tab, you can open the document that caused the error 2, view the error details 3, and, if needed, retry the recognition 4.

After the recognition process is complete, you can select any recognized document from the list 1, then select Open document 2 to view the created document and edit the attribute values if needed.

2.14.1.3. View Recognition Status

Using the Recognition Log shortcut, you can view the recognition status of individual documents or entire groups. You can also open the recognition form for each document to view the details.

Method 1: for administrator
  1. In the navigation panel, select the Studio 1 workspace.

  2. Select the AI Center 2 shortcut group, then select the Document Recognition 3 shortcut group.

  3. Select the Recognition Log 4 shortcut.

  4. Filter the table results by the Created column to display the most recent recognitions at the top.

  5. Select the required group (if you upload multiple files at once, they are combined into a group) or the document whose recognition status you want to view.

  6. You will see a list of files you imported for recognition. In the status column, you can view the recognition status. See section Status Values.

Method 2: for user
  1. Go to the shortcut where you performed bulk recognition.

  2. In the upper-right corner, select the 1 icon.

  3. Select Recognition Log 2.

  4. Filter the table results by the Created column to display the most recent recognitions at the top.

  5. Select the required group (if you upload multiple files at once, they are combined into a group) or the document whose recognition status you want to view.

  6. You will see a list of files you imported for recognition. In the status column, you can view the recognition status. See section Status Values.

2.14.1.3.1. Status Values

  • New — A recognition request that is queued.

  • In progress — The system is still processing this file. Wait for the document to move to the Success or Error status.

  • Success — The system has successfully recognized the document. To view the created document, select the record, then in the toolbar select Created document.

    You can also view additional recognition details in the following tabs:

    • Document — contains the attributes of the recognized document.
    • [Table name] — if your document contains table attributes, you will see a separate tab with the name and content of that table.
    • Raw result — all data that the AI "saw" in the document: both valid values and those that do not match any attributes.
    • Extracted values — a filtered result containing only the fields that match the document type attributes. These are the values the system will use to populate the attributes in the created document.
    • Processing log — contains errors that occurred during validation. For example, if the Price attribute has a constraint of ≤500 but the file contains 600, the system will clear this field after recognition. Similarly, if an attribute expects a date but the file contains a different format, the document will be created with an empty value for that attribute.

  • Error — The system was unable to recognize the document, so the document was not created. Select the status to see the reason in the Error details field.

    You can also select the Retry button.

2.14.1.4. Configure File Splitting

The Document Splitting feature is an auxiliary tool for preparing large multi-page files for subsequent AI document recognition.


Splitting serves two key purposes:

  • Prepares the document for recognition — the system divides the source file into several separate parts.
  • Allows identifying different document types within a single set of pages.

Example:

  1. You upload a multi-page document (for example, an 80-page PDF).
  2. The platform automatically splits it into equal parts. This is needed to optimize the LLM model performance. The smaller the document fragments passed for processing, the better the result.
  3. The connected AI model recognizes each part separately, identifies the content type and logical document boundaries.
  4. Based on the recognition, the system forms separate documents with clear boundaries, for example:
    • Pages 1–3 — Resume
    • Pages 4–15 — Contract
    • Pages 16–18 — Act

As a result, from one large set of pages, the system automatically creates a structured set of documents of the corresponding types, ready for further work in the platform.


To configure splitting, complete the following steps:

Note:

Before starting the splitting configuration, make sure you have configured AI recognition.

  1. Create a business process for splitting.
  2. Create a recognition template to call the process.
  3. Create a shortcut for recognition.

2.14.1.4.1. Create a Business Process for Splitting

  1. Create a business process definition. Build the process according to your needs. The process can consist of the following stages:

    1. A Split the document into equal parts — this is needed to optimize the AI model performance. Can be implemented using a service task (template Call Entity Method). Example of a call scenario using the split PDF method:

      var startPage = execution.getVariable('startPage')

      JSON.stringify({
      entity: "dfx_AiExecution",
      method: "splitPDF",
      execParams: {
      ID: execution.getVariable('temp_aiExecutionID'),
      sourceEntity: "dfx_IdpJob",
      sourceID: execution.getVariable('$ID'),
      sourceAttribute: "sourceFile",
      pageRanges: JSON.stringify([[
      startPage ? startPage : 1,
      startPage ? startPage + 15 : 15,
      ]])
      }
      })

      The splitPDF method splits a PDF document into one fragment of 15 pages, starting from the page stored in the startPage variable. If startPage is not set, the range 1–15 is used. This method supports flexible page range definition as an array of ranges and individual pages. You can use the following formats:

      • Page range: [1,6] — pages 1 through 6.
      • Individual pages and ranges: ['1,2,5-6'] — pages 1, 2, 5, 6.
      • Single page: [1,1] — page 1 only.
    2. B Run the system AI scenario for splitting — the AI analyzes the fragment and identifies document type ranges within it. Can be implemented using a service task (template AI Execution). The system scenario for splitting can be connected in the task: sys_doc_splitter.

    3. C To correctly transform and pass data between these stages, use a script task.

    4. In the service task (marked with the icon), you can define the AI scenario for recognition.

      Example of such a process:

      Screenshot

2.14.1.4.2. Create a Recognition Template to Call the Process

  1. In the navigation panel, select the Studio 1 workspace.

  2. Select the AI Center 2 shortcut group, then select the AI Document Recognition 3 shortcut group.

  3. Select the Form Recognition Templates 4 shortcut, then in the toolbar select + 5.

    Screenshot
  4. Fill in the fields using the guidance in the table below.

FieldDescription
Code*
  • The code must be unique.
  • The code must be short (typically up to 10 characters).
  • Use only Latin letters and digits.
Name*Enter the template name.
DescriptionIf needed, enter a brief description of the template's purpose.
Recognition method*Select the BPMN Process option.
Process definition*Select the process definition you created in the previous section from the list.
Version*Select one of the following options:
  • Use the latest version — always use the latest deployed version of the definition.
  • Use a specific version — when selected, choose the required version in the Specify process version field.
Document typesSelect one of the following options:
  • Allow all types — the user will be able to recognize all document types they have access to.
  • Select types — the template will recognize only the specified document types. When you select this option, a field will appear for choosing the required document types.
Multiple documentsSelect the checkbox.
  1. In the toolbar, select Save.

2.14.1.5. Run File Splitting

Note:

Before starting, make sure you have configured file splitting.

Follow all steps from the Recognize a Document Using AI section.

After starting recognition, a section with execution details A will appear, showing the number of split, recognized, and skipped pages. Below it, the list of detected document types B is displayed.

In the Detected Documents panel, select a document 1 to view the list of attributes with values recognized by the LLM model 2. If needed, you can edit the attribute values or enter new ones if some attributes are empty. To save the recognition and splitting results, select the Create document 3 button. Repeat this action for each detected document.

If errors occurred during recognition, the corresponding records will be additionally grouped in the Errors 1 tab for convenient review. In this tab, you can open the document that caused the error 2, view the error details 3, and, if needed, retry the recognition 4.

If the automatic splitting incorrectly identified document boundaries or skipped pages, you can manually define the page range for each document.

2.14.1.5.1. Manually Define Page Range Boundaries

Note:

The actions described in this section can only be performed by users with the Admin or Developer role.

In some cases, automatic splitting may not work correctly (for example, document boundaries may be incorrectly identified, or pages may be skipped). In such cases, you can manually add the missing parts without restarting the entire recognition process.

For example, you have a 4-page file that the system identified as 4 separate documents — that is, 1 page = 1 document. In reality, the first 2 pages belong to one document, and the other 2 pages belong to another. In this case, you can manually merge the first 2 pages into one document and the other 2 pages into another. Then delete the documents with incorrect page ranges that the system created earlier.


To manually define the page range boundaries for a document:

  1. Open the recognition form of the document for which you need to change the page range.

  2. On the recognition form, in the Detected Documents section, right-click the document 1 for which you want to manually define the page range boundaries.

  3. In the context menu, select Create document from range 2.

  4. In the Pages for recognition field, enter the page range to create.

  5. Optional: in the Recognition template 1 field, select a different recognition template to apply to this page range.

  6. Optional: change the value of the Automatically create document 2 checkbox. If the checkbox is selected, the document will be created immediately after recognition completes. If not selected, the document will not be created automatically, and you will be able to review the result and manually confirm document creation.

  7. Select Create task.

A new document with the specified page range will appear in the Detected Documents section.

To delete a document with an incorrect page range that the system created earlier, right-click that document 1, then select Delete 2.

2.14.1.6. Bulk Actions in the "Recognition Log" Shortcut

Using the system Recognition Log shortcut, the administrator can view the recognition status and perform actions on multiple execution records at once. This is done using multi-select mode. For example, instead of canceling several recognitions one by one, you can select multiple records in the log and apply the required action to all selected records simultaneously.


The following actions are available for bulk processing:

  • Cancel — stop the recognition. A canceled recognition can be restarted later if needed. This action is available for recognitions with the In progress status.

  • Restart — re-run the recognition for the selected records. Typically used after cancellation or when an error occurred during a previous recognition. This action is available for recognitions with the Error, Completed with errors, Canceled, or Hung statuses.

  • Delete — permanently remove the recognition record from the log. Once deleted, the record cannot be restored.

  • Create document — create a document in the system based on the results of the completed recognition. This action is available for recognitions with the Success status. If the recognition is grouped and its status is Completed with errors, Canceled, or Hung, but at least one of the nested recognitions was completed successfully, it is not possible to create a document from such a record in the grid. In that case, the document can be created from the recognition form.


To perform bulk actions in the Recognition Log shortcut:

  1. In the navigation panel, select the Studio 1 workspace.

  2. Select the AI Center 2 shortcut group, then select the AI Document Recognition 3 shortcut group.

  3. Select the Recognition Log 4 shortcut.

  4. Enable Multi-select mode and select the checkboxes next to the required recognition records 5.

  5. Right-click and in the context menu select the required action 6.

    Screenshot

For the Cancel, Restart, and Create document actions, a table will open showing the selected records A and a button to confirm the action B.

Note:

If the selected record does not support the chosen action, it will display the Not applicable status. This may happen, for example, if you attempt to cancel a recognition that has not yet been started.