Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Evaluation (v0.20.0)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::Evaluation.

An evaluation of a ProcessorVersion's performance.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#all_entities_metrics

def all_entities_metrics() -> ::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics

Returns

(::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics) — Metrics for all the entities in aggregate.

#all_entities_metrics=

def all_entities_metrics=(value) -> ::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics

Parameter

value (::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics) — Metrics for all the entities in aggregate.

Returns

(::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics) — Metrics for all the entities in aggregate.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — The time that the evaluation was created.

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — The time that the evaluation was created.

Returns

(::Google::Protobuf::Timestamp) — The time that the evaluation was created.

#document_counters

def document_counters() -> ::Google::Cloud::DocumentAI::V1::Evaluation::Counters

Returns

(::Google::Cloud::DocumentAI::V1::Evaluation::Counters) — Counters for the documents used in the evaluation.

#document_counters=

def document_counters=(value) -> ::Google::Cloud::DocumentAI::V1::Evaluation::Counters

Parameter

value (::Google::Cloud::DocumentAI::V1::Evaluation::Counters) — Counters for the documents used in the evaluation.

Returns

(::Google::Cloud::DocumentAI::V1::Evaluation::Counters) — Counters for the documents used in the evaluation.

#entity_metrics

def entity_metrics() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics}

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics}) — Metrics across confidence levels, for different entities.

#entity_metrics=

def entity_metrics=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics}

Parameter

value (::Google::Protobuf::Map{::String => ::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics}) — Metrics across confidence levels, for different entities.

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::DocumentAI::V1::Evaluation::MultiConfidenceMetrics}) — Metrics across confidence levels, for different entities.

#kms_key_name

def kms_key_name() -> ::String

Returns

(::String) — The KMS key name used for encryption.

#kms_key_name=

def kms_key_name=(value) -> ::String

Parameter

value (::String) — The KMS key name used for encryption.

Returns

(::String) — The KMS key name used for encryption.

#kms_key_version_name

def kms_key_version_name() -> ::String

Returns

(::String) — The KMS key version with which data is encrypted.

#kms_key_version_name=

def kms_key_version_name=(value) -> ::String

Parameter

value (::String) — The KMS key version with which data is encrypted.

Returns

(::String) — The KMS key version with which data is encrypted.

#name

def name() -> ::String

Returns

(::String) — The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

#name=

def name=(value) -> ::String

Parameter

value (::String) — The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

Returns

(::String) — The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}