public final class ConversationModelEvaluation extends GeneratedMessageV3 implements ConversationModelEvaluationOrBuilder
Represents evaluation result of a conversation model.
Protobuf type google.cloud.dialogflow.v2.ConversationModelEvaluation
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
EVALUATION_CONFIG_FIELD_NUMBER
public static final int EVALUATION_CONFIG_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RAW_HUMAN_EVAL_TEMPLATE_CSV_FIELD_NUMBER
public static final int RAW_HUMAN_EVAL_TEMPLATE_CSV_FIELD_NUMBER
Field Value
SMART_REPLY_METRICS_FIELD_NUMBER
public static final int SMART_REPLY_METRICS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ConversationModelEvaluation getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ConversationModelEvaluation.Builder newBuilder()
Returns
newBuilder(ConversationModelEvaluation prototype)
public static ConversationModelEvaluation.Builder newBuilder(ConversationModelEvaluation prototype)
Parameter
Returns
public static ConversationModelEvaluation parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ConversationModelEvaluation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ConversationModelEvaluation parseFrom(byte[] data)
Parameter
| Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ConversationModelEvaluation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ConversationModelEvaluation parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ConversationModelEvaluation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ConversationModelEvaluation parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ConversationModelEvaluation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ConversationModelEvaluation parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ConversationModelEvaluation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ConversationModelEvaluation parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ConversationModelEvaluation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ConversationModelEvaluation> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. Creation time of this model.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation time of this model.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public ConversationModelEvaluation getDefaultInstanceForType()
Returns
getDisplayName()
public String getDisplayName()
Optional. The display name of the model evaluation. At most 64 bytes long.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. The display name of the model evaluation. At most 64 bytes long.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
ByteString |
The bytes for displayName.
|
getEvaluationConfig()
public EvaluationConfig getEvaluationConfig()
Optional. The configuration of the evaluation task.
.google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];
getEvaluationConfigOrBuilder()
public EvaluationConfigOrBuilder getEvaluationConfigOrBuilder()
Optional. The configuration of the evaluation task.
.google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];
getMetricsCase()
public ConversationModelEvaluation.MetricsCase getMetricsCase()
Returns
getName()
The resource name of the evaluation. Format:
projects/<Project ID>/conversationModels/<Conversation Model
ID>/evaluations/<Evaluation ID>
string name = 1;
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
The resource name of the evaluation. Format:
projects/<Project ID>/conversationModels/<Conversation Model
ID>/evaluations/<Evaluation ID>
string name = 1;
getParserForType()
public Parser<ConversationModelEvaluation> getParserForType()
Returns
Overrides
getRawHumanEvalTemplateCsv()
public String getRawHumanEvalTemplateCsv()
Output only. Human eval template in csv format.
It tooks real-world conversations provided through input dataset, generates
example suggestions for customer to verify quality of the model.
For Smart Reply, the generated csv file contains columns of
Context, (Suggestions,Q1,Q2)*3, Actual reply.
Context contains at most 10 latest messages in the conversation prior to
the current suggestion.
Q1: "Would you send it as the next message of agent?"
Evaluated based on whether the suggest is appropriate to be sent by
agent in current context.
Q2: "Does the suggestion move the conversation closer to resolution?"
Evaluated based on whether the suggestion provide solutions, or answers
customer's question or collect information from customer to resolve the
customer's issue.
Actual reply column contains the actual agent reply sent in the context.
string raw_human_eval_template_csv = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
String |
The rawHumanEvalTemplateCsv.
|
getRawHumanEvalTemplateCsvBytes()
public ByteString getRawHumanEvalTemplateCsvBytes()
Output only. Human eval template in csv format.
It tooks real-world conversations provided through input dataset, generates
example suggestions for customer to verify quality of the model.
For Smart Reply, the generated csv file contains columns of
Context, (Suggestions,Q1,Q2)*3, Actual reply.
Context contains at most 10 latest messages in the conversation prior to
the current suggestion.
Q1: "Would you send it as the next message of agent?"
Evaluated based on whether the suggest is appropriate to be sent by
agent in current context.
Q2: "Does the suggestion move the conversation closer to resolution?"
Evaluated based on whether the suggestion provide solutions, or answers
customer's question or collect information from customer to resolve the
customer's issue.
Actual reply column contains the actual agent reply sent in the context.
string raw_human_eval_template_csv = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
ByteString |
The bytes for rawHumanEvalTemplateCsv.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSmartReplyMetrics()
public SmartReplyMetrics getSmartReplyMetrics()
Output only. Only available when model is for smart reply.
.google.cloud.dialogflow.v2.SmartReplyMetrics smart_reply_metrics = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSmartReplyMetricsOrBuilder()
public SmartReplyMetricsOrBuilder getSmartReplyMetricsOrBuilder()
Output only. Only available when model is for smart reply.
.google.cloud.dialogflow.v2.SmartReplyMetrics smart_reply_metrics = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasCreateTime()
public boolean hasCreateTime()
Output only. Creation time of this model.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasEvaluationConfig()
public boolean hasEvaluationConfig()
Optional. The configuration of the evaluation task.
.google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
boolean |
Whether the evaluationConfig field is set.
|
hasSmartReplyMetrics()
public boolean hasSmartReplyMetrics()
Output only. Only available when model is for smart reply.
.google.cloud.dialogflow.v2.SmartReplyMetrics smart_reply_metrics = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
boolean |
Whether the smartReplyMetrics field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ConversationModelEvaluation.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ConversationModelEvaluation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ConversationModelEvaluation.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
