Class ConversationModelEvaluation (4.57.0)

public final class ConversationModelEvaluation extends GeneratedMessageV3 implements ConversationModelEvaluationOrBuilder

Represents evaluation result of a conversation model.

Protobuf type google.cloud.dialogflow.v2.ConversationModelEvaluation

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EVALUATION_CONFIG_FIELD_NUMBER

public static final int EVALUATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RAW_HUMAN_EVAL_TEMPLATE_CSV_FIELD_NUMBER

public static final int RAW_HUMAN_EVAL_TEMPLATE_CSV_FIELD_NUMBER
Field Value
Type Description
int

SMART_REPLY_METRICS_FIELD_NUMBER

public static final int SMART_REPLY_METRICS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConversationModelEvaluation getDefaultInstance()
Returns
Type Description
ConversationModelEvaluation

getDescriptor()

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

newBuilder()

public static ConversationModelEvaluation.Builder newBuilder()
Returns
Type Description
ConversationModelEvaluation.Builder

newBuilder(ConversationModelEvaluation prototype)

public static ConversationModelEvaluation.Builder newBuilder(ConversationModelEvaluation prototype)
Parameter
Name Description
prototype ConversationModelEvaluation
Returns
Type Description
ConversationModelEvaluation.Builder

parseDelimitedFrom(InputStream input)

public static ConversationModelEvaluation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationModelEvaluation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConversationModelEvaluation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConversationModelEvaluation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConversationModelEvaluation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConversationModelEvaluation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConversationModelEvaluation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationModelEvaluation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConversationModelEvaluation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationModelEvaluation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConversationModelEvaluation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConversationModelEvaluation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConversationModelEvaluation> parser()
Returns
Type Description
Parser<ConversationModelEvaluation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

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.

getParserForType()

public Parser<ConversationModelEvaluation> getParserForType()
Returns
Type Description
Parser<ConversationModelEvaluation>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConversationModelEvaluation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConversationModelEvaluation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException