Skip to main content

StructuredOutputProcessor

Struct StructuredOutputProcessor 

Source
pub struct StructuredOutputProcessor { /* private fields */ }
Expand description

Per-request structured-output parser state.

Implementations§

Source§

impl StructuredOutputProcessor

Source

pub fn mask_logits( &self, logits: &mut [f32], generated: &[TokenId], ) -> Result<()>

Consume newly generated tokens and hard-mask every illegal next token. Waiting-for-reasoning mode leaves normal logits untouched until the typed delimiter has been observed.

Source

pub fn mask_logits_with_terminals( &self, logits: &mut [f32], generated: &[TokenId], terminal_token_ids: &HashSet<u32>, hidden_control_token_ids: &HashSet<u32>, ) -> Result<StructuredOutputMaskOutcome>

Apply the grammar mask while allowing engine-resolved stop tokens once the grammar accepts. Some model templates use an end-of-turn token that is not the tokenizer’s primary EOS, so it cannot be represented by the grammar parser’s EOS set alone.

Source

pub fn is_accepting(&self, generated: &[TokenId]) -> Result<bool>

True only when reasoning has closed and the grammar accepts the full generated structured value.

Source

pub fn is_accepting_with_terminals( &self, generated: &[TokenId], terminal_token_ids: &HashSet<u32>, ) -> Result<bool>

Completion check that treats an engine-resolved terminal sampled after grammar acceptance as framing rather than part of the JSON value.

Source

pub fn progress_with_terminals( &self, generated: &[TokenId], terminal_token_ids: &HashSet<u32>, ) -> Result<StructuredOutputProgress>

Inspect the typed activation/grammar state after consuming generated.

Source

pub fn reset(&self) -> Result<()>

Trait Implementations§

Source§

impl Debug for StructuredOutputProcessor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V