Document AI V1 API - Class Google::Cloud::DocumentAI::V1::ProcessOptions (v1.2.0)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::ProcessOptions.

Options for Process API

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#from_end

def from_end() -> ::Integer

Returns

(::Integer) — Only process certain pages from the end, same as above.

#from_end=

def from_end=(value) -> ::Integer

Parameter

value (::Integer) — Only process certain pages from the end, same as above.

Returns

(::Integer) — Only process certain pages from the end, same as above.

#from_start

def from_start() -> ::Integer

Returns

(::Integer) — Only process certain pages from the start. Process all if the document has fewer pages.

#from_start=

def from_start=(value) -> ::Integer

Parameter

value (::Integer) — Only process certain pages from the start. Process all if the document has fewer pages.

Returns

(::Integer) — Only process certain pages from the start. Process all if the document has fewer pages.

#individual_page_selector

def individual_page_selector() -> ::Google::Cloud::DocumentAI::V1::ProcessOptions::IndividualPageSelector

Returns

(::Google::Cloud::DocumentAI::V1::ProcessOptions::IndividualPageSelector) — Which pages to process (1-indexed).

#individual_page_selector=

def individual_page_selector=(value) -> ::Google::Cloud::DocumentAI::V1::ProcessOptions::IndividualPageSelector

Parameter

value (::Google::Cloud::DocumentAI::V1::ProcessOptions::IndividualPageSelector) — Which pages to process (1-indexed).

Returns

(::Google::Cloud::DocumentAI::V1::ProcessOptions::IndividualPageSelector) — Which pages to process (1-indexed).

#layout_config

def layout_config() -> ::Google::Cloud::DocumentAI::V1::ProcessOptions::LayoutConfig

Returns

(::Google::Cloud::DocumentAI::V1::ProcessOptions::LayoutConfig) — Optional. Only applicable to LAYOUT_PARSER_PROCESSOR. Returns error if set on other processor types.

#layout_config=

def layout_config=(value) -> ::Google::Cloud::DocumentAI::V1::ProcessOptions::LayoutConfig

Parameter

value (::Google::Cloud::DocumentAI::V1::ProcessOptions::LayoutConfig) — Optional. Only applicable to LAYOUT_PARSER_PROCESSOR. Returns error if set on other processor types.

Returns

(::Google::Cloud::DocumentAI::V1::ProcessOptions::LayoutConfig) — Optional. Only applicable to LAYOUT_PARSER_PROCESSOR. Returns error if set on other processor types.

#ocr_config

def ocr_config() -> ::Google::Cloud::DocumentAI::V1::OcrConfig

Returns

(::Google::Cloud::DocumentAI::V1::OcrConfig) — Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

#ocr_config=

def ocr_config=(value) -> ::Google::Cloud::DocumentAI::V1::OcrConfig

Parameter

value (::Google::Cloud::DocumentAI::V1::OcrConfig) — Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

Returns

(::Google::Cloud::DocumentAI::V1::OcrConfig) — Only applicable to OCR_PROCESSOR and FORM_PARSER_PROCESSOR. Returns error if set on other processor types.

#schema_override

def schema_override() -> ::Google::Cloud::DocumentAI::V1::DocumentSchema

Returns

(::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.

#schema_override=

def schema_override=(value) -> ::Google::Cloud::DocumentAI::V1::DocumentSchema

Parameter

value (::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.

Returns

(::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.