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.



6275
6276
6277
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6275

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:



6228
6229
6230
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6228

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) 


6235
6236
6237
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6235

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:



6240
6241
6242
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6240

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:



6245
6246
6247
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6245

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:



6250
6251
6252
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6250

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:



6255
6256
6257
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6255

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:



6260
6261
6262
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6260

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) 


6268
6269
6270
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6268

def parent
  @parent
end

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

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

Returns:



6273
6274
6275
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6273

def table_extraction_params
  @table_extraction_params
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6280

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