Google Cloud Document Ai V1 Client - Class ProcessOptions (2.0.0)

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class ProcessOptions.

Options for Process API

Generated from protobuf message google.cloud.documentai.v1.ProcessOptions

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ individual_page_selector Google\Cloud\DocumentAI\V1\ProcessOptions\IndividualPageSelector

Which pages to process (1-indexed).

↳ from_start int

Only process certain pages from the start. Process all if the document has fewer pages.

↳ from_end int

Only process certain pages from the end, same as above.

↳ ocr_config Google\Cloud\DocumentAI\V1\OcrConfig

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

↳ layout_config Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig

Optional. Only applicable to LAYOUT_PARSER_PROCESSOR. Returns error if set on other processor types.

↳ schema_override Google\Cloud\DocumentAI\V1\DocumentSchema

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

getIndividualPageSelector

Which pages to process (1-indexed).

Returns
Type Description
Google\Cloud\DocumentAI\V1\ProcessOptions\IndividualPageSelector|null

hasIndividualPageSelector

setIndividualPageSelector

Which pages to process (1-indexed).

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\ProcessOptions\IndividualPageSelector
Returns
Type Description
$this

getFromStart

Only process certain pages from the start. Process all if the document has fewer pages.

Returns
Type Description
int

hasFromStart

setFromStart

Only process certain pages from the start. Process all if the document has fewer pages.

Parameter
Name Description
var int
Returns
Type Description
$this

getFromEnd

Only process certain pages from the end, same as above.

Returns
Type Description
int

hasFromEnd

setFromEnd

Only process certain pages from the end, same as above.

Parameter
Name Description
var int
Returns
Type Description
$this

getOcrConfig

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR.

Returns error if set on other processor types.

Returns
Type Description
Google\Cloud\DocumentAI\V1\OcrConfig|null

hasOcrConfig

clearOcrConfig

setOcrConfig

Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR.

Returns error if set on other processor types.

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\OcrConfig
Returns
Type Description
$this

getLayoutConfig

Optional. Only applicable to LAYOUT_PARSER_PROCESSOR.

Returns error if set on other processor types.

Returns
Type Description
Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig|null

hasLayoutConfig

clearLayoutConfig

setLayoutConfig

Optional. Only applicable to LAYOUT_PARSER_PROCESSOR.

Returns error if set on other processor types.

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\ProcessOptions\LayoutConfig
Returns
Type Description
$this

getSchemaOverride

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

Returns
Type Description
Google\Cloud\DocumentAI\V1\DocumentSchema|null

hasSchemaOverride

clearSchemaOverride

setSchemaOverride

Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override.

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\DocumentSchema
Returns
Type Description
$this

getPageRange

Returns
Type Description
string