Package com.google.cloud.dialogflow.v2

Class ConversationModelEvaluation

  • All Implemented Interfaces:
    ConversationModelEvaluationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ConversationModelEvaluation
extends com.google.protobuf.GeneratedMessageV3
implements ConversationModelEvaluationOrBuilder
     Represents evaluation result of a conversation model.
    Protobuf type google.cloud.dialogflow.v2.ConversationModelEvaluation
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EVALUATION_CONFIG_FIELD_NUMBER

        public static final int EVALUATION_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SMART_REPLY_METRICS_FIELD_NUMBER

        public static final int SMART_REPLY_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RAW_HUMAN_EVAL_TEMPLATE_CSV_FIELD_NUMBER

        public static final int RAW_HUMAN_EVAL_TEMPLATE_CSV_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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];
        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 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];
        Specified by:
        getRawHumanEvalTemplateCsvBytes in interface ConversationModelEvaluationOrBuilder
        Returns:
        The bytes for rawHumanEvalTemplateCsv.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ConversationModelEvaluation parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversationModelEvaluation parseFrom​(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversationModelEvaluation parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversationModelEvaluation parseFrom​(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversationModelEvaluation parseFrom​(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversationModelEvaluation parseFrom​(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ConversationModelEvaluation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ConversationModelEvaluation> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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