Skip to main content
Skip table of contents

Braille Inspection

Braille Inspection

📌 API Reference: https://verify-automation.globalvision.co/reference/createbraillejob

This feature will verify that Braille text in a file is correctly translated, properly formatted, and meets accessibility standards.

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"
}

Dictionary Name

  • Defaults to: English

  • Sets the dictionary name to use in the inspection

CODE 
 "dictionaryName": "English"

Raster DPI

  • Default value: 300

  • Sets the DPI resolution used when converting documents to images for braille detection. Higher DPI values improve detection accuracy for small or low-quality braille, but may require more processing resources.

CODE 
"rasterDpi": 300

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
        }
      ]

Separations to Hide

  • Lists the names of separations (inks) to hide during inspection. Use this to exclude specific color channels from the inspection process.

  • This is useful for focusing on certain inks (e.g., black) or removing distracting elements from the inspection.

CODE 
      "separationsToHide": [
        "separation1",
        "separation2"
      ]

Shape to Selected Layer

  • Defines an object for cropping the inspection region based on a selected layer's shape.

  • All visible layers within this area will be included in the inspection, allowing you to focus the analysis on specific zones of interest.

CODE 
"shapeTo": {
    "selectedLayerName": "layer1"
      }

Shape to Selected Separation

  • Specifies the name of a separation (ink) whose shape is used to crop the inspection region.

  • All visible content within the area covered by this separation will be inspected.

CODE 
"shapeTo": {
    "selectedSeparationName": "separation1"
      }

PDF Box Type

  • 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": "CropBox"

Report Type

  • Defaults to: Default

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

  • Options:

    • default: Includes summary, thumbnails, and annotated report.

    • summaryAnnotated: Includes only the summary and annotated report (no thumbnails).

CODE 
"reportType": "default"

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"
                {

Braille Decoding

The API will provide the following information for each braille word detected during the inspection:

  • characters = the number of characters decoded from braille to text

  • decodedTextLines = each text line detected and decoded

  • decodedTextLinesCount = number of text lines found

  • dots -> allDots = an array with the coordinates information for each braille dot found

  • detectedDots = number of dots in each braille word found

  • index and diffIndex = individually identify each braille found

  • location shows the boundingBox and pageNumber coordinates for the entire braille word

  • Braille Measurements (check for value and Marburg compliance for each measurement)

    • characterSpacing

    • dotHorizontalSpacing

    • lineSpacing

    • wordSpacing

NONE 
{
      "decoding": {
        "characters": 12,
        "decodedTextLines": [
              "serlain",
              "50 mg"
                            ],
      "decodedTextLinesCount": 2,
      "dots": {
         "allDots": [
             {
               "boundingBox": {
                   "bottom": 565.68,
                   "left": 390.48,
                   "right": 394.8,
                   "top": 561.36
                              },
               "isDetected": false
              },
              {
                "boundingBox": {
                   "bottom": 572.88,
                   "left": 390.48,
                   "right": 394.8,
                   "top": 568.56
                               },
               "isDetected": true
               },
              "detectedDots": 35
               }
                },
         "index": 0,
         "location": {
               "boundingBox": {
                  "bottom": 610.32,
                  "left": 388.32,
                  "right": 506.16,
                  "top": 559.2
                              },
         "pageNumber": 1
                 },
          "measurements": {
             "characterSpacing": {
               "isMarburgCompliant": true,
               "value": 6
                            },
             "dotHorizontalSpacing": {
                "isMarburgCompliant": true,
                "value": 2.46
                            },
             "dotVerticalSpacing": {
                "isMarburgCompliant": true,
                "value": 2.49
               },
             "lineSpacing": {
                 "isMarburgCompliant": true,
                 "value": 9.99
               },
             "wordSpacing": {
                 "isMarburgCompliant": true,
                 "value": 11.96
              }
        },
           "diffIndex": 1
}

Braille Results Summary

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

CODE 
"brailleInspectedAmount": 2
JavaScript errors detected

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

If this problem persists, please contact our support.

Contact Support Close