Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation

Inherits:

Object

• Object
• Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Evaluation

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 more...

Overview

An evaluation of a ProcessorVersion's performance.

Instance Attribute Summary

• #all_entities_metrics ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics

  Metrics across multiple confidence levels.

• #create_time ⇒ String

  The time that the evaluation was created.

• #document_counters ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters

  Evaluation counters for the documents that were used.

• #entity_metrics ⇒ Hash<String,Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics>

  Metrics across confidence levels, for different entities.

• #kms_key_name ⇒ String

  The KMS key name used for encryption.

• #kms_key_version_name ⇒ String

  The KMS key version with which data is encrypted.

• #name ⇒ String

  The resource name of the evaluation.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDocumentaiV1Evaluation constructor

  A new instance of GoogleCloudDocumentaiV1Evaluation.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1Evaluation

Returns a new instance of GoogleCloudDocumentaiV1Evaluation.

# File 'lib/google/apis/documentai_v1/classes.rb', line 4034

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

Instance Attribute Details

#all_entities_metrics ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics

Metrics across multiple confidence levels. Corresponds to the JSON property allEntitiesMetrics

Returns:

• (Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics)

# File 'lib/google/apis/documentai_v1/classes.rb', line 4000

def all_entities_metrics
  @all_entities_metrics
end

#create_time ⇒ String

The time that the evaluation was created. Corresponds to the JSON property createTime

Returns:

• (String)

# File 'lib/google/apis/documentai_v1/classes.rb', line 4005

def create_time
  @create_time
end

#document_counters ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters

Evaluation counters for the documents that were used. Corresponds to the JSON property documentCounters

Returns:

• (Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationCounters)

# File 'lib/google/apis/documentai_v1/classes.rb', line 4010

def document_counters
  @document_counters
end

#entity_metrics ⇒ Hash<String,Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics>

Metrics across confidence levels, for different entities. Corresponds to the JSON property entityMetrics

Returns:

• (Hash<String,Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics>)

# File 'lib/google/apis/documentai_v1/classes.rb', line 4015

def entity_metrics
  @entity_metrics
end

#kms_key_name ⇒ String

The KMS key name used for encryption. Corresponds to the JSON property kmsKeyName

Returns:

• (String)

# File 'lib/google/apis/documentai_v1/classes.rb', line 4020

def kms_key_name
  @kms_key_name
end

#kms_key_version_name ⇒ String

The KMS key version with which data is encrypted. Corresponds to the JSON property kmsKeyVersionName

Returns:

• (String)

# File 'lib/google/apis/documentai_v1/classes.rb', line 4025

def kms_key_version_name
  @kms_key_version_name
end

#name ⇒ String

The resource name of the evaluation. Format: projects/project/locations/ location/processors/processor/processorVersions/processor_version/ evaluations/evaluation` Corresponds to the JSON propertyname`

Returns:

• (String)

# File 'lib/google/apis/documentai_v1/classes.rb', line 4032

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/documentai_v1/classes.rb', line 4039

def update!(**args)
  @all_entities_metrics = args[:all_entities_metrics] if args.key?(:all_entities_metrics)
  @create_time = args[:create_time] if args.key?(:create_time)
  @document_counters = args[:document_counters] if args.key?(:document_counters)
  @entity_metrics = args[:entity_metrics] if args.key?(:entity_metrics)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @kms_key_version_name = args[:kms_key_version_name] if args.key?(:kms_key_version_name)
  @name = args[:name] if args.key?(:name)
end