Index

_

__init__() (xgrammar.BatchGrammarMatcher method) (xgrammar.GrammarCompiler method) (xgrammar.GrammarMatcher method) (xgrammar.TokenizerInfo method) __str__() (xgrammar.Grammar method) _deepseek_xml_tool_calling_to_ebnf() (in module xgrammar.testing) _ebnf_to_grammar_no_normalization() (in module xgrammar.testing) _generate_float_regex() (in module xgrammar.testing) _generate_range_regex() (in module xgrammar.testing) _get_allow_empty_rule_ids() (in module xgrammar.testing) _get_masked_tokens_from_bitmask() (in module xgrammar.testing)

_get_matcher_from_grammar() (in module xgrammar.testing) _get_matcher_from_grammar_and_tokenizer_info() (in module xgrammar.testing) _glm_xml_tool_calling_to_ebnf() (in module xgrammar.testing) _is_grammar_accept_string() (in module xgrammar.testing) _is_single_token_bitmask() (in module xgrammar.testing) _json_schema_to_ebnf() (in module xgrammar.testing) _minimax_xml_tool_calling_to_ebnf() (in module xgrammar.testing) _print_grammar_fsms() (in module xgrammar.testing) _qwen_xml_tool_calling_to_ebnf() (in module xgrammar.testing) _regex_to_ebnf() (in module xgrammar.testing) _traverse_draft_tree() (in module xgrammar.testing)

A

accept_string() (xgrammar.GrammarMatcher method) accept_token() (xgrammar.GrammarMatcher method) add_prefix_space (xgrammar.TokenizerInfo property) allocate_token_bitmask() (in module xgrammar)

allowed_tools (xgrammar.openai_tool_call_schema.AllowedToolChoiceParam attribute) AllowedToolChoiceParam (class in xgrammar.openai_tool_call_schema) apply_token_bitmask_inplace() (in module xgrammar) at_least_one (xgrammar.structural_tag.TagsWithSeparatorFormat attribute) (xgrammar.structural_tag.TriggeredTagsFormat attribute)

B

batch_accept_string() (xgrammar.BatchGrammarMatcher static method) batch_accept_token() (xgrammar.BatchGrammarMatcher static method) batch_fill_next_token_bitmask() (xgrammar.BatchGrammarMatcher method) batch_rollback() (xgrammar.BatchGrammarMatcher static method) BatchGrammarMatcher (class in xgrammar) begin (xgrammar.structural_tag.StructuralTagItem attribute) (xgrammar.structural_tag.TagFormat attribute) bitmask_dtype (in module xgrammar)

bitmask_to_bool_mask() (in module xgrammar.testing) bool_mask_to_bitmask() (in module xgrammar.testing) builtin_json_grammar() (xgrammar.Grammar static method) BuiltinToolChoiceParam (class in xgrammar.openai_tool_call_schema) BuiltinToolParam (class in xgrammar.openai_tool_call_schema) BYTE_FALLBACK (xgrammar.VocabType attribute) BYTE_LEVEL (xgrammar.VocabType attribute) byte_string_fuser() (xgrammar.testing.GrammarFunctor static method)

C

cache_limit_bytes (xgrammar.GrammarCompiler property) clear_cache() (xgrammar.GrammarCompiler method) compile_builtin_json_grammar() (xgrammar.GrammarCompiler method) compile_grammar() (xgrammar.GrammarCompiler method) compile_json_schema() (xgrammar.GrammarCompiler method)

compile_regex() (xgrammar.GrammarCompiler method) compile_structural_tag() (xgrammar.GrammarCompiler method) CompiledGrammar (class in xgrammar) concat() (xgrammar.Grammar static method) content (xgrammar.structural_tag.TagFormat attribute)

D

dead_code_eliminator() (xgrammar.testing.GrammarFunctor static method) decoded_vocab (xgrammar.TokenizerInfo property) description (xgrammar.openai_tool_call_schema.FunctionDefinition attribute) deserialize_json() (xgrammar.CompiledGrammar static method) (xgrammar.Grammar static method) (xgrammar.TokenizerInfo static method)

DeserializeFormatError (class in xgrammar.exception) DeserializeVersionError (class in xgrammar.exception) dump_metadata() (xgrammar.TokenizerInfo method)

E

elements (xgrammar.structural_tag.OrFormat attribute) (xgrammar.structural_tag.SequenceFormat attribute) end (xgrammar.structural_tag.StructuralTagItem attribute) (xgrammar.structural_tag.TagFormat attribute)

excludes (xgrammar.structural_tag.AnyTextFormat attribute) (xgrammar.structural_tag.TriggeredTagsFormat attribute)

F

fill_next_token_bitmask() (xgrammar.GrammarMatcher method) find_jump_forward_string() (xgrammar.GrammarMatcher method) fork() (xgrammar.GrammarMatcher method) Format (in module xgrammar.structural_tag) format (xgrammar.StructuralTag attribute) from_ebnf() (xgrammar.Grammar static method) from_huggingface() (xgrammar.TokenizerInfo static method) from_json() (xgrammar.StructuralTag static method)

from_json_schema() (xgrammar.Grammar static method) from_legacy_structural_tag() (xgrammar.StructuralTag static method) from_regex() (xgrammar.Grammar static method) from_structural_tag() (xgrammar.Grammar static method) from_vocab_and_metadata() (xgrammar.TokenizerInfo static method) function (xgrammar.openai_tool_call_schema.FunctionToolParam attribute) (xgrammar.openai_tool_call_schema.NamedToolChoiceParam attribute) FunctionDefinition (class in xgrammar.openai_tool_call_schema) FunctionToolParam (class in xgrammar.openai_tool_call_schema)

G

get_bitmask_shape() (in module xgrammar) get_builtin_structural_tag() (in module xgrammar.builtin_structural_tag) get_cache_size_bytes() (xgrammar.GrammarCompiler method) get_deepseek_r1_structural_tag() (in module xgrammar.builtin_structural_tag) get_deepseek_v3_1_structural_tag() (in module xgrammar.builtin_structural_tag) get_deepseek_v3_2_structural_tag() (in module xgrammar.builtin_structural_tag) get_deepseek_v4_structural_tag() (in module xgrammar.builtin_structural_tag) get_glm_4_7_structural_tag() (in module xgrammar.builtin_structural_tag) get_harmony_structural_tag() (in module xgrammar.builtin_structural_tag) get_kimi_structural_tag() (in module xgrammar.builtin_structural_tag) get_llama_structural_tag() (in module xgrammar.builtin_structural_tag) get_max_recursion_depth() (in module xgrammar)

get_minimax_structural_tag() (in module xgrammar.builtin_structural_tag) get_model_structural_tag() (in module xgrammar.builtin_structural_tag) get_qwen_3_5_structural_tag() (in module xgrammar.builtin_structural_tag) get_qwen_3_coder_structural_tag() (in module xgrammar.builtin_structural_tag) get_qwen_3_structural_tag() (in module xgrammar.builtin_structural_tag) get_serialization_version() (in module xgrammar) Grammar (class in xgrammar) grammar (xgrammar.CompiledGrammar property) (xgrammar.structural_tag.GrammarFormat attribute) grammar_optimizer() (xgrammar.testing.GrammarFunctor static method) GrammarCompiler (class in xgrammar) GrammarFunctor (class in xgrammar.testing) GrammarMatcher (class in xgrammar)

I

InvalidJSONError (class in xgrammar.exception) InvalidStructuralTagError (class in xgrammar.exception)

is_completed() (xgrammar.GrammarMatcher method) is_terminated() (xgrammar.GrammarMatcher method)

J

json_schema (xgrammar.structural_tag.JSONSchemaFormat attribute) (xgrammar.structural_tag.QwenXMLParameterFormat attribute)

L

lookahead_assertion_analyzer() (xgrammar.testing.GrammarFunctor static method)

M

max_recursion_depth() (in module xgrammar) max_rollback_tokens (xgrammar.GrammarMatcher property) memory_size_bytes (xgrammar.CompiledGrammar property) model_config (xgrammar.openai_tool_call_schema.AllowedToolChoiceParam attribute) (xgrammar.openai_tool_call_schema.BuiltinToolChoiceParam attribute) (xgrammar.openai_tool_call_schema.BuiltinToolParam attribute) (xgrammar.openai_tool_call_schema.FunctionDefinition attribute) (xgrammar.openai_tool_call_schema.FunctionToolParam attribute) (xgrammar.openai_tool_call_schema.NamedToolChoiceParam attribute)

module xgrammar.builtin_structural_tag xgrammar.testing

N

name (xgrammar.openai_tool_call_schema.BuiltinToolChoiceParam attribute) (xgrammar.openai_tool_call_schema.BuiltinToolParam attribute) (xgrammar.openai_tool_call_schema.FunctionDefinition attribute)

NamedToolChoiceParam (class in xgrammar.openai_tool_call_schema) normalize_tool_choice() (in module xgrammar.builtin_structural_tag)

P

parameters (xgrammar.openai_tool_call_schema.BuiltinToolParam attribute) (xgrammar.openai_tool_call_schema.FunctionDefinition attribute)

pattern (xgrammar.structural_tag.RegexFormat attribute) prepend_space_in_tokenization (xgrammar.TokenizerInfo property)

R

RAW (xgrammar.VocabType attribute) register_model_structural_tag() (in module xgrammar.builtin_structural_tag) repetition_normalizer() (xgrammar.testing.GrammarFunctor static method)

reset() (xgrammar.GrammarMatcher method) reset_token_bitmask() (in module xgrammar) rollback() (xgrammar.GrammarMatcher method) rule_inliner() (xgrammar.testing.GrammarFunctor static method)

S

schema_ (xgrammar.structural_tag.StructuralTagItem attribute) separator (xgrammar.structural_tag.TagsWithSeparatorFormat attribute) serialize_json() (xgrammar.CompiledGrammar method) (xgrammar.Grammar method) (xgrammar.TokenizerInfo method) set_max_recursion_depth() (in module xgrammar) special_token_ids (xgrammar.TokenizerInfo property) stop_after_first (xgrammar.structural_tag.TagsWithSeparatorFormat attribute) (xgrammar.structural_tag.TriggeredTagsFormat attribute)

stop_token_ids (xgrammar.GrammarMatcher property) (xgrammar.TokenizerInfo property) strict (xgrammar.openai_tool_call_schema.FunctionDefinition attribute) StructuralTag (class in xgrammar) StructuralTagItem (class in xgrammar.structural_tag) structure_normalizer() (xgrammar.testing.GrammarFunctor static method) style (xgrammar.structural_tag.JSONSchemaFormat attribute)

T

tags (xgrammar.structural_tag.TagsWithSeparatorFormat attribute) (xgrammar.structural_tag.TriggeredTagsFormat attribute) tokenizer_info (xgrammar.CompiledGrammar property) TokenizerInfo (class in xgrammar) ToolChoiceOptionParam (in module xgrammar.openai_tool_call_schema) ToolParam (in module xgrammar.openai_tool_call_schema) traverse_draft_tree() (xgrammar.GrammarMatcher method) triggers (xgrammar.structural_tag.TriggeredTagsFormat attribute) type (xgrammar.openai_tool_call_schema.AllowedToolChoiceParam attribute) (xgrammar.openai_tool_call_schema.BuiltinToolChoiceParam attribute) (xgrammar.openai_tool_call_schema.BuiltinToolParam attribute) (xgrammar.openai_tool_call_schema.FunctionToolParam attribute) (xgrammar.openai_tool_call_schema.NamedToolChoiceParam attribute) (xgrammar.structural_tag.AnyTextFormat attribute) (xgrammar.structural_tag.ConstStringFormat attribute) (xgrammar.structural_tag.GrammarFormat attribute) (xgrammar.structural_tag.JSONSchemaFormat attribute) (xgrammar.structural_tag.OrFormat attribute) (xgrammar.structural_tag.QwenXMLParameterFormat attribute) (xgrammar.structural_tag.RegexFormat attribute) (xgrammar.structural_tag.SequenceFormat attribute) (xgrammar.structural_tag.TagFormat attribute) (xgrammar.structural_tag.TagsWithSeparatorFormat attribute) (xgrammar.structural_tag.TriggeredTagsFormat attribute) (xgrammar.StructuralTag attribute)

U

union() (xgrammar.Grammar static method)

V

value (xgrammar.structural_tag.ConstStringFormat attribute) vocab_size (xgrammar.TokenizerInfo property)

vocab_type (xgrammar.TokenizerInfo property) VocabType (class in xgrammar)

X

xgrammar.builtin_structural_tag module

xgrammar.testing module