Skip to content

Commit a283962

Browse files
committed
Add more 5.6 features
1 parent f714bfc commit a283962

File tree

1 file changed

+40
-17
lines changed

1 file changed

+40
-17
lines changed

p-process.yml

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,13 @@ components:
174174
that have meaningful information on both pages, like Russian domestic passport, or some others.
175175
By default is set to false."
176176
type: boolean
177+
# default false
178+
generateDoublePageSpreadImage:
179+
description: 'When enabled together with "doublePageSpread" and there is a passport with two pages
180+
spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured
181+
on a flatbed scanner.'
182+
type: boolean
183+
# default false
177184
fieldTypesFilter:
178185
description: "List of text field types to extract. If empty, all text fields from template will be extracted.
179186
Narrowing the list can shorten processing time. By default is empty."
@@ -199,6 +206,7 @@ components:
199206
already cropped document by its edges. This was designed to process on the
200207
server side images captured and cropped on mobile. By default is set to false."
201208
type: boolean
209+
# default false
202210
customParams:
203211
description: "This option allows to pass custom processing parameters that can be implemented in future without
204212
changing API."
@@ -207,6 +215,11 @@ components:
207215
log:
208216
description: "This option can be set to true if you need to get base64 string of transaction processing log."
209217
type: boolean
218+
# default log
219+
logLevel:
220+
description: "When used together with 'log' parameter enabled, sets the level of logs detalization."
221+
$ref: "#/components/schemas/LogLevel"
222+
# default: "INFO"
210223
forceDocID:
211224
description: "Force use of specific template ID and skip document type identification step."
212225
type: integer
@@ -216,30 +229,25 @@ components:
216229
to match the mask and provide a correctly formatted value, making assumptions based on the provided field mask
217230
in the template."
218231
type: boolean
219-
default: true
232+
# default: true
220233
fastDocDetect:
221234
description: "When enabled, shorten the list of candidates to process during document detection in a
222235
single image process mode. Reduces processing time for specific backgrounds."
223236
type: boolean
224-
default: true
237+
# default: true
225238
updateOCRValidityByGlare:
226239
description: "When enabled, fail OCR field validity, if there is a glare over the text field on the image."
227240
type: boolean
228-
default: false
229-
generateDoublePageSpreadImage:
230-
description: 'When enabled together with "doublePageSpread" and there is a passport with two pages
231-
spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured
232-
on a flatbed scanner.'
233-
type: boolean
241+
# default: false
234242
checkRequiredTextFields:
235243
description: 'When enabled, each field in template will be checked for value presence and if the field
236244
is marked as required, but has no value, it will have "error" in validity status.'
237245
type: boolean
238-
default: false
246+
# default: false
239247
returnCroppedBarcode:
240248
description: 'When enabled, returns cropped barcode images for unknown documents'
241249
type: boolean
242-
default: false
250+
# default: false
243251
imageQA:
244252
$ref: '#/components/schemas/ImageQA'
245253
forceDocFormat:
@@ -249,22 +257,37 @@ components:
249257
noGraphics:
250258
description: "When enabled no graphic fields will be cropped from document image."
251259
type: boolean
252-
default: false
260+
# default: false
253261
documentAreaMin:
254262
description: "Specifies minimal area of the image
255263
that document should cover to be treated as candidate when locating.
256264
Value should be in range from 0 to 1, where 1 is when document should fully cover the image."
257265
type: number
258266
format: float
259-
default: 0
260-
logLevel:
261-
description: "When used together with 'log' parameter enabled, sets the level of logs detalization."
262-
default: "INFO"
263-
$ref: "#/components/schemas/LogLevel"
267+
# default: 0
264268
depersonalizeLog:
265269
description: "When enabled all personal data will be forcibly removed from the logs."
266270
type: boolean
267-
default: false
271+
# default: false
272+
multiDocOnImage:
273+
description: "This option allows locating and cropping multiple documents from one image if enabled."
274+
type: boolean
275+
# default false
276+
shiftExpiryDate:
277+
description: "This option allows shifting the date of expiry into the future or past for number of months specified.
278+
This is useful, for example, in some cases when document might be still valid for some period
279+
after original expiration date to prevent negative validity status for such documents.
280+
Or by shifting the date to the past will set negative validity for the documents
281+
that is about to expire in a specified number of months."
282+
type: integer
283+
minimalHolderAge:
284+
description: "This options allows specifying the minimal age in years of the document holder
285+
for the document to be considered valid."
286+
type: integer
287+
returnUncroppedImage:
288+
description: "This option allows returning input images in output if enabled."
289+
type: boolean
290+
# default false
268291
required:
269292
- scenario
270293

0 commit comments

Comments
 (0)