/
mkdocs.yml
189 lines (186 loc) · 6.14 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
copyright: Copyright © 2023 Mirascope, Inc.
site_name: Mirascope
site_url: https://docs.mirascope.io/
site_description: Mirascope is an intuitive approach to building with LLMs.
repo_name: mirascope
repo_url: https://github.com/Mirascope/mirascope/
theme:
name: material
custom_dir: docs/overrides
icon:
repo: fontawesome/brands/github
features:
- content.code.annotation
- content.code.copy
- content.code.link
- navigation.footer
- navigation.indexes
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- search.highlight
- search.suggest
- toc.follow
language: en
palette:
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
primary: indigo
accent: indigo
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
primary: indigo
accent: indigo
font:
text: Roboto
code: Roboto Mono
extra:
version:
provider: mike
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/mirascope
- icon: fontawesome/brands/twitter
link: https://twitter.com/WilliamBakst
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/wbakst/
analytics:
provider: google
property: G-DJHT1QG9GK
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- admonition
- pymdownx.arithmatex:
generic: true
- footnotes
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format ""
- pymdownx.tabbed:
alternate_style: true
- pymdownx.mark
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tasklist:
custom_checkbox: true
- toc:
permalink: true
plugins:
- mike:
alias_type: symlink
canonical_version: latest
- search
- mkdocstrings:
handlers:
python:
options:
show_root_heading: false
docstring_style: google
nav:
- Get Started: "README.md"
- Concepts:
- Philosophy: "concepts/philosophy.md"
- Writing Prompts: "concepts/writing_prompts.md"
- Generating content: "concepts/generating_content.md"
- Streaming generated content: "concepts/streaming_generated_content.md"
- Chaining calls: "concepts/chaining_calls.md"
- Retries: "concepts/retries.md"
- Chat History: "concepts/chat_history.md"
- Tools (Function Calling): "concepts/tools_(function_calling).md"
- Extracting structured information using LLMs: "concepts/extracting_structured_information_using_llms.md"
- RAG (Retrieval Augmented Generation): "concepts/rag_(retrieval_augmented_generation).md"
- Dumping prompts and calls: "concepts/dumping_prompts_and_calls.md"
- Supported LLM providers: "concepts/supported_llm_providers.md"
- Tracking Costs for LLM Providers: "concepts/tracking_costs_for_llm_providers.md"
- Integrations:
- Logfire: "integrations/logfire.md"
- Langfuse: "integrations/langfuse.md"
- FastAPI: "integrations/fastapi.md"
- Weights & Biases: "integrations/weights_and_biases.md"
- LangChain & LangSmith: "integrations/langchain.md"
- Llama Index: "integrations/llama_index.md"
- Client Wrappers: "integrations/client_wrappers.md"
- Cookbook: "cookbook/index.md"
- API Reference:
- "api/index.md"
- anthropic:
- "api/anthropic/index.md"
- calls: "api/anthropic/calls.md"
- extractors: "api/anthropic/extractors.md"
- tools: "api/anthropic/tools.md"
- types: "api/anthropic/types.md"
- base:
- "api/base/index.md"
- calls: "api/base/calls.md"
- extractors: "api/base/extractors.md"
- prompts: "api/base/prompts.md"
- tools: "api/base/tools.md"
- types: "api/base/types.md"
- utils: "api/base/utils.md"
- chroma:
- "api/chroma/index.md"
- types: "api/chroma/types.md"
- vectorstores: "api/chroma/vectorstores.md"
- cohere:
- "api/cohere/index.md"
- calls: "api/cohere/calls.md"
- embedders: "api/cohere/embedders.md"
- extractors: "api/cohere/extractors.md"
- tools: "api/cohere/tools.md"
- types: "api/cohere/types.md"
- enums: "api/enums.md"
- gemini:
- "api/gemini/index.md"
- calls: "api/gemini/calls.md"
- extractors: "api/gemini/extractors.md"
- tools: "api/gemini/tools.md"
- types: "api/gemini/types.md"
- langfuse:
- "api/langfuse/index.md"
- langfuse: "api/langfuse/langfuse.md"
- logfire:
- "api/logfire/index.md"
- logfire: "api/logfire/logfire.md"
- mistral:
- "api/mistral/index.md"
- calls: "api/mistral/calls.md"
- extractors: "api/mistral/extractors.md"
- tools: "api/mistral/tools.md"
- types: "api/mistral/types.md"
- openai:
- "api/openai/index.md"
- calls: "api/openai/calls.md"
- embedders: "api/openai/embedders.md"
- extractors: "api/openai/extractors.md"
- tools: "api/openai/tools.md"
- types: "api/openai/types.md"
- pinecone:
- "api/pinecone/index.md"
- vectorstores: "api/pinecone/vectorstores.md"
- types: "api/pinecone/types.md"
- rag:
- "api/rag/index.md"
- embedders: "api/rag/embedders.md"
- chunkers:
- "api/rag/chunkers/index.md"
- base_chunker: "api/rag/chunkers/base_chunker.md"
- text_chunker: "api/rag/chunkers/text_chunker.md"
- vectorstores: "api/rag/vectorstores.md"
- wandb:
- "api/wandb/index.md"
- wandb: "api/wandb/wandb.md"
- weave: "api/wandb/weave.md"
- Help: "HELP.md"
- Contributing: "CONTRIBUTING.md"