Struct ConversationModelEvaluation 

#[non_exhaustive]
pub struct ConversationModelEvaluation {
    pub name: String,
    pub display_name: String,
    pub evaluation_config: Option<EvaluationConfig>,
    pub create_time: Option<Timestamp>,
    pub raw_human_eval_template_csv: String,
    pub metrics: Option<Metrics>,
    /* private fields */
}

Available on crate feature conversation-models only.

Represents evaluation result of a conversation model.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

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

display_name: String

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

evaluation_config: Option<EvaluationConfig>

Optional. The configuration of the evaluation task.

create_time: Option<Timestamp>

Output only. Creation time of this model.

raw_human_eval_template_csv: String

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.

metrics: Option<Metrics>

Metrics details.

Implementations

impl ConversationModelEvaluation

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = ConversationModelEvaluation::new().set_name("example");

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

Example

let x = ConversationModelEvaluation::new().set_display_name("example");

pub fn set_evaluation_config<T>(self, v: T) -> Self

where T: Into<EvaluationConfig>,

Sets the value of evaluation_config.

Example

use google_cloud_dialogflow_v2::model::EvaluationConfig;
let x = ConversationModelEvaluation::new().set_evaluation_config(EvaluationConfig::default()/* use setters */);

pub fn set_or_clear_evaluation_config<T>(self, v: Option<T>) -> Self

where T: Into<EvaluationConfig>,

Sets or clears the value of evaluation_config.

Example

use google_cloud_dialogflow_v2::model::EvaluationConfig;
let x = ConversationModelEvaluation::new().set_or_clear_evaluation_config(Some(EvaluationConfig::default()/* use setters */));
let x = ConversationModelEvaluation::new().set_or_clear_evaluation_config(None::<EvaluationConfig>);

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = ConversationModelEvaluation::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = ConversationModelEvaluation::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = ConversationModelEvaluation::new().set_or_clear_create_time(None::<Timestamp>);

pub fn set_raw_human_eval_template_csv<T: Into<String>>(self, v: T) -> Self

Sets the value of raw_human_eval_template_csv.

Example

let x = ConversationModelEvaluation::new().set_raw_human_eval_template_csv("example");

pub fn set_metrics<T: Into<Option<Metrics>>>(self, v: T) -> Self

Sets the value of metrics.

Note that all the setters affecting metrics are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::SmartReplyMetrics;
let x = ConversationModelEvaluation::new().set_metrics(Some(
    google_cloud_dialogflow_v2::model::conversation_model_evaluation::Metrics::SmartReplyMetrics(SmartReplyMetrics::default().into())));

pub fn smart_reply_metrics(&self) -> Option<&Box<SmartReplyMetrics>>

The value of metrics if it holds a SmartReplyMetrics, None if the field is not set or holds a different branch.

pub fn set_smart_reply_metrics<T: Into<Box<SmartReplyMetrics>>>( self, v: T, ) -> Self

Sets the value of metrics to hold a SmartReplyMetrics.

Note that all the setters affecting metrics are mutually exclusive.

Example

use google_cloud_dialogflow_v2::model::SmartReplyMetrics;
let x = ConversationModelEvaluation::new().set_smart_reply_metrics(SmartReplyMetrics::default()/* use setters */);
assert!(x.smart_reply_metrics().is_some());

Trait Implementations

impl Clone for ConversationModelEvaluation

fn clone(&self) -> ConversationModelEvaluation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConversationModelEvaluation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConversationModelEvaluation

fn default() -> ConversationModelEvaluation

Returns the “default value” for a type.

impl Message for ConversationModelEvaluation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ConversationModelEvaluation

fn eq(&self, other: &ConversationModelEvaluation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConversationModelEvaluation