Struct Sentiment 

#[non_exhaustive]
pub struct Sentiment {
    pub label: SentimentLabel,
    pub score: f64,
    pub confidence: f64,
}

Sentiment score for a news article or transcript segment.

Only present when the sentiment feature is enabled.

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.

label: SentimentLabel

Directional classification.

score: f64

Compound score: -1.0 (most bearish) to +1.0 (most bullish).

confidence: f64

Confidence: 0.0 to 1.0 (magnitude of the compound score).

Implementations

impl Sentiment

pub fn to_dataframe(&self) -> PolarsResult<DataFrame>

Converts this struct to a single-row polars DataFrame.

All scalar fields are included as columns. Nested objects and complex types are excluded.

This method is auto-generated by the ToDataFrame derive macro.

pub fn vec_to_dataframe(items: &[Self]) -> PolarsResult<DataFrame>

Converts a slice of structs to a multi-row polars DataFrame.

All scalar fields are included as columns. Nested objects and complex types are excluded.

This method is auto-generated by the ToDataFrame derive macro.

impl Sentiment

pub fn from_compound(score: f64) -> Self

Build a Sentiment from a VADER compound score in [-1.0, 1.0].

pub fn neutral() -> Self

A neutral, zero-confidence score (used as the empty aggregate).

Trait Implementations

impl Clone for Sentiment

fn clone(&self) -> Sentiment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Sentiment

impl Debug for Sentiment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sentiment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Sentiment

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Sentiment

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Sentiment