Discovery Engine v1beta API - Class Evaluation (1.0.0-beta18)

public sealed class Evaluation : IMessage<Evaluation>, IEquatable<Evaluation>, IDeepCloneable<Evaluation>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class Evaluation.

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

Inheritance

object > Evaluation

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

Evaluation()

public Evaluation()

Evaluation(Evaluation)

public Evaluation(Evaluation other)
Parameter
Name Description
other Evaluation

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp the [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] was created at.

Property Value
Type Description
Timestamp

EndTime

public Timestamp EndTime { get; set; }

Output only. Timestamp the [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] was completed at.

Property Value
Type Description
Timestamp

Error

public Status Error { get; set; }

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

Property Value
Type Description
Status

ErrorSamples

public RepeatedField<Status> ErrorSamples { get; }

Output only. A sample of errors encountered while processing the request.

Property Value
Type Description
RepeatedFieldStatus

EvaluationName

public EvaluationName EvaluationName { get; set; }

EvaluationName-typed view over the Name resource name property.

Property Value
Type Description
EvaluationName

EvaluationSpec

public Evaluation.Types.EvaluationSpec EvaluationSpec { get; set; }

Required. The specification of the evaluation.

Property Value
Type Description
EvaluationTypesEvaluationSpec

Name

public string Name { get; set; }

Identifier. The full resource name of the [Evaluation][google.cloud.discoveryengine.v1beta.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.

Property Value
Type Description
string

QualityMetrics

public QualityMetrics QualityMetrics { get; set; }

Output only. The metrics produced by the evaluation, averaged across all [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s in the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Only populated when the evaluation's state is SUCCEEDED.

Property Value
Type Description
QualityMetrics

State

public Evaluation.Types.State State { get; set; }

Output only. The state of the evaluation.

Property Value
Type Description
EvaluationTypesState