Package com.google.cloud.dialogflow.v2

Class ConversationModelEvaluation.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ConversationModelEvaluation.Builder>
com.google.cloud.dialogflow.v2.ConversationModelEvaluation.Builder
All Implemented Interfaces:
ConversationModelEvaluationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ConversationModelEvaluation
public static final class ConversationModelEvaluation.Builder extends com.google.protobuf.GeneratedMessage.Builder<ConversationModelEvaluation.Builder> implements ConversationModelEvaluationOrBuilder
 Represents evaluation result of a conversation model.
Protobuf type google.cloud.dialogflow.v2.ConversationModelEvaluation

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ConversationModelEvaluation.Builder>

    • clear

      public ConversationModelEvaluation.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ConversationModelEvaluation.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ConversationModelEvaluation.Builder>

    • getDefaultInstanceForType

      public ConversationModelEvaluation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ConversationModelEvaluation build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ConversationModelEvaluation buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ConversationModelEvaluation.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ConversationModelEvaluation.Builder>

    • mergeFrom

      public ConversationModelEvaluation.Builder mergeFrom(ConversationModelEvaluation other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ConversationModelEvaluation.Builder>

    • mergeFrom

      public ConversationModelEvaluation.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ConversationModelEvaluation.Builder>
      Throws:
      IOException

    • getMetricsCase

      public ConversationModelEvaluation.MetricsCase getMetricsCase()
      Specified by:
      getMetricsCase in interface ConversationModelEvaluationOrBuilder

    • clearMetrics

      public ConversationModelEvaluation.Builder clearMetrics()

    • getName

      public String getName()
       The resource name of the evaluation. Format:
 `projects/<Project ID>/conversationModels/<Conversation Model
 ID>/evaluations/<Evaluation ID>`
      string name = 1;
      Specified by:
      getName in interface ConversationModelEvaluationOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface ConversationModelEvaluationOrBuilder
      Returns:
      The bytes for name.

    • setName

      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;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setNameBytes

      public ConversationModelEvaluation.Builder setNameBytes(com.google.protobuf.ByteString value)
       The resource name of the evaluation. Format:
 `projects/<Project ID>/conversationModels/<Conversation Model
 ID>/evaluations/<Evaluation ID>`
      string name = 1;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getDisplayName in interface ConversationModelEvaluationOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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];
      Specified by:
      getDisplayNameBytes in interface ConversationModelEvaluationOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      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];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setDisplayNameBytes

      public ConversationModelEvaluation.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       Optional. The display name of the model evaluation. At most 64 bytes long.
      string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • hasEvaluationConfig

      public boolean hasEvaluationConfig()
       Optional. The configuration of the evaluation task.
      .google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEvaluationConfig in interface ConversationModelEvaluationOrBuilder
      Returns:
      Whether the evaluationConfig field is set.

    • getEvaluationConfig

      public EvaluationConfig getEvaluationConfig()
       Optional. The configuration of the evaluation task.
      .google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEvaluationConfig in interface ConversationModelEvaluationOrBuilder
      Returns:
      The evaluationConfig.

    • setEvaluationConfig

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

    • setEvaluationConfig

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

    • mergeEvaluationConfig

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

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

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

    • getEvaluationConfigOrBuilder

      public EvaluationConfigOrBuilder getEvaluationConfigOrBuilder()
       Optional. The configuration of the evaluation task.
      .google.cloud.dialogflow.v2.EvaluationConfig evaluation_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEvaluationConfigOrBuilder in interface ConversationModelEvaluationOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Creation time of this model.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ConversationModelEvaluationOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Creation time of this model.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface ConversationModelEvaluationOrBuilder
      Returns:
      The createTime.

    • setCreateTime

      public ConversationModelEvaluation.Builder setCreateTime(com.google.protobuf.Timestamp value)
       Output only. Creation time of this model.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setCreateTime

      public ConversationModelEvaluation.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Creation time of this model.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeCreateTime

      public ConversationModelEvaluation.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       Output only. Creation time of this model.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearCreateTime

      public ConversationModelEvaluation.Builder clearCreateTime()
       Output only. Creation time of this model.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
       Output only. Creation time of this model.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Creation time of this model.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ConversationModelEvaluationOrBuilder

    • 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];
      Specified by:
      hasSmartReplyMetrics in interface ConversationModelEvaluationOrBuilder
      Returns:
      Whether the smartReplyMetrics field is set.

    • 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];
      Specified by:
      getSmartReplyMetrics in interface ConversationModelEvaluationOrBuilder
      Returns:
      The smartReplyMetrics.

    • setSmartReplyMetrics

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

    • setSmartReplyMetrics

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

    • mergeSmartReplyMetrics

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

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

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

    • 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];
      Specified by:
      getSmartReplyMetricsOrBuilder in interface ConversationModelEvaluationOrBuilder

    • getRawHumanEvalTemplateCsv

      public String getRawHumanEvalTemplateCsv()
       Output only. Human eval template in csv format.
 It takes 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];
      Specified by:
      getRawHumanEvalTemplateCsv in interface ConversationModelEvaluationOrBuilder
      Returns:
      The rawHumanEvalTemplateCsv.

    • getRawHumanEvalTemplateCsvBytes

      public com.google.protobuf.ByteString getRawHumanEvalTemplateCsvBytes()
       Output only. Human eval template in csv format.
 It takes 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];
      Specified by:
      getRawHumanEvalTemplateCsvBytes in interface ConversationModelEvaluationOrBuilder
      Returns:
      The bytes for rawHumanEvalTemplateCsv.

    • setRawHumanEvalTemplateCsv

      public ConversationModelEvaluation.Builder setRawHumanEvalTemplateCsv(String value)
       Output only. Human eval template in csv format.
 It takes 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];
      Parameters:
      value - The rawHumanEvalTemplateCsv to set.
      Returns:
      This builder for chaining.

    • clearRawHumanEvalTemplateCsv

      public ConversationModelEvaluation.Builder clearRawHumanEvalTemplateCsv()
       Output only. Human eval template in csv format.
 It takes 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:
      This builder for chaining.

    • setRawHumanEvalTemplateCsvBytes

      public ConversationModelEvaluation.Builder setRawHumanEvalTemplateCsvBytes(com.google.protobuf.ByteString value)
       Output only. Human eval template in csv format.
 It takes 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];
      Parameters:
      value - The bytes for rawHumanEvalTemplateCsv to set.
      Returns:
      This builder for chaining.