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

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

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

Request message for [EvaluationService.RunEvaluation][google.cloud.ces.v1beta.EvaluationService.RunEvaluation].

Inheritance

object > RunEvaluationRequest

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

RunEvaluationRequest()

public RunEvaluationRequest()

RunEvaluationRequest(RunEvaluationRequest)

public RunEvaluationRequest(RunEvaluationRequest other)
Parameter
Name Description
other RunEvaluationRequest

Properties

App

public string App { get; set; }

Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}

Property Value
Type Description
string

AppAsAppName

public AppName AppAsAppName { get; set; }

AppName-typed view over the App resource name property.

Property Value
Type Description
AppName

AppVersion

public string AppVersion { get; set; }

Optional. 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

Config

public EvaluationConfig Config { get; set; }

Optional. The configuration to use for the run.

Property Value
Type Description
EvaluationConfig

DisplayName

public string DisplayName { get; set; }

Optional. The display name of the evaluation run.

Property Value
Type Description
string

EvaluationDataset

public string EvaluationDataset { get; set; }

Optional. An evaluation dataset to run. 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

Evaluations

public RepeatedField<string> Evaluations { get; }

Optional. List of evaluations to run. 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

GenerateLatencyReport

public bool GenerateLatencyReport { get; set; }

Optional. Whether to generate a latency report for the evaluation run.

Property Value
Type Description
bool

GoldenRunMethod

public GoldenRunMethod GoldenRunMethod { get; set; }

Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.

Property Value
Type Description
GoldenRunMethod

HasRunCount

public bool HasRunCount { get; }

Gets whether the "run_count" field is set

Property Value
Type Description
bool

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; }

Optional. The configuration to use for the run per persona.

Property Value
Type Description
RepeatedFieldPersonaRunConfig

RunCount

public int RunCount { get; set; }

Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.

Property Value
Type Description
int

ScheduledEvaluationRun

public string ScheduledEvaluationRun { get; set; }

Optional. The resource name of the ScheduledEvaluationRun that is triggering this evaluation run.

If this field is set, the scheduled_evaluation_run field on the created EvaluationRun resource will be populated from this value. 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