Skip to main content
Skip table of contents

Spell Check Inspection

Spell Check Inspection

📌 API Reference: https://verify-api-docs.globalvision.co/reference/createspellingjob

This feature will automatically scan text for spelling errors and suggest corrections to help ensure content accuracy.

Supported Languages/Dictionaries

The following languages are supported:

  • Arabic

  • Bulgarian

  • Catalan

  • Croatian

  • Czech

  • Danish

  • Dutch

  • English (Canada)

  • English (Canada) + Medical

  • English (United Kingdom)

  • English (United Kingdom) + Medical

  • English (USA)

  • English (USA) + Medical

  • Estonian

  • Finnish

  • French

  • German

  • German (Austria)

  • German (Switzerland)

  • Greek

  • Hebrew

  • Hungarian

  • Indonesian

  • Irish

  • Italian

  • Japanese

  • Korean

  • Latvian

  • Lithuanian

  • Maltese

  • Norwegian (Bokmal)

  • Norwegian (Nynorsk)

  • Polish

  • Portuguese (Brazil)

  • Portuguese (Portugal)

  • Romanian

  • Russian

  • Serbian (Cyrillic)

  • Serbian (Latin)

  • Slovak

  • Slovenian

  • Spanish (Mexico)

  • Spanish (Spain)

  • Swedish (Sweden)

  • Thai

  • Turkish

  • Ukrainian

  • Medical

Inspection Features (API Input)

You can leverage any of the features below to prepare your inspection:

Feature

API Parameter Example

Document ID (required)

  • Leverage this parameter to inform the ID of the file you want to inspect.

CODE 
{
  "documentId": "your_doc_ID"
}

Review In Verify

  • Use this option if you’d like to generate a Verify User Interface URL to review the inspection results in our user interface.

  • Options are: True and False.

  • Defaults to false.

CODE 
"reviewInVerify": true,

Dictionary Names

Set the dictionary names you wish to use in your spelling inspection. Choose from any of the languages/dictionaries listed above.

CODE 
"dictionaryNames": [
        "English (Canada)",
        "Danish"

Custom Dictionary IDs

  • No Default Value

  • An array of unique IDs (UUIDs) that identify the custom dictionaries to apply during the spelling inspection. These dictionaries allow you to include domain-specific terms (e.g., brand names, technical vocabulary) that should be considered valid.

CODE 
"customDictionaryIds": "30b7-5f6-4d01-ab-44"

Preform OCR

  • Defaults to: False

  • Set to perform or not perform Optical Character Recognition (OCR) when running a spell check inspection

CODE 
"performOCR": false

Auto-Prep Layers

  • When active, this configuration will go through the layers of the file and use an AI-based logic to automatically hide selected layers that obstruct the content to be inspected.

  • Options are: True and False.

  • Defaults to false.

CODE 
"autoPrepLayers": true,

Layers Visibility

  • By default, all layers are visible.

  • Configures which layers in a document are visible during the inspection process. This is especially relevant for files that contain multiple or complex layers, such as PDF or design files.

CODE 
"layersVisibility": [
        {
          "name": "layer1",
          "visible": false
        },
        {
          "name": "layer2",
          "visible": false
        }
      ]

Crop to PDF Box Type

  • Defaults to: CropBox

  • Sets the PDF box used to crop the document for inspection.

  • Options are: CropBox, MediaBox, BleedBox, TrimBox, and ArtBox.

  • Choosing the appropriate box helps focus the inspection on the desired content area and can improve accuracy by excluding irrelevant margins or marks.

CODE 
"pdfBoxType": "TrimBox"

Ignore Regex Pattern

Set the Regex pattern that will be used to ignore spelling errors. The pattern should follow the ECMAScript standard.

CODE 
"ignoreRegexPattern": 
"\\b(?:ArtProof|ScanTVS)\\b"

Report Type

  • Determines the format and content of the PDF inspection report.

  • Options:

    • default: will generate a report with a summary, thumbnails, and an annotated report using the sample document.

    • summaryAnnotated: will generate a report with a summary and an annotated report using the sample document.

    • detailed: will generate a report with only the thumbnails.

    • detailedAnnotated: will generate a report with the thumbnails and an annotated report using the sample document.

    • annotated: will generate a report with only the annotated report using the sample document.

  • Defaults to default

CODE 
"reportType": "detailedAnnotated"

Inspection Results (API Output)

The official output of this API endpoint will be the Job ID. Use this ID to access all the inspection details described below.

Inspection Result

API Output Example

Report URL

  • Link to the generated PDF inspection report.

  • The content of this report is determined by the reportType parameter.

CODE 
"reportUrl": "https://verify-automation-api.globalvision.co/files/automation-report?fileKey=PDF_File_Key"

XFDF Reports

  • Links to XFDF annotation files for both master and sample documents (if available), which can be used for further integration with PDF viewers or automated review systems.

CODE 
"xfdfReports": {
                "master": null,
                "sample": "https://verify-automation-api.globalvision.co/files/automation-report?fileKey=XFDF_File_key"
                {

Verify URL

  • URL that can be accessed to review the results in the Verify User Interface.

  • Only available when the reviewInVerify parameter is set to true.

CODE 
"verifyUrl": "https://verify.globalvision.co/inspection/7c591d94-bd8f-/result"

Verify Report Generated

  • This parameter shows whether a new report has been created after reviewing the inspection results in the Verify UI. It switches from false to true when operators generate the report within the Verify UI.

  • Only available when the reviewInVerify parameter is set to true.

CODE 
"verifyReportGenerated": false

Spellcheck Results

Individual Results

Every result found by the spell check inspection will be shown with the following info:

  • word is the original word found in the document

  • confidence shows the confidence level of the spell check mistake, on a 0 → 1 scale

  • errorType labels the type of spell-check mistake

  • index and diffIndex individually identify each spell check mistake found

  • Results Coordinates

    • location -> boundingBox contains the coordinates of where to find the spell check mistake

    • pageNumber shows the page where the spell check mistake was found

  • suggestions is an array containing the dictionary name and word suggestion(s) to fix the spell check mistake found.

NONE 
{
       "confidence": 0.8,
       "errorType": "General",
       "index": 0,
       "location": {
          "boundingBox": {
             "bottom": 392.05,
             "left": 222.583,
             "right": 325.072,
             "top": 372.454
               },
        "pageNumber": 1
               },
        "suggestions": [
          {
            "dictionaryName": "English (USA)",
               "suggestions": [
                               "Metamucil"
                              ]
                            }
                        ],
         "word": "Bittamucin",
         "diffIndex": 1
 }

Spell Check Results Summary

  • spellingErrorsAmount informs the number of spelling errors found in the inspection

CODE 
"spellingErrorsAmount": 9
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close