gRPC API Reference Messages
OCRBlock
View as Markdown
Struct for describing an OCR block.
Fields
Field Type Number Description
idint321 Unique ID (within a vault).
namestring2 Human-friendly name of the block.
pageuint323 One-based number of page on which this block should appear. 0 can be used to indicate the first recognizable instance.
dimension_unitOCRBlockDimUnitType4 Defines the unit of the block rectangle dimensions. Default is pixels.Values: OCRBLOCK_DIM_UNIT_TYPE_PIXELS (0), OCRBLOCK_DIM_UNIT_TYPE_MILLIMETERS_X10 (1), OCRBLOCK_DIM_UNIT_TYPE_INCHES_X100 (2).
leftuint325 Distance from the left of the image.
topuint326 Distance from the top of the image.
widthuint327 Width of the block rectangle.
heightuint328 Height of the block rectangle.
optionsOCROptions9 OCR options used for this block. If unset, default settings are used.
confidence_thresholdint3210 Max confidence level that is acceptable for reognition. No threshold if -1.
filter_regular_expressionstring11 Regular expression for value confirmation (not used if length is 0).
remove_line_breaksbool12 Indicates whether recognized value lines should be collapsed into a one-line value. Default is true.
is_barcodebool13 True if the block should be interpreted as barcode.
data_typeDatatype14 Data type for the result.
Used in fields