Interface ConversationModelEvaluationOrBuilder (4.43.0)

public interface ConversationModelEvaluationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Creation time of this model.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time of this model.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDisplayName()

public abstract 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
TypeDescription
String

The displayName.

getDisplayNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for displayName.

getEvaluationConfig()

public abstract EvaluationConfig getEvaluationConfig()

Optional. The configuration of the evaluation task.

.google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
EvaluationConfig

The evaluationConfig.

getEvaluationConfigOrBuilder()

public abstract EvaluationConfigOrBuilder getEvaluationConfigOrBuilder()

Optional. The configuration of the evaluation task.

.google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
EvaluationConfigOrBuilder

getMetricsCase()

public abstract ConversationModelEvaluation.MetricsCase getMetricsCase()
Returns
TypeDescription
ConversationModelEvaluation.MetricsCase

getName()

public abstract String getName()

The resource name of the evaluation. Format: projects/<Project ID>/conversationModels/<Conversation Model ID>/evaluations/<Evaluation ID>

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The resource name of the evaluation. Format: projects/<Project ID>/conversationModels/<Conversation Model ID>/evaluations/<Evaluation ID>

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getRawHumanEvalTemplateCsv()

public abstract 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
TypeDescription
String

The rawHumanEvalTemplateCsv.

getRawHumanEvalTemplateCsvBytes()

public abstract 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
TypeDescription
ByteString

The bytes for rawHumanEvalTemplateCsv.

getSmartReplyMetrics()

public abstract 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
TypeDescription
SmartReplyMetrics

The smartReplyMetrics.

getSmartReplyMetricsOrBuilder()

public abstract 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];

Returns
TypeDescription
SmartReplyMetricsOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Creation time of this model.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEvaluationConfig()

public abstract boolean hasEvaluationConfig()

Optional. The configuration of the evaluation task.

.google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the evaluationConfig field is set.

hasSmartReplyMetrics()

public abstract 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
TypeDescription
boolean

Whether the smartReplyMetrics field is set.