Class ConversationModelEvaluation.Builder (4.58.0)

public static final class ConversationModelEvaluation.Builder extends GeneratedMessageV3.Builder<ConversationModelEvaluation.Builder> implements ConversationModelEvaluationOrBuilder

Represents evaluation result of a conversation model.

Protobuf type google.cloud.dialogflow.v2.ConversationModelEvaluation

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ConversationModelEvaluation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides

build()

public ConversationModelEvaluation build()
Returns
Type Description
ConversationModelEvaluation

buildPartial()

public ConversationModelEvaluation buildPartial()
Returns
Type Description
ConversationModelEvaluation

clear()

public ConversationModelEvaluation.Builder clear()
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides

clearCreateTime()

public ConversationModelEvaluation.Builder clearCreateTime()

Output only. Creation time of this model.

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

Returns
Type Description
ConversationModelEvaluation.Builder

clearDisplayName()

public ConversationModelEvaluation.Builder clearDisplayName()

Optional. The display name of the model evaluation. At most 64 bytes long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationModelEvaluation.Builder

This builder for chaining.

clearEvaluationConfig()

public ConversationModelEvaluation.Builder clearEvaluationConfig()

Optional. The configuration of the evaluation task.

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

Returns
Type Description
ConversationModelEvaluation.Builder

clearField(Descriptors.FieldDescriptor field)

public ConversationModelEvaluation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides

clearMetrics()

public ConversationModelEvaluation.Builder clearMetrics()
Returns
Type Description
ConversationModelEvaluation.Builder

clearName()

public ConversationModelEvaluation.Builder clearName()

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

string name = 1;

Returns
Type Description
ConversationModelEvaluation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ConversationModelEvaluation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides

clearRawHumanEvalTemplateCsv()

public ConversationModelEvaluation.Builder clearRawHumanEvalTemplateCsv()

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
Type Description
ConversationModelEvaluation.Builder

This builder for chaining.

clearSmartReplyMetrics()

public ConversationModelEvaluation.Builder clearSmartReplyMetrics()

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
Type Description
ConversationModelEvaluation.Builder

clone()

public ConversationModelEvaluation.Builder clone()
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation time of this model.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Creation time of this model.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time of this model.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ConversationModelEvaluation getDefaultInstanceForType()
Returns
Type Description
ConversationModelEvaluation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

Returns
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];

Returns
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];

Returns
Type Description
EvaluationConfig

The evaluationConfig.

getEvaluationConfigBuilder()

public EvaluationConfig.Builder getEvaluationConfigBuilder()

Optional. The configuration of the evaluation task.

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

Returns
Type Description
EvaluationConfig.Builder

getEvaluationConfigOrBuilder()

public EvaluationConfigOrBuilder getEvaluationConfigOrBuilder()

Optional. The configuration of the evaluation task.

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

Returns
Type Description
EvaluationConfigOrBuilder

getMetricsCase()

public ConversationModelEvaluation.MetricsCase getMetricsCase()
Returns
Type Description
ConversationModelEvaluation.MetricsCase

getName()

public String getName()

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

string name = 1;

Returns
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;

Returns
Type Description
ByteString

The bytes for name.

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

Returns
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];

Returns
Type Description
ByteString

The bytes for rawHumanEvalTemplateCsv.

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

Returns
Type Description
SmartReplyMetrics

The smartReplyMetrics.

getSmartReplyMetricsBuilder()

public SmartReplyMetrics.Builder getSmartReplyMetricsBuilder()

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
Type Description
SmartReplyMetrics.Builder

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

Returns
Type Description
SmartReplyMetricsOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation time of this model.

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

Returns
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];

Returns
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];

Returns
Type Description
boolean

Whether the smartReplyMetrics field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public ConversationModelEvaluation.Builder mergeCreateTime(Timestamp value)

Output only. Creation time of this model.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ConversationModelEvaluation.Builder

mergeEvaluationConfig(EvaluationConfig value)

public ConversationModelEvaluation.Builder mergeEvaluationConfig(EvaluationConfig value)

Optional. The configuration of the evaluation task.

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

Parameter
Name Description
value EvaluationConfig
Returns
Type Description
ConversationModelEvaluation.Builder

mergeFrom(ConversationModelEvaluation other)

public ConversationModelEvaluation.Builder mergeFrom(ConversationModelEvaluation other)
Parameter
Name Description
other ConversationModelEvaluation
Returns
Type Description
ConversationModelEvaluation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ConversationModelEvaluation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ConversationModelEvaluation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides

mergeSmartReplyMetrics(SmartReplyMetrics value)

public ConversationModelEvaluation.Builder mergeSmartReplyMetrics(SmartReplyMetrics value)

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

Parameter
Name Description
value SmartReplyMetrics
Returns
Type Description
ConversationModelEvaluation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ConversationModelEvaluation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides

setCreateTime(Timestamp value)

public ConversationModelEvaluation.Builder setCreateTime(Timestamp value)

Output only. Creation time of this model.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
ConversationModelEvaluation.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ConversationModelEvaluation.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Creation time of this model.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ConversationModelEvaluation.Builder

setDisplayName(String value)

public ConversationModelEvaluation.Builder setDisplayName(String value)

Optional. The display name of the model evaluation. At most 64 bytes long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
ConversationModelEvaluation.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ConversationModelEvaluation.Builder setDisplayNameBytes(ByteString value)

Optional. The display name of the model evaluation. At most 64 bytes long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
ConversationModelEvaluation.Builder

This builder for chaining.

setEvaluationConfig(EvaluationConfig value)

public ConversationModelEvaluation.Builder setEvaluationConfig(EvaluationConfig value)

Optional. The configuration of the evaluation task.

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

Parameter
Name Description
value EvaluationConfig
Returns
Type Description
ConversationModelEvaluation.Builder

setEvaluationConfig(EvaluationConfig.Builder builderForValue)

public ConversationModelEvaluation.Builder setEvaluationConfig(EvaluationConfig.Builder builderForValue)

Optional. The configuration of the evaluation task.

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

Parameter
Name Description
builderForValue EvaluationConfig.Builder
Returns
Type Description
ConversationModelEvaluation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ConversationModelEvaluation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides

setName(String value)

public ConversationModelEvaluation.Builder setName(String value)

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

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ConversationModelEvaluation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ConversationModelEvaluation.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ConversationModelEvaluation.Builder

This builder for chaining.

setRawHumanEvalTemplateCsv(String value)

public ConversationModelEvaluation.Builder setRawHumanEvalTemplateCsv(String value)

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

Parameter
Name Description
value String

The rawHumanEvalTemplateCsv to set.

Returns
Type Description
ConversationModelEvaluation.Builder

This builder for chaining.

setRawHumanEvalTemplateCsvBytes(ByteString value)

public ConversationModelEvaluation.Builder setRawHumanEvalTemplateCsvBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for rawHumanEvalTemplateCsv to set.

Returns
Type Description
ConversationModelEvaluation.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ConversationModelEvaluation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides

setSmartReplyMetrics(SmartReplyMetrics value)

public ConversationModelEvaluation.Builder setSmartReplyMetrics(SmartReplyMetrics value)

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

Parameter
Name Description
value SmartReplyMetrics
Returns
Type Description
ConversationModelEvaluation.Builder

setSmartReplyMetrics(SmartReplyMetrics.Builder builderForValue)

public ConversationModelEvaluation.Builder setSmartReplyMetrics(SmartReplyMetrics.Builder builderForValue)

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

Parameter
Name Description
builderForValue SmartReplyMetrics.Builder
Returns
Type Description
ConversationModelEvaluation.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ConversationModelEvaluation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides