Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentLabel

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/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.



5794
5795
5796
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5794

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) 


5781
5782
5783
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5781

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) 


5786
5787
5788
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5786

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) 


5792
5793
5794
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5792

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5799
5800
5801
5802
5803
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5799

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