public static final class Evaluation.Scenario extends GeneratedMessage implements Evaluation.ScenarioOrBuilder
The config for a scenario
Protobuf type google.cloud.ces.v1beta.Evaluation.Scenario
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
EVALUATION_EXPECTATIONS_FIELD_NUMBER
public static final int EVALUATION_EXPECTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_TURNS_FIELD_NUMBER
public static final int MAX_TURNS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RUBRICS_FIELD_NUMBER
public static final int RUBRICS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SCENARIO_EXPECTATIONS_FIELD_NUMBER
public static final int SCENARIO_EXPECTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TASK_COMPLETION_BEHAVIOR_FIELD_NUMBER
public static final int TASK_COMPLETION_BEHAVIOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TASK_FIELD_NUMBER
public static final int TASK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USER_FACTS_FIELD_NUMBER
public static final int USER_FACTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USER_GOAL_BEHAVIOR_FIELD_NUMBER
public static final int USER_GOAL_BEHAVIOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VARIABLE_OVERRIDES_FIELD_NUMBER
public static final int VARIABLE_OVERRIDES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Evaluation.Scenario getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Evaluation.Scenario.Builder newBuilder()
newBuilder(Evaluation.Scenario prototype)
public static Evaluation.Scenario.Builder newBuilder(Evaluation.Scenario prototype)
public static Evaluation.Scenario parseDelimitedFrom(InputStream input)
public static Evaluation.Scenario parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Evaluation.Scenario parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Evaluation.Scenario parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Evaluation.Scenario parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Evaluation.Scenario parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Evaluation.Scenario parseFrom(CodedInputStream input)
public static Evaluation.Scenario parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Evaluation.Scenario parseFrom(InputStream input)
public static Evaluation.Scenario parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Evaluation.Scenario parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Evaluation.Scenario parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Evaluation.Scenario> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Evaluation.Scenario getDefaultInstanceForType()
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 |
int
The 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 |
int
The 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) = { ... }
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.
|
getParserForType()
public Parser<Evaluation.Scenario> getParserForType()
Overrides
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 |
int
The 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 |
int
The 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];
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
|
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];
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
|
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> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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
|
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];
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
|
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];
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.
|
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];
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Evaluation.Scenario.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Evaluation.Scenario.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Evaluation.Scenario.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides