public static final class Evaluation.Scenario.Builder extends GeneratedMessage.Builder<Evaluation.Scenario.Builder> implements Evaluation.ScenarioOrBuilderThe config for a scenario
Protobuf type google.cloud.ces.v1beta.Evaluation.Scenario
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Evaluation.Scenario.BuilderImplements
Evaluation.ScenarioOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllEvaluationExpectations(Iterable<String> values)
public Evaluation.Scenario.Builder addAllEvaluationExpectations(Iterable<String> values) 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 |
values |
Iterable<String>The evaluationExpectations to add. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
addAllRubrics(Iterable<String> values)
public Evaluation.Scenario.Builder addAllRubrics(Iterable<String> values)Required. The rubrics to score the scenario against.
repeated string rubrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The rubrics to add. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
addAllScenarioExpectations(Iterable<? extends Evaluation.ScenarioExpectation> values)
public Evaluation.Scenario.Builder addAllScenarioExpectations(Iterable<? extends Evaluation.ScenarioExpectation> values)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 |
values |
Iterable<? extends com.google.cloud.ces.v1beta.Evaluation.ScenarioExpectation> |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
addAllUserFacts(Iterable<? extends Evaluation.Scenario.UserFact> values)
public Evaluation.Scenario.Builder addAllUserFacts(Iterable<? extends Evaluation.Scenario.UserFact> values)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 |
values |
Iterable<? extends com.google.cloud.ces.v1beta.Evaluation.Scenario.UserFact> |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
addEvaluationExpectations(String value)
public Evaluation.Scenario.Builder addEvaluationExpectations(String value) 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 |
value |
StringThe evaluationExpectations to add. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
addEvaluationExpectationsBytes(ByteString value)
public Evaluation.Scenario.Builder addEvaluationExpectationsBytes(ByteString value) 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 |
value |
ByteStringThe bytes of the evaluationExpectations to add. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
addRubrics(String value)
public Evaluation.Scenario.Builder addRubrics(String value)Required. The rubrics to score the scenario against.
repeated string rubrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe rubrics to add. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
addRubricsBytes(ByteString value)
public Evaluation.Scenario.Builder addRubricsBytes(ByteString value)Required. The rubrics to score the scenario against.
repeated string rubrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the rubrics to add. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
addScenarioExpectations(Evaluation.ScenarioExpectation value)
public Evaluation.Scenario.Builder addScenarioExpectations(Evaluation.ScenarioExpectation value)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 |
value |
Evaluation.ScenarioExpectation |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
addScenarioExpectations(Evaluation.ScenarioExpectation.Builder builderForValue)
public Evaluation.Scenario.Builder addScenarioExpectations(Evaluation.ScenarioExpectation.Builder builderForValue)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 |
builderForValue |
Evaluation.ScenarioExpectation.Builder |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
addScenarioExpectations(int index, Evaluation.ScenarioExpectation value)
public Evaluation.Scenario.Builder addScenarioExpectations(int index, Evaluation.ScenarioExpectation value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Evaluation.ScenarioExpectation |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
addScenarioExpectations(int index, Evaluation.ScenarioExpectation.Builder builderForValue)
public Evaluation.Scenario.Builder addScenarioExpectations(int index, Evaluation.ScenarioExpectation.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Evaluation.ScenarioExpectation.Builder |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
addScenarioExpectationsBuilder()
public Evaluation.ScenarioExpectation.Builder addScenarioExpectationsBuilder()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 |
Evaluation.ScenarioExpectation.Builder |
|
addScenarioExpectationsBuilder(int index)
public Evaluation.ScenarioExpectation.Builder addScenarioExpectationsBuilder(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.Builder |
|
addUserFacts(Evaluation.Scenario.UserFact value)
public Evaluation.Scenario.Builder addUserFacts(Evaluation.Scenario.UserFact value)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 |
value |
Evaluation.Scenario.UserFact |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
addUserFacts(Evaluation.Scenario.UserFact.Builder builderForValue)
public Evaluation.Scenario.Builder addUserFacts(Evaluation.Scenario.UserFact.Builder builderForValue)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 |
builderForValue |
Evaluation.Scenario.UserFact.Builder |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
addUserFacts(int index, Evaluation.Scenario.UserFact value)
public Evaluation.Scenario.Builder addUserFacts(int index, Evaluation.Scenario.UserFact value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Evaluation.Scenario.UserFact |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
addUserFacts(int index, Evaluation.Scenario.UserFact.Builder builderForValue)
public Evaluation.Scenario.Builder addUserFacts(int index, Evaluation.Scenario.UserFact.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Evaluation.Scenario.UserFact.Builder |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
addUserFactsBuilder()
public Evaluation.Scenario.UserFact.Builder addUserFactsBuilder()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 |
Evaluation.Scenario.UserFact.Builder |
|
addUserFactsBuilder(int index)
public Evaluation.Scenario.UserFact.Builder addUserFactsBuilder(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.Builder |
|
build()
public Evaluation.Scenario build()| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario |
|
buildPartial()
public Evaluation.Scenario buildPartial()| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario |
|
clear()
public Evaluation.Scenario.Builder clear()| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
clearEvaluationExpectations()
public Evaluation.Scenario.Builder clearEvaluationExpectations() 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 |
Evaluation.Scenario.Builder |
This builder for chaining. |
clearMaxTurns()
public Evaluation.Scenario.Builder clearMaxTurns()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 |
Evaluation.Scenario.Builder |
This builder for chaining. |
clearRubrics()
public Evaluation.Scenario.Builder clearRubrics()Required. The rubrics to score the scenario against.
repeated string rubrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
clearScenarioExpectations()
public Evaluation.Scenario.Builder clearScenarioExpectations()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 |
Evaluation.Scenario.Builder |
|
clearTask()
public Evaluation.Scenario.Builder clearTask()Required. The task to be targeted by the scenario.
string task = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
clearTaskCompletionBehavior() (deprecated)
public Evaluation.Scenario.Builder clearTaskCompletionBehavior()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.Builder |
This builder for chaining. |
clearUserFacts()
public Evaluation.Scenario.Builder clearUserFacts()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 |
Evaluation.Scenario.Builder |
|
clearUserGoalBehavior()
public Evaluation.Scenario.Builder clearUserGoalBehavior()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.Builder |
This builder for chaining. |
clearVariableOverrides()
public Evaluation.Scenario.Builder clearVariableOverrides()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 |
Evaluation.Scenario.Builder |
|
getDefaultInstanceForType()
public Evaluation.Scenario getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEvaluationExpectations(int index)
public 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The evaluationExpectations at the given index. |
getEvaluationExpectationsBytes(int index)
public 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the evaluationExpectations at the given index. |
getEvaluationExpectationsCount()
public 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 ProtocolStringList 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 |
ProtocolStringList |
A list containing the evaluationExpectations. |
getMaxTurns()
public 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 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The rubrics at the given index. |
getRubricsBytes(int index)
public 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the rubrics at the given index. |
getRubricsCount()
public 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 ProtocolStringList getRubricsList()Required. The rubrics to score the scenario against.
repeated string rubrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the rubrics. |
getScenarioExpectations(int index)
public 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 |
|
getScenarioExpectationsBuilder(int index)
public Evaluation.ScenarioExpectation.Builder getScenarioExpectationsBuilder(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.Builder |
|
getScenarioExpectationsBuilderList()
public List<Evaluation.ScenarioExpectation.Builder> getScenarioExpectationsBuilderList()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<Builder> |
|
getScenarioExpectationsCount()
public 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 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 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 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 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 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 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 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 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 |
|
getUserFactsBuilder(int index)
public Evaluation.Scenario.UserFact.Builder getUserFactsBuilder(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.Builder |
|
getUserFactsBuilderList()
public List<Evaluation.Scenario.UserFact.Builder> getUserFactsBuilderList()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<Builder> |
|
getUserFactsCount()
public 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 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 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 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 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 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 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. |
getVariableOverridesBuilder()
public Struct.Builder getVariableOverridesBuilder()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 |
Builder |
|
getVariableOverridesOrBuilder()
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Evaluation.Scenario other)
public Evaluation.Scenario.Builder mergeFrom(Evaluation.Scenario other)| Parameter | |
|---|---|
| Name | Description |
other |
Evaluation.Scenario |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Evaluation.Scenario.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Evaluation.Scenario.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
mergeVariableOverrides(Struct value)
public Evaluation.Scenario.Builder mergeVariableOverrides(Struct value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
removeScenarioExpectations(int index)
public Evaluation.Scenario.Builder removeScenarioExpectations(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.Scenario.Builder |
|
removeUserFacts(int index)
public Evaluation.Scenario.Builder removeUserFacts(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.Builder |
|
setEvaluationExpectations(int index, String value)
public Evaluation.Scenario.Builder setEvaluationExpectations(int index, String value) 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) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe evaluationExpectations to set. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
setMaxTurns(int value)
public Evaluation.Scenario.Builder setMaxTurns(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe maxTurns to set. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
setRubrics(int index, String value)
public Evaluation.Scenario.Builder setRubrics(int index, String value)Required. The rubrics to score the scenario against.
repeated string rubrics = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe rubrics to set. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
setScenarioExpectations(int index, Evaluation.ScenarioExpectation value)
public Evaluation.Scenario.Builder setScenarioExpectations(int index, Evaluation.ScenarioExpectation value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Evaluation.ScenarioExpectation |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
setScenarioExpectations(int index, Evaluation.ScenarioExpectation.Builder builderForValue)
public Evaluation.Scenario.Builder setScenarioExpectations(int index, Evaluation.ScenarioExpectation.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Evaluation.ScenarioExpectation.Builder |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
setTask(String value)
public Evaluation.Scenario.Builder setTask(String value)Required. The task to be targeted by the scenario.
string task = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe task to set. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
setTaskBytes(ByteString value)
public Evaluation.Scenario.Builder setTaskBytes(ByteString value)Required. The task to be targeted by the scenario.
string task = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for task to set. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
setTaskCompletionBehavior(Evaluation.Scenario.TaskCompletionBehavior value) (deprecated)
public Evaluation.Scenario.Builder setTaskCompletionBehavior(Evaluation.Scenario.TaskCompletionBehavior value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Evaluation.Scenario.TaskCompletionBehaviorThe taskCompletionBehavior to set. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
setTaskCompletionBehaviorValue(int value) (deprecated)
public Evaluation.Scenario.Builder setTaskCompletionBehaviorValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for taskCompletionBehavior to set. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
setUserFacts(int index, Evaluation.Scenario.UserFact value)
public Evaluation.Scenario.Builder setUserFacts(int index, Evaluation.Scenario.UserFact value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Evaluation.Scenario.UserFact |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
setUserFacts(int index, Evaluation.Scenario.UserFact.Builder builderForValue)
public Evaluation.Scenario.Builder setUserFacts(int index, Evaluation.Scenario.UserFact.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Evaluation.Scenario.UserFact.Builder |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
setUserGoalBehavior(Evaluation.Scenario.UserGoalBehavior value)
public Evaluation.Scenario.Builder setUserGoalBehavior(Evaluation.Scenario.UserGoalBehavior value)Optional. The expected behavior of the user goal.
.google.cloud.ces.v1beta.Evaluation.Scenario.UserGoalBehavior user_goal_behavior = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Evaluation.Scenario.UserGoalBehaviorThe userGoalBehavior to set. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
setUserGoalBehaviorValue(int value)
public Evaluation.Scenario.Builder setUserGoalBehaviorValue(int value)Optional. The expected behavior of the user goal.
.google.cloud.ces.v1beta.Evaluation.Scenario.UserGoalBehavior user_goal_behavior = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for userGoalBehavior to set. |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
This builder for chaining. |
setVariableOverrides(Struct value)
public Evaluation.Scenario.Builder setVariableOverrides(Struct value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|
setVariableOverrides(Struct.Builder builderForValue)
public Evaluation.Scenario.Builder setVariableOverrides(Struct.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Evaluation.Scenario.Builder |
|