Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2ProcessDocumentRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1beta2/classes.rb,
lib/google/apis/documentai_v1beta2/representations.rb,
lib/google/apis/documentai_v1beta2/representations.rb

Overview

Request to process one document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta2ProcessDocumentRequest

Returns a new instance of GoogleCloudDocumentaiV1beta2ProcessDocumentRequest.



5501
5502
5503
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5501

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#automl_params ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2AutoMlParams

Parameters to control AutoML model prediction behavior. Corresponds to the JSON property automlParams

Returns:



5454
5455
5456
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5454

def automl_params
  @automl_params
end

#document_type ⇒ String

Specifies a known document type for deeper structure detection. Valid values are currently "general" and "invoice". If not provided, "general"\ is used as default. If any other value is given, the request is rejected. Corresponds to the JSON property documentType

Returns:

  • (String) 


5461
5462
5463
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5461

def document_type
  @document_type
end

#entity_extraction_params ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2EntityExtractionParams

Parameters to control entity extraction behavior. Corresponds to the JSON property entityExtractionParams

Returns:



5466
5467
5468
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5466

def entity_extraction_params
  @entity_extraction_params
end

#form_extraction_params ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2FormExtractionParams

Parameters to control form extraction behavior. Corresponds to the JSON property formExtractionParams

Returns:



5471
5472
5473
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5471

def form_extraction_params
  @form_extraction_params
end

#input_config ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2InputConfig

The desired input location and metadata. Corresponds to the JSON property inputConfig

Returns:



5476
5477
5478
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5476

def input_config
  @input_config
end

#ocr_params ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2OcrParams

Parameters to control Optical Character Recognition (OCR) behavior. Corresponds to the JSON property ocrParams

Returns:



5481
5482
5483
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5481

def ocr_params
  @ocr_params
end

#output_config ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2OutputConfig

The desired output location and metadata. Corresponds to the JSON property outputConfig

Returns:



5486
5487
5488
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5486

def output_config
  @output_config
end

#parent ⇒ String

Target project and location to make a call. Format: projects/project-id/ locations/location-id`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method. Corresponds to the JSON propertyparent`

Returns:

  • (String) 


5494
5495
5496
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5494

def parent
  @parent
end

#table_extraction_params ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2TableExtractionParams

Parameters to control table extraction behavior. Corresponds to the JSON property tableExtractionParams

Returns:



5499
5500
5501
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5499

def table_extraction_params
  @table_extraction_params
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 5506

def update!(**args)
  @automl_params = args[:automl_params] if args.key?(:automl_params)
  @document_type = args[:document_type] if args.key?(:document_type)
  @entity_extraction_params = args[:entity_extraction_params] if args.key?(:entity_extraction_params)
  @form_extraction_params = args[:form_extraction_params] if args.key?(:form_extraction_params)
  @input_config = args[:input_config] if args.key?(:input_config)
  @ocr_params = args[:ocr_params] if args.key?(:ocr_params)
  @output_config = args[:output_config] if args.key?(:output_config)
  @parent = args[:parent] if args.key?(:parent)
  @table_extraction_params = args[:table_extraction_params] if args.key?(:table_extraction_params)
end