1.0.0-beta09 (latest) 1.0.0-beta08

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

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1beta API class EvaluationRun.

An evaluation run represents an all the evaluation results from an
evaluation execution.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> EvaluationRun

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[EvaluationRun](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[EvaluationRun](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[EvaluationRun](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun), [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.Ces.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta)

## Assembly

Google.Cloud.Ces.V1Beta.dll

## Constructors

### EvaluationRun()

    public EvaluationRun()

### EvaluationRun(EvaluationRun)

    public EvaluationRun(EvaluationRun other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun` |

## Properties

### AppVersion

    public string AppVersion { get; set; }

Output only. The app version to evaluate.
Format:
`projects/{project}/locations/{location}/apps/{app}/versions/{version}`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### AppVersionAsAppVersionName

    public AppVersionName AppVersionAsAppVersionName { get; set; }

[AppVersionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.AppVersionName)-typed view over the [AppVersion](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun#Google_Cloud_Ces_V1Beta_EvaluationRun_AppVersion) resource name property.

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

### AppVersionDisplayName

    public string AppVersionDisplayName { get; set; }

Output only. The display name of the `app_version` that the evaluation ran
against.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Changelog

    public string Changelog { get; set; }

Output only. The changelog of the app version that the evaluation ran
against. This is populated if user runs evaluation on latest/draft.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ChangelogAsChangelogName

    public ChangelogName ChangelogAsChangelogName { get; set; }

[ChangelogName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.ChangelogName)-typed view over the [Changelog](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun#Google_Cloud_Ces_V1Beta_EvaluationRun_Changelog) resource name property.

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

### ChangelogCreateTime

    public Timestamp ChangelogCreateTime { get; set; }

Output only. The create time of the changelog of the app version that the
evaluation ran against. This is populated if user runs evaluation on
latest/draft.

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

### Config

    public EvaluationConfig Config { get; set; }

Output only. The configuration used in the run.

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

### CreateTime

    public Timestamp CreateTime { get; set; }

Output only. Timestamp when the evaluation run was created.

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

### DisplayName

    public string DisplayName { get; set; }

Optional. User-defined display name of the evaluation run.
default: "\<evaluation-dataset-display-name\> run - \<timestamp\>".

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Error

    [Obsolete]
    public Status Error { get; set; }

Output only. Deprecated: Use error_info instead. Errors encountered during
execution.

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

### ErrorInfo

    public EvaluationErrorInfo ErrorInfo { get; set; }

Output only. Error information for the evaluation run.

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

### EvaluationDataset

    public string EvaluationDataset { get; set; }

Output only. The evaluation dataset that this run is associated with. This
field is mutually exclusive with `evaluations`. Format:
`projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### EvaluationDatasetAsEvaluationDatasetName

    public EvaluationDatasetName EvaluationDatasetAsEvaluationDatasetName { get; set; }

[EvaluationDatasetName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationDatasetName)-typed view over the [EvaluationDataset](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun#Google_Cloud_Ces_V1Beta_EvaluationRun_EvaluationDataset) resource name
property.

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

### EvaluationResults

    public RepeatedField<string> EvaluationResults { get; }

Output only. The evaluation results that are part of this run.
Format:
`projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### EvaluationResultsAsEvaluationResultNames

    public ResourceNameList<EvaluationResultName> EvaluationResultsAsEvaluationResultNames { get; }

[EvaluationResultName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationResultName)-typed view over the [EvaluationResults](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun#Google_Cloud_Ces_V1Beta_EvaluationRun_EvaluationResults) resource name
property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNameList-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationResultName` |   |

### EvaluationRunName

    public EvaluationRunName EvaluationRunName { get; set; }

[EvaluationRunName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRunName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun#Google_Cloud_Ces_V1Beta_EvaluationRun_Name) resource name property.

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

### EvaluationRunSummaries

    public MapField<string, EvaluationRun.Types.EvaluationRunSummary> EvaluationRunSummaries { get; }

Output only. Map of evaluation name to EvaluationRunSummary.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRunhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun.Types.EvaluationRunSummary` |   |

### EvaluationType

    public EvaluationRun.Types.EvaluationType EvaluationType { get; set; }

Output only. The type of the evaluations in this run.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRunhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun.Types.EvaluationType` |   |

### Evaluations

    public RepeatedField<string> Evaluations { get; }

Output only. The evaluations that are part of this run. The list may
contain evaluations of either type. This field is mutually exclusive with
`evaluation_dataset`.
Format:
`projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### EvaluationsAsEvaluationNames

    public ResourceNameList<EvaluationName> EvaluationsAsEvaluationNames { get; }

[EvaluationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationName)-typed view over the [Evaluations](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun#Google_Cloud_Ces_V1Beta_EvaluationRun_Evaluations) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNameList-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationName` |   |

### GoldenRunMethod

    public GoldenRunMethod GoldenRunMethod { get; set; }

Output only. The method used to run the evaluation.

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

### InitiatedBy

    public string InitiatedBy { get; set; }

Output only. The user who initiated the evaluation run.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### LatencyReport

    public LatencyReport LatencyReport { get; set; }

Output only. Latency report for the evaluation run.

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

### Name

    public string Name { get; set; }

Identifier. The unique identifier of the evaluation run.
Format:
`projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Operation

    public string Operation { get; set; }

Output only. The operation that created this evaluation run.
Format:
`projects/{project}/locations/{location}/operations/{operation}`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### OptimizationConfig

    public OptimizationConfig OptimizationConfig { get; set; }

Optional. Configuration for running the optimization step after the
evaluation run. If not set, the optimization step will not be run.

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

### PersonaRunConfigs

    public RepeatedField<PersonaRunConfig> PersonaRunConfigs { get; }

Output only. The configuration to use for the run per persona.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.PersonaRunConfig` |   |

### Progress

    public EvaluationRun.Types.Progress Progress { get; set; }

Output only. The progress of the evaluation run.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRunhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun.Types.Progress` |   |

### RunCount

    public int RunCount { get; set; }

Output only. The number of times the evaluations inside the run were run.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### ScheduledEvaluationRun

    public string ScheduledEvaluationRun { get; set; }

Output only. The scheduled evaluation run resource name that created this
evaluation run. This field is only set if the evaluation run was created
by a scheduled evaluation run.
Format:
`projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ScheduledEvaluationRunAsScheduledEvaluationRunName

    public ScheduledEvaluationRunName ScheduledEvaluationRunAsScheduledEvaluationRunName { get; set; }

[ScheduledEvaluationRunName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.ScheduledEvaluationRunName)-typed view over the [ScheduledEvaluationRun](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun#Google_Cloud_Ces_V1Beta_EvaluationRun_ScheduledEvaluationRun) resource
name property.

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

### State

    public EvaluationRun.Types.EvaluationRunState State { get; set; }

Output only. The state of the evaluation run.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRunhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Ces.V1Beta/latest/Google.Cloud.Ces.V1Beta.EvaluationRun.Types.EvaluationRunState` |   |