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.



6622
6623
6624
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6622

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) 


6609
6610
6611
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6609

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) 


6614
6615
6616
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6614

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) 


6620
6621
6622
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6620

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6627
6628
6629
6630
6631
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6627

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