-
Notifications
You must be signed in to change notification settings - Fork 89
/
Copy pathdocs.yml
811 lines (799 loc) · 31.9 KB
/
docs.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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
instances:
- url: https://boundary.docs.buildwithfern.com
# vv example custom domain configuration vv
custom-domain: docs.boundaryml.com
edit-this-page:
github:
owner: BoundaryML
repo: baml
branch: canary
title: Boundary Documentation
tabs:
home:
display-name: Home
icon: fa-solid fa-house
slug: home
guides:
display-name: Guide
icon: fa-solid fa-book
slug: guide
examples:
display-name: Examples
icon: fa-solid fa-grid-2
reference:
display-name: BAML Reference
icon: fa-solid fa-code
slug: ref
# paid-tooling:
# display-name: Paid Offerings
# icon: fa-solid fa-dollar-sign
# slug: paid-tooling
playground:
display-name: Playground
icon: fa-solid fa-play
href: https://promptfiddle.com
changelog:
display-name: Changelog
icon: fa-regular fa-history
slug: changelog
navigation:
- tab: home
layout:
- page: Welcome
path: pages/welcome.mdx
- tab: guides
layout:
- section: Introduction
contents:
- page: What is BAML?
icon: fa-regular fa-question-circle
path: 01-guide/what-are-function-definitions.mdx
- page: What's the baml_src folder
icon: fa-regular fa-folder
path: 01-guide/what-is-baml_src.mdx
slug: baml_src
- page: What's baml_client
icon: fa-regular fa-folder-gear
path: 01-guide/what-is-baml_client.mdx
slug: baml_client
- section: "Installation: Editors"
contents:
- page: VSCode Extension
icon: fa-brands fa-microsoft
path: 01-guide/01-editors/vscode.mdx
- page: Cursor Extension
icon: fa-brands fa-microsoft
path: 01-guide/01-editors/cursor.mdx
- page: Others
icon: fa-brands fa-microsoft
path: 01-guide/01-editors/others.mdx
- section: "Installation: Language"
contents:
- page: Python
icon: fa-brands fa-python
path: 01-guide/02-languages/python.mdx
- page: Typescript
icon: fa-brands fa-js
path: 01-guide/02-languages/typescript.mdx
- page: Ruby
icon: fa-regular fa-gem
path: 01-guide/02-languages/ruby.mdx
- page: REST API (other languages)
icon: fa-regular fa-network-wired
path: 01-guide/02-languages/rest.mdx
- section: Framework Integration
icon: fa-solid fa-plug
contents:
- section: React/Next.js
icon: fa-brands fa-react
contents:
- page: Quick Start
icon: fa-regular fa-rocket
path: 01-guide/08-frameworks/01-react-nextjs/01-quick-start.mdx
- page: Building a Chatbot
icon: fa-solid fa-robot
path: 01-guide/08-frameworks/01-react-nextjs/02-chatbot.mdx
- section: Development
contents:
- page: Environment Variables
icon: fa-regular fa-cogs
path: 01-guide/03-development/environment-variables.mdx
- page: Terminal Logs
icon: fa-regular fa-file-lines
path: 01-guide/03-development/terminal-logs.mdx
- page: Upgrade BAML versions
icon: fa-regular fa-circle-arrow-up
path: 01-guide/03-development/upgrade-baml-versions.mdx
- section: Deploying
icon: fa-regular fa-rocket
contents:
- page: AWS
icon: fa-brands fa-aws
path: 01-guide/03-development/deploying/aws.mdx
- page: Docker
icon: fa-brands fa-docker
path: 01-guide/03-development/deploying/docker.mdx
- page: Docker (REST API)
icon: fa-brands fa-docker
path: 01-guide/03-development/deploying/openapi.mdx
- section: BAML Basics
contents:
- page: Prompting with BAML
icon: fa-solid fa-terminal
path: 01-guide/04-baml-basics/my-first-function.mdx
- page: Switching LLMs
slug: switching-llms
icon: fa-regular fa-random
path: 01-guide/04-baml-basics/switching-llms.mdx
- page: Testing functions
icon: fa-regular fa-vial
path: 01-guide/04-baml-basics/testing-functions.mdx
- page: Streaming
icon: fa-regular fa-faucet
path: 01-guide/04-baml-basics/streaming.mdx
- page: Multi-Modal (Images / Audio)
icon: fa-regular fa-image
path: 01-guide/04-baml-basics/multi-modal.mdx
- page: Error Handling
icon: fa-regular fa-triangle-exclamation
path: 01-guide/04-baml-basics/error-handling.mdx
- page: Concurrent Calls
icon: fa-regular fa-clock-rotate-left
path: 01-guide/04-baml-basics/concurrent-calls.mdx
- section: BAML Advanced
contents:
- page: LLM Client Registry
icon: fa-regular fa-gears
path: 01-guide/05-baml-advanced/client-registry.mdx
- page: Dynamic / Runtime Types
icon: fa-solid fa-person-running
path: 01-guide/05-baml-advanced/dynamic-types.mdx
- page: Reusing Prompt Snippets
icon: fa-regular fa-repeat
path: 01-guide/05-baml-advanced/reusing-prompt-snippets.mdx
- page: Prompt Caching / Message Role Metadata
icon: fa-regular fa-database
path: 01-guide/05-baml-advanced/prompt-caching.mdx
- page: Checks and Asserts
icon: fa-regular fa-check-circle
path: 01-guide/05-baml-advanced/checks-and-asserts.mdx
- section: Boundary Cloud
contents:
# - section: Functions
# icon: fa-cloud
# contents:
# - page: Get Started
# path: 01-guide/functions/get-started.mdx
# - page: Using OpenAPI
# path: 01-guide/functions/using-openapi.mdx
# - page: Environment Variables
# path: 01-guide/functions/environment-variables.mdx
- section: Observability
icon: fa-chart-simple
contents:
- page: Tracking Usage
icon: fa-regular fa-bar-chart
path: 01-guide/07-observability/studio.mdx
- section: Comparisons
contents:
- page: BAML vs Marvin
icon: fa-solid fa-magnifying-glass
path: 01-guide/09-comparisons/marvin.mdx
- page: BAML vs Pydantic
icon: fa-solid fa-magnifying-glass
path: 01-guide/09-comparisons/pydantic.mdx
- page: Contact
icon: fa-regular fa-envelope
path: 01-guide/contact.mdx
- tab: examples
layout:
- page: Interactive Examples
icon: fa-solid fa-play
path: 02-examples/interactive-examples.mdx
- section: Prompt Engineering
contents:
- page: Reducing Hallucinations
icon: fa-regular fa-person-fairy
path: 01-guide/06-prompt-engineering/hallucinations.mdx
- page: Chat
icon: fa-regular fa-comments
path: 01-guide/06-prompt-engineering/chat-history.mdx
- page: Tools / Function Calling
icon: fa-regular fa-wrench
path: 01-guide/06-prompt-engineering/tools.mdx
# - page: Zero shot prompting
# icon: fa-regular fa-bullseye
# path: 01-guide/introduction.mdx
# - page: Few shot prompting
# icon: fa-regular fa-dice-three
# path: 01-guide/introduction.mdx
- page: Chain of Thought
icon: fa-solid fa-brain
path: 01-guide/06-prompt-engineering/chain-of-thought.mdx
- page: Symbol Tuning
icon: fa-regular fa-adjust
path: 01-guide/06-prompt-engineering/symbol-tuning.mdx
# - page: Self-Consistency Prompting
# icon: fa-regular fa-sync-alt
# path: 01-guide/introduction.mdx
# - page: Prompt Chaining
# icon: fa-regular fa-link
# path: 01-guide/introduction.mdx
- page: Retrieval Augmented Generation
icon: fa-regular fa-database
path: 01-guide/introduction.mdx
# - section: Python
# icon: fa-brands fa-python
# contents:
# - page: Hello World
# icon: fa-regular fa-rocket
# path: 01-guide/introduction.mdx
# - page: FastAPI + RAG + streaming
# icon: fa-regular fa-database
# path: 01-guide/introduction.mdx
# - page: Flask + ChatBot
# icon: fa-regular fa-comments
# path: 01-guide/introduction.mdx
# - page: Reflex + Receipt Parsing
# icon: fa-regular fa-receipt
# path: 01-guide/introduction.mdx
# - page: Parsing PDFs
# icon: fa-regular fa-file-pdf
# path: 01-guide/introduction.mdx
# - page: Web scraping with Selenium
# icon: fa-regular fa-globe
# path: 01-guide/introduction.mdx
# - section: Typescript
# icon: fa-brands fa-js
# contents:
# - page: Hello World
# icon: fa-regular fa-rocket
# path: 01-guide/introduction.mdx
# - page: NextJS + RAG + streaming
# icon: fa-regular fa-database
# path: 01-guide/introduction.mdx
# - page: React + Express + ChatBot
# icon: fa-regular fa-comments
# path: 01-guide/introduction.mdx
# - page: NextJS parsing PDFs
# icon: fa-regular fa-file-pdf
# path: 01-guide/introduction.mdx
# - page: Web scraping with Playwright
# icon: fa-regular fa-globe
# path: 01-guide/introduction.mdx
# - section: Ruby
# icon: fa-solid fa-gem
# contents:
# - page: Hello world
# icon: fa-regular fa-rocket
# path: 01-guide/introduction.mdx
# - page: Rails + RAG + streaming
# icon: fa-regular fa-database
# path: 01-guide/introduction.mdx
# - section: Rest API Hello World
# icon: fa-regular fa-network-wired
# contents:
# - page: Ruby
# icon: fa-solid fa-gem
# path: 01-guide/introduction.mdx
# - page: Java
# icon: fa-brands fa-java
# path: 01-guide/introduction.mdx
# - page: Go
# icon: fa-brands fa-golang
# path: 01-guide/introduction.mdx
# - page: C++
# icon: fa-brands fa-cuttlefish
# path: 01-guide/introduction.mdx
# - page: Rust
# icon: fa-brands fa-rust
# path: 01-guide/introduction.mdx
# - page: PHP
# icon: fa-brands fa-php
# path: 01-guide/introduction.mdx
# - page: b
# path: 01-guide/introduction.mdx
# - page: async_client
# path: 01-guide/introduction.mdx
# - page: sync_client
# path: 01-guide/introduction.mdx
# - page: reset_baml_env_vars
# path: 01-guide/introduction.mdx
# - page: trace
# path: 01-guide/introduction.mdx
# - page: set_tags
# path: 01-guide/introduction.mdx
# - section: "baml_client: Typescript"
# contents:
# - page: TypeBuilder
# path: 01-guide/introduction.mdx
# - page: ClientRegistry
# path: 01-guide/introduction.mdx
# - page: BamlError
# path: 01-guide/introduction.mdx
# - page: BamlImageTs
# path: 01-guide/introduction.mdx
# - page: BamlAudioTs
# path: 01-guide/introduction.mdx
# - page: b
# path: 01-guide/introduction.mdx
# - page: async_client
# path: 01-guide/introduction.mdx
# - page: sync_client
# path: 01-guide/introduction.mdx
# - page: resetBamlEnvVars
# path: 01-guide/introduction.mdx
# - page: trace_async
# path: 01-guide/introduction.mdx
# - page: trace_sync
# path: 01-guide/introduction.mdx
# - page: set_tags
# path: 01-guide/introduction.mdx
- tab: reference
layout:
# - page: Changelog
# icon: fa-regular fa-history
# path: ./Changelog.mdx
# - section: Boundary Tools
# contents:
# - api: Document Extraction API
# icon: fa-regular fa-dollar-sign
# slug: reference/extract
# display-errors: true
# layout:
# - POST /extract
# - page: Extraction Examples
# path: reference/extract/examples.mdx
# slug: examples
- page: Overview
path: 03-reference/overview.mdx
- section: baml-cli
contents:
- page: init
path: 03-reference/baml-cli/init.mdx
- page: generate
path: 03-reference/baml-cli/generate.mdx
- page: serve
path: 03-reference/baml-cli/serve.mdx
- page: dev
path: 03-reference/baml-cli/dev.mdx
- page: fmt
path: 03-reference/baml-cli/fmt.mdx
- section: Language Reference
slug: baml
contents:
- section: General BAML Syntax
contents:
- page: comments
path: 03-reference/baml/comments.mdx
- page: Environment Variables
path: 03-reference/baml/env-vars.mdx
- page: string
path: 03-reference/baml/string.mdx
- page: "int / float"
path: 03-reference/baml/int-float.mdx
- page: bool
path: 03-reference/baml/bool.mdx
- page: array (list)
path: 03-reference/baml/array.mdx
- page: map (dictionary)
path: 03-reference/baml/map.mdx
- page: "image / audio"
slug: media
path: 03-reference/baml/media.mdx
- page: Types
path: 03-reference/baml/types.mdx
- page: function
path: 03-reference/baml/function.mdx
- page: test
path: 03-reference/baml/test.mdx
- page: template_string
path: 03-reference/baml/template_string.mdx
- page: "client<llm>"
path: 03-reference/baml/client-llm.mdx
- page: class
path: 03-reference/baml/class.mdx
- page: enum
path: 03-reference/baml/enum.mdx
- page: generator
path: 03-reference/generator.mdx
- section: Generated baml_client
slug: baml_client
contents:
- page: TypeBuilder
path: 03-reference/baml_client/typebuilder.mdx
- page: ClientRegistry
path: 01-guide/05-baml-advanced/client-registry.mdx
- page: BamlImage / BamlAudio
slug: media
path: 03-reference/baml_client/media.mdx
- section: Errors
contents:
- page: Overview
path: 03-reference/baml_client/errors/overview.mdx
- page: BamlValidationError
path: 03-reference/baml_client/errors/baml-validation-error.mdx
- page: BamlClientFinishReasonError
path: 03-reference/baml_client/errors/baml-client-finish-reason-error.mdx
- section: React/Next.js
contents:
- page: use{FunctionName} Hook
path: 03-reference/baml_client/react-nextjs/use-function-name.mdx
- page: HookInput
path: 03-reference/baml_client/react-nextjs/hook-input.mdx
- page: HookOutput
path: 03-reference/baml_client/react-nextjs/hook-output.mdx
- section: Attributes
contents:
- page: What are attributes?
path: 03-reference/baml/attributes/attributes-overview.mdx
- page: "@alias / @@alias"
slug: alias
path: 03-reference/baml/attributes/alias.mdx
- page: "@description / @@description"
slug: description
path: 03-reference/baml/attributes/description.mdx
- page: "@skip"
path: 03-reference/baml/attributes/skip.mdx
- page: "@assert"
path: 03-reference/baml/attributes/assert.mdx
- page: "@check"
path: 03-reference/baml/attributes/check.mdx
- page: "@@dynamic"
path: 03-reference/baml/attributes/dynamic.mdx
- section: LLM Client Providers
contents:
- page: "AWS Bedrock"
path: 03-reference/baml/clients/providers/aws-bedrock.mdx
- page: "Anthropic"
path: 03-reference/baml/clients/providers/anthropic.mdx
- page: "Google AI: Gemini"
path: 03-reference/baml/clients/providers/google-ai.mdx
- page: "Google: Vertex"
path: 03-reference/baml/clients/providers/vertex.mdx
- page: "OpenAI"
path: 03-reference/baml/clients/providers/openai.mdx
- page: "OpenAI from Azure"
path: 03-reference/baml/clients/providers/azure.mdx
- page: "openai-generic"
path: 03-reference/baml/clients/providers/openai-generic.mdx
- page: "openai-generic: Azure AI Foundary"
path: 03-reference/baml/clients/providers/azure-ai-foundary.mdx
- page: "openai-generic: Groq"
path: 03-reference/baml/clients/providers/groq.mdx
- page: "openai-generic: Hugging Face"
path: 03-reference/baml/clients/providers/huggingface.mdx
- page: "openai-generic: Keywords AI"
path: 03-reference/baml/clients/providers/keywordsai.mdx
- page: "openai-generic: LM Studio"
path: 03-reference/baml/clients/providers/lmstudio.mdx
- page: "openai-generic: Ollama"
path: 03-reference/baml/clients/providers/ollama.mdx
- page: "openai-generic: OpenRouter"
path: 03-reference/baml/clients/providers/openrouter.mdx
- page: "openai-generic: TogetherAI"
path: 03-reference/baml/clients/providers/together.mdx
- page: "openai-generic: Unify AI"
path: 03-reference/baml/clients/providers/unify.mdx
- page: "openai-generic: vLLM"
path: 03-reference/baml/clients/providers/vllm.mdx
- section: LLM Client Strategies
contents:
- page: "Retry Policy"
path: 03-reference/baml/clients/strategy/retry.mdx
- page: "Fallback"
path: 03-reference/baml/clients/strategy/fallback.mdx
- page: "Round Robin"
path: 03-reference/baml/clients/strategy/round-robin.mdx
- section: Prompt Syntax
contents:
- page: What is jinja?
path: 03-reference/baml/prompt-syntax/what-is-jinja.mdx
- page: "ctx.output_format"
path: 03-reference/baml/prompt-syntax/output-format.mdx
- page: "ctx.client"
path: 03-reference/baml/prompt-syntax/ctx.mdx
- page: "_.role"
path: 03-reference/baml/prompt-syntax/role.mdx
- page: Variables
path: 03-reference/baml/prompt-syntax/variables.mdx
- page: Conditionals
path: 03-reference/baml/prompt-syntax/conditionals.mdx
- page: Loops
path: 03-reference/baml/prompt-syntax/loops.mdx
- section: Editor Extension Settings
contents:
- page: baml.cliPath
path: 03-reference/vscode-ext/clipath.mdx
- page: baml.generateCodeOnSave
path: 03-reference/vscode-ext/generateCodeOnSave.mdx
- page: baml.restartTSServerOnSave
path: 03-reference/vscode-ext/restartTSServerOnSave.mdx
- page: baml.enablePlaygroundProxy
path: 03-reference/vscode-ext/enablePlaygroundProxy.mdx
- section: Boundary Extraction API
contents:
- api: API Reference
layout:
- POST /extract
- page: Extraction Examples
path: 03-reference/extract/examples.mdx
slug: extract
summary: 03-reference/extract/summary.mdx
display-errors: true
- section: Boundary Cloud API
contents:
- page: Limits
path: 03-reference/cloud/limits.mdx
# - section: "baml_client: Python"
# contents:
# - page: TypeBuilder
# path: 01-guide/introduction.mdx
# - page: ClientRegistry
# path: 01-guide/introduction.mdx
# - page: BamlError
# path: 01-guide/introduction.mdx
# - page: BamlImagePy
# path: 01-guide/introduction.mdx
# - page: BamlAudioPy
# path: 01-guide/introduction.mdx
# - page: b
# path: 01-guide/introduction.mdx
# - page: async_client
# path: 01-guide/introduction.mdx
# - page: sync_client
# path: 01-guide/introduction.mdx
# - page: reset_baml_env_vars
# path: 01-guide/introduction.mdx
# - page: trace
# path: 01-guide/introduction.mdx
# - page: set_tags
# path: 01-guide/introduction.mdx
# - section: "baml_client: Typescript"
# contents:
# - page: TypeBuilder
# path: 01-guide/introduction.mdx
# - page: ClientRegistry
# path: 01-guide/introduction.mdx
# - page: BamlError
# path: 01-guide/introduction.mdx
# - page: BamlImageTs
# path: 01-guide/introduction.mdx
# - page: BamlAudioTs
# path: 01-guide/introduction.mdx
# - page: b
# path: 01-guide/introduction.mdx
# - page: async_client
# path: 01-guide/introduction.mdx
# - page: sync_client
# path: 01-guide/introduction.mdx
# - page: resetBamlEnvVars
# path: 01-guide/introduction.mdx
# - page: trace_async
# path: 01-guide/introduction.mdx
# - page: trace_sync
# path: 01-guide/introduction.mdx
# - page: set_tags
# path: 01-guide/introduction.mdx
- tab: playground
- tab: changelog
layout:
- page: Changelog
icon: fa-regular fa-history
path: pages/changelog.mdx
# - tab: paid-tooling
# layout:
# - section: Extract API
# contents:
# - api: API Reference
# slug: reference/extract
# summary: reference/extract/summary.mdx
# display-errors: true
# layout:
# - POST /extract
# - page: Extraction Examples
# path: reference/extract/examples.mdx
# slug: examples
navbar-links:
- type: github
value: https://github.com/boundaryml/baml
- type: filled
text: Help on Discord
url: https://discord.gg/BTNBeXGuaS
colors:
accent-primary:
light: "#6025d1"
dark: "#b794ff"
background:
light: "#ffffff"
dark: "#0b0d0e"
border:
light: "#e2e8f0cc"
dark: "#2e2e2ecc"
sidebar-background:
light: "#ffffff"
dark: "#0b0d0e"
header-background:
light: "#ffffffb3"
dark: "#0b0d0eb3"
card-background:
light: "#ffffff"
dark: "#0b0d0e"
logo:
light: assets/favicon.ico
dark: assets/favicon.ico
height: 40
favicon: assets/favicon.ico
css: assets/styles.css
layout:
page-width: full
disable-header: false
searchbar-placement: header
header-height: 54px
tabs-placement: header
typography:
bodyFont:
name: OpenSans
paths:
- path: ./assets/open-sans-v17-all-charsets-regular.woff2
weight: "400"
- path: ./assets/open-sans-v17-all-charsets-italic.woff2
style: italic
headingsFont:
name: OpenSans
path: ./assets/open-sans-v17-all-charsets-700.woff2
weight: "600"
# Legacy docs
redirects:
- source: "/guide/baml-basics/switching-ll-ms"
destination: "/guide/baml-basics/switching-llms"
- source: "/docs/get-started/what-is-baml"
destination: "/guide/introduction/what-is-baml"
- source: "/docs/get-started/interactive-demos"
destination: "/examples/interactive-examples"
- source: "/docs/get-started/quickstart/python"
destination: "/guide/installation-language/python"
- source: "/docs/get-started/quickstart/typescript"
destination: "/guide/installation-language/typescript"
- source: "/docs/get-started/quickstart/ruby"
destination: "/guide/installation-language/ruby"
- source: "/docs/get-started/quickstart/openapi"
destination: "/guide/installation-language/rest-api-other-languages"
- source: "/docs/get-started/quickstart/editors-vscode"
destination: "/guide/installation-editors/vs-code-extension"
- source: "/docs/get-started/quickstart/editors-other"
destination: "/guide/installation-editors/others"
- source: "/docs/get-started/debugging/vscode-playground"
destination: "/guide/development/terminal-logs"
- source: "/docs/get-started/debugging/enable-logging"
destination: "/guide/development/terminal-logs"
- source: "/baml/get-started/debugging/exception-handling"
destination: "/guide/baml-basics/error-handling"
- source: "/docs/get-started/deploying/docker"
destination: "/guide/development/deploying/docker"
- source: "/docs/get-started/deploying/nextjs"
destination: "/guide/development/deploying/nextjs"
- source: "/docs/get-started/deploying/aws"
destination: "/guide/development/deploying/aws"
- source: "/docs/get-started/deploying/openapi"
destination: "/guide/development/deploying/openapi"
- source: "/docs/snippets/syntax/comments"
destination: "/ref/baml/general-baml-syntax/comments"
- source: "/docs/snippets/syntax/strings"
destination: "/ref/baml/general-baml-syntax/string"
- source: "/docs/snippets/syntax/lists"
destination: "/ref/baml/general-baml-syntax/array-list"
- source: "/docs/snippets/syntax/dictionaries"
destination: "/ref/baml/general-baml-syntax/map-dictionary"
- source: "/docs/snippets/supported-types"
destination: "/ref/baml/types"
- source: "/docs/snippets/clients/overview"
destination: "/ref/baml/client-llm"
- source: "/docs/snippets/clients/providers/anthropic"
destination: "/ref/llm-client-providers/anthropic"
- source: "/docs/snippets/clients/providers/aws-bedrock"
destination: "/ref/llm-client-providers/aws-bedrock"
- source: "/docs/snippets/clients/providers/azure"
destination: "/ref/llm-client-providers/open-ai-from-azure"
- source: "/docs/snippets/clients/providers/gemini"
destination: "/ref/llm-client-providers/google-ai-studio"
- source: "/docs/snippets/clients/providers/groq"
destination: "/ref/llm-client-providers/openai-generic-groq"
- source: "/docs/snippets/clients/providers/huggingface"
destination: "/ref/llm-client-providers/openai-generic-hugging-face"
- source: "/docs/snippets/clients/providers/ollama"
destination: "/ref/llm-client-providers/openai-generic-ollama"
- source: "/docs/snippets/clients/providers/openai"
destination: "/ref/llm-client-providers/open-ai"
- source: "/docs/snippets/clients/providers/openai-generic"
destination: "/ref/llm-client-providers/openai-generic"
- source: "/docs/snippets/clients/providers/openrouter"
destination: "/ref/llm-client-providers/openai-generic-open-router"
- source: "/docs/snippets/clients/providers/together"
destination: "/ref/llm-client-providers/openai-generic-together-ai"
- source: "/docs/snippets/clients/providers/vertex"
destination: "/ref/llm-client-providers/vertex"
- source: "/docs/snippets/clients/providers/vllm"
destination: "/ref/llm-client-providers/openai-generic-v-llm"
- source: "/docs/snippets/clients/providers/lmstudio"
destination: "/ref/llm-client-providers/openai-generic-lm-studio"
- source: "/docs/snippets/clients/providers/keywordsai"
destination: "/ref/llm-client-providers/openai-generic-keywords-ai"
- source: "/docs/snippets/clients/fallback"
destination: "/ref/llm-client-strategies/fallback"
- source: "/docs/snippets/clients/round-robin"
destination: "/ref/llm-client-strategies/round-robin"
- source: "/docs/snippets/clients/retry"
destination: "/ref/llm-client-strategies/retry-policy"
- source: "/docs/snippets/functions/overview"
destination: "/ref/baml/function"
- source: "/docs/snippets/functions/classification"
destination: "/guide/baml-basics/prompting-with-baml"
- source: "/docs/snippets/functions/extraction"
destination: "/guide/baml-basics/prompting-with-baml"
- source: "/docs/snippets/functions/function-calling"
destination: "/examples/prompt-engineering/tools-function-calling"
- source: "/docs/snippets/class"
destination: "/ref/baml/class"
- source: "/docs/snippets/enum"
destination: "/ref/baml/enum"
- source: "/docs/snippets/prompt-syntax/what-is-jinja"
destination: "/ref/prompt-syntax/what-is-jinja"
- source: "/docs/snippets/prompt-syntax/output-format"
destination: "/ref/prompt-syntax/ctx-output-format"
- source: "/docs/snippets/prompt-syntax/roles"
destination: "/ref/prompt-syntax/role"
- source: "/docs/snippets/prompt-syntax/variables"
destination: "/ref/prompt-syntax/variables"
- source: "/docs/snippets/prompt-syntax/conditionals"
destination: "/ref/prompt-syntax/conditionals"
- source: "/docs/snippets/prompt-syntax/loops"
destination: "/ref/prompt-syntax/loops"
- source: "/docs/snippets/prompt-syntax/comments"
destination: "/ref/baml/general-baml-syntax/comments"
- source: "/docs/snippets/prompt-syntax/ctx"
destination: "/ref/prompt-syntax/ctx-client"
- source: "/docs/snippets/template-string"
destination: "/ref/baml/template-string"
- source: "/docs/snippets/test-cases"
destination: "/ref/baml/test"
- source: "/docs/calling-baml/dynamic-types"
destination: "/guide/baml-advanced/dynamic-runtime-types"
- source: "/docs/calling-baml/client-registry"
destination: "/guide/baml-advanced/llm-client-registry"
- source: "/docs/calling-baml/checks-and-asserts"
destination: "/guide/baml-basics/error-handling"
- source: "/docs/calling-baml/generate-baml-client"
destination: "/ref/baml-client/type-builder"
- source: "/docs/calling-baml/set-env-vars"
destination: "/docs/guide/development/environment-variables"
- source: "/docs/calling-baml/calling-functions"
destination: "/guide/baml-basics/prompting-and-calling-ll-ms-with-baml"
- source: "/docs/calling-baml/streaming"
destination: "/guide/baml-basics/streaming"
- source: "/docs/calling-baml/concurrent-calls"
destination: "/guide/baml-basics/concurrent-calls"
- source: "/docs/calling-baml/multi-modal"
destination: "/guide/baml-basics/multi-modal"
- source: "/docs/baml-nextjs/baml-nextjs"
destination: "/guides/installation-language/next-js"
- source: "/docs/observability/overview"
destination: "/guide/observability/tracking-usage"
- source: "/docs/observability/tracing-tagging"
destination: "/guide/observability/tracking-usage"
- source: "/docs/comparisons/marvin"
destination: "/guide/comparisons/baml-vs-marvin"
- source: "/docs/comparisons/pydantic"
destination: "/guide/comparisons/baml-vs-pydantic"
- source: "/contact"
destination: "/guide/contact"
- source: "/docs/reference/env-vars"
destination: "/docs/guide/development/environment-variables"
- source: "/docs/incidents/2024-07-10-ssrf-issue-in-fiddle-proxy"
destination: "/changelog/changelog"
- source: "/document-extraction-api/overview/docs/api"
destination: "/ref/boundary-extraction-api/extract"
- source: "/document-extraction-api/overview/docs/api/extract-data"
destination: "/ref/boundary-extraction-api/extract"
- source: "/document-extraction-api/overview/docs/api/extraction-examples"
destination: "/ref/boundary-extraction-api/extract/examples"