Struct SummarizationQualityInstance 

#[non_exhaustive]
pub struct SummarizationQualityInstance {
    pub prediction: Option<String>,
    pub reference: Option<String>,
    pub context: Option<String>,
    pub instruction: Option<String>,
    /* private fields */
}

Available on crate feature evaluation-service only.

Spec for summarization quality instance.

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.

prediction: Option<String>

Required. Output of the evaluated model.

reference: Option<String>

Optional. Ground truth used to compare against the prediction.

context: Option<String>

Required. Text to be summarized.

instruction: Option<String>

Required. Summarization prompt for LLM.

Implementations

impl SummarizationQualityInstance

pub fn new() -> Self

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

where T: Into<String>,

Sets the value of prediction.

Example

let x = SummarizationQualityInstance::new().set_prediction("example");

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

where T: Into<String>,

Sets or clears the value of prediction.

Example

let x = SummarizationQualityInstance::new().set_or_clear_prediction(Some("example"));
let x = SummarizationQualityInstance::new().set_or_clear_prediction(None::<String>);

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

where T: Into<String>,

Sets the value of reference.

Example

let x = SummarizationQualityInstance::new().set_reference("example");

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

where T: Into<String>,

Sets or clears the value of reference.

Example

let x = SummarizationQualityInstance::new().set_or_clear_reference(Some("example"));
let x = SummarizationQualityInstance::new().set_or_clear_reference(None::<String>);

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

where T: Into<String>,

Sets the value of context.

Example

let x = SummarizationQualityInstance::new().set_context("example");

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

where T: Into<String>,

Sets or clears the value of context.

Example

let x = SummarizationQualityInstance::new().set_or_clear_context(Some("example"));
let x = SummarizationQualityInstance::new().set_or_clear_context(None::<String>);

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

where T: Into<String>,

Sets the value of instruction.

Example

let x = SummarizationQualityInstance::new().set_instruction("example");

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

where T: Into<String>,

Sets or clears the value of instruction.

Example

let x = SummarizationQualityInstance::new().set_or_clear_instruction(Some("example"));
let x = SummarizationQualityInstance::new().set_or_clear_instruction(None::<String>);

Trait Implementations

impl Clone for SummarizationQualityInstance

fn clone(&self) -> SummarizationQualityInstance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SummarizationQualityInstance

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

Formats the value using the given formatter.

impl Default for SummarizationQualityInstance

fn default() -> SummarizationQualityInstance

Returns the “default value” for a type.

impl Message for SummarizationQualityInstance

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SummarizationQualityInstance

fn eq(&self, other: &SummarizationQualityInstance) -> 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 SummarizationQualityInstance