txtai/mkdocs.yml at master · neuml/txtai · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
#
# txtai Material for MkDocs configuration
#

site_name: txtai
site_description: "txtai is an all-in-one open-source AI framework for semantic search, LLM orchestration and language model workflows"
repo_name: neuml/txtai
repo_url: https://github.com/neuml/txtai
copyright: © NeuML LLC, Apache-2.0 License
theme:
    name: material
    logo: images/logo.png
    favicon: images/logo.png
    custom_dir: docs/overrides
    icon:
        repo: fontawesome/brands/github
    palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: light blue
      accent: light blue
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
    features:
        - navigation.indexes
        - navigation.instant
plugins:
    - search
    - mkdocstrings:
        handlers:
            python:
                options:
                    show_root_full_path: false
                    show_root_heading: true
                    show_root_toc_entry: false
    - redirects:
        redirect_maps:
            "pipeline/text/llm.md": "pipeline/llm/llm.md"
            "pipeline/text/rag.md": "pipeline/llm/rag.md"

markdown_extensions:
    - admonition
    - pymdownx.details
    - pymdownx.highlight
    - pymdownx.superfences
nav:
    - Home: index.md
    - Why txtai?: why.md
    - Use Cases: usecases.md
    - Installation: install.md
    - Model Guide: models.md
    - Embeddings:
        - embeddings/index.md
        - Configuration:
            - embeddings/configuration/index.md
            - ANN: embeddings/configuration/ann.md
            - Cloud: embeddings/configuration/cloud.md
            - Database: embeddings/configuration/database.md
            - General: embeddings/configuration/general.md
            - Graph: embeddings/configuration/graph.md
            - Scoring: embeddings/configuration/scoring.md
            - Vectors: embeddings/configuration/vectors.md
        - Index Format: embeddings/format.md
        - Index Guide: embeddings/indexing.md
        - Methods: embeddings/methods.md
        - Query Guide: embeddings/query.md
    - Agent:
        - agent/index.md
        - Configuration: agent/configuration.md
        - Methods: agent/methods.md
    - Pipeline:
        - pipeline/index.md
        - Audio:
            - Audio Mixer: pipeline/audio/audiomixer.md
            - Audio Stream: pipeline/audio/audiostream.md
            - Microphone: pipeline/audio/microphone.md
            - Text To Audio: pipeline/audio/texttoaudio.md
            - Text To Speech: pipeline/audio/texttospeech.md
            - Transcription: pipeline/audio/transcription.md
        - Data:
            - File To HTML: pipeline/data/filetohtml.md
            - HTML To Markdown: pipeline/data/htmltomd.md
            - Segmentation: pipeline/data/segmentation.md
            - Tabular: pipeline/data/tabular.md
            - Textractor: pipeline/data/textractor.md
            - Tokenizer: pipeline/data/tokenizer.md
            - URL Retrieve: pipeline/data/urlretrieve.md
        - Image:
            - Caption: pipeline/image/caption.md
            - Image Hash: pipeline/image/imagehash.md
            - Objects: pipeline/image/objects.md
        - LLM:
            - LLM: pipeline/llm/llm.md
            - RAG: pipeline/llm/rag.md
        - Text:
            - Entity: pipeline/text/entity.md
            - Labels: pipeline/text/labels.md
            - Reranker: pipeline/text/reranker.md
            - Similarity: pipeline/text/similarity.md
            - Summary: pipeline/text/summary.md
            - Translation: pipeline/text/translation.md
        - Train:
            - HF ONNX: pipeline/train/hfonnx.md
            - LEMUR Trainer: pipeline/train/lemur.md
            - ML ONNX: pipeline/train/mlonnx.md
            - Trainer: pipeline/train/trainer.md
    - Workflow:
        - workflow/index.md
        - Schedule: workflow/schedule.md
        - Tasks:
            - workflow/task/index.md
            - Console: workflow/task/console.md
            - Export: workflow/task/export.md
            - File: workflow/task/file.md
            - Image: workflow/task/image.md
            - Retrieve: workflow/task/retrieve.md
            - Service: workflow/task/service.md
            - Storage: workflow/task/storage.md
            - Template: workflow/task/template.md
            - Url: workflow/task/url.md
            - Workflow: workflow/task/workflow.md
    - API:
        - api/index.md
        - Cluster: api/cluster.md
        - Configuration: api/configuration.md
        - Customization: api/customization.md
        - Methods: api/methods.md
        - Model Context Protocol: api/mcp.md
        - OpenAI: api/openai.md
        - Security: api/security.md
    - Cloud: cloud.md
    - Examples: examples.md
    - FAQ: faq.md
    - Observability: observability.md
    - Powered by txtai: poweredby.md
    - Further Reading: further.md