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

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

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

The config for a scenario

Inheritance

object > Evaluation.Types.Scenario

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

Scenario()

public Scenario()

Scenario(Scenario)

public Scenario(Evaluation.Types.Scenario other)
Parameter
Name Description
other EvaluationTypesScenario

Properties

EvaluationExpectations

public RepeatedField<string> EvaluationExpectations { get; }

Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}

Property Value
Type Description
RepeatedFieldstring

EvaluationExpectationsAsEvaluationExpectationNames

public ResourceNameList<EvaluationExpectationName> EvaluationExpectationsAsEvaluationExpectationNames { get; }

EvaluationExpectationName-typed view over the EvaluationExpectations resource name property.

Property Value
Type Description
ResourceNameListEvaluationExpectationName

MaxTurns

public int MaxTurns { get; set; }

Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete.

Property Value
Type Description
int

Rubrics

public RepeatedField<string> Rubrics { get; }

Required. The rubrics to score the scenario against.

Property Value
Type Description
RepeatedFieldstring

ScenarioExpectations

public RepeatedField<Evaluation.Types.ScenarioExpectation> ScenarioExpectations { get; }

Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation.

Property Value
Type Description
RepeatedFieldEvaluationTypesScenarioExpectation

Task

public string Task { get; set; }

Required. The task to be targeted by the scenario.

Property Value
Type Description
string

TaskCompletionBehavior

[Obsolete]
public Evaluation.Types.Scenario.Types.TaskCompletionBehavior TaskCompletionBehavior { get; set; }

Optional. Deprecated. Use user_goal_behavior instead.

Property Value
Type Description
EvaluationTypesScenarioTypesTaskCompletionBehavior

UserFacts

public RepeatedField<Evaluation.Types.Scenario.Types.UserFact> UserFacts { get; }

Optional. The user facts to be used by the scenario.

Property Value
Type Description
RepeatedFieldEvaluationTypesScenarioTypesUserFact

UserGoalBehavior

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

Optional. The expected behavior of the user goal.

Property Value
Type Description
EvaluationTypesScenarioTypesUserGoalBehavior

VariableOverrides

public Struct VariableOverrides { get; set; }

Optional. Variables / Session Parameters as context for the session, keyed by variable names. Members of this struct will override any default values set by the system.

Note, these are different from user facts, which are facts known to the user. Variables are parameters known to the agent: i.e. MDN (phone number) passed by the telephony system.

Property Value
Type Description
Struct