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.



4569
4570
4571
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4569

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) 


4556
4557
4558
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4556

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) 


4561
4562
4563
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4561

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) 


4567
4568
4569
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4567

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4574
4575
4576
4577
4578
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4574

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