prosaic-core 0.6.2

General-purpose natural language generation from structured data
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

#[cfg(not(feature = "std"))]
use alloc::string::String;
#[cfg(not(feature = "std"))]
use alloc::vec::Vec;

use thiserror::Error;

#[derive(Debug, Error, PartialEq)]
pub enum ProsaicError {
    #[error("missing slot `{slot}` in template `{template}`")]
    MissingSlot { template: String, slot: String },

    #[error("unknown template `{0}`")]
    UnknownTemplate(String),

    #[error("invalid pipe `{pipe}`: {reason}")]
    InvalidPipe { pipe: String, reason: String },

    #[error("grammar error: {0}")]
    GrammarError(String),

    #[error("template parse error in `{template}` at position {position}: {reason}")]
    TemplateParseError {
        template: String,
        position: usize,
        reason: String,
    },

    /// Returned when the faithfulness gate is enabled and the rendered output
    /// fails the precision threshold or has a polarity mismatch. The session
    /// state is rolled back as if the render had not occurred.
    #[error("faithfulness rejected: precision {precision:.3}, polarity_match {polarity_match}")]
    FaithfulnessRejection {
        precision: f32,
        polarity_match: bool,
    },

    /// Returned by `register_partial` when registering the partial would
    /// introduce a direct or indirect `{>name}` cycle. The `cycle` field
    /// carries the names involved in the offending chain in traversal order,
    /// repeating the entry partial at the tail so the cycle reads
    /// `a -> b -> a`.
    #[error("recursive partial cycle detected: {}", cycle.join(" -> "))]
    RecursivePartial { cycle: Vec<String> },
}