Package com.google.cloud.dialogflow.v2
Interface ConversationModelEvaluationOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ConversationModelEvaluation
,ConversationModelEvaluation.Builder
public interface ConversationModelEvaluationOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com.google.protobuf.Timestamp
getCreateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getCreateTimeOrBuilder()
Output only.String
getDisplayName()
Optional.com.google.protobuf.ByteString
getDisplayNameBytes()
Optional.EvaluationConfig
getEvaluationConfig()
Optional.EvaluationConfigOrBuilder
getEvaluationConfigOrBuilder()
Optional.ConversationModelEvaluation.MetricsCase
getMetricsCase()
String
getName()
The resource name of the evaluation.com.google.protobuf.ByteString
getNameBytes()
The resource name of the evaluation.String
getRawHumanEvalTemplateCsv()
Output only.com.google.protobuf.ByteString
getRawHumanEvalTemplateCsvBytes()
Output only.SmartReplyMetrics
getSmartReplyMetrics()
Output only.SmartReplyMetricsOrBuilder
getSmartReplyMetricsOrBuilder()
Output only.boolean
hasCreateTime()
Output only.boolean
hasEvaluationConfig()
Optional.boolean
hasSmartReplyMetrics()
Output only.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
String getName()
The resource name of the evaluation. Format: `projects/<Project ID>/conversationModels/<Conversation Model ID>/evaluations/<Evaluation ID>`
string name = 1;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()
The resource name of the evaluation. Format: `projects/<Project ID>/conversationModels/<Conversation Model ID>/evaluations/<Evaluation ID>`
string name = 1;
- Returns:
- The bytes for name.
-
getDisplayName
String getDisplayName()
Optional. The display name of the model evaluation. At most 64 bytes long.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()
Optional. The display name of the model evaluation. At most 64 bytes long.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
- Returns:
- The bytes for displayName.
-
hasEvaluationConfig
boolean hasEvaluationConfig()
Optional. The configuration of the evaluation task.
.google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];
- Returns:
- Whether the evaluationConfig field is set.
-
getEvaluationConfig
EvaluationConfig getEvaluationConfig()
Optional. The configuration of the evaluation task.
.google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];
- Returns:
- The evaluationConfig.
-
getEvaluationConfigOrBuilder
EvaluationConfigOrBuilder getEvaluationConfigOrBuilder()
Optional. The configuration of the evaluation task.
.google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];
-
hasCreateTime
boolean hasCreateTime()
Output only. Creation time of this model.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()
Output only. Creation time of this model.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation time of this model.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
hasSmartReplyMetrics
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];
- Returns:
- Whether the smartReplyMetrics field is set.
-
getSmartReplyMetrics
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];
- Returns:
- The smartReplyMetrics.
-
getSmartReplyMetricsOrBuilder
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];
-
getRawHumanEvalTemplateCsv
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];
- Returns:
- The rawHumanEvalTemplateCsv.
-
getRawHumanEvalTemplateCsvBytes
com.google.protobuf.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];
- Returns:
- The bytes for rawHumanEvalTemplateCsv.
-
getMetricsCase
ConversationModelEvaluation.MetricsCase getMetricsCase()
-
-