Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
citeformer 0.3
citeformer 0.3

User guide

  • Getting started
  • Guarantees
  • Verification

Reference

  • Reference
  • Architecture
  • §10 Contracts
  • API reference
    • citeformer
      • citeformer.grammar
        • citeformer.grammar.builder
      • citeformer.integrations
        • citeformer.integrations.llamaindex
        • citeformer.integrations.langchain
      • citeformer.verify
        • citeformer.verify.sentences
        • citeformer.verify.existence
        • citeformer.verify.entailment
        • citeformer.verify.coverage
        • citeformer.verify.verifier
        • citeformer.verify.nli
        • citeformer.verify.report
      • citeformer.render
        • citeformer.render.formatters
          • citeformer.render.formatters.mla
          • citeformer.render.formatters.chicago
          • citeformer.render.formatters.ieee
          • citeformer.render.formatters.apa
          • citeformer.render.formatters.nature
          • citeformer.render.formatters.vancouver
        • citeformer.render.csl
        • citeformer.render.styles
      • citeformer.cli
        • citeformer.cli.app
      • citeformer.backends
        • citeformer.backends.llamacpp
        • citeformer.backends.base
        • citeformer.backends.mock
        • citeformer.backends.gemini
        • citeformer.backends.openrouter
        • citeformer.backends.vllm
        • citeformer.backends.mistral
        • citeformer.backends.anthropic
        • citeformer.backends.together
        • citeformer.backends.openai
        • citeformer.backends.hf
        • citeformer.backends.fireworks
      • citeformer.metadata
        • citeformer.metadata.url
        • citeformer.metadata.zotero
        • citeformer.metadata.bibtex
        • citeformer.metadata.cache
        • citeformer.metadata.crossref
        • citeformer.metadata.pdf
        • citeformer.metadata.arxiv
      • citeformer.prompts
      • citeformer.citeformer
      • citeformer.csl
      • citeformer.core
    • citeformer._version
    • citeformer.backends
      • citeformer.backends.llamacpp
      • citeformer.backends.base
      • citeformer.backends.mock
      • citeformer.backends.gemini
      • citeformer.backends.openrouter
      • citeformer.backends.vllm
      • citeformer.backends.mistral
      • citeformer.backends.anthropic
      • citeformer.backends.together
      • citeformer.backends.openai
      • citeformer.backends.hf
      • citeformer.backends.fireworks
    • citeformer.backends.anthropic
    • citeformer.backends.base
    • citeformer.backends.fireworks
    • citeformer.backends.gemini
    • citeformer.backends.hf
    • citeformer.backends.llamacpp
    • citeformer.backends.mistral
    • citeformer.backends.mock
    • citeformer.backends.openai
    • citeformer.backends.openrouter
    • citeformer.backends.together
    • citeformer.backends.vllm
    • citeformer.citeformer
    • citeformer.cli
      • citeformer.cli.app
    • citeformer.cli.app
    • citeformer.core
    • citeformer.csl
    • citeformer.grammar
      • citeformer.grammar.builder
    • citeformer.grammar.builder
    • citeformer.integrations
      • citeformer.integrations.llamaindex
      • citeformer.integrations.langchain
    • citeformer.integrations.langchain
    • citeformer.integrations.llamaindex
    • citeformer.metadata
      • citeformer.metadata.url
      • citeformer.metadata.zotero
      • citeformer.metadata.bibtex
      • citeformer.metadata.cache
      • citeformer.metadata.crossref
      • citeformer.metadata.pdf
      • citeformer.metadata.arxiv
    • citeformer.metadata.arxiv
    • citeformer.metadata.bibtex
    • citeformer.metadata.cache
    • citeformer.metadata.crossref
    • citeformer.metadata.pdf
    • citeformer.metadata.url
    • citeformer.metadata.zotero
    • citeformer.prompts
    • citeformer.render
      • citeformer.render.formatters
        • citeformer.render.formatters.mla
        • citeformer.render.formatters.chicago
        • citeformer.render.formatters.ieee
        • citeformer.render.formatters.apa
        • citeformer.render.formatters.nature
        • citeformer.render.formatters.vancouver
      • citeformer.render.csl
      • citeformer.render.styles
    • citeformer.render.csl
    • citeformer.render.formatters
      • citeformer.render.formatters.mla
      • citeformer.render.formatters.chicago
      • citeformer.render.formatters.ieee
      • citeformer.render.formatters.apa
      • citeformer.render.formatters.nature
      • citeformer.render.formatters.vancouver
    • citeformer.render.formatters._base
    • citeformer.render.formatters.apa
    • citeformer.render.formatters.chicago
    • citeformer.render.formatters.ieee
    • citeformer.render.formatters.mla
    • citeformer.render.formatters.nature
    • citeformer.render.formatters.vancouver
    • citeformer.render.styles
    • citeformer.verify
      • citeformer.verify.sentences
      • citeformer.verify.existence
      • citeformer.verify.entailment
      • citeformer.verify.coverage
      • citeformer.verify.verifier
      • citeformer.verify.nli
      • citeformer.verify.report
    • citeformer.verify.coverage
    • citeformer.verify.entailment
    • citeformer.verify.existence
    • citeformer.verify.nli
    • citeformer.verify.report
    • citeformer.verify.sentences
    • citeformer.verify.verifier

Development

  • Development setup
  • Releasing

Architecture decisions

  • Architecture decisions
    • ADR-001 — Grammar builder emits GBNF, not Lark
    • ADR-002 — GenerationResult.text keeps [N] markers verbatim
    • ADR-003 — Bundle five CSL styles; accept user paths; drop Vancouver from v0.1
    • ADR-004 — Replace citeproc-py with a home-grown formatter
    • ADR-005 — Metadata-fetch and render deps go in main, not extras
    • ADR-006 — vllm excluded from the all extra
    • ADR-007 — REQUIRED policy lets the model stall in content state
    • ADR-008 — GenerationResult + VerificationReport bumped to schema_version=2
    • ADR-009 — Bounded content rule closes the REQUIRED progression gap
    • ADR-010 — VerificationReport gains citations_checked (schema v3)
    • ADR-011 — Configurable inline marker shapes
    • ADR-012 — GenerationResult bumped to schema_version=3 with optional usage
    • ADR-013 — Citation extended with cited_text + source_span + document_title
    • ADR-014 — Async surface (agenerate / astream) on Backend + Citeformer
    • ADR-015 — Defer Bedrock + Vertex AI backends to a future release
    • ADR-016 — Defer fine-grain windowing for verify() until calibration data exists
    • ADR-017 — Defer per-model cost tables; surface tokens, let consumers price

History

  • citeformer v0 — frozen spec
Back to top
Copyright © 2026, Blaise and citeformer contributors
Made with Sphinx and @pradyunsg's Furo