Class Evaluation.Scenario (0.3.0)

public static final class Evaluation.Scenario extends GeneratedMessage implements Evaluation.ScenarioOrBuilder

The config for a scenario

Protobuf type google.cloud.ces.v1beta.Evaluation.Scenario

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()
Returns
Type Description
Evaluation.Scenario

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Evaluation.Scenario.Builder newBuilder()
Returns
Type Description
Evaluation.Scenario.Builder

newBuilder(Evaluation.Scenario prototype)

public static Evaluation.Scenario.Builder newBuilder(Evaluation.Scenario prototype)
Parameter
Name Description
prototype Evaluation.Scenario
Returns
Type Description
Evaluation.Scenario.Builder

parseDelimitedFrom(InputStream input)

public static Evaluation.Scenario parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Scenario parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Evaluation.Scenario parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Scenario parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Evaluation.Scenario parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Scenario parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Evaluation.Scenario parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Scenario parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Evaluation.Scenario parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Scenario parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Evaluation.Scenario parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.Scenario parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.Scenario
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Evaluation.Scenario> parser()
Returns
Type Description
Parser<Scenario>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Evaluation.Scenario getDefaultInstanceForType()
Returns
Type Description
Evaluation.Scenario

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) = { ... }

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.

getParserForType()

public Parser<Evaluation.Scenario> getParserForType()
Returns
Type Description
Parser<Scenario>
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];

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

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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Evaluation.Scenario.Builder newBuilderForType()
Returns
Type Description
Evaluation.Scenario.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Evaluation.Scenario.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Evaluation.Scenario.Builder
Overrides

toBuilder()

public Evaluation.Scenario.Builder toBuilder()
Returns
Type Description
Evaluation.Scenario.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException