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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ individual_page_selector |
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 |
OcrConfig
Only applicable to |
↳ layout_config |
ProcessOptions\LayoutConfig
Optional. Only applicable to |
↳ schema_override |
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 |
ProcessOptions\IndividualPageSelector|null |
|
hasIndividualPageSelector
setIndividualPageSelector
Which pages to process (1-indexed).
| Parameter | |
|---|---|
| Name | Description |
var |
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 |
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 |
OcrConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLayoutConfig
Optional. Only applicable to LAYOUT_PARSER_PROCESSOR.
Returns error if set on other processor types.
| Returns | |
|---|---|
| Type | Description |
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 |
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 |
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 |
DocumentSchema
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageRange
| Returns | |
|---|---|
| Type | Description |
string |
|