-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathmkdocs.yml
169 lines (169 loc) · 5.7 KB
/
mkdocs.yml
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
site_name: ragbits docs
site_description: Building blocks for rapid development of GenAI applications
site_url: https://ragbits.deepsense.ai
repo_name: deepsense-ai/ragbits
repo_url: https://github.com/deepsense-ai/ragbits
copyright: Copyright © 2025 deepsense.ai
nav:
- ragbits: index.md
- Quickstart:
- quickstart/quickstart1_prompts.md
- quickstart/quickstart2_rag.md
- How-to:
- Prompting:
- "Define and use prompts": how-to/prompts/use_prompting.md
- "Use images in prompts": how-to/prompts/use_images_in_prompts.md
- "Manage prompts using GUI": how-to/prompts/prompts_lab.md
- "Test prompts with promptfoo": how-to/prompts/promptfoo.md
- LLMs:
- "Interact with LLMs": how-to/llms/use_llms.md
- "Use local or self-hosted LLMs": how-to/llms/use_local_llms.md
- Vector Stores:
- "Perform hybrid search": how-to/vector_stores/hybrid.md
- "Use PostgreSQL as a vector store with pgvector": how-to/vector_stores/use_pgVector_store.md
- Dataset Loading:
- "Load dataset with sources": how-to/sources/load-dataset.md
- Project configuration:
- "Set preferred components in project": how-to/project/component_preferences.md
- "Setup tracing": how-to/project/use_tracing.md
- Document Search:
- "Ingest documents": how-to/document_search/ingest-documents.md
- "Search documents": how-to/document_search/search-documents.md
- Guardrails:
- "Setup guardrails": how-to/guardrails/use_guardrails.md
- Evaluate:
- "Evaluate pipelines": how-to/evaluate/evaluate.md
- "Create custom evaluation pipeline": how-to/evaluate/custom_evaluation_pipeline.md
- "Create custom evaluation metric": how-to/evaluate/custom_metric.md
- "Create custom data loader": how-to/evaluate/custom_dataloader.md
- "Generate new dataset with LLM": how-to/evaluate/generate_dataset.md
- "Auto-optimize hyperparameter tuning": how-to/evaluate/optimize.md
- CLI:
- cli/main.md
- API Reference:
- Core:
- api_reference/core/prompt.md
- api_reference/core/llms.md
- api_reference/core/embeddings.md
- api_reference/core/vector-stores.md
- api_reference/core/hybrid.md
- api_reference/core/sources.md
- Document Search:
- api_reference/document_search/index.md
- Documents:
- api_reference/document_search/documents/documents.md
- api_reference/document_search/documents/elements.md
- Ingest:
- api_reference/document_search/ingest/parsers.md
- api_reference/document_search/ingest/enrichers.md
- api_reference/document_search/ingest/strategies.md
- Retrieval:
- api_reference/document_search/retrieval/rephrasers.md
- api_reference/document_search/retrieval/rerankers.md
- Conversations:
- api_reference/conversations/compressors/base.md
- api_reference/conversations/compressors/llm.md
- Guardrails:
- api_reference/guardrails/index.md
hooks:
- mkdocs_hooks.py
theme:
name: material
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme)"
primary: black
accent: custom
toggle:
icon: material/lightbulb-auto
name: Switch to light mode
- media: '(prefers-color-scheme: light)'
scheme: default
primary: black
accent: custom
toggle:
icon: material/lightbulb
name: Switch to dark mode
- media: '(prefers-color-scheme: dark)'
scheme: slate
primary: black
accent: custom
toggle:
icon: material/lightbulb-outline
name: Switch to system preference
features:
- navigation.footer
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- content.code.annotate
- content.code.copy
- toc.integrate
- toc.follow
extra_css:
- stylesheets/extra.css
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
- admonition
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.inlinehilite
- attr_list
- md_in_html
- pymdownx.details
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: "#"
- mkdocs-click
plugins:
- search
- autorefs
- mkdocstrings:
handlers:
python:
options:
show_root_heading: true
show_if_no_docstring: true
inherited_members: true
members_order: source
separate_signature: true
unwrap_annotated: true
filters:
- "!^_"
merge_init_into_class: true
docstring_section_style: spacy
signature_crossrefs: true
show_symbol_type_heading: true
show_symbol_type_toc: true
show_signature_annotations: true
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/deepsense-ai
- icon: fontawesome/brands/x-twitter
link: https://x.com/deepsense_ai
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/company/deepsense-ai
- icon: fontawesome/brands/youtube
link: https://youtube.com/@deepsenseai
- icon: fontawesome/brands/medium
link: https://medium.com/deepsense-ai
- icon: fontawesome/solid/globe
link: https://deepsense.ai
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn