public final class Evaluation extends GeneratedMessageV3 implements EvaluationOrBuilder
An evaluation of a ProcessorVersion's performance.
Protobuf type google.cloud.documentai.v1beta3.Evaluation
Static Fields
ALL_ENTITIES_METRICS_FIELD_NUMBER
public static final int ALL_ENTITIES_METRICS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DOCUMENT_COUNTERS_FIELD_NUMBER
public static final int DOCUMENT_COUNTERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENTITY_METRICS_FIELD_NUMBER
public static final int ENTITY_METRICS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_VERSION_NAME_FIELD_NUMBER
public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Evaluation getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Evaluation.Builder newBuilder()
newBuilder(Evaluation prototype)
public static Evaluation.Builder newBuilder(Evaluation prototype)
public static Evaluation parseDelimitedFrom(InputStream input)
public static Evaluation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Evaluation parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Evaluation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Evaluation parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Evaluation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Evaluation parseFrom(CodedInputStream input)
public static Evaluation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Evaluation parseFrom(InputStream input)
public static Evaluation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Evaluation parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Evaluation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Evaluation> parser()
Methods
containsEntityMetrics(String key)
public boolean containsEntityMetrics(String key)
Metrics across confidence levels, for different entities.
map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAllEntitiesMetrics()
public Evaluation.MultiConfidenceMetrics getAllEntitiesMetrics()
Metrics for all the entities in aggregate.
.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
getAllEntitiesMetricsOrBuilder()
public Evaluation.MultiConfidenceMetricsOrBuilder getAllEntitiesMetricsOrBuilder()
Metrics for all the entities in aggregate.
.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
getCreateTime()
public Timestamp getCreateTime()
The time that the evaluation was created.
.google.protobuf.Timestamp create_time = 2;
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
The time that the evaluation was created.
.google.protobuf.Timestamp create_time = 2;
getDefaultInstanceForType()
public Evaluation getDefaultInstanceForType()
getDocumentCounters()
public Evaluation.Counters getDocumentCounters()
Counters for the documents used in the evaluation.
.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;
getDocumentCountersOrBuilder()
public Evaluation.CountersOrBuilder getDocumentCountersOrBuilder()
Counters for the documents used in the evaluation.
.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;
getEntityMetrics()
public Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetrics()
getEntityMetricsCount()
public int getEntityMetricsCount()
Metrics across confidence levels, for different entities.
map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
| Returns |
|---|
| Type | Description |
int | |
getEntityMetricsMap()
public Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetricsMap()
Metrics across confidence levels, for different entities.
map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
getEntityMetricsOrDefault(String key, Evaluation.MultiConfidenceMetrics defaultValue)
public Evaluation.MultiConfidenceMetrics getEntityMetricsOrDefault(String key, Evaluation.MultiConfidenceMetrics defaultValue)
Metrics across confidence levels, for different entities.
map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
getEntityMetricsOrThrow(String key)
public Evaluation.MultiConfidenceMetrics getEntityMetricsOrThrow(String key)
Metrics across confidence levels, for different entities.
map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
| Parameter |
|---|
| Name | Description |
key | String
|
getKmsKeyName()
public String getKmsKeyName()
The KMS key name used for encryption.
string kms_key_name = 6;
| Returns |
|---|
| Type | Description |
String | The kmsKeyName.
|
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes()
The KMS key name used for encryption.
string kms_key_name = 6;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for kmsKeyName.
|
getKmsKeyVersionName()
public String getKmsKeyVersionName()
The KMS key version with which data is encrypted.
string kms_key_version_name = 7;
| Returns |
|---|
| Type | Description |
String | The kmsKeyVersionName.
|
getKmsKeyVersionNameBytes()
public ByteString getKmsKeyVersionNameBytes()
The KMS key version with which data is encrypted.
string kms_key_version_name = 7;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for kmsKeyVersionName.
|
getName()
The resource name of the evaluation.
Format:
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
The resource name of the evaluation.
Format:
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Evaluation> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasAllEntitiesMetrics()
public boolean hasAllEntitiesMetrics()
Metrics for all the entities in aggregate.
.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
| Returns |
|---|
| Type | Description |
boolean | Whether the allEntitiesMetrics field is set.
|
hasCreateTime()
public boolean hasCreateTime()
The time that the evaluation was created.
.google.protobuf.Timestamp create_time = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasDocumentCounters()
public boolean hasDocumentCounters()
Counters for the documents used in the evaluation.
.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the documentCounters field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Evaluation.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Evaluation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Evaluation.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
