Graphics Inspection
๐ API Reference: https://verify-automation.globalvision.co/reference/creategraphicsjob
This feature automatically compares two image files to detect visual differences, ensuring artwork or packaging designs remain consistent and error-free.
You can leverage any of the features below to prepare your inspection:
Feature | API Parameter Example |
---|
Graphics Custom Profile Sensitivity |
CODE
{
"profile": {
"sensitivity": "Low"
}
|
Document ID (required) |
NONE
{
"documentId": "your_doc_ID"
}
|
Layers Visibility For both Master and Sample objects 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 For both Master and Sample objects 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 For both Master and Sample objects 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 For both Master and Sample objects 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 For both Master and Sample objects 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 |
CODE
"reportType": "default"
|
Annotated Report Source Defaults to: Sample Source of the annotated report, valid options are master or sample . Will be used only if reportType is summaryAnnotated .
|
CODE
{
"annotatedReportSource": "sample",
"reportType": "default"
}
|
Inspection Results (API Output)
Inspection Result | API Output Example |
---|
Report URL |
CODE
"reportUrl": "https://verify-automation-api.globalvision.co/files/automation-report?fileKey=PDF_File_Key"
|
XFDF Reports |
CODE
"xfdfReports": {
"master": https://verify-automation-api.globalvision.co/files/automation-report?fileKey=XFDF_File_key,
"sample": "https://verify-automation-api.globalvision.co/files/automation-report?fileKey=XFDF_File_key"
{
|
Graphics Differences Individual Differences Every difference found by the graphics inspection will be shown with the following info: |
NONE
{
"index": 0,
"master": {
"location": {
"boundingBox": {
"bottom": 24.48,
"left": 110.88,
"right": 129.84,
"top": 18.48
},
"pageNumber": 1
}
},
"matchIndex": 0,
"sample": {
"location": {
"boundingBox": {
"bottom": 24.48,
"left": 110.88,
"right": 129.84,
"top": 18.48
},
"pageNumber": 1
}
},
"diffIndex": 1
}
|
Graphics Inspection Summary Match Details confidence shows the confidence level in 0 โ 1 scale
confidenceLevel translates the confidence to a High, Medium, Low scale
masterLocation, sampleLocation, and pageNumber show the coordinates of the overall graphics match on both the master and sample files
|
NONE
"matchDetails": [
{
"confidence": 0.9941202998161316,
"confidenceLevel": "High",
"masterLocation": {
"boundingBox": {
"bottom": 792,
"left": 0,
"right": 612,
"top": 0
},
"pageNumber": 1
},
"sampleLocation": {
"boundingBox": {
"bottom": 792,
"left": 0,
"right": 612,
"top": 0
},
"pageNumber": 1
}
}
]
|
Graphics Inspection Summary Inspection Details |
NONE
"graphicsDifferencesAmount": 12,
"graphicsFilesNotComparable": false
|