-
Notifications
You must be signed in to change notification settings - Fork 5
/
mkdocs.yml
200 lines (200 loc) · 6.16 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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
site_name: db-ally docs
site_description: Efficient, consistent and secure library for querying structured data with natural language
site_url: https://db-ally.deepsense.ai
repo_name: deepsense-ai/db-ally
repo_url: https://github.com/deepsense-ai/db-ally
copyright: Copyright © 2024 deepsense.ai
nav:
- db-ally docs: index.md
- Quickstart:
- quickstart/index.md
- quickstart/aggregations.md
- quickstart/semantic-similarity.md
- quickstart/multiple-views.md
- Concepts:
- concepts/views.md
- concepts/structured_views.md
- concepts/freeform_views.md
- concepts/collections.md
- concepts/iql.md
- concepts/similarity_indexes.md
- concepts/nl_responder.md
- How-to:
- Using data sources:
- how-to/views/sql.md
- how-to/views/text-to-sql.md
- how-to/views/pandas.md
- how-to/views/custom.md
- how-to/views/few-shots.md
- Using LLMs:
- how-to/llms/litellm.md
- how-to/llms/local.md
- how-to/llms/custom.md
- Using similarity indexes:
- how-to/use_custom_similarity_fetcher.md
- how-to/use_chromadb_store.md
- how-to/use_elastic_store.md
- how-to/use_custom_similarity_store.md
- how-to/update_similarity_indexes.md
- how-to/visualize-collection.md
- how-to/log_runs_to_langsmith.md
- how-to/trace_runs_with_otel.md
- how-to/create_custom_event_handler.md
- how-to/openai_assistants_integration.md
- Tutorials: tutorials.md
- API Reference:
- reference/index.md
- reference/collection.md
- Views:
- reference/views/index.md
- Structured:
- reference/views/structured.md
- reference/views/databases.md
- reference/views/dataframe.md
- Freeform:
- reference/views/text-to-sql.md
- IQL:
- reference/iql/index.md
- reference/iql/iql_generator.md
- Event handlers:
- reference/event_handlers/index.md
- reference/event_handlers/cli_handler.md
- reference/event_handlers/langsmith_handler.md
- reference/event_handlers/otel_handler.md
- View Selection:
- reference/view_selection/index.md
- reference/view_selection/llm_view_selector.md
- reference/nl_responder.md
- LLMs:
- reference/llms/index.md
- reference/llms/litellm.md
- reference/llms/local.md
- reference/prompt.md
- Similarity:
- reference/similarity/index.md
- Store:
- reference/similarity/similarity_store/index.md
- reference/similarity/similarity_store/faiss.md
- reference/similarity/similarity_store/chroma.md
- reference/similarity/similarity_store/elastic.md
- Fetcher:
- reference/similarity/similarity_fetcher/index.md
- reference/similarity/similarity_fetcher/sqlalchemy.md
- reference/similarity/similarity_fetcher/sqlalchemy_simple.md
- Embeddings:
- reference/embeddings/index.md
- reference/embeddings/litellm.md
- About:
- about/roadmap.md
- about/contributing.md
- about/changelog.md
- about/contact.md
theme:
name: material
logo: assets/logo.svg
favicon: assets/favicon.ico
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/lightbulb-auto
name: Switch to light mode
- media: '(prefers-color-scheme: light)'
scheme: default
primary: primary
toggle:
icon: material/lightbulb
name: Switch to dark mode
- media: '(prefers-color-scheme: dark)'
scheme: slate
primary: primary
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
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: "#"
plugins:
- search
- autorefs:
enable: true
- mkdocstrings:
handlers:
python:
options:
# extensions:
# - griffe_typingdoc
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:
analytics:
provider: google
property: G-FBBJRN0H0G
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback!
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