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

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

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

An evaluation represents all of the information needed to simulate and evaluate an agent.

Inheritance

object > Evaluation

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

Evaluation()

public Evaluation()

Evaluation(Evaluation)

public Evaluation(Evaluation other)
Parameter
Name Description
other Evaluation

Properties

AggregatedMetrics

public AggregatedMetrics AggregatedMetrics { get; set; }

Output only. The aggregated metrics for this evaluation across all runs.

Property Value
Type Description
AggregatedMetrics

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when the evaluation was created.

Property Value
Type Description
Timestamp

CreatedBy

public string CreatedBy { get; set; }

Output only. The user who created the evaluation.

Property Value
Type Description
string

Description

public string Description { get; set; }

Optional. User-defined description of the evaluation.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. User-defined display name of the evaluation. Unique within an App.

Property Value
Type Description
string

Etag

public string Etag { get; set; }

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

Property Value
Type Description
string

EvaluationDatasets

public RepeatedField<string> EvaluationDatasets { get; }

Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

Property Value
Type Description
RepeatedFieldstring

EvaluationDatasetsAsEvaluationDatasetNames

public ResourceNameList<EvaluationDatasetName> EvaluationDatasetsAsEvaluationDatasetNames { get; }

EvaluationDatasetName-typed view over the EvaluationDatasets resource name property.

Property Value
Type Description
ResourceNameListEvaluationDatasetName

EvaluationName

public EvaluationName EvaluationName { get; set; }

EvaluationName-typed view over the Name resource name property.

Property Value
Type Description
EvaluationName

EvaluationRuns

public RepeatedField<string> EvaluationRuns { get; }

Output only. The EvaluationRuns that this Evaluation is associated with.

Property Value
Type Description
RepeatedFieldstring

EvaluationRunsAsEvaluationRunNames

public ResourceNameList<EvaluationRunName> EvaluationRunsAsEvaluationRunNames { get; }

EvaluationRunName-typed view over the EvaluationRuns resource name property.

Property Value
Type Description
ResourceNameListEvaluationRunName

Golden

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

Optional. The golden steps to be evaluated.

Property Value
Type Description
EvaluationTypesGolden

InputsCase

public Evaluation.InputsOneofCase InputsCase { get; }
Property Value
Type Description
EvaluationInputsOneofCase

Invalid

public bool Invalid { get; set; }

Output only. Whether the evaluation is invalid. This can happen if an evaluation is referencing a tool, toolset, or agent that has since been deleted.

Property Value
Type Description
bool

LastCompletedResult

public EvaluationResult LastCompletedResult { get; set; }

Output only. The latest evaluation result for this evaluation.

Property Value
Type Description
EvaluationResult

LastTenResults

public RepeatedField<EvaluationResult> LastTenResults { get; }

Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest.

Property Value
Type Description
RepeatedFieldEvaluationResult

LastUpdatedBy

public string LastUpdatedBy { get; set; }

Output only. The user who last updated the evaluation.

Property Value
Type Description
string

Name

public string Name { get; set; }

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

Property Value
Type Description
string

Scenario

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

Optional. The config for a scenario.

Property Value
Type Description
EvaluationTypesScenario

Tags

public RepeatedField<string> Tags { get; }

Optional. User defined tags to categorize the evaluation.

Property Value
Type Description
RepeatedFieldstring

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when the evaluation was last updated.

Property Value
Type Description
Timestamp