SYMBOL INDEX (790 symbols across 59 files)

FILE: client/graphpaper-inline/src/clickoutside.ts
  function clickOutside (line 3) | function clickOutside(node: HTMLElement) {

FILE: client/graphpaper-inline/src/interfaces.ts
  type MetricDef (line 5) | interface MetricDef {
  type MetricVal (line 13) | type MetricVal = string | number | Array<number | string>;
  type FlatToken (line 15) | interface FlatToken {
  type TokenCallback (line 27) | type TokenCallback = (token: FlatToken) => string;
  type MediaNodeContext (line 29) | interface MediaNodeContext {
  type MediaType (line 34) | type MediaType = "audio" | "video" | "image";
  type MediaNode (line 36) | interface MediaNode {
  type MultimodalNode (line 43) | type MultimodalNode =

FILE: client/graphpaper-inline/src/longhover.ts
  function longhover (line 3) | function longhover(node: HTMLElement, duration: number) {

FILE: client/graphpaper-inline/src/stitch.ts
  type NodeAttr (line 6) | interface NodeAttr {
  type TextOutput (line 10) | interface TextOutput extends NodeAttr {
  type TokenOutput (line 19) | interface TokenOutput extends TextOutput {
  type Token (line 25) | interface Token {
  type Backtrack (line 32) | interface Backtrack extends NodeAttr {
  type ImageOutput (line 38) | interface ImageOutput extends NodeAttr {
  type AudioOutput (line 45) | interface AudioOutput extends NodeAttr {
  type VideoOutput (line 52) | interface VideoOutput extends NodeAttr {
  type RoleOpenerInput (line 59) | interface RoleOpenerInput extends NodeAttr {
  type RoleCloserInput (line 66) | interface RoleCloserInput extends NodeAttr {
  type GuidanceMessage (line 72) | interface GuidanceMessage {
  type TraceMessage (line 77) | interface TraceMessage extends GuidanceMessage {
  type ResetDisplayMessage (line 84) | interface ResetDisplayMessage extends GuidanceMessage {
  type ExecutionStartedMessage (line 88) | interface ExecutionStartedMessage extends GuidanceMessage {
  type ExecutionCompletedMessage (line 92) | interface ExecutionCompletedMessage extends GuidanceMessage {
  type ClientReadyMessage (line 97) | interface ClientReadyMessage extends GuidanceMessage {
  type ClientReadyAckMessage (line 101) | interface ClientReadyAckMessage extends GuidanceMessage {
  type OutputRequestMessage (line 105) | interface OutputRequestMessage extends GuidanceMessage {
  type OutputRequestAckMessage (line 110) | interface OutputRequestAckMessage extends GuidanceMessage {
  type MetricMessage (line 114) | interface MetricMessage extends GuidanceMessage {
  type StitchMessage (line 121) | interface StitchMessage {
  function isGuidanceMessage (line 126) | function isGuidanceMessage(o: GuidanceMessage | undefined | null): o is ...
  function isTraceMessage (line 131) | function isTraceMessage(o: GuidanceMessage | undefined | null): o is Tra...
  function isBacktrack (line 136) | function isBacktrack(o: NodeAttr | undefined | null): o is Backtrack {
  function isRoleOpenerInput (line 141) | function isRoleOpenerInput(o: NodeAttr | undefined | null): o is RoleOpe...
  function isRoleCloserInput (line 146) | function isRoleCloserInput(o: NodeAttr | undefined | null): o is RoleClo...
  function isTextOutput (line 151) | function isTextOutput(o: NodeAttr | undefined | null): o is TextOutput {
  function isTokenOutput (line 156) | function isTokenOutput(o: NodeAttr | undefined | null): o is TokenOutput {
  function isImageOutput (line 161) | function isImageOutput(o: NodeAttr | undefined | null): o is ImageOutput {
  function isAudioOutput (line 166) | function isAudioOutput(o: NodeAttr | undefined | null): o is AudioOutput {
  function isVideoOutput (line 171) | function isVideoOutput(o: NodeAttr | undefined | null): o is VideoOutput {
  function isResetDisplayMessage (line 176) | function isResetDisplayMessage(o: GuidanceMessage | undefined | null): o...
  function isMetricMessage (line 181) | function isMetricMessage(o: GuidanceMessage | undefined | null): o is Me...
  function isClientReadyAckMessage (line 186) | function isClientReadyAckMessage(o: GuidanceMessage | undefined | null):...
  function isOutputRequestAckMessage (line 191) | function isOutputRequestAckMessage(o: GuidanceMessage | undefined | null...
  function isExecutionCompletedMessage (line 196) | function isExecutionCompletedMessage(o: GuidanceMessage | undefined | nu...
  function isExecutionStartedMessage (line 201) | function isExecutionStartedMessage(o: GuidanceMessage | undefined | null...
  type Status (line 210) | enum Status {

FILE: docs/conf.py
  function setup (line 389) | def setup(app):
  function build_finished (line 395) | def build_finished(app, exception):

FILE: guidance/__init__.py
  class _Guidance (line 23) | class _Guidance(ModuleType):
    method __call__ (line 24) | def __call__(self, f=None, *, stateless=False, cache=None, dedent=True...

FILE: guidance/_ast.py
  function _parse_tags (line 40) | def _parse_tags(s: str) -> Union["GrammarNode", "Function"]:
  class Tagged (line 53) | class Tagged:
    method __str__ (line 54) | def __str__(self):
  class Match (line 66) | class Match:
    method __init__ (line 67) | def __init__(self, captures, log_probs, partial):
    method __getitem__ (line 72) | def __getitem__(self, key):
    method __len__ (line 75) | def __len__(self):
    method __bool__ (line 78) | def __bool__(self):
    method __str__ (line 81) | def __str__(self):
    method __repr__ (line 84) | def __repr__(self):
  class StatefulException (line 88) | class StatefulException(Exception):
  class Function (line 99) | class Function(Tagged):
    method __post_init__ (line 105) | def __post_init__(self):
    method __call__ (line 108) | def __call__(self, model):
    method __add__ (line 116) | def __add__(self, other):
    method __radd__ (line 131) | def __radd__(self, other):
  class ASTNode (line 150) | class ASTNode(ABC):
    method _run (line 152) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
    method simplify (line 155) | def simplify(self) -> "ASTNode":
  class RoleStart (line 160) | class RoleStart(ASTNode):
    method _run (line 163) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class RoleEnd (line 168) | class RoleEnd(ASTNode):
    method _run (line 171) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class ImageBlob (line 176) | class ImageBlob(ASTNode):
    method _run (line 179) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class ImageUrl (line 184) | class ImageUrl(ASTNode):
    method _run (line 187) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class AudioBlob (line 192) | class AudioBlob(ASTNode):
    method _run (line 195) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class GenAudio (line 199) | class GenAudio(ASTNode):
    method __init__ (line 200) | def __init__(self, kwargs: dict[str, Any]):
    method _run (line 203) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class GrammarNode (line 208) | class GrammarNode(Tagged, ASTNode):
    method is_null (line 210) | def is_null(self) -> bool:
    method is_allowed_in_lark_terminal (line 217) | def is_allowed_in_lark_terminal(self) -> bool:
    method is_allowed_in_lark_rule_with_attrs (line 225) | def is_allowed_in_lark_rule_with_attrs(self) -> bool:
    method simplify (line 233) | def simplify(self) -> "GrammarNode":
    method children (line 236) | def children(self) -> Sequence["GrammarNode"]:
    method __add__ (line 239) | def __add__(self, other) -> "GrammarNode":
    method __radd__ (line 257) | def __radd__(self, other) -> "GrammarNode":
    method __getitem__ (line 275) | def __getitem__(self, key):
    method match (line 278) | def match(
    method forced_prefix (line 307) | def forced_prefix(self) -> str:
    method ll_grammar (line 311) | def ll_grammar(self, enforce_max_tokens: bool = True) -> str:
  class LiteralNode (line 317) | class LiteralNode(GrammarNode):
    method is_null (line 321) | def is_null(self) -> bool:
    method _run (line 324) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class SpecialToken (line 329) | class SpecialToken(GrammarNode):
    method __post_init__ (line 334) | def __post_init__(self):
    method format (line 338) | def format(self) -> str:
    method is_allowed_in_lark_terminal (line 348) | def is_allowed_in_lark_terminal(self) -> bool:
    method is_allowed_in_lark_rule_with_attrs (line 352) | def is_allowed_in_lark_rule_with_attrs(self) -> bool:
    method _run (line 355) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class RegexNode (line 361) | class RegexNode(GrammarNode):
    method _run (line 364) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class SelectNode (line 369) | class SelectNode(GrammarNode):
    method is_null (line 373) | def is_null(self) -> bool:
    method simplify (line 376) | def simplify(self) -> "GrammarNode":
    method children (line 389) | def children(self) -> Sequence["GrammarNode"]:
    method _run (line 392) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class JoinNode (line 397) | class JoinNode(GrammarNode):
    method is_null (line 401) | def is_null(self) -> bool:
    method simplify (line 404) | def simplify(self) -> "GrammarNode":
    method children (line 412) | def children(self) -> Sequence["GrammarNode"]:
    method _run (line 415) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class RepeatNode (line 420) | class RepeatNode(GrammarNode):
    method is_null (line 426) | def is_null(self) -> bool:
    method __post_init__ (line 429) | def __post_init__(self):
    method children (line 435) | def children(self) -> Sequence["GrammarNode"]:
    method simplify (line 438) | def simplify(self) -> GrammarNode:
    method _run (line 441) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class SubstringNode (line 446) | class SubstringNode(GrammarNode):
    method is_allowed_in_lark_terminal (line 450) | def is_allowed_in_lark_terminal(self) -> bool:
    method _run (line 454) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class RuleNode (line 464) | class RuleNode(GrammarNode):
    method __post_init__ (line 476) | def __post_init__(self) -> None:
    method is_allowed_in_lark_terminal (line 489) | def is_allowed_in_lark_terminal(self) -> bool:
    method children (line 501) | def children(self) -> tuple[GrammarNode]:
    method _run (line 504) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class RuleRefNode (line 509) | class RuleRefNode(GrammarNode):
    method set_target (line 512) | def set_target(self, target: RuleNode) -> None:
    method is_allowed_in_lark_terminal (line 519) | def is_allowed_in_lark_terminal(self) -> bool:
    method _run (line 524) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class BaseSubgrammarNode (line 531) | class BaseSubgrammarNode(GrammarNode):
    method is_allowed_in_lark_terminal (line 533) | def is_allowed_in_lark_terminal(self) -> bool:
    method is_allowed_in_lark_rule_with_attrs (line 537) | def is_allowed_in_lark_rule_with_attrs(self) -> bool:
  class SubgrammarNode (line 544) | class SubgrammarNode(BaseSubgrammarNode):
    method _run (line 548) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class LLGJsonCompileOptions (line 552) | class LLGJsonCompileOptions(TypedDict):
  class JsonNode (line 568) | class JsonNode(BaseSubgrammarNode):
    method _run (line 572) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
    method _llguidance_json (line 576) | def _llguidance_json(self) -> dict[str, Any]:
    method _llguidance_validate (line 592) | def _llguidance_validate(self) -> None:
  class LarkNode (line 605) | class LarkNode(BaseSubgrammarNode):
    method _run (line 608) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class ToolCallNode (line 613) | class ToolCallNode(ASTNode):
    method from_tools (line 620) | def from_tools(
    method __post_init__ (line 645) | def __post_init__(self):
    method _run (line 649) | def _run(self, interpreter: "Interpreter[S]", **kwargs) -> Iterator[Ou...
  class LarkSerializer (line 653) | class LarkSerializer:
    method __init__ (line 654) | def __init__(self, enforce_max_tokens: bool = True):
    method serialize (line 659) | def serialize(self, node: GrammarNode) -> str:
    method visit (line 682) | def visit(self, node: GrammarNode, top=False) -> str:
    method normalize_name (line 815) | def normalize_name(self, name: str, terminal: bool) -> str:
    method regex (line 825) | def regex(self, pattern: str) -> str:

FILE: guidance/_bg/__init__.py
  function _start_asyncio_loop (line 15) | def _start_asyncio_loop(loop: AbstractEventLoop):
  function _asyncio_background_thread (line 20) | def _asyncio_background_thread() -> tuple[threading.Thread, AbstractEven...
  class BackgroundAsync (line 27) | class BackgroundAsync:
    method __init__ (line 30) | def __init__(self):
    method _thread_and_loop (line 35) | def _thread_and_loop(self) -> tuple[threading.Thread, AbstractEventLoop]:
    method call_soon_threadsafe (line 41) | def call_soon_threadsafe(self, cb, *args, context=None):
    method run_async_coroutine (line 47) | def run_async_coroutine(self, coroutine: Coroutine[Any, Any, T]) -> Fu...
    method async_task (line 61) | async def async_task(coroutine: Coroutine[Any, Any, T]) -> Task[T]:
    method print_all_tasks (line 74) | async def print_all_tasks():  # pragma: no cover

FILE: guidance/_grammar.py
  function string (line 19) | def string(s: str) -> LiteralNode:
  function regex (line 23) | def regex(pattern: str) -> RegexNode:
  function gen (line 27) | def gen(
  function select (line 61) | def select(
  function repeat (line 117) | def repeat(value: str | int | float | GrammarNode, min: int, max: int | ...
  function token_limit (line 141) | def token_limit(value: GrammarNode, max_tokens: int) -> RuleNode:
  function with_temperature (line 156) | def with_temperature(value: GrammarNode, temperature: float) -> RuleNode:
  function capture (line 175) | def capture(value: GrammarNode, name: str, list_append: bool = False) ->...
  function subgrammar (line 182) | def subgrammar(
  function special_token (line 201) | def special_token(token: str) -> SpecialToken:
  function quote_regex (line 211) | def quote_regex(value: str) -> str:

FILE: guidance/_guidance.py
  function guidance (line 17) | def guidance(
  class GuidanceFunction (line 44) | class GuidanceFunction:
    method __init__ (line 45) | def __init__(
    method __call__ (line 65) | def __call__(self, *args, **kwargs):
    method __get__ (line 68) | def __get__(self, instance, owner=None, /):
    method __repr__ (line 76) | def __repr__(self):
  class GuidanceMethod (line 80) | class GuidanceMethod:
    method __init__ (line 83) | def __init__(self, impl, instance):
    method from_guidance_function (line 95) | def from_guidance_function(cls, guidance_function: GuidanceFunction, i...
    method __call__ (line 119) | def __call__(self, *args, **kwargs):
    method __repr__ (line 122) | def __repr__(self):
  function _decorator (line 129) | def _decorator(f, *, stateless, cache, model):

FILE: guidance/_guidance.pyi
  function guidance (line 30) | def guidance(
  function guidance (line 39) | def guidance(
  function guidance (line 48) | def guidance(
  function guidance (line 57) | def guidance(
  function guidance (line 66) | def guidance(
  function guidance (line 75) | def guidance(

FILE: guidance/_parser.py
  class TokenParserException (line 16) | class TokenParserException(Exception):
  class InvalidTokenException (line 20) | class InvalidTokenException(TokenParserException):
    method __init__ (line 21) | def __init__(self, token: int, valid_tokens: list[int]):
  class TokenParser (line 27) | class TokenParser:
    method __init__ (line 28) | def __init__(
    method is_accepting (line 49) | def is_accepting(self) -> bool:
    method done (line 52) | def done(self) -> bool:
    method advance (line 55) | def advance(
    method has_pending_stop (line 67) | def has_pending_stop(self) -> bool:
    method process_prompt (line 70) | def process_prompt(
    method compute_mask (line 113) | def compute_mask(self) -> tuple[bytes | None, LLInterpreterResponse, f...
    method _parse (line 119) | def _parse(
    method cleanup (line 171) | def cleanup(self):
  class ByteParserException (line 189) | class ByteParserException(Exception):
    method __init__ (line 190) | def __init__(self, *args, **kwargs):
  class ByteParser (line 197) | class ByteParser:
    method __init__ (line 198) | def __init__(
    method matched (line 215) | def matched(self) -> bool:
    method valid_next_bytes (line 220) | def valid_next_bytes(self) -> set[bytes]:
    method next_byte_mask (line 227) | def next_byte_mask(self) -> NDArray[np.uint8]:
    method _advance (line 233) | def _advance(self, token_id: int | None) -> None:
    method consume_bytes (line 264) | def consume_bytes(self, bts: bytes) -> None:
    method force_done (line 311) | def force_done(self):
    method get_captures (line 321) | def get_captures(self):
    method _update_capture (line 324) | def _update_capture(self, response: LegacyEngineCallResponse):

FILE: guidance/_schema.py
  class TokenUsage (line 9) | class TokenUsage(BaseModel):
    method output_tokens (line 48) | def output_tokens(self) -> NonNegativeInt:
    method token_savings (line 57) | def token_savings(self) -> Annotated[float, Ge(0), Le(1)] | None:
    method avg_latency_ms (line 67) | def avg_latency_ms(self) -> float:
    method __add__ (line 73) | def __add__(self, other: "TokenUsage") -> "TokenUsage":
  class EngineResponse (line 93) | class EngineResponse(BaseModel):
  class LegacyEngineCallResponse (line 103) | class LegacyEngineCallResponse(BaseModel):
  class GenToken (line 118) | class GenToken(BaseModel):
  class GenTokenExtra (line 130) | class GenTokenExtra(GenToken):
  class GenData (line 134) | class GenData(BaseModel):
    method valid_next_tokens (line 141) | def valid_next_tokens(self) -> list[int]:
  class LLProgressCapture (line 145) | class LLProgressCapture(BaseModel):
    method strip_list_append_prefix (line 153) | def strip_list_append_prefix(cls, values):
  class LLProgressText (line 162) | class LLProgressText(BaseModel):
  class LLProgressFinalText (line 170) | class LLProgressFinalText(BaseModel):
  class LLProgress (line 181) | class LLProgress(RootModel):
    method to_engine_call_response (line 184) | def to_engine_call_response(self) -> LegacyEngineCallResponse:
  class LLInterpreterResponse (line 227) | class LLInterpreterResponse(BaseModel):
  class SamplingParams (line 233) | class SamplingParams(TypedDict):
  class StepContext (line 240) | class StepContext(TypedDict):
  class StepFeedback (line 249) | class StepFeedback(TypedDict, total=False):
  class StepConfig (line 255) | class StepConfig(TypedDict, total=False):

FILE: guidance/_tools.py
  class GrammarFormat (line 14) | class GrammarFormat(BaseModel):
  class CustomTool (line 24) | class CustomTool(BaseModel):
  class FunctionTool (line 29) | class FunctionTool(BaseModel):
    method from_callable (line 34) | def from_callable(cls, callable: Callable) -> "FunctionTool":
    method get_schema (line 56) | def get_schema(self) -> dict[str, Any]:
    method serialize_parameters (line 65) | def serialize_parameters(self, parameters: builtins.type[BaseModel] | ...
  class Tool (line 77) | class Tool(BaseModel):
    method call (line 84) | def call(self, *args, **kwargs) -> Any:
    method from_callable (line 96) | def from_callable(
    method from_regex (line 117) | def from_regex(
    method from_lark (line 138) | def from_lark(
    method from_grammar (line 159) | def from_grammar(
    method to_openai_style (line 176) | def to_openai_style(self) -> dict[str, Any]:
    method with_name (line 205) | def with_name(self, name: str) -> "Tool":

FILE: guidance/_utils.py
  function bytes_from (line 26) | def bytes_from(src: str | pathlib.Path | bytes, allow_local: bool) -> by...
  class _Rewrite (line 47) | class _Rewrite(ast.NodeTransformer):
    method __init__ (line 48) | def __init__(self, source_lines):
    method visit_JoinedStr (line 52) | def visit_JoinedStr(self, node):
    method visit_Constant (line 58) | def visit_Constant(self, node):
    method _dedent_constant (line 63) | def _dedent_constant(self, node, lineno):
  class normalize_notebook_stdout_stderr (line 78) | class normalize_notebook_stdout_stderr:
    method __enter__ (line 84) | def __enter__(self):
    method __exit__ (line 97) | def __exit__(self, exc_type, exc_value, traceback):
  function strip_multiline_string_indents (line 104) | def strip_multiline_string_indents(f):
  function make_weak_bound_method (line 155) | def make_weak_bound_method(f, instance):
  function signature_pop (line 172) | def signature_pop(signature, index):
  class JupyterComm (line 178) | class JupyterComm:
    method __init__ (line 179) | def __init__(self, target_id, ipython_handle, callback=None, on_open=N...
    method clear_send_queue (line 214) | def clear_send_queue(self):
    method _fire_callback (line 219) | def _fire_callback(self, msg):
    method send (line 222) | def send(self, data):
    method _send_loop (line 225) | async def _send_loop(self):
  function is_interactive (line 247) | def is_interactive():
  function log_softmax (line 253) | def log_softmax(array: np.ndarray, axis: int = -1) -> np.ndarray:
  function softmax (line 269) | def softmax(array: np.ndarray, axis: int = -1) -> np.ndarray:
  function pydantic_no_default_repr (line 276) | def pydantic_no_default_repr(obj: pydantic.BaseModel, target_fields=None):
  function pydantic_no_default_str (line 293) | def pydantic_no_default_str(obj: pydantic.BaseModel, target_fields=None):
  function log_init (line 310) | def log_init(s: str):
  function log_copy (line 315) | def log_copy(s: str):
  function log_cleanup (line 320) | def log_cleanup(s: str):
  function to_utf8_or_bytes_string (line 325) | def to_utf8_or_bytes_string(_bytes: bytes) -> str:
  function apply_repetition_penalty (line 347) | def apply_repetition_penalty(input_ids: list[int], logits: np.ndarray, s...
  function apply_top_k_only (line 373) | def apply_top_k_only(logits: np.ndarray, k: int) -> np.ndarray:
  function apply_min_p_filter (line 382) | def apply_min_p_filter(logits: np.ndarray, sampling_params: Optional["Sa...
  function apply_top_k_and_top_p_filter (line 399) | def apply_top_k_and_top_p_filter(logits: np.ndarray, sampling_params: Op...

FILE: guidance/chat.py
  class ChatTemplate (line 5) | class ChatTemplate:
    method get_role_start (line 8) | def get_role_start(self, role_name: str, **kwargs):
    method get_role_end (line 11) | def get_role_end(self, role_name: str | None = None):
  class ChatTemplateCache (line 15) | class ChatTemplateCache:
    method __init__ (line 16) | def __init__(self) -> None:
    method __getitem__ (line 19) | def __getitem__(self, key: str) -> ChatTemplate:
    method __setitem__ (line 23) | def __setitem__(self, key: str, value):
    method __contains__ (line 27) | def __contains__(self, key: str):
  class UnsupportedRoleException (line 37) | class UnsupportedRoleException(Exception):
    method __init__ (line 38) | def __init__(self, role_name, instance):
    method _format_message (line 43) | def _format_message(self):
  function load_template_class (line 47) | def load_template_class(chat_template=None):
  function _template_class_from_string (line 83) | def _template_class_from_string(template_str):
  class ChatMLTemplate (line 98) | class ChatMLTemplate(ChatTemplate):
    method get_role_start (line 101) | def get_role_start(self, role_name):
    method get_role_end (line 104) | def get_role_end(self, role_name=None):  # noqa ARG002
  class Llama2ChatTemplate (line 118) | class Llama2ChatTemplate(ChatTemplate):
    method get_role_start (line 122) | def get_role_start(self, role_name):
    method get_role_end (line 132) | def get_role_end(self, role_name=None):
  class Llama3ChatTemplate (line 153) | class Llama3ChatTemplate(ChatTemplate):
    method get_role_start (line 157) | def get_role_start(self, role_name):
    method get_role_end (line 167) | def get_role_end(self, role_name=None):  # noqa ARG002
  class Phi3MiniChatTemplate (line 181) | class Phi3MiniChatTemplate(ChatTemplate):
    method get_role_start (line 185) | def get_role_start(self, role_name):
    method get_role_end (line 195) | def get_role_end(self, role_name=None):  # noqa ARG002
  class Phi3SmallMediumChatTemplate (line 211) | class Phi3SmallMediumChatTemplate(ChatTemplate):
    method get_role_start (line 215) | def get_role_start(self, role_name):
    method get_role_end (line 223) | def get_role_end(self, role_name=None):  # noqa ARG002
  class Phi4MiniChatTemplate (line 238) | class Phi4MiniChatTemplate(ChatTemplate):
    method get_role_start (line 242) | def get_role_start(self, role_name):
    method get_role_end (line 245) | def get_role_end(self, role_name=None):  # noqa ARG002
  class Mistral7BInstructChatTemplate (line 259) | class Mistral7BInstructChatTemplate(ChatTemplate):
    method get_role_start (line 263) | def get_role_start(self, role_name):
    method get_role_end (line 273) | def get_role_end(self, role_name=None):
  class Gemma29BInstructChatTemplate (line 292) | class Gemma29BInstructChatTemplate(ChatTemplate):
    method get_role_start (line 296) | def get_role_start(self, role_name):
    method get_role_end (line 306) | def get_role_end(self, role_name=None):
  class Qwen2dot5ChatTemplate (line 327) | class Qwen2dot5ChatTemplate(ChatTemplate):
    method get_role_start (line 331) | def get_role_start(self, role_name):
    method get_role_end (line 337) | def get_role_end(self, role_name=None):  # noqa ARG002
  class Qwen3ChatTemplate (line 354) | class Qwen3ChatTemplate(ChatTemplate):
    method get_role_start (line 358) | def get_role_start(self, role_name):
    method get_role_end (line 364) | def get_role_end(self, role_name=None):  # noqa ARG002
  class Llama3dot2ChatTemplate (line 381) | class Llama3dot2ChatTemplate(ChatTemplate):
    method get_role_start (line 385) | def get_role_start(self, role_name):
    method get_role_end (line 396) | def get_role_end(self, role_name=None):  # noqa ARG002

FILE: guidance/debug.py
  function enable_widget_debug (line 11) | def enable_widget_debug() -> None:
  function dump_widget_debug (line 36) | def dump_widget_debug() -> str | None:
  function clear_widget_debug (line 64) | def clear_widget_debug() -> None:
  function widget_debug_info (line 90) | def widget_debug_info() -> None:

FILE: guidance/library/_audio.py
  function audio (line 10) | def audio(lm, src: str | pathlib.Path | bytes, allow_local: bool = True):
  function gen_audio (line 18) | def gen_audio(lm, **kwargs):

FILE: guidance/library/_block.py
  class Block (line 8) | class Block:
    method __init__ (line 9) | def __init__(self, name: str | None, opener: str | Function | ASTNode,...
  function block (line 16) | def block(name=None, opener=None, closer=None):

FILE: guidance/library/_capture.py
  function capture (line 8) | def capture(lm, value, name):

FILE: guidance/library/_ebnf.py
  function lark (line 7) | def lark(
  function gbnf_to_lark (line 31) | def gbnf_to_lark(gbnf_grammar: str) -> str:

FILE: guidance/library/_gen.py
  function gen (line 13) | def gen(
  function regex (line 155) | def regex(lm, pattern, *, name=None):

FILE: guidance/library/_image.py
  function image (line 13) | def image(lm, src: str | pathlib.Path | bytes, allow_local: bool = True):
  function gen_image (line 24) | def gen_image(lm):

FILE: guidance/library/_json.py
  function json (line 13) | def json(

FILE: guidance/library/_optional.py
  function optional (line 6) | def optional(lm, value):

FILE: guidance/library/_pydantic.py
  class GenerateJsonSchemaSafe (line 7) | class GenerateJsonSchemaSafe(pydantic.json_schema.GenerateJsonSchema):
    method generate_inner (line 18) | def generate_inner(self, schema):
  function pydantic_to_json_schema (line 26) | def pydantic_to_json_schema(schema: Union[type["pydantic.BaseModel"], "p...

FILE: guidance/library/_role.py
  function role (line 8) | def role(role: str) -> AbstractContextManager:
  function system (line 16) | def system() -> AbstractContextManager:
  function user (line 32) | def user() -> AbstractContextManager:
  function assistant (line 48) | def assistant() -> AbstractContextManager:

FILE: guidance/library/_sequences.py
  function exactly_n_repeats (line 6) | def exactly_n_repeats(model, value, n_repeats: int):
  function at_most_n_repeats (line 11) | def at_most_n_repeats(model, value, n_repeats: int):
  function sequence (line 16) | def sequence(model, value, min_length: int = 0, max_length: int | None =...
  function one_or_more (line 22) | def one_or_more(model, value):
  function zero_or_more (line 27) | def zero_or_more(model, value):

FILE: guidance/library/_subgrammar.py
  function as_regular_grammar (line 7) | def as_regular_grammar(node: GrammarNode, lexeme=False):
  function lexeme (line 17) | def lexeme(body_regex: str, json_string: bool = False):

FILE: guidance/library/_substring.py
  function chunk_on_word (line 7) | def chunk_on_word(text: str) -> list[str]:
  function substring (line 11) | def substring(

FILE: guidance/library/_video.py
  function video (line 13) | def video(lm, src: str | pathlib.Path | bytes, allow_local: bool = True):
  function gen_video (line 23) | def gen_video(lm):

FILE: guidance/metrics/_metrics.py
  class PeriodicMetricsGenerator (line 19) | class PeriodicMetricsGenerator:
    method __init__ (line 20) | def __init__(self, monitor: "Monitor", sleep_sec=0.5):
    method start (line 27) | def start(self):
    method stop (line 33) | def stop(self):
    method pause (line 38) | def pause(self):
    method resume (line 46) | def resume(self):
    method _emit (line 54) | async def _emit(self):
  class MonitoringMetric (line 100) | class MonitoringMetric(str, Enum):
  class Monitor (line 108) | class Monitor:
    method __init__ (line 111) | def __init__(self, interval_ms: int = 1000, **kwargs):
    method _monitor_fn (line 126) | async def _monitor_fn(self):
    method start (line 181) | def start(self):
    method stop (line 189) | def stop(self):
    method reset (line 198) | def reset(self):
    method get_metrics (line 203) | def get_metrics(
    method get_metric (line 217) | def get_metric(self, metric: MonitoringMetric) -> Any:
  function emit_usage (line 221) | def emit_usage(usage: TokenUsage) -> None:

FILE: guidance/models/_azureai.py
  class AzureOpenAIInterpreter (line 30) | class AzureOpenAIInterpreter(OpenAIRuleMixin, OpenAIJSONMixin, OpenAIReg...
    method __init__ (line 33) | def __init__(
  class AzureOpenAIAudioInterpreter (line 64) | class AzureOpenAIAudioInterpreter(OpenAIAudioMixin, AzureOpenAIInterpret...
  class AzureOpenAIImageInterpreter (line 70) | class AzureOpenAIImageInterpreter(OpenAIImageMixin, AzureOpenAIInterpret...
  function create_azure_openai_model (line 76) | def create_azure_openai_model(
  class AzureAIClientWrapper (line 158) | class AzureAIClientWrapper(BaseOpenAIClientWrapper):
    method __init__ (line 159) | def __init__(self, client: "azure.ai.inference.ChatCompletionsClient"):
    method streaming_chat_completions (line 162) | def streaming_chat_completions(
  class AzureInferenceInterpreter (line 188) | class AzureInferenceInterpreter(OpenAIRuleMixin, OpenAIJSONMixin, OpenAI...
    method __init__ (line 189) | def __init__(
    method json (line 209) | def json(self, node: JsonNode, **kwargs) -> Iterator[OutputAttr]:
  function create_azure_aifoundry_model (line 220) | def create_azure_aifoundry_model(

FILE: guidance/models/_base/_interpreter.py
  class Interpreter (line 32) | class Interpreter(Generic[S]):
    method __init__ (line 33) | def __init__(self, state: S):
    method run (line 36) | def run(self, node: ASTNode, **kwargs) -> Iterator[OutputAttr]:
    method _role_start (line 39) | def _role_start(self, node: RoleStart, **kwargs) -> Iterator[OutputAttr]:
    method role_start (line 44) | def role_start(self, node: RoleStart, **kwargs) -> Iterator[OutputAttr...
    method _role_end (line 47) | def _role_end(self, node: RoleEnd, **kwargs) -> Iterator[OutputAttr]:
    method role_end (line 54) | def role_end(self, node: RoleEnd, **kwargs) -> Iterator[OutputAttr]:  ...
    method text (line 57) | def text(self, node: LiteralNode, **kwargs) -> Iterator[OutputAttr]:  ...
    method image_blob (line 60) | def image_blob(self, node: ImageBlob, **kwargs) -> Iterator[OutputAttr...
    method image_url (line 63) | def image_url(self, node: ImageUrl, **kwargs) -> Iterator[OutputAttr]:
    method grammar (line 67) | def grammar(self, node: GrammarNode, **kwargs) -> Iterator[OutputAttr]...
    method regex (line 70) | def regex(self, node: RegexNode, **kwargs) -> Iterator[OutputAttr]:
    method select (line 73) | def select(self, node: SelectNode, **kwargs) -> Iterator[OutputAttr]:
    method join (line 76) | def join(self, node: JoinNode, **kwargs) -> Iterator[OutputAttr]:
    method repeat (line 79) | def repeat(self, node: RepeatNode, **kwargs) -> Iterator[OutputAttr]:
    method substring (line 82) | def substring(self, node: SubstringNode, **kwargs) -> Iterator[OutputA...
    method rule (line 85) | def rule(self, node: RuleNode, **kwargs) -> Iterator[OutputAttr]:
    method subgrammar (line 88) | def subgrammar(self, node: SubgrammarNode, **kwargs) -> Iterator[Outpu...
    method json (line 91) | def json(self, node: JsonNode, **kwargs) -> Iterator[OutputAttr]:
    method lark (line 94) | def lark(self, node: LarkNode, **kwargs) -> Iterator[OutputAttr]:
    method audio_blob (line 97) | def audio_blob(self, node: AudioBlob, **kwargs) -> Iterator[OutputAttr...
    method gen_audio (line 100) | def gen_audio(self, node: GenAudio, **kwargs) -> Iterator[OutputAttr]:...
    method tool_call (line 103) | def tool_call(self, node: ToolCallNode, **kwargs) -> Iterator[OutputAt...
  class UnsupportedNodeError (line 107) | class UnsupportedNodeError(ValueError):
    method __init__ (line 108) | def __init__(self, interpreter: Interpreter, node: ASTNode):

FILE: guidance/models/_base/_model.py
  function _gen_id (line 45) | def _gen_id():
  class Model (line 58) | class Model:
    method __init__ (line 59) | def __init__(
    method _update_trace_node (line 81) | def _update_trace_node(
    method __add__ (line 100) | def __add__(self, other: str | Function | ASTNode) -> Self:
    method _apply_node (line 115) | def _apply_node(self, node: ASTNode) -> Self:
    method _send_to_event_queue (line 152) | def _send_to_event_queue(self) -> None:
    method stream (line 157) | def stream(self) -> "ModelStream":
    method _apply_blocks (line 161) | def _apply_blocks(self) -> Self:
    method _update_open_block_captures (line 192) | def _update_open_block_captures(self) -> Self:
    method copy (line 199) | def copy(self) -> Self:
    method __str__ (line 212) | def __str__(self) -> str:
    method __len__ (line 215) | def __len__(self):
    method __setitem__ (line 218) | def __setitem__(self, key, value):
    method __getitem__ (line 223) | def __getitem__(self, key: str) -> Any:
    method __contains__ (line 233) | def __contains__(self, key: str) -> bool:
    method get (line 236) | def get(self, key: str, default: D | None = None) -> str | list[str] |...
    method set (line 251) | def set(self, key: str, value: str | list[str]) -> Self:
    method remove (line 268) | def remove(self, key: str) -> Self:
    method log_prob (line 280) | def log_prob(self, key: str, default: D | None = None) -> float | list...
    method with_sampling_params (line 299) | def with_sampling_params(self, sampling_params: SamplingParams) -> Self:
    method with_step_config (line 305) | def with_step_config(self, step_config: StepConfig) -> Self:
    method __getattribute__ (line 315) | def __getattribute__(self, name):
    method _get_usage (line 321) | def _get_usage(self) -> TokenUsage:
    method _reset_usage (line 326) | def _reset_usage(self) -> None:
  class ModelStream (line 330) | class ModelStream:
    method __init__ (line 331) | def __init__(
    method __add__ (line 345) | def __add__(self, grammar: str | ASTNode) -> Self:
    method _inner_run (line 352) | def _inner_run(self, model):
    method __iter__ (line 361) | def __iter__(self) -> Iterator[Model]:

FILE: guidance/models/_base/_state.py
  class CaptureVar (line 9) | class CaptureVar(TypedDict):
  class State (line 14) | class State(ABC):
    method __init__ (line 15) | def __init__(self, token_usage: TokenUsage | None = None) -> None:
    method add_usage (line 20) | def add_usage(self, usage: TokenUsage) -> None:
    method get_usage (line 26) | def get_usage(self) -> TokenUsage:
    method reset_usage (line 30) | def reset_usage(self) -> None:
    method __str__ (line 35) | def __str__(self) -> str:
    method apply_capture (line 38) | def apply_capture(

FILE: guidance/models/_byte_tokenizer.py
  class ByteTokenizer (line 7) | class ByteTokenizer(Tokenizer):
    method __init__ (line 8) | def __init__(self, chat_template=None):
    method encode (line 28) | def encode(self, byte_string: bytes, *, parse_special: bool = True) ->...

FILE: guidance/models/_engine/_engine.py
  class LogitsOutput (line 32) | class LogitsOutput(TypedDict):
  class Engine (line 38) | class Engine(ABC):
    method __init__ (line 47) | def __init__(
    method enable_backtrack (line 78) | def enable_backtrack(self):
    method enable_ff_tokens (line 82) | def enable_ff_tokens(self):
    method enable_monitoring (line 86) | def enable_monitoring(self):
    method get_chat_template (line 89) | def get_chat_template(
    method __call__ (line 94) | def __call__(
    method get_next_token_with_top_k (line 542) | def get_next_token_with_top_k(
    method chat_completion_streaming (line 659) | def chat_completion_streaming(
    method chat_completion (line 691) | def chat_completion(
    method get_logits (line 710) | def get_logits(self, token_ids: list[int], include_all_uncached_tokens...
  function get_top_k (line 723) | def get_top_k(_probs: NDArray, _k: int = 5) -> list[int]:
  function apply_temp_and_sampling_params (line 732) | def apply_temp_and_sampling_params(

FILE: guidance/models/_engine/_interpreter.py
  class EngineInterpreter (line 16) | class EngineInterpreter(Interpreter[EngineState]):
    method __init__ (line 17) | def __init__(self, engine: Engine):
    method __deepcopy__ (line 23) | def __deepcopy__(self, memo):
    method get_role_start (line 36) | def get_role_start(self, role: str) -> str:
    method get_role_end (line 41) | def get_role_end(self, role: str) -> str:
    method role_start (line 46) | def role_start(self, node: RoleStart, **kwargs) -> Iterator[OutputAttr]:
    method role_end (line 54) | def role_end(self, node: RoleEnd, **kwargs) -> Iterator[OutputAttr]:
    method text (line 62) | def text(self, node: LiteralNode, **kwargs) -> Iterator[OutputAttr]:
    method grammar (line 65) | def grammar(self, node: GrammarNode, **kwargs) -> Iterator[OutputAttr]:
    method tool_call (line 154) | def tool_call(self, node: ToolCallNode, **kwargs) -> Iterator[OutputAt...
  class Llama3VisionInterpreter (line 158) | class Llama3VisionInterpreter(EngineInterpreter):
    method image_blob (line 159) | def image_blob(self, node: ImageBlob, **kwargs) -> Iterator[OutputAttr]:
  class Phi3VisionInterpreter (line 175) | class Phi3VisionInterpreter(EngineInterpreter):
    method image_blob (line 176) | def image_blob(self, node: ImageBlob, **kwargs) -> Iterator[OutputAttr]:
  function partial_decode (line 197) | def partial_decode(data: bytes) -> tuple[str, bytes]:
  function recode_special_tokens (line 209) | def recode_special_tokens(tokenizer: Tokenizer, data: bytes) -> bytes:
  function text_to_grammar (line 214) | def text_to_grammar(tokenizer: Tokenizer, text: str) -> GrammarNode:

FILE: guidance/models/_engine/_state.py
  class EngineState (line 7) | class EngineState(State):
    method __init__ (line 8) | def __init__(self) -> None:
    method __str__ (line 17) | def __str__(self) -> str:

FILE: guidance/models/_engine/_tokenizer.py
  class TokenizerWrappable (line 11) | class TokenizerWrappable:
    method __call__ (line 18) | def __call__(self, byte_string: bytes) -> list[int]:
    method as_ll_tokenizer (line 21) | def as_ll_tokenizer(self) -> "llguidance.LLTokenizer":
  class Tokenizer (line 26) | class Tokenizer:
    method __init__ (line 33) | def __init__(
    method is_special_token (line 45) | def is_special_token(self, token_id: int) -> bool:
    method bos_token_id (line 50) | def bos_token_id(self) -> int | None:
    method eos_token_id (line 56) | def eos_token_id(self) -> int:
    method bos_token (line 60) | def bos_token(self) -> bytes | None:
    method eos_token (line 66) | def eos_token(self) -> bytes:
    method chat_template (line 70) | def chat_template(self) -> Any | None:
    method __call__ (line 73) | def __call__(self, byte_string: bytes):
    method encode (line 76) | def encode(self, byte_string: bytes, *, parse_special: bool = True) ->...
    method decode (line 80) | def decode(self, tokens: Sequence[int]) -> bytes:
    method recode (line 84) | def recode(self, tokens: Sequence[int]) -> list[int]:

FILE: guidance/models/_llama_cpp.py
  function set_shutdown_flag (line 35) | def set_shutdown_flag():
  class _LlamaBatchContext (line 44) | class _LlamaBatchContext:
    method __init__ (line 45) | def __init__(self, n_batch, n_ctx):
    method __del__ (line 51) | def __del__(self):
  class LlamaCppTokenizer (line 61) | class LlamaCppTokenizer(Tokenizer):
    method __init__ (line 62) | def __init__(self, model_obj: "Llama", chat_template: str | ChatTempla...
  class LlamaCppEngine (line 78) | class LlamaCppEngine(Engine):
    method __init__ (line 81) | def __init__(
    method get_logits (line 153) | def get_logits(self, token_ids: list[int], include_all_uncached_tokens...
  class LlamaCpp (line 239) | class LlamaCpp(Model):
    method __init__ (line 240) | def __init__(

FILE: guidance/models/_mock.py
  class MockTokenizer (line 14) | class MockTokenizer(Tokenizer):
    method __init__ (line 15) | def __init__(self, tokens: Sequence[bytes], special_token_ids: list[in...
    method encode (line 34) | def encode(self, byte_string: bytes, *, parse_special: bool = True) ->...
    method recode (line 61) | def recode(self, tokens: Sequence[int]) -> list[int]:
  class MockEngine (line 66) | class MockEngine(Engine):
    method __init__ (line 67) | def __init__(self, tokenizer, byte_patterns, force):
    method get_next_token_with_top_k (line 94) | def get_next_token_with_top_k(
    method get_logits (line 117) | def get_logits(self, token_ids: list[int], include_all_uncached_tokens...
    method _get_next_tokens (line 150) | def _get_next_tokens(self, byte_string):
  class Mock (line 165) | class Mock(Model):
    method __init__ (line 166) | def __init__(
  class ByteTrie (line 192) | class ByteTrie:
    method __init__ (line 195) | def __init__(self, byte_strings=None, values=None, parent=None):
    method keys (line 212) | def keys(self):
    method has_child (line 215) | def has_child(self, byte):
    method child (line 218) | def child(self, byte):
    method parent (line 221) | def parent(self):
    method size (line 224) | def size(self):
    method __len__ (line 227) | def __len__(self):
    method insert (line 230) | def insert(self, s, value, pos=0):
    method compute_probs (line 240) | def compute_probs(self, probs):

FILE: guidance/models/_onnxruntime.py
  class OnnxRuntimeGenAIEngine (line 28) | class OnnxRuntimeGenAIEngine(Engine):
    method __init__ (line 31) | def __init__(
    method get_logits (line 90) | def get_logits(self, token_ids: list[int], include_all_uncached_tokens...
  class OnnxRuntimeGenAI (line 148) | class OnnxRuntimeGenAI(Model):
    method __init__ (line 149) | def __init__(

FILE: guidance/models/_openai.py
  class OpenAIInterpreter (line 15) | class OpenAIInterpreter(OpenAIRuleMixin, OpenAIJSONMixin, OpenAIRegexMix...
    method __init__ (line 16) | def __init__(
  class OpenAI (line 34) | class OpenAI(Model):
    method __init__ (line 35) | def __init__(

FILE: guidance/models/_openai_base.py
  function get_role_start (line 38) | def get_role_start(role: str) -> str:
  function get_role_end (line 43) | def get_role_end(role: str) -> str:
  class AssistantAudio (line 48) | class AssistantAudio(BaseModel):
  class AssistantAudioMessage (line 55) | class AssistantAudioMessage(BaseModel):
  class TextContent (line 60) | class TextContent(BaseModel):
  class InputAudio (line 65) | class InputAudio(BaseModel):
  class AudioContent (line 70) | class AudioContent(BaseModel):
  class ImageUrlContentInner (line 75) | class ImageUrlContentInner(BaseModel):
  class ImageUrlContent (line 79) | class ImageUrlContent(BaseModel):
  class ContentMessage (line 87) | class ContentMessage(BaseModel):
  class Function (line 92) | class Function(BaseModel):
  class Custom (line 97) | class Custom(BaseModel):
  class FunctionCall (line 102) | class FunctionCall(BaseModel):
  class CustomCall (line 108) | class CustomCall(BaseModel):
  class ToolCallMessage (line 117) | class ToolCallMessage(BaseModel):
  class ToolCallResult (line 122) | class ToolCallResult(BaseModel):
  class OpenAIState (line 131) | class OpenAIState(State):
    method __init__ (line 132) | def __init__(self) -> None:
    method apply_text (line 138) | def apply_text(self, text: str) -> None:
    method get_active_message (line 144) | def get_active_message(self) -> Message | None:
    method __str__ (line 168) | def __str__(self) -> str:
  class BaseOpenAIClientWrapper (line 215) | class BaseOpenAIClientWrapper(ABC):
    method streaming_chat_completions (line 217) | def streaming_chat_completions(
  class OpenAIClientWrapper (line 228) | class OpenAIClientWrapper(BaseOpenAIClientWrapper):
    method __init__ (line 229) | def __init__(self, client: "openai.OpenAI"):
    method streaming_chat_completions (line 232) | def streaming_chat_completions(
  class BaseOpenAIInterpreter (line 251) | class BaseOpenAIInterpreter(Interpreter[OpenAIState]):
    method __init__ (line 258) | def __init__(self, model: str, client: BaseOpenAIClientWrapper, *, rea...
    method run (line 268) | def run(self, node: ASTNode, **kwargs) -> Iterator[OutputAttr]:
    method role_start (line 273) | def role_start(self, node: RoleStart, **kwargs) -> Iterator[OutputAttr]:
    method role_end (line 281) | def role_end(self, node: RoleEnd, **kwargs) -> Iterator[OutputAttr]:
    method text (line 290) | def text(self, node: LiteralNode, **kwargs) -> Iterator[OutputAttr]:
    method _run (line 294) | def _run(self, tools: dict[str, Tool] | None = None, **kwargs) -> Iter...
    method _handle_stream (line 336) | def _handle_stream(
    method tool_call (line 537) | def tool_call(self, node: ToolCallNode, **kwargs) -> Iterator[OutputAt...
    method __deepcopy__ (line 545) | def __deepcopy__(self, memo):
  class OpenAIRuleMixin (line 559) | class OpenAIRuleMixin(BaseOpenAIInterpreter):
    method rule (line 560) | def rule(self, node: RuleNode, **kwargs) -> Iterator[OutputAttr]:
  class OpenAIRegexMixin (line 593) | class OpenAIRegexMixin(BaseOpenAIInterpreter):
    method regex (line 594) | def regex(self, node: RegexNode, **kwargs) -> Iterator[OutputAttr]:
  class OpenAIJSONMixin (line 601) | class OpenAIJSONMixin(BaseOpenAIInterpreter):
    method json (line 602) | def json(self, node: JsonNode, **kwargs) -> Iterator[OutputAttr]:
  class OpenAIImageMixin (line 620) | class OpenAIImageMixin(BaseOpenAIInterpreter):
    method image_blob (line 621) | def image_blob(self, node: ImageBlob, **kwargs) -> Iterator[OutputAttr]:
    method image_url (line 646) | def image_url(self, node: ImageUrl, **kwargs) -> Iterator[OutputAttr]:
  class OpenAIAudioMixin (line 652) | class OpenAIAudioMixin(BaseOpenAIInterpreter):
    method audio_blob (line 656) | def audio_blob(self, node: AudioBlob, **kwargs) -> Iterator[OutputAttr]:
    method gen_audio (line 669) | def gen_audio(self, node: GenAudio, **kwargs) -> Iterator[OutputAttr]:

FILE: guidance/models/_transformers.py
  class ByteDecoderError (line 49) | class ByteDecoderError(Exception):
  class ByteTokensError (line 53) | class ByteTokensError(Exception):
  class TransformersTokenizer (line 57) | class TransformersTokenizer(Tokenizer):
    method __init__ (line 58) | def __init__(
    method from_pretrained (line 95) | def from_pretrained(
    method recode (line 110) | def recode(self, tokens: list[int]) -> list[int]:
    method _byte_tokens (line 139) | def _byte_tokens(
    method _byte_tokens_from_byte_decoder (line 179) | def _byte_tokens_from_byte_decoder(
    method _byte_tokens_from_sp_model (line 194) | def _byte_tokens_from_sp_model(
    method _byte_tokens_by_encoding_token_strings (line 217) | def _byte_tokens_by_encoding_token_strings(
    method _fallback_byte_decoder (line 255) | def _fallback_byte_decoder(cls) -> dict[str, int]:
    method _check_byte_decoder (line 270) | def _check_byte_decoder(
    method _bytes_to_unicode (line 328) | def _bytes_to_unicode(cls):
  class TransformersEngine (line 345) | class TransformersEngine(Engine):
    method __init__ (line 346) | def __init__(
    method _model (line 433) | def _model(self, model, **kwargs) -> "PreTrainedModel":
    method get_logits (line 444) | def get_logits(self, token_ids: list[int], include_all_uncached_tokens...
  class Transformers (line 581) | class Transformers(Model):
    method __init__ (line 582) | def __init__(

FILE: guidance/models/broken_models/_vertexai.py
  class VertexAIEngine (line 14) | class VertexAIEngine(GrammarlessEngine):
    method __init__ (line 15) | def __init__(self, tokenizer, max_streaming_tokens, timeout, compute_l...
  class VertexAI (line 20) | class VertexAI(Grammarless):
    method __init__ (line 21) | def __init__(
  class VertexAICompletion (line 113) | class VertexAICompletion(VertexAI):
  class VertexAICompletionEngine (line 117) | class VertexAICompletionEngine(VertexAIEngine):
    method _generator (line 118) | def _generator(self, prompt, temperature):
  class VertexAIInstruct (line 139) | class VertexAIInstruct(VertexAI, Instruct):
    method get_role_start (line 140) | def get_role_start(self, name):
    method get_role_end (line 143) | def get_role_end(self, name):
  class VertexAIInstructEngine (line 150) | class VertexAIInstructEngine(VertexAIEngine):
    method _generator (line 151) | def _generator(self, prompt, temperature):
  class VertexAIChat (line 169) | class VertexAIChat(VertexAI, Chat):
  class VertexAIChatEngine (line 173) | class VertexAIChatEngine(VertexAIEngine):
    method _generator (line 174) | def _generator(self, prompt, temperature):
    method _start_generator (line 247) | def _start_generator(self, system_text, messages, temperature):

FILE: guidance/models/experimental/_litellm.py
  class LiteLLMOpenAIClientWrapper (line 15) | class LiteLLMOpenAIClientWrapper(BaseOpenAIClientWrapper):
    method __init__ (line 16) | def __init__(self, router):
    method _wrapped_completion (line 20) | def _wrapped_completion(
    method streaming_chat_completions (line 46) | def streaming_chat_completions(
  class LiteLLMInterpreter (line 62) | class LiteLLMInterpreter(BaseOpenAIInterpreter):
    method __init__ (line 75) | def __init__(self, model_description: dict, **kwargs):
    method _check_model (line 95) | def _check_model(self, model_desc: dict) -> str:
    method rule (line 107) | def rule(self, node: RuleNode, **kwargs) -> Iterator[OutputAttr]:
    method regex (line 147) | def regex(self, node: RegexNode, **kwargs) -> Iterator[OutputAttr]:
    method _regex_vllm (line 158) | def _regex_vllm(self, node: RegexNode, **kwargs):
    method json (line 171) | def json(self, node: JsonNode, **kwargs) -> Iterator[OutputAttr]:
    method grammar (line 202) | def grammar(self, node: GrammarNode, **kwargs) -> Iterator[OutputAttr]:
    method _grammar_vllm (line 209) | def _grammar_vllm(self, node: GrammarNode, **kwargs) -> Iterator[Outpu...
    method _process_kwargs (line 242) | def _process_kwargs(self, **kwargs):
  class LiteLLM (line 265) | class LiteLLM(Model):
    method __init__ (line 266) | def __init__(

FILE: guidance/models/experimental/_sglang.py
  class SglangInterpreter (line 11) | class SglangInterpreter(BaseOpenAIInterpreter):
    method __init__ (line 12) | def __init__(
    method rule (line 29) | def rule(self, node: RuleNode, **kwargs) -> Iterator[OutputAttr]:
    method regex (line 64) | def regex(self, node: RegexNode, **kwargs) -> Iterator[OutputAttr]:
    method json (line 78) | def json(self, node: JsonNode, **kwargs) -> Iterator[OutputAttr]:
    method grammar (line 99) | def grammar(self, node: GrammarNode, **kwargs) -> Iterator[OutputAttr]:
    method _process_kwargs (line 131) | def _process_kwargs(self, **kwargs):
  class SglangModel (line 158) | class SglangModel(Model):
    method __init__ (line 159) | def __init__(self, model: str, sampling_params: SamplingParams | None ...

FILE: guidance/models/experimental/_vllm.py
  class VLLMInterpreter (line 11) | class VLLMInterpreter(BaseOpenAIInterpreter):
    method __init__ (line 12) | def __init__(
    method grammar (line 29) | def grammar(self, node: GrammarNode, **kwargs) -> Iterator[OutputAttr]:
    method _process_kwargs (line 70) | def _process_kwargs(self, **kwargs):
  class VLLMModel (line 96) | class VLLMModel(Model):
    method __init__ (line 97) | def __init__(self, model: str, sampling_params: SamplingParams | None ...

FILE: guidance/registry/_registry.py
  function get_monitor (line 27) | def get_monitor() -> Monitor:
  function get_bg_async (line 41) | def get_bg_async() -> BackgroundAsync:
  function get_exchange (line 51) | def get_exchange() -> TopicExchange:
  function get_trace_handler (line 61) | def get_trace_handler() -> TraceHandler:
  function get_renderer (line 71) | def get_renderer() -> Renderer:
  function set_renderer (line 82) | def set_renderer(renderer: Renderer) -> None:

FILE: guidance/trace/_trace.py
  class NodeAttr (line 15) | class NodeAttr(BaseModel):
    method __init_subclass__ (line 20) | def __init_subclass__(cls, **kwargs):
    method class_name (line 26) | def class_name(self) -> str:
    method validate_class_name (line 31) | def validate_class_name(cls, data):
    method as_discriminated_union (line 38) | def as_discriminated_union(cls) -> type["NodeAttr"]:
    method __repr__ (line 46) | def __repr__(self):
    method __str__ (line 49) | def __str__(self):
  class InputAttr (line 53) | class InputAttr(NodeAttr):
  class OutputAttr (line 59) | class OutputAttr(NodeAttr):
  class StatelessGuidanceInput (line 65) | class StatelessGuidanceInput(InputAttr):
    method __repr__ (line 71) | def __repr__(self):
  class StatefulGuidanceInput (line 75) | class StatefulGuidanceInput(InputAttr):
    method __repr__ (line 81) | def __repr__(self):
  class LiteralInput (line 85) | class LiteralInput(InputAttr):
  class ImageInput (line 91) | class ImageInput(InputAttr):
  class AudioInput (line 98) | class AudioInput(InputAttr):
  class VideoInput (line 105) | class VideoInput(InputAttr):
  class EmbeddedInput (line 112) | class EmbeddedInput(InputAttr):
  class RoleOpenerInput (line 118) | class RoleOpenerInput(InputAttr):
  class RoleCloserInput (line 129) | class RoleCloserInput(InputAttr):
  class AudioOutput (line 139) | class AudioOutput(OutputAttr):
  class VideoOutput (line 147) | class VideoOutput(OutputAttr):
  class ImageOutput (line 155) | class ImageOutput(OutputAttr):
  class TextOutput (line 163) | class TextOutput(OutputAttr):
    method __str__ (line 172) | def __str__(self):
  class Token (line 176) | class Token(BaseModel):
  class TokenOutput (line 183) | class TokenOutput(TextOutput):
  class Backtrack (line 188) | class Backtrack(OutputAttr):
  class CaptureOutput (line 193) | class CaptureOutput(OutputAttr):
    method __str__ (line 204) | def __str__(self):
  class WeakRefList (line 208) | class WeakRefList(list):
    method append (line 214) | def append(self, item):
    method __getitem__ (line 217) | def __getitem__(self, index):
    method __iter__ (line 224) | def __iter__(self):
    method remove (line 227) | def remove(self, item):
  function _cleanup (line 238) | def _cleanup(log_msg: str):
  class TraceNode (line 242) | class TraceNode(BaseModel):
    method __init__ (line 251) | def __init__(self, **kwargs):
    method add_child (line 255) | def add_child(self, child: "TraceNode") -> None:
    method remove_child (line 264) | def remove_child(self, child: "TraceNode") -> None:
    method ancestors (line 273) | def ancestors(self) -> Generator["TraceNode", None, None]:
    method path (line 284) | def path(self) -> Generator["TraceNode", None, None]:
    method root (line 293) | def root(self) -> "TraceNode":
    method traverse (line 305) | def traverse(self, bfs: bool = True):
    method __repr__ (line 325) | def __repr__(self):
    method __hash__ (line 328) | def __hash__(self):
  class TraceHandler (line 332) | class TraceHandler(BaseModel):
    method __init__ (line 347) | def __init__(self, **kwargs):
    method __getitem__ (line 351) | def __getitem__(self, item):
    method __hash__ (line 354) | def __hash__(self):
    method update_node (line 357) | def update_node(self, identifier: int, parent_id: int | None, node_att...
    method root (line 397) | def root(self) -> TraceNode:

FILE: guidance/visual/_environment.py
  class EnvFlags (line 14) | class EnvFlags(BaseModel):
  class Environment (line 21) | class Environment:
    method __init__ (line 24) | def __init__(self):
    method detected_envs (line 42) | def detected_envs(self) -> list[str]:
    method is_notebook (line 50) | def is_notebook(self) -> bool:
    method is_cloud (line 58) | def is_cloud(self) -> bool:
    method is_terminal (line 66) | def is_terminal(self) -> bool:
  function _detect_vscode (line 75) | def _detect_vscode(flags: EnvFlags) -> bool:
  function _detect_ipython (line 89) | def _detect_ipython(flags: EnvFlags) -> bool:
  function _detect_ipython_zmq (line 110) | def _detect_ipython_zmq(flags: EnvFlags) -> bool:

FILE: guidance/visual/_exchange.py
  class TopicExchange (line 16) | class TopicExchange:
    method __init__ (line 23) | def __init__(self):
    method subscribe (line 27) | def subscribe(self, callback: Callable[[GuidanceMessage], None], topic...
    method unsubscribe (line 38) | def unsubscribe(self, callback: Callable[[GuidanceMessage], None], top...
    method publish (line 56) | def publish(self, message: GuidanceMessage, topic: str = DEFAULT_TOPIC):

FILE: guidance/visual/_jupyter.py
  function ipy_handle_event_once (line 17) | def ipy_handle_event_once(cb: IPythonCallback, event_name: str) -> tuple...

FILE: guidance/visual/_message.py
  class GuidanceMessage (line 14) | class GuidanceMessage(BaseModel):
    method __init_subclass__ (line 21) | def __init_subclass__(cls, **kwargs):
    method class_name (line 27) | def class_name(self) -> str:
    method validate_class_name (line 32) | def validate_class_name(cls, data):
    method as_discriminated_union (line 39) | def as_discriminated_union(cls) -> type["GuidanceMessage"]:
  class TraceMessage (line 48) | class TraceMessage(GuidanceMessage):
  class MetricMessage (line 56) | class MetricMessage(GuidanceMessage):
  class ExecutionStartedMessage (line 64) | class ExecutionStartedMessage(GuidanceMessage):
  class ExecutionCompletedMessage (line 68) | class ExecutionCompletedMessage(GuidanceMessage):
  class ResetDisplayMessage (line 78) | class ResetDisplayMessage(GuidanceMessage):
  class ClientReadyMessage (line 84) | class ClientReadyMessage(GuidanceMessage):
  class ClientReadyAckMessage (line 90) | class ClientReadyAckMessage(GuidanceMessage):
  class OutputRequestMessage (line 96) | class OutputRequestMessage(GuidanceMessage):
  class OutputRequestAckMessage (line 102) | class OutputRequestAckMessage(GuidanceMessage):
  function serialize_message (line 108) | def serialize_message(message: GuidanceMessage) -> str:
  function deserialize_message (line 120) | def deserialize_message(data: str) -> GuidanceMessage:

FILE: guidance/visual/_renderer.py
  class Renderer (line 68) | class Renderer:
    method __init__ (line 71) | def __init__(self):
    method update (line 74) | def update(self, message: GuidanceMessage, topic: str = DEFAULT_TOPIC)...
  function _get_src_doc_template (line 85) | def _get_src_doc_template() -> str:
  function _create_stitch_widget (line 96) | def _create_stitch_widget() -> "StitchWidget":
  function _put_nowait_queue (line 108) | def _put_nowait_queue(queue: Queue, val: object) -> None:
  function _cleanup (line 114) | def _cleanup(recv_queue: Queue | None, send_queue: Queue | None, log_msg...
  function _create_queue (line 126) | async def _create_queue() -> Queue:
  function _on_stitch_clientmsg (line 131) | def _on_stitch_clientmsg(recv_queue_weakref: ReferenceType["Queue"], ide...
  function _on_cell_completion (line 138) | def _on_cell_completion(renderer_weakref: ReferenceType["JupyterWidgetRe...
  function _handle_recv_messages (line 157) | async def _handle_recv_messages(
  function _handle_send_messages (line 199) | async def _handle_send_messages(
  function _trace_path_to_messages (line 241) | def _trace_path_to_messages(trace_id: int) -> list["TraceMessage"]:
  class JupyterWidgetRenderer (line 276) | class JupyterWidgetRenderer(Renderer):
    method __init__ (line 279) | def __init__(self, trace_handler: TraceHandler) -> None:
    method _on_exchange (line 318) | def _on_exchange(self, message: GuidanceMessage) -> None:
    method has_divergence (line 329) | def has_divergence(self, message: GuidanceMessage) -> tuple[bool, int]:
    method _replay (line 398) | def _replay(self, message: OutputRequestMessage, topic=DEFAULT_TOPIC) ...
    method update (line 419) | def update(self, message: GuidanceMessage, topic=DEFAULT_TOPIC) -> None:
    method enable_debug (line 513) | def enable_debug(self) -> None:
    method clear_debug_data (line 519) | def clear_debug_data(self) -> None:
    method get_debug_data (line 524) | def get_debug_data(self) -> str | None:
  class DoNothingRenderer (line 570) | class DoNothingRenderer(Renderer):
    method __init__ (line 573) | def __init__(self, trace_handler: TraceHandler) -> None:
    method update (line 582) | def update(self, message: GuidanceMessage, topic: str = DEFAULT_TOPIC)...
  class AutoRenderer (line 586) | class AutoRenderer(Renderer):
    method __init__ (line 589) | def __init__(self, trace_handler: TraceHandler):
    method update (line 615) | def update(self, message: GuidanceMessage, topic: str = DEFAULT_TOPIC)...
    method renderer_type (line 618) | def renderer_type(self) -> type:

FILE: guidance/visual/_trace.py
  function trace_node_to_html (line 17) | def trace_node_to_html(node: TraceNode, prettify_roles=False) -> str:
  function trace_node_to_str (line 111) | def trace_node_to_str(node: TraceNode) -> str:
  function display_trace_tree (line 129) | def display_trace_tree(trace_handler: TraceHandler) -> None: