Struct NlpResult 

#[non_exhaustive]
pub struct NlpResult {
    pub tokens: Vec<NlpToken>,
    pub sentences: Vec<NlpSentence>,
    pub frames: Vec<SrlFrame>,
    pub speech_acts: Vec<SpeechAct>,
    pub entities: Vec<NerEntity>,
}

Structured output of an NLP analysis call.

Field population depends on the NlpTasks flags in the request and on the model’s NlpModel::supported_tasks. Unrequested or unsupported fields are empty (Vec::new()).

This struct is #[non_exhaustive]: construct it via NlpResult::default and assign fields, so future heads can be added without breaking callers.

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.

tokens: Vec<NlpToken>

Token sequence with optional POS / NER / DEP annotations.

sentences: Vec<NlpSentence>

Sentence boundaries (always populated when any head is requested).

frames: Vec<SrlFrame>

SRL frames. Empty unless NlpTasks::SRL was requested and supported.

speech_acts: Vec<SpeechAct>

Sentence-level classifications. Empty unless NlpTasks::CLS was requested and supported.

entities: Vec<NerEntity>

Merged named-entity spans, a BIO-collapsed view of the per-token NlpToken::ner tags. Empty unless NlpTasks::NER was requested and supported. See NerEntity.

Trait Implementations

impl Clone for NlpResult

fn clone(&self) -> NlpResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NlpResult

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

Formats the value using the given formatter.

impl Default for NlpResult

fn default() -> NlpResult

Returns the “default value” for a type.