-
Notifications
You must be signed in to change notification settings - Fork 26
Expand file tree
/
Copy pathmkdocs.yml
More file actions
764 lines (764 loc) · 49.5 KB
/
mkdocs.yml
File metadata and controls
764 lines (764 loc) · 49.5 KB
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
site_name: 'Instructor for PHP'
site_author: 'Dariusz Debowczyk'
site_description: 'A lightweight library for structured outputs with LLMs.'
repo_name: instructor-php
repo_url: 'https://github.com/cognesy/instructor-php'
site_url: 'https://cognesy.github.io/instructor-php/'
edit_uri: edit/main/builds/docs-mkdocs/
copyright: 'Copyright © 2024 Dariusz Debowczyk'
docs_dir: builds/docs-mkdocs
site_dir: builds/docs-site
theme:
name: material
icon:
repo: fontawesome/brands/github
edit: material/pencil
view: material/eye
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.code.select
- content.tabs.link
- content.tooltips
- header.autohide
- navigation.expand
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.prune
- navigation.sections
- navigation.tabs
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
palette:
-
scheme: default
primary: black
accent: indigo
toggle:
icon: material/brightness-7
name: 'Switch to dark mode'
-
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/brightness-4
name: 'Switch to light mode'
font:
text: Roboto
code: 'Roboto Mono'
markdown_extensions:
- abbr
- admonition
- pymdownx.details
- attr_list
- def_list
- footnotes
- md_in_html
-
toc:
permalink: true
-
pymdownx.arithmatex:
generic: true
-
pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
-
pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
-
pymdownx.magiclink:
normalize_issue_symbols: true
repo_url_shorthand: true
user: cognesy
repo: instructor-php
- pymdownx.mark
- pymdownx.smartsymbols
-
pymdownx.superfences:
custom_fences:
-
name: mermaid
class: mermaid
format: pymdownx.superfences.fence_code_format
-
pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
-
pymdownx.tasklist:
custom_checkbox: true
plugins:
-
search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
extra:
social:
-
icon: fontawesome/brands/twitter
link: 'https://twitter.com/ddebowczyk'
-
icon: fontawesome/brands/github
link: 'https://github.com/cognesy'
extra_css:
- stylesheets/nav.css
nav:
-
Main:
-
Overview: index.md
-
'Getting Started': getting-started.md
-
Features: features.md
-
Packages: packages.md
-
'Use Cases': use-cases.md
-
'Why Instructor': why-instructor.md
-
'Release Notes':
- { Overview: release-notes/versions.md }
- { v2.3.1: release-notes/v2.3.1.md }
- { v2.3.0: release-notes/v2.3.0.md }
- { v2.2.0: release-notes/v2.2.0.md }
- { v2.1.0: release-notes/v2.1.0.md }
- { v2.0.0: release-notes/v2.0.0.md }
- { v1.22.0: release-notes/v1.22.0.md }
- { v1.21.0: release-notes/v1.21.0.md }
- { v1.20.0: release-notes/v1.20.0.md }
- { v1.19.0: release-notes/v1.19.0.md }
- { v1.18.4: release-notes/v1.18.4.md }
- { v1.18.3: release-notes/v1.18.3.md }
- { v1.18.2: release-notes/v1.18.2.md }
- { v1.18.1: release-notes/v1.18.1.md }
- { v1.18.0: release-notes/v1.18.0.md }
- { v1.17.0: release-notes/v1.17.0.md }
- { v1.16.0: release-notes/v1.16.0.md }
- { v1.15.0: release-notes/v1.15.0.md }
- { v1.14.0: release-notes/v1.14.0.md }
- { v1.13.0: release-notes/v1.13.0.md }
- { v1.12.0: release-notes/v1.12.0.md }
- { v1.11.0: release-notes/v1.11.0.md }
- { v1.10.3: release-notes/v1.10.3.md }
- { v1.10.2: release-notes/v1.10.2.md }
- { v1.10.1: release-notes/v1.10.1.md }
- { v1.10.0: release-notes/v1.10.0.md }
- { v1.9.1: release-notes/v1.9.1.md }
- { v1.9.0: release-notes/v1.9.0.md }
- { v1.8.1: release-notes/v1.8.1.md }
- { v1.8.0: release-notes/v1.8.0.md }
- { v1.7.0: release-notes/v1.7.0.md }
- { v1.6.0: release-notes/v1.6.0.md }
- { v1.5.0: release-notes/v1.5.0.md }
- { v1.4.2: release-notes/v1.4.2.md }
- { v1.4.1: release-notes/v1.4.1.md }
- { v1.4.0: release-notes/v1.4.0.md }
- { v1.3.0: release-notes/v1.3.0.md }
- { v1.2.0: release-notes/v1.2.0.md }
- { v1.1.0: release-notes/v1.1.0.md }
- { v1.0.0: release-notes/v1.0.0.md }
- { v1.0.0-RC22: release-notes/v1.0.0-RC22.md }
- { v1.0.0-RC21: release-notes/v1.0.0-RC21.md }
- { v1.0.0-RC20: release-notes/v1.0.0-RC20.md }
- { v1.0.0-RC19: release-notes/v1.0.0-RC19.md }
- { v1.0.0-RC18: release-notes/v1.0.0-RC18.md }
- { v1.0.0-RC17: release-notes/v1.0.0-RC17.md }
- { v1.0.0-RC16: release-notes/v1.0.0-RC16.md }
- { v1.0.0-RC15: release-notes/v1.0.0-RC15.md }
- { v1.0.0-RC14: release-notes/v1.0.0-RC14.md }
- { v1.0.0-RC13: release-notes/v1.0.0-RC13.md }
- { v1.0.0-RC12: release-notes/v1.0.0-RC12.md }
- { v1.0.0-RC11: release-notes/v1.0.0-RC11.md }
- { v1.0.0-RC10: release-notes/v1.0.0-RC10.md }
- { v1.0.0-RC9: release-notes/v1.0.0-RC9.md }
- { v1.0.0-RC8: release-notes/v1.0.0-RC8.md }
- { v1.0.0-RC7: release-notes/v1.0.0-RC7.md }
- { v1.0.0-RC6: release-notes/v1.0.0-RC6.md }
- { v1.0.0-rc5: release-notes/v1.0.0-rc5.md }
- { v1.0.0-rc4: release-notes/v1.0.0-rc4.md }
- { v1.0.0-rc3: release-notes/v1.0.0-rc3.md }
- { v1.0.0-rc2: release-notes/v1.0.0-rc2.md }
- { v1.0.0-rc1: release-notes/v1.0.0-rc1.md }
- { v0.17.12: release-notes/v0.17.12.md }
- { v0.17.11: release-notes/v0.17.11.md }
- { v0.17.10: release-notes/v0.17.10.md }
- { v0.17.9: release-notes/v0.17.9.md }
- { v0.17.8: release-notes/v0.17.8.md }
- { v0.17.7: release-notes/v0.17.7.md }
- { v0.17.6: release-notes/v0.17.6.md }
- { v0.17.5: release-notes/v0.17.5.md }
- { v0.17.4: release-notes/v0.17.4.md }
- { v0.17.3: release-notes/v0.17.3.md }
- { v0.17.1: release-notes/v0.17.1.md }
- { v0.17.0: release-notes/v0.17.0.md }
- { v0.16.0: release-notes/v0.16.0.md }
- { v0.15.2: release-notes/v0.15.2.md }
- { v0.15.1: release-notes/v0.15.1.md }
- { v0.15.0: release-notes/v0.15.0.md }
- { v0.14.7: release-notes/v0.14.7.md }
- { v0.14.6: release-notes/v0.14.6.md }
- { v0.14.5: release-notes/v0.14.5.md }
- { v0.14.4: release-notes/v0.14.4.md }
- { v0.14.3: release-notes/v0.14.3.md }
- { v0.14.2: release-notes/v0.14.2.md }
- { v0.14.1: release-notes/v0.14.1.md }
- { v0.14.0: release-notes/v0.14.0.md }
- { v0.13.0: release-notes/v0.13.0.md }
- { v0.12.13: release-notes/v0.12.13.md }
- { v0.12.12: release-notes/v0.12.12.md }
- { v0.12.11: release-notes/v0.12.11.md }
- { v0.12.10: release-notes/v0.12.10.md }
- { v0.12.9: release-notes/v0.12.9.md }
- { v0.12.8: release-notes/v0.12.8.md }
- { v0.12.7: release-notes/v0.12.7.md }
- { v0.12.6: release-notes/v0.12.6.md }
- { v0.12.5: release-notes/v0.12.5.md }
- { v0.12.4: release-notes/v0.12.4.md }
- { v0.12.3: release-notes/v0.12.3.md }
- { v0.12.2: release-notes/v0.12.2.md }
- { v0.12.0: release-notes/v0.12.0.md }
- { v0.8.0: release-notes/v0.8.0.md }
-
Packages:
-
Overview: packages/index.md
-
Instructor:
- { Introduction: packages/instructor/introduction.md }
- { Quickstart: packages/instructor/quickstart.md }
- { Setup: packages/instructor/setup.md }
- { 'Testing Doubles': packages/instructor/testing-doubles.md }
- { Upgrade: packages/instructor/upgrade.md }
- { 'Cli Tools': packages/instructor/cli_tools.md }
- { Concepts: [{ Overview: packages/instructor/concepts/overview.md }, { Why: packages/instructor/concepts/why.md }] }
- { Essentials: [{ Usage: packages/instructor/essentials/usage.md }, { 'Data Model': packages/instructor/essentials/data_model.md }, { Validation: packages/instructor/essentials/validation.md }, { Modes: packages/instructor/essentials/modes.md }, { Scalars: packages/instructor/essentials/scalars.md }, { Demonstrations: packages/instructor/essentials/demonstrations.md }, { 'Customize Prompts': packages/instructor/essentials/customize_prompts.md }, { Configuration: packages/instructor/essentials/configuration.md }] }
- { Advanced: [{ Partials: packages/instructor/advanced/partials.md }, { Sequences: packages/instructor/advanced/sequences.md }, { Structures: packages/instructor/advanced/structures.md }, { 'Function Calls': packages/instructor/advanced/function_calls.md }, { 'Manual Schemas': packages/instructor/advanced/manual_schemas.md }, { 'Json Extraction': packages/instructor/advanced/json_extraction.md }, { 'Output Formats': packages/instructor/advanced/output_formats.md }, { Prompts: packages/instructor/advanced/prompts.md }, { 'Model Options': packages/instructor/advanced/model_options.md }, { 'Structure To Structure': packages/instructor/advanced/structure-to-structure.md }] }
- { Techniques: [{ Prompting: packages/instructor/techniques/prompting.md }, { Classification: packages/instructor/techniques/classification.md }, { Search: packages/instructor/techniques/search.md }] }
- { Internals: [{ Instructor: packages/instructor/internals/instructor.md }, { Lifecycle: packages/instructor/internals/lifecycle.md }, { 'Configuration Path': packages/instructor/internals/configuration_path.md }, { 'Config Files': packages/instructor/internals/config_files.md }, { 'Settings Class': packages/instructor/internals/settings_class.md }, { Environment: packages/instructor/internals/environment.md }, { Events: packages/instructor/internals/events.md }, { 'Response Models': packages/instructor/internals/response_models.md }, { Debugging: packages/instructor/internals/debugging.md }] }
- { Misc: [{ Help: packages/instructor/misc/help.md }, { 'Llm Providers': packages/instructor/misc/llm_providers.md }, { Philosophy: packages/instructor/misc/philosophy.md }, { Contributing: packages/instructor/misc/contributing.md }] }
-
Polyglot:
- { Overview: packages/polyglot/overview.md }
- { Quickstart: packages/polyglot/quickstart.md }
- { Setup: packages/polyglot/setup.md }
- { 'Testing Doubles': packages/polyglot/testing-doubles.md }
- { Upgrade: packages/polyglot/upgrade.md }
- { Essentials: [{ Overview: packages/polyglot/essentials/overview.md }, { 'Inference Class': packages/polyglot/essentials/inference-class.md }, { 'Creating Requests': packages/polyglot/essentials/creating-requests.md }, { 'Request Options': packages/polyglot/essentials/request-options.md }, { 'Response Handling': packages/polyglot/essentials/response-handling.md }] }
- { Modes: [{ Overview: packages/polyglot/modes/overview.md }, { Tools: packages/polyglot/modes/tools.md }, { 'Json Schema': packages/polyglot/modes/json-schema.md }, { Json: packages/polyglot/modes/json.md }, { 'Md Json': packages/polyglot/modes/md-json.md }, { Text: packages/polyglot/modes/text.md }] }
- { Streaming: [{ Overview: packages/polyglot/streaming/overview.md }, { Misc: packages/polyglot/streaming/misc.md }] }
- { Embeddings: [{ Overview: packages/polyglot/embeddings/overview.md }, { 'Work With Embeddings': packages/polyglot/embeddings/work-with-embeddings.md }, { Optimization: packages/polyglot/embeddings/optimization.md }] }
- { Advanced: [{ 'Custom Config': packages/polyglot/advanced/custom-config.md }, { 'Custom Http Client': packages/polyglot/advanced/custom-http-client.md }, { 'Context Caching': packages/polyglot/advanced/context-caching.md }, { 'Connection Mgmt': packages/polyglot/advanced/connection-mgmt.md }, { 'Json Schema': packages/polyglot/advanced/json-schema.md }, { Extending: packages/polyglot/advanced/extending.md }] }
- { Internals: [{ Overview: packages/polyglot/internals/overview.md }, { Lifecycle: packages/polyglot/internals/lifecycle.md }, { Configuration: packages/polyglot/internals/configuration.md }, { Providers: packages/polyglot/internals/providers.md }, { Adapters: packages/polyglot/internals/adapters.md }, { 'Http Client': packages/polyglot/internals/http-client.md }, { 'Request Response': packages/polyglot/internals/request-response.md }, { Events: packages/polyglot/internals/events.md }, { 'Public Api': packages/polyglot/internals/public-api.md }] }
- { Troubleshooting: [{ Overview: packages/polyglot/troubleshooting/overview.md }, { Debugging: packages/polyglot/troubleshooting/debugging.md }, { 'Issues Connection': packages/polyglot/troubleshooting/issues-connection.md }, { 'Issues Authentication': packages/polyglot/troubleshooting/issues-authentication.md }, { 'Issues Configuration': packages/polyglot/troubleshooting/issues-configuration.md }, { 'Issues Rate Limits': packages/polyglot/troubleshooting/issues-rate-limits.md }, { 'Issues Streaming': packages/polyglot/troubleshooting/issues-streaming.md }, { 'Issues Model Specific': packages/polyglot/troubleshooting/issues-model-specific.md }, { 'Issues Provider Specific': packages/polyglot/troubleshooting/issues-provider-specific.md }] }
-
Agents:
- { Introduction: packages/agents/01-introduction.md }
- { 'Basic Agent': packages/agents/02-basic-agent.md }
- { 'Basic Concepts': packages/agents/03-basic-concepts.md }
- { 'Controlling The Loop': packages/agents/04-controlling-the-loop.md }
- { Tools: packages/agents/05-tools.md }
- { 'Building Tools': packages/agents/06-building-tools.md }
- { 'Context And Compilers': packages/agents/07-context-and-compilers.md }
- { Hooks: packages/agents/08-hooks.md }
- { 'Stop Conditions': packages/agents/09-stop-conditions.md }
- { Testing: packages/agents/10-testing.md }
- { 'State Internals': packages/agents/11-state-internals.md }
- { 'Tool Calling Internals': packages/agents/12-tool-calling-internals.md }
- { 'Agent Builder': packages/agents/13-agent-builder.md }
- { 'Agent Templates': packages/agents/14-agent-templates.md }
- { Subagents: packages/agents/15-subagents.md }
- { 'Session Runtime': packages/agents/16-session-runtime.md }
- { 'Building Tools Advanced': packages/agents/17-building-tools-advanced.md }
- { 'Observing Agent Execution': packages/agents/18-observing-agent-execution.md }
- { Skills: packages/agents/19-skills.md }
- { 'Testing Doubles': packages/agents/testing-doubles.md }
-
Agent-ctrl:
- { Overview: packages/agent-ctrl/1-overview.md }
- { 'Getting Started': packages/agent-ctrl/2-getting-started.md }
- { 'Testing Doubles': packages/agent-ctrl/testing-doubles.md }
- { Streaming: packages/agent-ctrl/3-streaming.md }
- { 'Session Management': packages/agent-ctrl/4-session-management.md }
- { 'Agent Options': packages/agent-ctrl/5-agent-options.md }
- { 'Response Object': packages/agent-ctrl/6-response-object.md }
- { Troubleshooting: packages/agent-ctrl/7-troubleshooting.md }
- { 'Claude Code Bridge': packages/agent-ctrl/8-claude-code-bridge.md }
- { 'Codex Bridge': packages/agent-ctrl/9-codex-bridge.md }
- { 'Opencode Bridge': packages/agent-ctrl/10-opencode-bridge.md }
- { 'Pi Bridge': packages/agent-ctrl/11-pi-bridge.md }
- { 'Gemini Bridge': packages/agent-ctrl/12-gemini-bridge.md }
-
Telemetry:
- { Introduction: packages/telemetry/01-introduction.md }
- { 'Basic Setup': packages/telemetry/02-basic-setup.md }
- { 'Runtime Wiring': packages/telemetry/03-runtime-wiring.md }
- { Troubleshooting: packages/telemetry/04-troubleshooting.md }
- { Langfuse: packages/telemetry/05-langfuse.md }
- { Logfire: packages/telemetry/06-logfire.md }
-
Sandbox:
- { Overview: packages/sandbox/1-overview.md }
- { 'Getting Started': packages/sandbox/2-getting-started.md }
- { 'Execution Policy': packages/sandbox/3-execution-policy.md }
- { Drivers: packages/sandbox/4-drivers.md }
- { 'Streaming And Results': packages/sandbox/5-streaming-and-results.md }
- { Testing: packages/sandbox/6-testing.md }
- { Troubleshooting: packages/sandbox/7-troubleshooting.md }
-
'HTTP Client':
- { Overview: packages/http/1-overview.md }
- { 'Getting Started': packages/http/2-getting-started.md }
- { 'Testing Doubles': packages/http/testing-doubles.md }
- { 'Making Requests': packages/http/3-making-requests.md }
- { 'Handling Responses': packages/http/4-handling-responses.md }
- { 'Streaming Responses': packages/http/5-streaming-responses.md }
- { Pooling: packages/http/6-pooling.md }
- { Middleware: packages/http/10-middleware.md }
- { 'Changing Client': packages/http/7-changing-client.md }
- { 'Changing Client Config': packages/http/8-changing-client-config.md }
- { 'Custom Clients': packages/http/9-1-custom-clients.md }
-
Laravel:
- { Overview: packages/laravel/index.md }
- { Installation: packages/laravel/installation.md }
- { Configuration: packages/laravel/configuration.md }
- { Facades: packages/laravel/facades.md }
- { 'Native Agents': packages/laravel/native-agents.md }
- { 'Response Models': packages/laravel/response-models.md }
- { Agents: packages/laravel/agents.md }
- { Events: packages/laravel/events.md }
- { Commands: packages/laravel/commands.md }
- { Testing: packages/laravel/testing.md }
- { Advanced: packages/laravel/advanced.md }
- { Troubleshooting: packages/laravel/troubleshooting.md }
-
Symfony:
- { Overview: packages/symfony/overview.md }
- { Quickstart: packages/symfony/quickstart.md }
- { 'Runtime Surfaces': packages/symfony/runtime-surfaces.md }
- { Configuration: packages/symfony/configuration.md }
- { Sessions: packages/symfony/sessions.md }
- { Testing: packages/symfony/testing.md }
- { Telemetry: packages/symfony/telemetry.md }
- { Logging: packages/symfony/logging.md }
- { Delivery: packages/symfony/delivery.md }
- { Operations: packages/symfony/operations.md }
- { Migration: packages/symfony/migration.md }
-
Xprompt:
- { Introduction: packages/xprompt/01-introduction.md }
- { 'Getting Started': packages/xprompt/02-getting-started.md }
- { Composition: packages/xprompt/03-composition.md }
- { Templates: packages/xprompt/04-templates.md }
- { 'Structured Data': packages/xprompt/05-structured-data.md }
- { 'Variants And Registry': packages/xprompt/06-variants-and-registry.md }
- { Configuration: packages/xprompt/07-configuration.md }
-
Cookbook:
-
Introduction: cookbook/introduction.md
-
Contributing: cookbook/contributing.md
-
A01_Basics:
- { 'Basic use': cookbook/examples/A01_Basics/basic_use.md }
- { 'Specifying required and optional parameters via constructor': cookbook/examples/A01_Basics/constructor_parameters.md }
- { 'Getters and setters': cookbook/examples/A01_Basics/getters_and_setters.md }
- { 'Private vs public object field': cookbook/examples/A01_Basics/public_vs_private.md }
- { 'Basic use via StructuredOutput': cookbook/examples/A01_Basics/basic_use_mixin.md }
- { 'Fluent API': cookbook/examples/A01_Basics/fluent_api.md }
- { 'Handling errors with `Maybe` helper class': cookbook/examples/A01_Basics/maybe.md }
- { 'Messages API': cookbook/examples/A01_Basics/messages_api.md }
- { 'Mixed Type Property': cookbook/examples/A01_Basics/mixed_type_property.md }
- { Modes: cookbook/examples/A01_Basics/modes.md }
- { 'Making some fields optional': cookbook/examples/A01_Basics/optional_fields.md }
- { 'Automatic correction based on validation results': cookbook/examples/A01_Basics/self_correction.md }
- { 'Using attributes': cookbook/examples/A01_Basics/attributes.md }
- { 'Load LLM Config Data From YAML': cookbook/examples/A01_Basics/using_config.md }
- { Validation: cookbook/examples/A01_Basics/validation.md }
- { 'Custom validation using Symfony Validator': cookbook/examples/A01_Basics/custom_validation.md }
- { 'Validation across multiple fields': cookbook/examples/A01_Basics/validation_multifield.md }
- { 'Validation with LLM': cookbook/examples/A01_Basics/validation_with_llm.md }
-
A02_Advanced:
- { 'Use custom configuration source': cookbook/examples/A02_Advanced/config_providers.md }
- { 'Context caching (structured output)': cookbook/examples/A02_Advanced/context_cache_structured.md }
- { 'Context caching (structured output, OpenAI)': cookbook/examples/A02_Advanced/context_cache_structured_oai.md }
- { 'Context caching (structured output, OpenAI Responses)': cookbook/examples/A02_Advanced/context_cache_structured_oai_responses.md }
- { 'Customize parameters of LLM driver': cookbook/examples/A02_Advanced/custom_config.md }
- { 'Use custom HTTP client instance': cookbook/examples/A02_Advanced/custom_http_client.md }
- { 'Use custom HTTP client instance - Laravel': cookbook/examples/A02_Advanced/custom_http_client_laravel.md }
- { 'Custom prompts': cookbook/examples/A02_Advanced/custom_prompts.md }
- { 'Customize parameters via DSN': cookbook/examples/A02_Advanced/custom_llm_with_dsn.md }
- { 'Extracting arguments of function or method': cookbook/examples/A02_Advanced/function_calls.md }
- { 'Manual Schema Building': cookbook/examples/A02_Advanced/manual_schemas.md }
- { 'Streaming partial updates during inference': cookbook/examples/A02_Advanced/partials.md }
- { 'Providing example inputs and outputs': cookbook/examples/A02_Advanced/demonstrations.md }
- { 'Extracting scalar values': cookbook/examples/A02_Advanced/scalars.md }
- { 'Extracting sequences of objects': cookbook/examples/A02_Advanced/sequences.md }
- { Streaming: cookbook/examples/A02_Advanced/streaming.md }
- { Structures: cookbook/examples/A02_Advanced/structures.md }
-
A03_Troubleshooting:
- { 'Calculating request cost': cookbook/examples/A03_Troubleshooting/cost_calculation.md }
- { Debugging: cookbook/examples/A03_Troubleshooting/debugging.md }
- { 'Read StructuredOutput EventLog JSONL': cookbook/examples/A03_Troubleshooting/structured_output_eventlog_readback.md }
- { 'Laravel Logging Integration': cookbook/examples/A03_Troubleshooting/logging_laravel.md }
- { 'Monolog Logging with Functional Pipeline': cookbook/examples/A03_Troubleshooting/logging_monolog.md }
- { 'PSR-3 Logging with Functional Pipeline': cookbook/examples/A03_Troubleshooting/logging_psr.md }
- { 'Symfony Logging Integration': cookbook/examples/A03_Troubleshooting/logging_symfony.md }
- { 'Receive specific internal event with onEvent()': cookbook/examples/A03_Troubleshooting/on_event.md }
- { 'Load Config From Custom Path': cookbook/examples/A03_Troubleshooting/settings.md }
- { 'Send StructuredOutput telemetry to Langfuse': cookbook/examples/A03_Troubleshooting/structured_telemetry_langfuse.md }
- { 'Send StructuredOutput telemetry to Logfire': cookbook/examples/A03_Troubleshooting/structured_telemetry_logfire.md }
- { 'Tracking token usage via events': cookbook/examples/A03_Troubleshooting/token_usage_events.md }
- { 'Receive all internal events with wiretap()': cookbook/examples/A03_Troubleshooting/wiretap.md }
-
A04_APISupport:
- { A21: cookbook/examples/A04_APISupport/a21.md }
- { Anthropic: cookbook/examples/A04_APISupport/anthropic.md }
- { 'Azure OpenAI': cookbook/examples/A04_APISupport/azure_openai.md }
- { Cerebras: cookbook/examples/A04_APISupport/cerebras.md }
- { Cohere: cookbook/examples/A04_APISupport/cohere.md }
- { DeepSeek: cookbook/examples/A04_APISupport/deepseek.md }
- { Fireworks.ai: cookbook/examples/A04_APISupport/fireworks.md }
- { 'Google Gemini': cookbook/examples/A04_APISupport/google_gemini.md }
- { 'Google Gemini (OpenAI compatible API)': cookbook/examples/A04_APISupport/google_gemini_oai.md }
- { Groq: cookbook/examples/A04_APISupport/groq.md }
- { 'Hugging Face': cookbook/examples/A04_APISupport/huggingface.md }
- { Inception: cookbook/examples/A04_APISupport/inception.md }
- { Meta: cookbook/examples/A04_APISupport/meta.md }
- { Minimaxi: cookbook/examples/A04_APISupport/minimaxi.md }
- { 'Mistral AI': cookbook/examples/A04_APISupport/mistralai.md }
- { MoonshotAI: cookbook/examples/A04_APISupport/moonshotai.md }
- { 'Local / Ollama': cookbook/examples/A04_APISupport/ollama.md }
- { OpenAI: cookbook/examples/A04_APISupport/openai.md }
- { 'OpenAI Responses API': cookbook/examples/A04_APISupport/openai-responses.md }
- { OpenRouter: cookbook/examples/A04_APISupport/openrouter.md }
- { Perplexity: cookbook/examples/A04_APISupport/perplexity.md }
- { SambaNova: cookbook/examples/A04_APISupport/sambanova.md }
- { Together.ai: cookbook/examples/A04_APISupport/togetherai.md }
- { 'xAI / Grok': cookbook/examples/A04_APISupport/xai.md }
-
A05_Extras:
- { 'Extraction of complex objects': cookbook/examples/A05_Extras/complex_extraction.md }
- { 'Extraction of complex objects (Anthropic)': cookbook/examples/A05_Extras/complex_extraction_claude.md }
- { 'Extraction of complex objects (Cohere)': cookbook/examples/A05_Extras/complex_extraction_cohere.md }
- { 'Extraction of complex objects (Gemini)': cookbook/examples/A05_Extras/complex_extraction_gemini.md }
- { 'Cost calculation (StructuredOutput)': cookbook/examples/A05_Extras/cost_calculation_structured.md }
- { 'Custom Content Extractors': cookbook/examples/A05_Extras/custom_extractor.md }
- { 'Using structured data as an input': cookbook/examples/A05_Extras/structured_input.md }
- { 'Image processing - car damage detection': cookbook/examples/A05_Extras/image_car_damage.md }
- { 'Image to data (OpenAI)': cookbook/examples/A05_Extras/image_to_data.md }
- { 'Image to data (Anthropic)': cookbook/examples/A05_Extras/image_to_data_anthropic.md }
- { 'Image to data (Gemini)': cookbook/examples/A05_Extras/image_to_data_gemini.md }
- { 'Generating JSON Schema from PHP classes': cookbook/examples/A05_Extras/json_schema.md }
- { 'Streaming (Structured Output, OpenAI Responses)': cookbook/examples/A05_Extras/streaming_structured_openai_responses.md }
- { 'Return extracted data as array': cookbook/examples/A05_Extras/output_format_array.md }
- { 'Use different class for schema and output': cookbook/examples/A05_Extras/output_format_instance_of.md }
- { 'Streaming with array output format': cookbook/examples/A05_Extras/output_format_streaming.md }
- { 'Pure Array Processing (No Classes)': cookbook/examples/A05_Extras/pure_array_processing.md }
- { 'Generating JSON Schema from PHP classes': cookbook/examples/A05_Extras/schema.md }
- { 'Generating JSON Schema dynamically': cookbook/examples/A05_Extras/schema_dynamic.md }
- { 'Create tasks from meeting transcription': cookbook/examples/A05_Extras/transcription_to_tasks.md }
- { 'Translating UI text fields': cookbook/examples/A05_Extras/translate_ui_fields.md }
- { 'Web page to PHP objects': cookbook/examples/A05_Extras/web_to_objects.md }
-
B01_LLM:
- { 'Working directly with LLMs': cookbook/examples/B01_LLM/inference.md }
- { 'Working directly with LLMs and JSON - JSON mode': cookbook/examples/B01_LLM/llm_json.md }
- { 'Working directly with LLMs and JSON - JSON Schema mode': cookbook/examples/B01_LLM/llm_json_schema.md }
- { 'Working directly with LLMs and JSON - Markdown JSON prompting': cookbook/examples/B01_LLM/llm_md_json.md }
- { 'Working directly with LLMs and JSON - Tool calling': cookbook/examples/B01_LLM/llm_tools.md }
- { 'Generating JSON Schema from PHP classes': cookbook/examples/B01_LLM/llm_with_schema_helper.md }
- { 'Generating JSON Schema from PHP classes': cookbook/examples/B01_LLM/llm_with_tools_helper.md }
-
B02_LLMAdvanced:
- { 'Use custom configuration source for Inference': cookbook/examples/B02_LLMAdvanced/llm_config_providers.md }
- { 'Context caching (text inference)': cookbook/examples/B02_LLMAdvanced/context_cache_llm.md }
- { 'Context caching (text inference, OpenAI)': cookbook/examples/B02_LLMAdvanced/context_cache_llm_oai.md }
- { 'Customize configuration of LLM driver': cookbook/examples/B02_LLMAdvanced/llm_custom_config.md }
- { 'Custom Embeddings Config': cookbook/examples/B02_LLMAdvanced/custom_embeddings_config.md }
- { 'Using custom LLM driver': cookbook/examples/B02_LLMAdvanced/custom_llm_driver.md }
- { 'Customize LLM Configuration with DSN string': cookbook/examples/B02_LLMAdvanced/custom_llm_via_dsn.md }
- { 'Embeddings utils': cookbook/examples/B02_LLMAdvanced/embed_utils.md }
- { Embeddings: cookbook/examples/B02_LLMAdvanced/embeddings.md }
- { 'Work directly with HTTP client facade': cookbook/examples/B02_LLMAdvanced/http_client.md }
- { 'Parallel Calls': cookbook/examples/B02_LLMAdvanced/parallel_calls.md }
- { 'Reasoning Content Access': cookbook/examples/B02_LLMAdvanced/reasoning_content.md }
-
B03_LLMTroubleshooting:
- { 'Read Inference EventLog JSONL': cookbook/examples/B03_LLMTroubleshooting/inference_eventlog_readback.md }
- { 'Debugging HTTP Calls': cookbook/examples/B03_LLMTroubleshooting/http_debug.md }
- { 'Embeddings Logging with Laravel': cookbook/examples/B03_LLMTroubleshooting/llm_logging_laravel_embeddings.md }
- { 'Inference Logging with Laravel': cookbook/examples/B03_LLMTroubleshooting/llm_logging_laravel_inference.md }
- { 'Inference Logging with Monolog': cookbook/examples/B03_LLMTroubleshooting/llm_logging_monolog.md }
- { 'Inference Logging with Symfony': cookbook/examples/B03_LLMTroubleshooting/llm_logging_symfony.md }
- { 'Send LLM runtime telemetry to Langfuse': cookbook/examples/B03_LLMTroubleshooting/llm_telemetry_langfuse.md }
- { 'Send LLM runtime telemetry to Logfire': cookbook/examples/B03_LLMTroubleshooting/llm_telemetry_logfire.md }
- { 'Send streaming LLM telemetry to Langfuse': cookbook/examples/B03_LLMTroubleshooting/llm_telemetry_streaming_langfuse.md }
- { 'Send streaming LLM telemetry to Logfire': cookbook/examples/B03_LLMTroubleshooting/llm_telemetry_streaming_logfire.md }
-
B04_LLMApiSupport:
- { A21: cookbook/examples/B04_LLMApiSupport/llm_a21.md }
- { Anthropic: cookbook/examples/B04_LLMApiSupport/llm_anthropic.md }
- { 'Azure OpenAI': cookbook/examples/B04_LLMApiSupport/llm_azure_openai.md }
- { Cerebras: cookbook/examples/B04_LLMApiSupport/llm_cerebras.md }
- { Cohere: cookbook/examples/B04_LLMApiSupport/llm_cohere.md }
- { DeepSeek: cookbook/examples/B04_LLMApiSupport/llm_deepseek.md }
- { Fireworks.ai: cookbook/examples/B04_LLMApiSupport/llm_fireworks.md }
- { 'Google Gemini': cookbook/examples/B04_LLMApiSupport/llm_google_gemini.md }
- { 'Google Gemini (OpenAI-compatible)': cookbook/examples/B04_LLMApiSupport/llm_google_gemini_oai.md }
- { Groq: cookbook/examples/B04_LLMApiSupport/llm_groq.md }
- { Inception: cookbook/examples/B04_LLMApiSupport/llm_inception.md }
- { Meta: cookbook/examples/B04_LLMApiSupport/llm_meta.md }
- { Minimaxi: cookbook/examples/B04_LLMApiSupport/llm_minimaxi.md }
- { 'Mistral AI': cookbook/examples/B04_LLMApiSupport/llm_mistralai.md }
- { MoonshotAI: cookbook/examples/B04_LLMApiSupport/llm_moonshotai.md }
- { 'Local / Ollama': cookbook/examples/B04_LLMApiSupport/llm_ollama.md }
- { OpenAI: cookbook/examples/B04_LLMApiSupport/llm_openai.md }
- { 'OpenAI Responses API': cookbook/examples/B04_LLMApiSupport/llm_openai-responses.md }
- { OpenRouter: cookbook/examples/B04_LLMApiSupport/llm_openrouter.md }
- { Perplexity: cookbook/examples/B04_LLMApiSupport/llm_perplexity.md }
- { SambaNova: cookbook/examples/B04_LLMApiSupport/llm_sambanova.md }
- { Together.ai: cookbook/examples/B04_LLMApiSupport/llm_togetherai.md }
- { 'xAI / Grok': cookbook/examples/B04_LLMApiSupport/llm_xai.md }
-
B05_LLMExtras:
- { 'Multi-Participant AI Chat Panel Discussion': cookbook/examples/B05_LLMExtras/chat_with_many_participants.md }
- { 'Chat with summary': cookbook/examples/B05_LLMExtras/chat_with_summary.md }
- { 'Cost calculation (Polyglot)': cookbook/examples/B05_LLMExtras/cost_calculation_inference.md }
- { 'Using images in prompts': cookbook/examples/B05_LLMExtras/image_data.md }
- { 'Streaming metrics (Polyglot)': cookbook/examples/B05_LLMExtras/metrics_streaming.md }
- { 'Streaming (Inference, OpenAI Responses)': cookbook/examples/B05_LLMExtras/streaming_inference_openai_responses.md }
- { 'Prompt Templates': cookbook/examples/B05_LLMExtras/prompt_templates.md }
- { 'Simple content summary': cookbook/examples/B05_LLMExtras/summary_with_llm.md }
- { 'Inference and tool use': cookbook/examples/B05_LLMExtras/tool_use.md }
- { 'Inference and tool use (ReAct driver)': cookbook/examples/B05_LLMExtras/tool_use_react.md }
-
C01_Http:
- { 'HTTP Client – Basics': cookbook/examples/C01_Http/http_client_basics.md }
- { 'HTTP Client – Streaming Basics': cookbook/examples/C01_Http/http_client_streaming_basics.md }
- { 'HTTP Middleware (Hooks)': cookbook/examples/C01_Http/http_middleware_hooks.md }
- { 'HTTP Middleware (Stream)': cookbook/examples/C01_Http/http_middleware_stream.md }
- { 'HTTP Middleware (Sync)': cookbook/examples/C01_Http/http_middleware_sync.md }
- { 'HTTP Client – Pool Basics': cookbook/examples/C01_Http/http_client_pool_basics.md }
-
D01_Agents:
- { 'AgentLoop::execute()': cookbook/examples/D01_Agents/agent_loop_execute.md }
- { 'AgentLoop::iterate()': cookbook/examples/D01_Agents/agent_loop_iterate.md }
- { 'Agent with Bash Tool': cookbook/examples/D01_Agents/agent_loop_bash_tool.md }
- { 'Agent with Custom Tool': cookbook/examples/D01_Agents/agent_loop_custom_tool.md }
- { 'Agent Lifecycle Hooks': cookbook/examples/D01_Agents/agent_loop_hooks.md }
- { 'Custom Context Compiler': cookbook/examples/D01_Agents/agent_loop_context_compiler.md }
- { 'Agent Stop Conditions': cookbook/examples/D01_Agents/agent_loop_stop_conditions.md }
- { 'Agent Events and Wiretap': cookbook/examples/D01_Agents/agent_loop_events.md }
- { 'Multi-Execution Conversations': cookbook/examples/D01_Agents/agent_loop_multi_execution.md }
-
D02_AgentBuilder:
- { 'Basic Agent Usage': cookbook/examples/D02_AgentBuilder/agent_basic.md }
- { 'Agent with File System Tools': cookbook/examples/D02_AgentBuilder/agent_file_system.md }
- { 'Agent with Structured Output Extraction': cookbook/examples/D02_AgentBuilder/agent_structured_output.md }
- { 'Agent Hooks - Tool Interception': cookbook/examples/D02_AgentBuilder/agent_hooks.md }
- { 'Agent Self-Critique Pattern': cookbook/examples/D02_AgentBuilder/agent_self_critique.md }
- { 'Agent-Driven Codebase Search': cookbook/examples/D02_AgentBuilder/agent_search.md }
- { 'Agent Subagent Orchestration': cookbook/examples/D02_AgentBuilder/agent_subagents.md }
- { 'Agent Execution Retrospective (D-Mail)': cookbook/examples/D02_AgentBuilder/agent_retrospective.md }
- { 'Agent Planning Subagent Tool': cookbook/examples/D02_AgentBuilder/agent_planning_subagent.md }
- { 'Agent Skills - SKILL.md Open Standard': cookbook/examples/D02_AgentBuilder/agent_skills.md }
-
D03_AgentTemplates:
- { 'Template from Definition': cookbook/examples/D03_AgentTemplates/template_from_definition.md }
- { 'Template from Markdown': cookbook/examples/D03_AgentTemplates/template_from_markdown.md }
- { 'Template from YAML': cookbook/examples/D03_AgentTemplates/template_from_yaml.md }
- { 'Template with Tools and Capabilities': cookbook/examples/D03_AgentTemplates/template_with_tools_and_capabilities.md }
- { 'Template Overrides Seed State': cookbook/examples/D03_AgentTemplates/template_override_seed_state.md }
-
D04_AgentSessions:
- { 'Session Create and Persist': cookbook/examples/D04_AgentSessions/session_create_and_persist.md }
- { 'SessionRuntime Execute Action': cookbook/examples/D04_AgentSessions/session_runtime_execute_action.md }
- { 'SessionRuntime Read APIs': cookbook/examples/D04_AgentSessions/session_runtime_read_apis.md }
- { 'Session SendMessage Action': cookbook/examples/D04_AgentSessions/session_send_message_action.md }
- { 'Session Fork Action': cookbook/examples/D04_AgentSessions/session_fork_action.md }
- { 'Session Conflict Handling': cookbook/examples/D04_AgentSessions/session_conflict_handling.md }
- { 'Session Runtime Hooks': cookbook/examples/D04_AgentSessions/session_runtime_hooks.md }
-
D05_AgentTroubleshooting:
- { 'Read Agent EventLog JSONL': cookbook/examples/D05_AgentTroubleshooting/agent_eventlog_readback.md }
- { 'Send Subagent telemetry to Langfuse': cookbook/examples/D05_AgentTroubleshooting/agent_subagent_telemetry_langfuse.md }
- { 'Send Subagent telemetry to Logfire': cookbook/examples/D05_AgentTroubleshooting/agent_subagent_telemetry_logfire.md }
- { 'Send Agent telemetry to Langfuse': cookbook/examples/D05_AgentTroubleshooting/agent_telemetry_langfuse.md }
- { 'Send Agent telemetry to Logfire': cookbook/examples/D05_AgentTroubleshooting/agent_telemetry_logfire.md }
-
D10_AgentCtrl:
- { 'Basic Agent Control Usage': cookbook/examples/D10_AgentCtrl/agent_ctrl_basic.md }
- { 'Agent Control Events & Monitoring': cookbook/examples/D10_AgentCtrl/agent_ctrl_events.md }
- { 'Agent Control Streaming': cookbook/examples/D10_AgentCtrl/agent_ctrl_streaming.md }
- { 'Agent Control Runtime Switching': cookbook/examples/D10_AgentCtrl/agent_ctrl_switching.md }
- { 'Claude Code CLI - Basic': cookbook/examples/D10_AgentCtrl/claude_code_basic.md }
- { 'Claude Code CLI - Agentic Search': cookbook/examples/D10_AgentCtrl/claude_code_search.md }
- { 'OpenAI Codex CLI - Basic': cookbook/examples/D10_AgentCtrl/codex_basic.md }
- { 'OpenAI Codex CLI - Streaming': cookbook/examples/D10_AgentCtrl/codex_streaming.md }
- { 'Read AgentCtrl EventLog JSONL': cookbook/examples/D10_AgentCtrl/agent_ctrl_eventlog_readback.md }
- { 'Gemini CLI - Basic': cookbook/examples/D10_AgentCtrl/gemini_basic.md }
- { 'Gemini CLI - Streaming': cookbook/examples/D10_AgentCtrl/gemini_streaming.md }
- { 'OpenCode CLI - Basic': cookbook/examples/D10_AgentCtrl/opencode_basic.md }
- { 'OpenCode CLI - Streaming': cookbook/examples/D10_AgentCtrl/opencode_streaming.md }
- { 'Pi CLI - Basic': cookbook/examples/D10_AgentCtrl/pi_basic.md }
- { 'Pi CLI - Streaming': cookbook/examples/D10_AgentCtrl/pi_streaming.md }
- { 'Send AgentCtrl telemetry to Langfuse': cookbook/examples/D10_AgentCtrl/agent_ctrl_telemetry_langfuse.md }
- { 'Send AgentCtrl telemetry to Logfire': cookbook/examples/D10_AgentCtrl/agent_ctrl_telemetry_logfire.md }
-
D20_Sandbox:
- { 'Sandbox: Host ls -Al': cookbook/examples/D20_Sandbox/sandbox_host_ls.md }
- { 'Sandbox: Run PHP Script': cookbook/examples/D20_Sandbox/sandbox_run_php_script.md }
- { 'Sandbox: Streaming Output': cookbook/examples/D20_Sandbox/sandbox_streaming_output.md }
- { 'Sandbox: Timeout Guard': cookbook/examples/D20_Sandbox/sandbox_timeout_guard.md }
-
D21_SandboxAPIs:
- { 'Sandbox API: Bubblewrap': cookbook/examples/D21_SandboxAPIs/sandbox_api_bubblewrap_echo.md }
- { 'Sandbox API: Docker': cookbook/examples/D21_SandboxAPIs/sandbox_api_docker_echo.md }
- { 'Sandbox API: Firejail': cookbook/examples/D21_SandboxAPIs/sandbox_api_firejail_echo.md }
- { 'Sandbox API: Host': cookbook/examples/D21_SandboxAPIs/sandbox_api_host_echo.md }
- { 'Sandbox API: Podman': cookbook/examples/D21_SandboxAPIs/sandbox_api_podman_echo.md }
-
Z01_ZeroShot:
- { 'Assign a Role': cookbook/examples/Z01_ZeroShot/assign_role.md }
- { 'Auto-Refine The Prompt': cookbook/examples/Z01_ZeroShot/auto_refine.md }
- { 'Clarify Ambiguous Information': cookbook/examples/Z01_ZeroShot/clarify_ambiguity.md }
- { 'Define Style': cookbook/examples/Z01_ZeroShot/define_style.md }
- { 'Emotional Stimuli': cookbook/examples/Z01_ZeroShot/emotional_stimuli.md }
- { 'Generate Follow-Up Questions': cookbook/examples/Z01_ZeroShot/follow_up_questions.md }
- { 'Ask Model to Repeat the Query': cookbook/examples/Z01_ZeroShot/repeat_query.md }
- { 'Simulate a Perspective': cookbook/examples/Z01_ZeroShot/simulate_perspective.md }
-
Z02_FewShot:
- { 'Consistency Based Self Adaptive Prompting (COSP)': cookbook/examples/Z02_FewShot/consistency_based_examples.md }
- { 'Example Ordering': cookbook/examples/Z02_FewShot/example_ordering.md }
- { 'Generate In-Context Examples': cookbook/examples/Z02_FewShot/in_context_examples.md }
- { 'Select Effective Examples': cookbook/examples/Z02_FewShot/select_effective_samples.md }
-
Z03_ThoughtGen:
- { 'Analogical Prompting': cookbook/examples/Z03_ThoughtGen/analogical_prompting.md }
- { 'Automate Example Selection': cookbook/examples/Z03_ThoughtGen/automate_selection.md }
- { 'Prioritize Complex Examples': cookbook/examples/Z03_ThoughtGen/complex_examples.md }
- { 'Examine The Context': cookbook/examples/Z03_ThoughtGen/examine_context.md }
- { 'Consider Higher-Level Context': cookbook/examples/Z03_ThoughtGen/higher_level_context.md }
- { 'Include Incorrect Examples': cookbook/examples/Z03_ThoughtGen/incorrect_examples.md }
- { 'Use Majority Voting': cookbook/examples/Z03_ThoughtGen/majority_voting.md }
- { 'Generate Prompt Variations': cookbook/examples/Z03_ThoughtGen/prompt_variations.md }
- { 'Structure The Reasoning': cookbook/examples/Z03_ThoughtGen/structure_reasoning.md }
- { 'Prioritize Uncertain Examples': cookbook/examples/Z03_ThoughtGen/uncertain_examples.md }
-
Z04_Ensembling:
- { 'Combine Multiple Reasoning Chains': cookbook/examples/Z04_Ensembling/combine_reasoning_chains.md }
- { 'Use LLMs to Combine Different Responses': cookbook/examples/Z04_Ensembling/combine_responses.md }
- { 'Combine Different Specialized LLMs': cookbook/examples/Z04_Ensembling/combine_specialized_llms.md }
- { 'Prioritize Consistent Examples': cookbook/examples/Z04_Ensembling/consistent_examples.md }
- { 'Use Distinct Example Subsets': cookbook/examples/Z04_Ensembling/distinct_examples.md }
- { 'Use Ensembles To Test Prompts': cookbook/examples/Z04_Ensembling/ensemble_test_prompts.md }
- { 'Generate Multiple Candidate Responses': cookbook/examples/Z04_Ensembling/multiple_candidates.md }
- { 'Use Task Specific Evaluation Metrics': cookbook/examples/Z04_Ensembling/task_specific_evals.md }
- { 'Use Translation for Paraphrasing': cookbook/examples/Z04_Ensembling/translation_paraphrasing.md }
- { 'Verify Responses over Majority Voting': cookbook/examples/Z04_Ensembling/verify_majority_voting.md }
-
Z05_SelfCriticism:
- { 'Break Down Reasoning Into Multiple Steps': cookbook/examples/Z05_SelfCriticism/break_down_reasoning.md }
- { 'Determine Uncertainty of Reasoning Chain': cookbook/examples/Z05_SelfCriticism/determine_uncertainty.md }
- { 'Improve With Feedback': cookbook/examples/Z05_SelfCriticism/improve_with_feedback.md }
- { 'Reconstruct Prompt from Reasoning Steps': cookbook/examples/Z05_SelfCriticism/reconstruct_prompt.md }
- { 'Self-Verify Responses': cookbook/examples/Z05_SelfCriticism/self_verify.md }
- { 'Independently Verify Responses': cookbook/examples/Z05_SelfCriticism/verify_independently.md }
-
Z06_Decomposition:
- { 'Break Down Complex Tasks': cookbook/examples/Z06_Decomposition/break_down_complexity.md }
- { 'Ditch Vanilla Chain Of Thought': cookbook/examples/Z06_Decomposition/ditch_vanilla_cot.md }
- { 'Generate Code for Intermediate Steps': cookbook/examples/Z06_Decomposition/generate_code.md }
- { 'Generate in Parallel': cookbook/examples/Z06_Decomposition/generate_in_parallel.md }
- { 'Solve Simpler Subproblems': cookbook/examples/Z06_Decomposition/solve_simpler_subtasks.md }
- { 'Leverage Task Specific Systems': cookbook/examples/Z06_Decomposition/task_specific_systems.md }
-
Z07_Misc:
- { 'Arbitrary properties': cookbook/examples/Z07_Misc/arbitrary_properties.md }
- { 'Consistent values of arbitrary properties': cookbook/examples/Z07_Misc/arbitrary_properties_consistent.md }
- { 'Chain of Summaries': cookbook/examples/Z07_Misc/chain_of_summaries.md }
- { 'Chain of Thought': cookbook/examples/Z07_Misc/chain_of_thought.md }
- { 'Single label classification': cookbook/examples/Z07_Misc/classification.md }
- { 'Multiclass classification': cookbook/examples/Z07_Misc/classification_multiclass.md }
- { 'Entity relationship extraction': cookbook/examples/Z07_Misc/entity_relationships.md }
- { 'Handling errors': cookbook/examples/Z07_Misc/handling_errors.md }
- { 'Limiting the length of lists': cookbook/examples/Z07_Misc/limiting_lists.md }
- { 'Reflection Prompting': cookbook/examples/Z07_Misc/reflection_prompting.md }
- { 'Restating instructions': cookbook/examples/Z07_Misc/restate_instructions.md }
- { 'Ask LLM to rewrite instructions': cookbook/examples/Z07_Misc/rewrite_instructions.md }
- { 'Expanding search queries': cookbook/examples/Z07_Misc/search_query_expansion.md }
- { 'Summary with Keywords': cookbook/examples/Z07_Misc/summary_with_keywords.md }
- { 'Reusing components': cookbook/examples/Z07_Misc/component_reuse.md }
- { 'Using CoT to improve interpretation of component data': cookbook/examples/Z07_Misc/component_reuse_cot.md }
-
Cheatsheets:
-
Overview: cheatsheets/index.md
-
Instructor: cheatsheets/instructor.md
-
Polyglot: cheatsheets/polyglot.md
-
Agents: cheatsheets/agents.md
-
AgentCtrl: cheatsheets/agent-ctrl.md
-
Telemetry: cheatsheets/telemetry.md
-
Sandbox: cheatsheets/sandbox.md
-
'HTTP Client': cheatsheets/http-client.md
-
Laravel: cheatsheets/laravel.md
-
Config: cheatsheets/config.md
-
Dynamic: cheatsheets/dynamic.md
-
Events: cheatsheets/events.md
-
Logging: cheatsheets/logging.md
-
Messages: cheatsheets/messages.md
-
Metrics: cheatsheets/metrics.md
-
Pipeline: cheatsheets/pipeline.md
-
Schema: cheatsheets/schema.md
-
Setup: cheatsheets/setup.md
-
Stream: cheatsheets/stream.md
-
Symfony: cheatsheets/symfony.md
-
Templates: cheatsheets/templates.md
-
Utils: cheatsheets/utils.md
-
Xprompt: cheatsheets/xprompt.md