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

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

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

An evaluation result represents the output of running an Evaluation.

Inheritance

object > EvaluationResult

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

EvaluationResult()

public EvaluationResult()

EvaluationResult(EvaluationResult)

public EvaluationResult(EvaluationResult other)
Parameter
Name Description
other EvaluationResult

Properties

AppVersion

public string AppVersion { get; set; }

Output only. The app version used to generate the conversation that resulted in this result. 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 evaluation run that resulted in this result.

Property Value
Type Description
EvaluationConfig

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when the evaluation result was created.

Property Value
Type Description
Timestamp

DisplayName

public string DisplayName { get; set; }

Required. Display name of the Evaluation Result. Unique within an Evaluation. By default, it has the following format: "<evaluation-display-name> result

  • <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 result.

Property Value
Type Description
EvaluationErrorInfo

EvaluationMetricsThresholds

public EvaluationMetricsThresholds EvaluationMetricsThresholds { get; set; }

Output only. The evaluation thresholds for the result.

Property Value
Type Description
EvaluationMetricsThresholds

EvaluationResultName

public EvaluationResultName EvaluationResultName { get; set; }

EvaluationResultName-typed view over the Name resource name property.

Property Value
Type Description
EvaluationResultName

EvaluationRun

public string EvaluationRun { get; set; }

Output only. The evaluation run that produced this result. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

Property Value
Type Description
string

EvaluationRunAsEvaluationRunName

public EvaluationRunName EvaluationRunAsEvaluationRunName { get; set; }

EvaluationRunName-typed view over the EvaluationRun resource name property.

Property Value
Type Description
EvaluationRunName

EvaluationStatus

public EvaluationResult.Types.Outcome EvaluationStatus { get; set; }

Output only. The outcome of the evaluation. Only populated if execution_state is COMPLETE.

Property Value
Type Description
EvaluationResultTypesOutcome

ExecutionState

public EvaluationResult.Types.ExecutionState ExecutionState { get; set; }

Output only. The state of the evaluation result execution.

Property Value
Type Description
EvaluationResultTypesExecutionState

GoldenResult

public EvaluationResult.Types.GoldenResult GoldenResult { get; set; }

Output only. The outcome of a golden evaluation.

Property Value
Type Description
EvaluationResultTypesGoldenResult

GoldenRunMethod

public GoldenRunMethod GoldenRunMethod { get; set; }

Output only. The method used to run the golden evaluation.

Property Value
Type Description
GoldenRunMethod

InitiatedBy

public string InitiatedBy { get; set; }

Output only. The user who initiated the evaluation run that resulted in this result.

Property Value
Type Description
string

Name

public string Name { get; set; }

Identifier. The unique identifier of the evaluation result. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

Property Value
Type Description
string

Persona

public EvaluationPersona Persona { get; set; }

Output only. The persona used to generate the conversation for the evaluation result.

Property Value
Type Description
EvaluationPersona

ResultCase

public EvaluationResult.ResultOneofCase ResultCase { get; }
Property Value
Type Description
EvaluationResultResultOneofCase

ScenarioResult

public EvaluationResult.Types.ScenarioResult ScenarioResult { get; set; }

Output only. The outcome of a scenario evaluation.

Property Value
Type Description
EvaluationResultTypesScenarioResult