forked from Mirascope/mirascope
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
316 lines (311 loc) · 12 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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
copyright: Copyright © 2023 Mirascope, Inc.
site_name: Mirascope
site_url: https://docs.mirascope.io/
site_description: LLM abstractions that aren't obstructions
repo_name: mirascope
repo_url: https://github.com/Mirascope/mirascope/
strict: true
theme:
name: material
custom_dir: docs/overrides
icon:
repo: fontawesome/brands/github
logo: assets/brandmark.png
features:
- content.tabs.link
- content.code.annotate
- 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: custom
accent: indigo
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
primary: custom
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
supported_llm_providers:
- OpenAI
- Anthropic
- Mistral
- Gemini
- Groq
- Cohere
- LiteLLM
- Azure AI
- Vertex AI
prompt_writing_methods:
- shorthand
- messages
- string_template
- base_message_param
prompt_writing_method_titles:
- Shorthand
- Messages
- String Template
- BaseMessageParam
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
- md_in_html
- 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
- macros:
module_name: docs/macros
- mkdocs-jupyter:
execute: false
include_source: True
ignore: ["*.py"]
- mkdocstrings:
handlers:
python:
paths: [.]
options:
members_order: source
separate_signature: true
filters: ["!^_"]
show_root_heading: false
show_root_toc_entry: false
docstring_style: google
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
show_signature_annotations: true
signature_crossrefs: true
show_symbol_type_heading: true
show_symbol_type_toc: true
extensions:
- docs/plugins/griffe_doclinks.py
import:
- https://docs.python.org/3/objects.inv
extra_css:
- "extra/tweaks.css"
validation:
omitted_files: warn
absolute_links: relative_to_docs
unrecognized_links: warn
not_found: warn
nav:
- Get Started:
- "index.md"
- Why Use Mirascope: "WHY.md"
- Help: "HELP.md"
- Migration Guide: "MIGRATE.md"
- Contributing: "CONTRIBUTING.md"
- Changelog: "CHANGELOG.md"
- Tutorials:
- Quickstart: "tutorials/quickstart.ipynb"
- Structured Outputs: "tutorials/structured_outputs.ipynb"
- Dynamic Configuration & Chaining: "tutorials/dynamic_configuration_and_chaining.ipynb"
- Tools & Agents: "tutorials/tools_and_agents.ipynb"
- Learn:
- "learn/index.md"
- Prompts: "learn/prompts.md"
- Calls: "learn/calls.md"
- Streams: "learn/streams.md"
- Chaining: "learn/chaining.md"
- Response Models: "learn/response_models.md"
- JSON Mode: "learn/json_mode.md"
- Output Parsers: "learn/output_parsers.md"
- Async: "learn/async.md"
- Tools: "learn/tools.md"
- Agents: "learn/agents.md"
- Evals: "learn/evals.md"
- Provider-Specific Features: "learn/provider_specific_features.md"
- Cookbook:
- "cookbook/index.md"
- Text Classification: "cookbook/text_classification.md"
- Text Summarization: "cookbook/text_summarization.md"
- Text Translation: "cookbook/text_translation.md"
- Search with Sources: "cookbook/search_with_sources.md"
- LLM Validation With Retries: "cookbook/llm_validation_with_retries.md"
- Extract from PDF: "cookbook/extract_from_pdf.md"
- Knowledge Graph: "cookbook/knowledge_graph.md"
- Generating Captions: "cookbook/generating_captions.md"
- PII Scrubbing: "cookbook/pii_scrubbing.md"
- Extraction using Vision: "cookbook/extraction_using_vision.md"
- Code Generation and Execution: "cookbook/code_generation_and_execution.md"
- Support Ticket Routing: "cookbook/support_ticket_routing.md"
- Document Segmentation: "cookbook/document_segmentation.md"
- Generating Synthetic Data: "cookbook/generating_synthetic_data.md"
- Speech Transcription: "cookbook/speech_transcription.md"
- Removing Semantic Duplicates: "cookbook/removing_semantic_duplicates.md"
- Query Plan: "cookbook/query_plan.md"
- Named Entity Recognition: "cookbook/named_entity_recognition.md"
- Agents:
- "cookbook/agents/index.md"
- Web Search Agent: "cookbook/agents/web_search_agent.md"
- Blog Writing Agent: "cookbook/agents/blog_writing_agent.md"
- SQL Agent: "cookbook/agents/sql_agent.md"
- Localized Agent: "cookbook/agents/localized_agent.md"
- Local Chat with Codebase: "cookbook/agents/local_chat_with_codebase.md"
- Documentation Agent: "cookbook/agents/documentation_agent.md"
- Prompt Engineering:
- "cookbook/prompt_engineering/index.md"
- Text Based:
- "cookbook/prompt_engineering/text_based/index.md"
- Self Ask: "cookbook/prompt_engineering/text_based/self_ask.md"
- Chaining Based: "cookbook/prompt_engineering/chaining_based/index.md"
- Evaluations:
- "cookbook/evals/index.md"
- Evaluating SQL Agent: "cookbook/evals/evaluating_sql_agent.md"
- Evaluating Web Search Agent: "cookbook/evals/evaluating_web_search_agent.md"
- Evaluating Documentation Agent: "cookbook/evals/evaluating_documentation_agent.md"
- LangGraph vs. Mirascope:
- "cookbook/langgraph_vs_mirascope/index.md"
- Quickstart: "cookbook/langgraph_vs_mirascope/quickstart.md"
- Integrations:
- "integrations/index.md"
- Custom LLM Provider: "integrations/custom_provider.md"
- HyperDX: "integrations/hyperdx.md"
- Langfuse: "integrations/langfuse.md"
- Logfire: "integrations/logfire.md"
- Middleware: "integrations/middleware.md"
- OpenTelemetry: "integrations/otel.md"
- Tenacity: "integrations/tenacity.md"
- API Reference:
- "api/index.md"
- Core:
- "api/core/index.md"
- Anthropic:
- call: "api/core/anthropic/call.md"
- call_params: "api/core/anthropic/call_params.md"
- call_response: "api/core/anthropic/call_response.md"
- call_response_chunk: "api/core/anthropic/call_response_chunk.md"
- dynamic_config: "api/core/anthropic/dynamic_config.md"
- stream: "api/core/anthropic/stream.md"
- tool: "api/core/anthropic/tool.md"
- Azure AI:
- call: "api/core/azure/call.md"
- call_params: "api/core/azure/call_params.md"
- call_response: "api/core/azure/call_response.md"
- call_response_chunk: "api/core/azure/call_response_chunk.md"
- dynamic_config: "api/core/azure/dynamic_config.md"
- stream: "api/core/azure/stream.md"
- tool: "api/core/azure/tool.md"
- Base:
- call_factory: "api/core/base/call_factory.md"
- call_params: "api/core/base/call_params.md"
- call_response: "api/core/base/call_response.md"
- call_response_chunk: "api/core/base/call_response_chunk.md"
- dynamic_config: "api/core/base/dynamic_config.md"
- message_param: "api/core/base/message_param.md"
- metadata: "api/core/base/metadata.md"
- prompt: "api/core/base/prompt.md"
- stream: "api/core/base/stream.md"
- structured_stream: "api/core/base/structured_stream.md"
- tool: "api/core/base/tool.md"
- toolkit: "api/core/base/toolkit.md"
- Cohere:
- call: "api/core/cohere/call.md"
- call_params: "api/core/cohere/call_params.md"
- call_response: "api/core/cohere/call_response.md"
- call_response_chunk: "api/core/cohere/call_response_chunk.md"
- dynamic_config: "api/core/cohere/dynamic_config.md"
- stream: "api/core/cohere/stream.md"
- tool: "api/core/cohere/tool.md"
- Gemini:
- call: "api/core/gemini/call.md"
- call_params: "api/core/gemini/call_params.md"
- call_response: "api/core/gemini/call_response.md"
- call_response_chunk: "api/core/gemini/call_response_chunk.md"
- dynamic_config: "api/core/gemini/dynamic_config.md"
- stream: "api/core/gemini/stream.md"
- tool: "api/core/gemini/tool.md"
- Groq:
- call: "api/core/groq/call.md"
- call_params: "api/core/groq/call_params.md"
- call_response: "api/core/groq/call_response.md"
- call_response_chunk: "api/core/groq/call_response_chunk.md"
- dynamic_config: "api/core/groq/dynamic_config.md"
- stream: "api/core/groq/stream.md"
- tool: "api/core/groq/tool.md"
- LiteLLM:
- call: "api/core/litellm/call.md"
- Mistral:
- call: "api/core/mistral/call.md"
- call_params: "api/core/mistral/call_params.md"
- call_response: "api/core/mistral/call_response.md"
- call_response_chunk: "api/core/mistral/call_response_chunk.md"
- dynamic_config: "api/core/mistral/dynamic_config.md"
- stream: "api/core/mistral/stream.md"
- tool: "api/core/mistral/tool.md"
- OpenAI:
- call: "api/core/openai/call.md"
- call_params: "api/core/openai/call_params.md"
- call_response: "api/core/openai/call_response.md"
- call_response_chunk: "api/core/openai/call_response_chunk.md"
- dynamic_config: "api/core/openai/dynamic_config.md"
- stream: "api/core/openai/stream.md"
- tool: "api/core/openai/tool.md"
- Vertex AI:
- call: "api/core/vertex/call.md"
- call_params: "api/core/vertex/call_params.md"
- call_response: "api/core/vertex/call_response.md"
- call_response_chunk: "api/core/vertex/call_response_chunk.md"
- dynamic_config: "api/core/vertex/dynamic_config.md"
- stream: "api/core/vertex/stream.md"
- tool: "api/core/vertex/tool.md"
- Integrations:
- "api/integrations/index.md"
- Langfuse: "api/integrations/langfuse.md"
- Logfire: "api/integrations/logfire.md"
- Middleware: "api/integrations/middleware.md"
- OpenTelemetry: "api/integrations/otel.md"
- Tenacity: "api/integrations/tenacity.md"