Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2FormExtractionParams

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

Parameters to control form extraction behavior.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta2FormExtractionParams

Returns a new instance of GoogleCloudDocumentaiV1beta2FormExtractionParams.



6921
6922
6923
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6921

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

Instance Attribute Details

#enabledBoolean Also known as: enabled?

Whether to enable form extraction. Corresponds to the JSON property enabled

Returns:

  • (Boolean)


6904
6905
6906
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6904

def enabled
  @enabled
end

#key_value_pair_hintsArray<Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2KeyValuePairHint>

Reserved for future use. Corresponds to the JSON property keyValuePairHints



6910
6911
6912
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6910

def key_value_pair_hints
  @key_value_pair_hints
end

#model_versionString

Model version of the form extraction system. Default is "builtin/stable". Specify "builtin/latest" for the latest model. For custom form models, specify: "custom/model_name". Model name format is "bucket_name/path/to/modeldir" corresponding to "gs://bucket_name/path/to/modeldir" where annotated examples are stored. Corresponds to the JSON property modelVersion

Returns:

  • (String)


6919
6920
6921
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6919

def model_version
  @model_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6926
6927
6928
6929
6930
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 6926

def update!(**args)
  @enabled = args[:enabled] if args.key?(:enabled)
  @key_value_pair_hints = args[:key_value_pair_hints] if args.key?(:key_value_pair_hints)
  @model_version = args[:model_version] if args.key?(:model_version)
end