Interface Evaluation.ScenarioOrBuilder (0.3.0)

0.3.0 (latest) 0.1.0

public static interface Evaluation.ScenarioOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEvaluationExpectations(int index)

public abstract String getEvaluationExpectations(int index)

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

repeated string evaluation_expectations = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The evaluationExpectations at the given index.

getEvaluationExpectationsBytes(int index)

public abstract ByteString getEvaluationExpectationsBytes(int index)

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

repeated string evaluation_expectations = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the evaluationExpectations at the given index.

getEvaluationExpectationsCount()

public abstract int getEvaluationExpectationsCount()

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

repeated string evaluation_expectations = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
int	The count of evaluationExpectations.

getEvaluationExpectationsList()

public abstract List<String> getEvaluationExpectationsList()

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

repeated string evaluation_expectations = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
List<String>	A list containing the evaluationExpectations.

getMaxTurns()

public abstract int getMaxTurns()

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

int32 max_turns = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The maxTurns.

getRubrics(int index)

public abstract String getRubrics(int index)

Required. The rubrics to score the scenario against.

repeated string rubrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The rubrics at the given index.

getRubricsBytes(int index)

public abstract ByteString getRubricsBytes(int index)

Required. The rubrics to score the scenario against.

repeated string rubrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the rubrics at the given index.

getRubricsCount()

public abstract int getRubricsCount()

Required. The rubrics to score the scenario against.

repeated string rubrics = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The count of rubrics.

getRubricsList()

public abstract List<String> getRubricsList()

Required. The rubrics to score the scenario against.

repeated string rubrics = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<String>	A list containing the rubrics.

getScenarioExpectations(int index)

public abstract Evaluation.ScenarioExpectation getScenarioExpectations(int index)

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

repeated .google.cloud.ces.v1beta.Evaluation.ScenarioExpectation scenario_expectations = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Evaluation.ScenarioExpectation

getScenarioExpectationsCount()

public abstract int getScenarioExpectationsCount()

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

repeated .google.cloud.ces.v1beta.Evaluation.ScenarioExpectation scenario_expectations = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

getScenarioExpectationsList()

public abstract List<Evaluation.ScenarioExpectation> getScenarioExpectationsList()

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

repeated .google.cloud.ces.v1beta.Evaluation.ScenarioExpectation scenario_expectations = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<ScenarioExpectation>

getScenarioExpectationsOrBuilder(int index)

public abstract Evaluation.ScenarioExpectationOrBuilder getScenarioExpectationsOrBuilder(int index)

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

repeated .google.cloud.ces.v1beta.Evaluation.ScenarioExpectation scenario_expectations = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Evaluation.ScenarioExpectationOrBuilder

getScenarioExpectationsOrBuilderList()

public abstract List<? extends Evaluation.ScenarioExpectationOrBuilder> getScenarioExpectationsOrBuilderList()

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

repeated .google.cloud.ces.v1beta.Evaluation.ScenarioExpectation scenario_expectations = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<? extends com.google.cloud.ces.v1beta.Evaluation.ScenarioExpectationOrBuilder>

getTask()

public abstract String getTask()

Required. The task to be targeted by the scenario.

string task = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The task.

getTaskBytes()

public abstract ByteString getTaskBytes()

Required. The task to be targeted by the scenario.

string task = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for task.

getTaskCompletionBehavior() (deprecated)

public abstract Evaluation.Scenario.TaskCompletionBehavior getTaskCompletionBehavior()

Deprecated. google.cloud.ces.v1beta.Evaluation.Scenario.task_completion_behavior is deprecated. See google/cloud/ces/v1beta/evaluation.proto;l=337

Optional. Deprecated. Use user_goal_behavior instead.

.google.cloud.ces.v1beta.Evaluation.Scenario.TaskCompletionBehavior task_completion_behavior = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Evaluation.Scenario.TaskCompletionBehavior	The taskCompletionBehavior.

getTaskCompletionBehaviorValue() (deprecated)

public abstract int getTaskCompletionBehaviorValue()

Deprecated. google.cloud.ces.v1beta.Evaluation.Scenario.task_completion_behavior is deprecated. See google/cloud/ces/v1beta/evaluation.proto;l=337

Optional. Deprecated. Use user_goal_behavior instead.

.google.cloud.ces.v1beta.Evaluation.Scenario.TaskCompletionBehavior task_completion_behavior = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for taskCompletionBehavior.

getUserFacts(int index)

public abstract Evaluation.Scenario.UserFact getUserFacts(int index)

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

repeated .google.cloud.ces.v1beta.Evaluation.Scenario.UserFact user_facts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
Evaluation.Scenario.UserFact

getUserFactsCount()

public abstract int getUserFactsCount()

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

repeated .google.cloud.ces.v1beta.Evaluation.Scenario.UserFact user_facts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getUserFactsList()

public abstract List<Evaluation.Scenario.UserFact> getUserFactsList()

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

repeated .google.cloud.ces.v1beta.Evaluation.Scenario.UserFact user_facts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<UserFact>

getUserFactsOrBuilder(int index)

public abstract Evaluation.Scenario.UserFactOrBuilder getUserFactsOrBuilder(int index)

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

repeated .google.cloud.ces.v1beta.Evaluation.Scenario.UserFact user_facts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
Evaluation.Scenario.UserFactOrBuilder

getUserFactsOrBuilderList()

public abstract List<? extends Evaluation.Scenario.UserFactOrBuilder> getUserFactsOrBuilderList()

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

repeated .google.cloud.ces.v1beta.Evaluation.Scenario.UserFact user_facts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.ces.v1beta.Evaluation.Scenario.UserFactOrBuilder>

getUserGoalBehavior()

public abstract Evaluation.Scenario.UserGoalBehavior getUserGoalBehavior()

Optional. The expected behavior of the user goal.

.google.cloud.ces.v1beta.Evaluation.Scenario.UserGoalBehavior user_goal_behavior = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Evaluation.Scenario.UserGoalBehavior	The userGoalBehavior.

getUserGoalBehaviorValue()

public abstract int getUserGoalBehaviorValue()

Optional. The expected behavior of the user goal.

.google.cloud.ces.v1beta.Evaluation.Scenario.UserGoalBehavior user_goal_behavior = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for userGoalBehavior.

getVariableOverrides()

public abstract Struct getVariableOverrides()

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.

.google.protobuf.Struct variable_overrides = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The variableOverrides.

getVariableOverridesOrBuilder()

public abstract StructOrBuilder getVariableOverridesOrBuilder()

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.

.google.protobuf.Struct variable_overrides = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

hasVariableOverrides()

public abstract boolean hasVariableOverrides()

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.

.google.protobuf.Struct variable_overrides = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the variableOverrides field is set.