Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentLabel

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

Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta2DocumentLabel

Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentLabel.



2817
2818
2819
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2817

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

Instance Attribute Details

#automl_model ⇒ String

Label is generated AutoML model. This field stores the full resource name of the AutoML model. Format: projects/project-id/locations/location-id/ models/model-id` Corresponds to the JSON propertyautomlModel`

Returns:

  • (String) 


2804
2805
2806
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2804

def automl_model
  @automl_model
end

#confidence ⇒ Float

Confidence score between 0 and 1 for label assignment. Corresponds to the JSON property confidence

Returns:

  • (Float) 


2809
2810
2811
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2809

def confidence
  @confidence
end

#name ⇒ String

Name of the label. When the label is generated from AutoML Text Classification model, this field represents the name of the category. Corresponds to the JSON property name

Returns:

  • (String) 


2815
2816
2817
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2815

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2822
2823
2824
2825
2826
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2822

def update!(**args)
  @automl_model = args[:automl_model] if args.key?(:automl_model)
  @confidence = args[:confidence] if args.key?(:confidence)
  @name = args[:name] if args.key?(:name)
end