Enum Grammar

pub enum Grammar {
    Regex(String),
    JsonSchema(Value),
    Llguidance(LlguidanceGrammar),
    Lark(String),
}

Grammar specification for structured generation

Defines different types of grammars that can be used to constrain model output, ensuring it follows specific formats or structures.

Examples

use mistralrs_server_core::openai::Grammar;

// Regex grammar for phone numbers
let phone_regex = Grammar::Regex(r"\d{3}-\d{3}-\d{4}".to_string());

// JSON schema for structured data
let json_schema = Grammar::JsonSchema(serde_json::json!({
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "age": {"type": "integer"}
    },
    "required": ["name", "age"]
}));

// Lark grammar for arithmetic expressions
let lark_grammar = Grammar::Lark(r#"
    ?start: expr
    expr: term ("+" term | "-" term)*
    term: factor ("*" factor | "/" factor)*
    factor: NUMBER | "(" expr ")"
    %import common.NUMBER
"#.to_string());

Variants

Regex(String)

Regular expression grammar

JsonSchema(Value)

JSON schema grammar

Llguidance(LlguidanceGrammar)

LLGuidance grammar

Lark(String)

Lark parser grammar

Trait Implementations

impl Clone for Grammar

fn clone(&self) -> Grammar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Grammar

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Grammar

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialSchema for Grammar

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for Grammar

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for Grammar

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

fn name() -> Cow<'static, str>

Return name of the schema.