Class Evaluation (0.12.0)

Evaluation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

Attributes

Name Description
name str
Identifier. The full resource name of the Evaluation, in the format of projects/{project}/locations/{location}/evaluations/{evaluation}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
evaluation_spec google.cloud.discoveryengine_v1alpha.types.Evaluation.EvaluationSpec
Required. The specification of the evaluation.
quality_metrics google.cloud.discoveryengine_v1alpha.types.QualityMetrics
Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
state google.cloud.discoveryengine_v1alpha.types.Evaluation.State
Output only. The state of the evaluation.
error google.rpc.status_pb2.Status
Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp the Evaluation was created at.
end_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp the Evaluation was completed at.
error_samples MutableSequence[google.rpc.status_pb2.Status]
Output only. A sample of errors encountered while processing the request.

Classes

EvaluationSpec

EvaluationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

State

State(value)

Describes the state of an evaluation.