Struct ClassificationCategory 

#[non_exhaustive]
pub struct ClassificationCategory {
    pub name: String,
    pub confidence: f32,
    pub severity: f32,
    /* private fields */
}

Represents a category returned from the text classifier.

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 name of the category representing the document.

confidence: f32

The classifier’s confidence of the category. Number represents how certain the classifier is that this category represents the given text.

severity: f32

Optional. The classifier’s severity of the category. This is only present when the ModerateTextRequest.ModelVersion is set to MODEL_VERSION_2, and the corresponding category has a severity score.

Implementations

impl ClassificationCategory

pub fn new() -> Self

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

Sets the value of name.

Example

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

pub fn set_confidence<T: Into<f32>>(self, v: T) -> Self

Sets the value of confidence.

Example

let x = ClassificationCategory::new().set_confidence(42.0);

pub fn set_severity<T: Into<f32>>(self, v: T) -> Self

Sets the value of severity.

Example

let x = ClassificationCategory::new().set_severity(42.0);

Trait Implementations

impl Clone for ClassificationCategory

fn clone(&self) -> ClassificationCategory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClassificationCategory

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

Formats the value using the given formatter.

impl Default for ClassificationCategory

fn default() -> ClassificationCategory

Returns the “default value” for a type.

impl Message for ClassificationCategory

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ClassificationCategory

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