1  #
  2  # txtai Material for MkDocs configuration
  3  #
  4  
  5  site_name: txtai
  6  site_description: "txtai is an all-in-one open-source AI framework for semantic search, LLM orchestration and language model workflows"
  7  repo_name: neuml/txtai
  8  repo_url: https://github.com/neuml/txtai
  9  copyright: © NeuML LLC, Apache-2.0 License
 10  theme:
 11      name: material
 12      logo: images/logo.png
 13      favicon: images/logo.png
 14      custom_dir: docs/overrides
 15      icon:
 16          repo: fontawesome/brands/github
 17      palette:
 18      - media: "(prefers-color-scheme: light)"
 19        scheme: default
 20        primary: blue
 21        accent: blue
 22        toggle:
 23          icon: material/toggle-switch-off-outline
 24          name: Switch to dark mode
 25      - media: "(prefers-color-scheme: dark)"
 26        scheme: slate
 27        primary: light blue
 28        accent: light blue
 29        toggle:
 30          icon: material/toggle-switch
 31          name: Switch to light mode
 32      features:
 33          - navigation.indexes
 34          - navigation.instant
 35  plugins:
 36      - search
 37      - mkdocstrings:
 38          handlers:
 39              python:
 40                  options:
 41                      show_root_full_path: false
 42                      show_root_heading: true
 43                      show_root_toc_entry: false
 44      - redirects:
 45          redirect_maps:
 46              "pipeline/text/llm.md": "pipeline/llm/llm.md"
 47              "pipeline/text/rag.md": "pipeline/llm/rag.md"
 48  
 49  markdown_extensions:
 50      - admonition
 51      - pymdownx.details
 52      - pymdownx.highlight
 53      - pymdownx.superfences
 54  nav:
 55      - Home: index.md
 56      - Why txtai?: why.md
 57      - Use Cases: usecases.md
 58      - Installation: install.md
 59      - Model Guide: models.md
 60      - Embeddings:
 61          - embeddings/index.md
 62          - Configuration:
 63              - embeddings/configuration/index.md
 64              - ANN: embeddings/configuration/ann.md
 65              - Cloud: embeddings/configuration/cloud.md
 66              - Database: embeddings/configuration/database.md
 67              - General: embeddings/configuration/general.md
 68              - Graph: embeddings/configuration/graph.md
 69              - Scoring: embeddings/configuration/scoring.md
 70              - Vectors: embeddings/configuration/vectors.md
 71          - Index Format: embeddings/format.md
 72          - Index Guide: embeddings/indexing.md
 73          - Methods: embeddings/methods.md
 74          - Query Guide: embeddings/query.md
 75      - Agent:
 76          - agent/index.md
 77          - Configuration: agent/configuration.md
 78          - Methods: agent/methods.md
 79      - Pipeline:
 80          - pipeline/index.md
 81          - Audio:
 82              - Audio Mixer: pipeline/audio/audiomixer.md
 83              - Audio Stream: pipeline/audio/audiostream.md
 84              - Microphone: pipeline/audio/microphone.md
 85              - Text To Audio: pipeline/audio/texttoaudio.md
 86              - Text To Speech: pipeline/audio/texttospeech.md
 87              - Transcription: pipeline/audio/transcription.md
 88          - Data:
 89              - File To HTML: pipeline/data/filetohtml.md
 90              - HTML To Markdown: pipeline/data/htmltomd.md
 91              - Segmentation: pipeline/data/segmentation.md
 92              - Tabular: pipeline/data/tabular.md
 93              - Textractor: pipeline/data/textractor.md
 94              - Tokenizer: pipeline/data/tokenizer.md
 95          - Image:
 96              - Caption: pipeline/image/caption.md
 97              - Image Hash: pipeline/image/imagehash.md
 98              - Objects: pipeline/image/objects.md
 99          - LLM:
100              - LLM: pipeline/llm/llm.md
101              - RAG: pipeline/llm/rag.md
102          - Text:
103              - Entity: pipeline/text/entity.md
104              - Labels: pipeline/text/labels.md
105              - Reranker: pipeline/text/reranker.md
106              - Similarity: pipeline/text/similarity.md
107              - Summary: pipeline/text/summary.md
108              - Translation: pipeline/text/translation.md
109          - Train:
110              - HF ONNX: pipeline/train/hfonnx.md
111              - ML ONNX: pipeline/train/mlonnx.md
112              - Trainer: pipeline/train/trainer.md
113      - Workflow:
114          - workflow/index.md
115          - Schedule: workflow/schedule.md
116          - Tasks:
117              - workflow/task/index.md
118              - Console: workflow/task/console.md
119              - Export: workflow/task/export.md
120              - File: workflow/task/file.md
121              - Image: workflow/task/image.md
122              - Retrieve: workflow/task/retrieve.md
123              - Service: workflow/task/service.md
124              - Storage: workflow/task/storage.md
125              - Template: workflow/task/template.md
126              - Url: workflow/task/url.md
127              - Workflow: workflow/task/workflow.md
128      - API:
129          - api/index.md
130          - Cluster: api/cluster.md
131          - Configuration: api/configuration.md
132          - Customization: api/customization.md
133          - Methods: api/methods.md
134          - Model Context Protocol: api/mcp.md
135          - OpenAI: api/openai.md
136          - Security: api/security.md
137      - Cloud: cloud.md
138      - Examples: examples.md
139      - FAQ: faq.md
140      - Observability: observability.md
141      - Powered by txtai: poweredby.md
142      - Further Reading: further.md