1.0.0-beta25 (latest) 1.0.0-beta24

    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](https://learn.microsoft.com/dotnet/api/system.object) \> Evaluation

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Evaluation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Evaluation), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Evaluation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Evaluation), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Evaluation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Evaluation), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DiscoveryEngine.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)

## Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

## Constructors

### Evaluation()

    public Evaluation()

### Evaluation(Evaluation)

    public Evaluation(Evaluation other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### EndTime

    public Timestamp EndTime { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### 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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.CommonProtos/latest/Google.Rpc.Status.html` |   |

### ErrorSamples

    public RepeatedField<Status> ErrorSamples { get; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://cloud.google.com/dotnet/docs/reference/Google.Api.CommonProtos/latest/Google.Rpc.Status.html` |   |

### EvaluationName

    public EvaluationName EvaluationName { get; set; }

[EvaluationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.EvaluationName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Evaluation#Google_Cloud_DiscoveryEngine_V1Beta_Evaluation_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.EvaluationName` |   |

### EvaluationSpec

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

Required. The specification of the evaluation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Evaluationhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Evaluation.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Evaluation.Types.EvaluationSpec` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.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** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.QualityMetrics` |   |

### State

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

Output only. The state of the evaluation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Evaluationhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Evaluation.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.Evaluation.Types.State` |   |