Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::ProcessOptions (v0.39.0)

Version latest

• 0.39.0 (latest)
• 0.38.0
• 0.37.0
• 0.36.1
• 0.35.0
• 0.34.0
• 0.33.1
• 0.32.0
• 0.31.0
• 0.30.2
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.4

Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::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.

  Note: The following fields are mutually exclusive: from_end, individual_page_selector, from_start. If a field in that set is populated, all other fields in the set will automatically be cleared.

#from_end=

def from_end=(value) -> ::Integer

Parameter

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

  Note: The following fields are mutually exclusive: from_end, individual_page_selector, from_start. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

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

  Note: The following fields are mutually exclusive: from_end, individual_page_selector, from_start. If a field in that set is populated, all other fields in the set will automatically be cleared.

#from_start

def from_start() -> ::Integer

Returns

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

  Note: The following fields are mutually exclusive: from_start, individual_page_selector, from_end. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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.

  Note: The following fields are mutually exclusive: from_start, individual_page_selector, from_end. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

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

  Note: The following fields are mutually exclusive: from_start, individual_page_selector, from_end. If a field in that set is populated, all other fields in the set will automatically be cleared.

#individual_page_selector

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

Returns

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

  Note: The following fields are mutually exclusive: individual_page_selector, from_start, from_end. If a field in that set is populated, all other fields in the set will automatically be cleared.

#individual_page_selector=

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

Parameter

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

  Note: The following fields are mutually exclusive: individual_page_selector, from_start, from_end. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

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

  Note: The following fields are mutually exclusive: individual_page_selector, from_start, from_end. If a field in that set is populated, all other fields in the set will automatically be cleared.

#layout_config

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

Returns

• (::Google::Cloud::DocumentAI::V1beta3::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::V1beta3::ProcessOptions::LayoutConfig

Parameter

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

Returns

• (::Google::Cloud::DocumentAI::V1beta3::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::V1beta3::OcrConfig

Returns

• (::Google::Cloud::DocumentAI::V1beta3::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::V1beta3::OcrConfig

Parameter

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

Returns

• (::Google::Cloud::DocumentAI::V1beta3::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::V1beta3::DocumentSchema

Returns

• (::Google::Cloud::DocumentAI::V1beta3::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::V1beta3::DocumentSchema

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::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::V1beta3::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.