-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathmkdocs.yml
172 lines (172 loc) · 8.74 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
170
171
172
edit_uri: edit/main/docs/
nav:
- Home: index.md
- Quickstart:
- Quickstart Setup: quickstart/quickstart_setup.md
- Local Developement Setup: quickstart/developer_setup.md
- How to:
- Configure RAG System: how_to/how_to_configure.md
- Add a New LLM: how_to/how_to_add_new_llm.md
- Add a New Embedding Model: how_to/how_to_add_new_embedding_model.md
- Add a New Vector Store: how_to/how_to_add_new_vector_store.md
- Add a New Datasource: how_to/how_to_add_new_datasource.md
- Evaluation:
- In progress: evaluation/in_progress.md
- Monitoring:
- In progress: monitoring/in_progress.md
- Code Docs:
- Augment: src/augment.md
- Embed: src/embed.md
- Evaluate: src/evaluate.md
- Augmentation:
- Bootstrap:
- Initializer: src/augmentation/bootstrap/initializer.md
- Configuration:
- Chainlit_configuration: src/augmentation/bootstrap/configuration/chainlit_configuration.md
- Configuration: src/augmentation/bootstrap/configuration/configuration.md
- Langfuse_configuration: src/augmentation/bootstrap/configuration/langfuse_configuration.md
- Components:
- Llm_configuration: src/augmentation/bootstrap/configuration/components/llm_configuration.md
- Retriever_configuration: src/augmentation/bootstrap/configuration/components/retriever_configuration.md
- Postprocessors_configuration: src/augmentation/bootstrap/configuration/components/postprocessors_configuration.md
- Synthesizer_configuration: src/augmentation/bootstrap/configuration/components/synthesizer_configuration.md
- Query_engine_configuration: src/augmentation/bootstrap/configuration/components/query_engine_configuration.md
- Components:
- Llms:
- Openai_like:
- Llm: src/augmentation/components/llms/openai_like/llm.md
- Output_extractor: src/augmentation/components/llms/openai_like/output_extractor.md
- Configuration: src/augmentation/components/llms/openai_like/configuration.md
- Openai:
- Llm: src/augmentation/components/llms/openai/llm.md
- Output_extractor: src/augmentation/components/llms/openai/output_extractor.md
- Configuration: src/augmentation/components/llms/openai/configuration.md
- Registry: src/augmentation/components/llms/registry.md
- Core:
- Base_output_extractor: src/augmentation/components/llms/core/base_output_extractor.md
- Query_engines:
- Registry: src/augmentation/components/query_engines/registry.md
- Langfuse:
- Callback_manager: src/augmentation/components/query_engines/langfuse/callback_manager.md
- Query_engine: src/augmentation/components/query_engines/langfuse/query_engine.md
- Configuration: src/augmentation/components/query_engines/langfuse/configuration.md
- Postprocessors:
- Colbert_rerank:
- Configuraiton: src/augmentation/components/postprocessors/colbert_rerank/configuraiton.md
- Postprocessor: src/augmentation/components/postprocessors/colbert_rerank/postprocessor.md
- Registry: src/augmentation/components/postprocessors/registry.md
- Retrievers:
- Auto:
- Configuration: src/augmentation/components/retrievers/auto/configuration.md
- Retriever: src/augmentation/components/retrievers/auto/retriever.md
- Registry: src/augmentation/components/retrievers/registry.md
- Basic:
- Configuration: src/augmentation/components/retrievers/basic/configuration.md
- Retriever: src/augmentation/components/retrievers/basic/retriever.md
- Synthesizers:
- Tree:
- Synthesizer: src/augmentation/components/synthesizers/tree/synthesizer.md
- Configuration: src/augmentation/components/synthesizers/tree/configuration.md
- Registry: src/augmentation/components/synthesizers/registry.md
- Langfuse:
- Dataset_service: src/augmentation/langfuse/dataset_service.md
- Client: src/augmentation/langfuse/client.md
- Chainlit:
- Feedback_service: src/augmentation/chainlit/feedback_service.md
- Exceptions: src/augmentation/chainlit/exceptions.md
- Utils: src/augmentation/chainlit/utils.md
- Service: src/augmentation/chainlit/service.md
- Core:
- Base_configuration: src/core/base_configuration.md
- Base_factory: src/core/base_factory.md
- Logger: src/core/logger.md
- Base_initializer: src/core/base_initializer.md
- Configuration_retrievers: src/core/configuration_retrievers.md
- Embedding:
- Bootstrap:
- Initializer: src/embedding/bootstrap/initializer.md
- Configuration:
- Vector_store_configuration: src/embedding/bootstrap/configuration/vector_store_configuration.md
- Embedding_model_configuration: src/embedding/bootstrap/configuration/embedding_model_configuration.md
- Splitting_configuration: src/embedding/bootstrap/configuration/splitting_configuration.md
- Configuration: src/embedding/bootstrap/configuration/configuration.md
- Embedding_models:
- Hugging_face:
- Configuration: src/embedding/embedding_models/hugging_face/configuration.md
- Embedding_model: src/embedding/embedding_models/hugging_face/embedding_model.md
- Openai:
- Configuration: src/embedding/embedding_models/openai/configuration.md
- Embedding_model: src/embedding/embedding_models/openai/embedding_model.md
- Registry: src/embedding/embedding_models/registry.md
- Voyage:
- Configuration: src/embedding/embedding_models/voyage/configuration.md
- Embedding_model: src/embedding/embedding_models/voyage/embedding_model.md
- Vector_stores:
- Registry: src/embedding/vector_stores/registry.md
- Pgvector:
- Vector_store: src/embedding/vector_stores/pgvector/vector_store.md
- Validator: src/embedding/vector_stores/pgvector/validator.md
- Configuration: src/embedding/vector_stores/pgvector/configuration.md
- Client: src/embedding/vector_stores/pgvector/client.md
- Core:
- Validator: src/embedding/vector_stores/core/validator.md
- Exceptions: src/embedding/vector_stores/core/exceptions.md
- Chroma:
- Vector_store: src/embedding/vector_stores/chroma/vector_store.md
- Validator: src/embedding/vector_stores/chroma/validator.md
- Configuration: src/embedding/vector_stores/chroma/configuration.md
- Client: src/embedding/vector_stores/chroma/client.md
- Qdrant:
- Vector_store: src/embedding/vector_stores/qdrant/vector_store.md
- Validator: src/embedding/vector_stores/qdrant/validator.md
- Configuration: src/embedding/vector_stores/qdrant/configuration.md
- Client: src/embedding/vector_stores/qdrant/client.md
- Splitters:
- Base_splitter: src/embedding/splitters/base_splitter.md
- Registry: src/embedding/splitters/registry.md
- Basic_markdown:
- Configuration: src/embedding/splitters/basic_markdown/configuration.md
- Basic_markdown_splitter: src/embedding/splitters/basic_markdown/basic_markdown_splitter.md
- Embedders:
- Registry: src/embedding/embedders/registry.md
- Basic:
- Embedder: src/embedding/embedders/basic/embedder.md
- Base_embedder: src/embedding/embedders/base_embedder.md
- Orchestrators:
- Registry: src/embedding/orchestrators/registry.md
- Base_orchestrator: src/embedding/orchestrators/base_orchestrator.md
- Basic:
- Orchestrator: src/embedding/orchestrators/basic/orchestrator.md
- Evaluation:
- Bootstrap:
- Initializer: src/evaluation/bootstrap/initializer.md
- Configuration:
- Configuration: src/evaluation/bootstrap/configuration/configuration.md
- Evaluators:
- Ragas: src/evaluation/evaluators/ragas.md
- Langfuse: src/evaluation/evaluators/langfuse.md
- Extraction:
- Bootstrap:
- Initializer: src/extraction/bootstrap/initializer.md
- Configuration:
- Datasources: src/extraction/bootstrap/configuration/datasources.md
- Configuration: src/extraction/bootstrap/configuration/configuration.md
- Datasources:
- Registry: src/extraction/datasources/registry.md
- Notion: src/extraction/datasources/notion.md
- Core: src/extraction/datasources/core.md
- Pdf: src/extraction/datasources/pdf.md
- Confluence: src/extraction/datasources/confluence.md
- Orchestrators:
- Registry: src/extraction/orchestrators/registry.md
- Base_orchestator: src/extraction/orchestrators/base_orchestator.md
- Basic:
- Orchestrator: src/extraction/orchestrators/basic/orchestrator.md
plugins:
- mkdocstrings
- search
repo_url: https://github.com/feld-m/rag_blueprint/
site_name: RAG Systems
theme: readthedocs
watch:
- .