llguidance 0.6.26

Super-fast Structured Outputs
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use crate::HashSet;
use serde::{Deserialize, Serialize};
use toktrie::{bytes::to_hex_string, StepResult};

use crate::{api::StopReason, earley, TokenParser};

#[derive(Serialize, Deserialize)]
pub struct BytesOutput {
    pub str: String,
    pub hex: String,
}

#[derive(Serialize, Deserialize)]
#[serde(tag = "object", rename_all = "snake_case")]
pub enum ParserOutput {
    Capture {
        name: String,
        #[serde(flatten)]
        bytes: BytesOutput,
        log_prob: f64,
    },
    FinalText {
        #[serde(flatten)]
        bytes: BytesOutput,
        stop_reason: StopReason,
    },
    Text {
        #[serde(flatten)]
        bytes: BytesOutput,
        log_prob: f64,
        num_tokens: usize,
        is_generated: bool,
        stats: ParserStats,
    },
}

#[derive(Serialize, Deserialize)]
pub struct ParserStats {
    runtime_us: u64,
    #[serde(flatten)]
    stats: earley::ParserStats,
}

impl From<&[u8]> for BytesOutput {
    fn from(bytes: &[u8]) -> Self {
        BytesOutput::from_bytes(bytes)
    }
}

impl BytesOutput {
    pub fn from_bytes(bytes: &[u8]) -> Self {
        BytesOutput {
            str: String::from_utf8_lossy(bytes).to_string(),
            hex: to_hex_string(bytes),
        }
    }
}

#[derive(Clone, Default)]
pub struct Reporter {
    reported_captures: usize,
    text_ptr: usize,
    token_ptr: usize,
    prev_stats: earley::ParserStats,
    is_generated: bool,
}

impl Reporter {
    pub fn get_progress(
        &mut self,
        tok_parser: &TokenParser,
        mid_res: &StepResult,
    ) -> Vec<ParserOutput> {
        let mut res = self.get_progress_core(tok_parser);
        self.is_generated = !mid_res.is_stop() && mid_res.splices.len() == 0;

        if mid_res.is_stop() {
            res.push(self.final_text(tok_parser));
        }

        res
    }

    pub fn final_text(&self, tok_parser: &TokenParser) -> ParserOutput {
        ParserOutput::FinalText {
            bytes: tok_parser.final_bytes().into(),
            stop_reason: tok_parser.stop_reason(),
        }
    }

    pub fn set_is_generated(&mut self, is_generated: bool) {
        self.is_generated = is_generated;
    }

    pub fn get_progress_core(&mut self, tok_parser: &TokenParser) -> Vec<ParserOutput> {
        let mut res = vec![];

        // start with captures
        let captures = &tok_parser.parser.captures()[self.reported_captures..];
        self.reported_captures += captures.len();

        // remove duplicate names
        let mut seen = HashSet::default();
        let captures = captures
            .iter()
            .rev()
            .filter(|(name, _)| seen.insert(name))
            .collect::<Vec<_>>();
        for (name, val) in captures.iter().rev() {
            res.push(ParserOutput::Capture {
                name: name.clone(),
                bytes: val.as_slice().into(),
                log_prob: 0.0, // TODO
            });
        }

        // compute stats
        let delta = tok_parser.parser_stats().delta(&self.prev_stats);
        self.prev_stats = tok_parser.parser_stats().clone();
        let runtime_us = tok_parser.compute_mask_start_time.elapsed().as_micros() as u64;
        let stats = ParserStats {
            runtime_us,
            stats: delta,
        };

        // report newly generated text
        let num_tokens = tok_parser.num_tokens();
        let new_text = tok_parser.bytes_since(self.text_ptr);
        res.push(ParserOutput::Text {
            bytes: new_text.into(),
            log_prob: 0.0, // TODO
            num_tokens: num_tokens.saturating_sub(self.token_ptr),
            is_generated: self.is_generated,
            stats,
        });
        self.text_ptr += new_text.len();
        self.token_ptr = num_tokens;

        res
    }
}