Gemini Enterprise for Customer Experience v1beta API - Class EvaluationRun (1.0.0-beta01)

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 > EvaluationRun

Implements

IMessageEvaluationRun, IEquatableEvaluationRun, IDeepCloneableEvaluationRun, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

EvaluationRun()

public EvaluationRun()

EvaluationRun(EvaluationRun)

public EvaluationRun(EvaluationRun other)

Parameter
Name	Description
other	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
string

AppVersionAsAppVersionName

public AppVersionName AppVersionAsAppVersionName { get; set; }

AppVersionName-typed view over the AppVersion resource name property.

Property Value
Type	Description
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
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
string

ChangelogAsChangelogName

public ChangelogName ChangelogAsChangelogName { get; set; }

ChangelogName-typed view over the Changelog resource name property.

Property Value
Type	Description
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
Timestamp

Config

public EvaluationConfig Config { get; set; }

Output only. The configuration used in the run.

Property Value
Type	Description
EvaluationConfig

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when the evaluation run was created.

Property Value
Type	Description
Timestamp

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
string

Error

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

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

Property Value
Type	Description
Status

ErrorInfo

public EvaluationErrorInfo ErrorInfo { get; set; }

Output only. Error information for the evaluation run.

Property Value
Type	Description
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
string

EvaluationDatasetAsEvaluationDatasetName

public EvaluationDatasetName EvaluationDatasetAsEvaluationDatasetName { get; set; }

EvaluationDatasetName-typed view over the EvaluationDataset resource name property.

Property Value
Type	Description
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
RepeatedFieldstring

EvaluationResultsAsEvaluationResultNames

public ResourceNameList<EvaluationResultName> EvaluationResultsAsEvaluationResultNames { get; }

EvaluationResultName-typed view over the EvaluationResults resource name property.

Property Value
Type	Description
ResourceNameListEvaluationResultName

EvaluationRunName

public EvaluationRunName EvaluationRunName { get; set; }

EvaluationRunName-typed view over the Name resource name property.

Property Value
Type	Description
EvaluationRunName

EvaluationRunSummaries

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

Output only. Map of evaluation name to EvaluationRunSummary.

Property Value
Type	Description
MapFieldstringEvaluationRunTypesEvaluationRunSummary

EvaluationType

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

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

Property Value
Type	Description
EvaluationRunTypesEvaluationType

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
RepeatedFieldstring

EvaluationsAsEvaluationNames

public ResourceNameList<EvaluationName> EvaluationsAsEvaluationNames { get; }

EvaluationName-typed view over the Evaluations resource name property.

Property Value
Type	Description
ResourceNameListEvaluationName

GoldenRunMethod

public GoldenRunMethod GoldenRunMethod { get; set; }

Output only. The method used to run the evaluation.

Property Value
Type	Description
GoldenRunMethod

InitiatedBy

public string InitiatedBy { get; set; }

Output only. The user who initiated the evaluation run.

Property Value
Type	Description
string

LatencyReport

public LatencyReport LatencyReport { get; set; }

Output only. Latency report for the evaluation run.

Property Value
Type	Description
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
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
OptimizationConfig

PersonaRunConfigs

public RepeatedField<PersonaRunConfig> PersonaRunConfigs { get; }

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

Property Value
Type	Description
RepeatedFieldPersonaRunConfig

Progress

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

Output only. The progress of the evaluation run.

Property Value
Type	Description
EvaluationRunTypesProgress

RunCount

public int RunCount { get; set; }

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

Property Value
Type	Description
int

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
string

ScheduledEvaluationRunAsScheduledEvaluationRunName

public ScheduledEvaluationRunName ScheduledEvaluationRunAsScheduledEvaluationRunName { get; set; }

ScheduledEvaluationRunName-typed view over the ScheduledEvaluationRun resource name property.

Property Value
Type	Description
ScheduledEvaluationRunName

State

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

Output only. The state of the evaluation run.

Property Value
Type	Description
EvaluationRunTypesEvaluationRunState