-
Notifications
You must be signed in to change notification settings - Fork 57
Expand file tree
/
Copy pathmkdocs.yml
More file actions
560 lines (553 loc) · 33 KB
/
Copy pathmkdocs.yml
File metadata and controls
560 lines (553 loc) · 33 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
site_name: Pipelex Documentation
# IMPORTANT: site_url must be the bare domain, NOT https://docs.pipelex.com/latest/.
# Mike inserts the version prefix into sitemap URLs during deployment. If site_url
# already contains /latest/, mike produces broken double paths like /latest/0.20.9/page/.
# Canonical URLs are forced to /latest/ via a template override in docs/overrides/main.html.
site_url: https://docs.pipelex.com/
site_description: "Official documentation for Pipelex, an open-source library/CLI for building and running executable AI methods."
docs_dir: docs
repo_url: "https://github.com/Pipelex/pipelex"
repo_name: "Pipelex on GitHub"
theme:
name: material
language: en
custom_dir: docs/overrides
favicon: images/pipelex-favicon-32.png
logo: https://pipelex-web.s3.amazonaws.com/logo/Pipelex-logo-wot-mono-560x176.png
features:
- navigation.footer
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.top
- content.code.copy
palette:
- scheme: default # light
primary: custom
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate # dark
primary: custom
toggle:
icon: material/weather-sunny
name: Switch to light mode
copyright: "© 2025–2026 Evotis S.A.S. <br/>Pipelex is a trademark of Evotis S.A.S."
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Pipelex/pipelex
name: Pipelex on GitHub
- icon: fontawesome/brands/python
link: https://pypi.org/project/pipelex/
name: pipelex on PyPI
- icon: fontawesome/brands/twitter
link: https://x.com/PipelexAI
name: Pipelex on X
- icon: fontawesome/brands/discord
link: https://go.pipelex.com/discord
name: Pipelex on Discord
generator: false
version:
provider: mike
plugins:
- search:
separator: '[\s\-\.]+'
- redirects:
redirect_maps:
'under-the-hood/temporal-deployment.md': 'distributed-execution/index.md'
'distributed-execution/temporal/index.md': 'distributed-execution/index.md'
'distributed-execution/cluster-setup.md': 'distributed-execution/index.md'
'distributed-execution/workers.md': 'distributed-execution/index.md'
'distributed-execution/task-routing.md': 'distributed-execution/index.md'
'distributed-execution/observability.md': 'distributed-execution/index.md'
'under-the-hood/temporal-integration.md': 'under-the-hood/runtime-bridge-and-transport.md'
'home/1-features/advanced-customizations.md': 'features/advanced-customizations.md'
'home/1-features/claude-code-skills-plugin.md': 'features/claude-code-skills-plugin.md'
'home/1-features/cli.md': 'features/cli.md'
'home/1-features/cloud-storage.md': 'features/cloud-storage.md'
'home/1-features/concepts.md': 'features/concepts.md'
'home/1-features/configuration.md': 'features/configuration.md'
'home/1-features/cost-tracking.md': 'features/cost-tracking.md'
'home/1-features/document-extraction.md': 'features/document-extraction.md'
'home/1-features/execution-graph.md': 'features/execution-graph.md'
'home/1-features/gateway.md': 'features/gateway.md'
'home/1-features/image-generation.md': 'features/image-generation.md'
'home/1-features/index.md': 'features/index.md'
'home/1-features/llm-integration.md': 'features/llm-integration.md'
'home/1-features/mthds-language.md': 'features/mthds-language.md'
'home/1-features/pipe-operators.md': 'features/pipe-operators.md'
'home/1-features/pipeline-orchestration.md': 'features/pipeline-orchestration.md'
'home/1-features/plxt.md': 'features/plxt.md'
'home/1-features/telemetry.md': 'features/telemetry.md'
'home/1-features/validation-dry-run.md': 'features/validation-dry-run.md'
'home/1-features/web-search.md': 'features/web-search.md'
'home/10-advanced-customizations/content-generator-injection.md': 'advanced/content-generator-injection.md'
'home/10-advanced-customizations/index.md': 'advanced/index.md'
'home/10-advanced-customizations/observer-provider-injection.md': 'advanced/observer-provider-injection.md'
'home/10-advanced-customizations/pipe-router-injection.md': 'advanced/pipe-router-injection.md'
'home/10-advanced-customizations/reporting-delegate-injection.md': 'advanced/reporting-delegate-injection.md'
'home/10-advanced-customizations/secrets-provider-injection.md': 'advanced/secrets-provider-injection.md'
'home/10-advanced-customizations/storage-provider-injection.md': 'advanced/storage-provider-injection.md'
'get-started/write-methods-manually.md': 'get-started/mthds-language-tutorial.md'
'home/2-get-started/write-methods-manually.md': 'get-started/mthds-language-tutorial.md'
'home/3-understand-pipelex/viewpoint.md': 'viewpoint/viewpoint.md'
'home/4-cookbook-examples/extract-dpe.md': 'cookbook/extract-dpe.md'
'home/4-cookbook-examples/extract-gantt.md': 'cookbook/extract-gantt.md'
'home/4-cookbook-examples/extract-generic.md': 'cookbook/extract-generic.md'
'home/4-cookbook-examples/extract-proof-of-purchase.md': 'cookbook/extract-proof-of-purchase.md'
'home/4-cookbook-examples/extract-table.md': 'cookbook/extract-table.md'
'home/4-cookbook-examples/hello-world.md': 'cookbook/hello-world.md'
'home/4-cookbook-examples/index.md': 'cookbook/index.md'
'home/4-cookbook-examples/invoice-extractor.md': 'cookbook/extract-invoice.md'
'home/4-cookbook-examples/simple-ocr.md': 'cookbook/index.md'
'cookbook/simple-ocr.md': 'cookbook/index.md'
'cookbook/invoice-extractor.md': 'cookbook/extract-invoice.md'
'home/4-cookbook-examples/write-tweet.md': 'cookbook/write-tweet.md'
'home/5-setup/configure-ai-providers.md': 'get-started/configure-ai-providers.md'
'home/5-setup/gateway-models.md': 'setup/gateway-models.md'
'home/5-setup/index.md': 'get-started/build-with-claude-code.md'
'home/5-setup/project-organization.md': 'get-started/build-with-claude-code.md'
'home/5-setup/telemetry.md': 'setup/telemetry.md'
'setup/index.md': 'get-started/build-with-claude-code.md'
'setup/project-organization.md': 'get-started/build-with-claude-code.md'
'setup/configure-ai-providers.md': 'get-started/configure-ai-providers.md'
'home/6-build-reliable-ai-workflows/adapt-to-llm-prompting-style-openai-anthropic-mistral.md': 'building-methods/adapt-to-llm-prompting-style-openai-anthropic-mistral.md'
'home/6-build-reliable-ai-workflows/concepts/define_your_concepts.md': 'building-methods/concepts/define_your_concepts.md'
'home/6-build-reliable-ai-workflows/concepts/inline-structures.md': 'building-methods/concepts/inline-structures.md'
'home/6-build-reliable-ai-workflows/concepts/native-concepts.md': 'building-methods/concepts/native-concepts.md'
'home/6-build-reliable-ai-workflows/concepts/python-classes.md': 'building-methods/concepts/python-classes.md'
'home/6-build-reliable-ai-workflows/concepts/refining-concepts.md': 'building-methods/concepts/refining-concepts.md'
'home/6-build-reliable-ai-workflows/configure-ai-llm-to-optimize-methods.md': 'building-methods/configure-ai-llm-to-optimize-methods.md'
'home/6-build-reliable-ai-workflows/domain.md': 'building-methods/domain.md'
'home/6-build-reliable-ai-workflows/kick-off-a-methods-project.md': 'building-methods/kick-off-a-methods-project.md'
'home/6-build-reliable-ai-workflows/llm-structured-generation-config.md': 'under-the-hood/build-time-elaboration.md'
'building-methods/llm-structured-generation-config.md': 'under-the-hood/build-time-elaboration.md'
'home/6-build-reliable-ai-workflows/libraries.md': 'building-methods/libraries.md'
'home/6-build-reliable-ai-workflows/packages.md': 'building-methods/packages.md'
'home/6-build-reliable-ai-workflows/pipelex-bundle-specification.md': 'building-methods/pipelex-bundle-specification.md'
'home/6-build-reliable-ai-workflows/pipes/executing-pipelines.md': 'building-methods/pipes/executing-pipelines.md'
'home/6-build-reliable-ai-workflows/pipes/index.md': 'building-methods/pipes/index.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-controllers/PipeBatch.md': 'building-methods/pipes/pipe-controllers/PipeBatch.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-controllers/PipeCondition.md': 'building-methods/pipes/pipe-controllers/PipeCondition.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-controllers/PipeParallel.md': 'building-methods/pipes/pipe-controllers/PipeParallel.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-controllers/PipeSequence.md': 'building-methods/pipes/pipe-controllers/PipeSequence.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-controllers/index.md': 'building-methods/pipes/pipe-controllers/index.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeCompose.md': 'building-methods/pipes/pipe-operators/PipeCompose.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeExtract.md': 'building-methods/pipes/pipe-operators/PipeExtract.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeFunc.md': 'building-methods/pipes/pipe-operators/PipeFunc.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeImgGen.md': 'building-methods/pipes/pipe-operators/PipeImgGen.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeLLM.md': 'building-methods/pipes/pipe-operators/PipeLLM.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeSearch.md': 'building-methods/pipes/pipe-operators/PipeSearch.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-operators/index.md': 'building-methods/pipes/pipe-operators/index.md'
'home/6-build-reliable-ai-workflows/pipes/pipe-output.md': 'building-methods/pipes/pipe-output.md'
'home/6-build-reliable-ai-workflows/pipes/provide-inputs.md': 'building-methods/pipes/provide-inputs.md'
'home/6-build-reliable-ai-workflows/pipes/understanding-multiplicity.md': 'building-methods/pipes/understanding-multiplicity.md'
'home/6-build-reliable-ai-workflows/pipes/working-memory.md': 'building-methods/pipes/working-memory.md'
'home/7-configuration/config-pipeline-validation/dry-run-config.md': 'configuration/config-pipeline-validation/dry-run-config.md'
'home/7-configuration/config-practical/logging-config.md': 'configuration/config-practical/logging-config.md'
'home/7-configuration/config-practical/pipe-run-config.md': 'configuration/config-practical/pipe-run-config.md'
'home/7-configuration/config-practical/reporting-config.md': 'configuration/config-practical/reporting-config.md'
'home/7-configuration/config-practical/telemetry-config.md': 'configuration/config-practical/telemetry-config.md'
'home/7-configuration/config-technical/aws-config.md': 'configuration/config-technical/aws-config.md'
'home/7-configuration/config-technical/cogt-config.md': 'configuration/config-technical/cogt-config.md'
'home/7-configuration/config-technical/inference-backend-config.md': 'configuration/config-technical/inference-backend-config.md'
'home/7-configuration/config-technical/library-config.md': 'configuration/config-technical/library-config.md'
'home/7-configuration/index.md': 'configuration/index.md'
'home/8-analytics/data-extraction.md': 'analytics/data-extraction.md'
'home/9-tools/cli/agent-cli.md': 'tools/cli/agent-cli.md'
'home/9-tools/cli/build/index.md': 'tools/cli/build/index.md'
'home/9-tools/cli/build/inputs.md': 'tools/cli/build/inputs.md'
'home/9-tools/cli/build/output.md': 'tools/cli/build/output.md'
'home/9-tools/cli/build/runner.md': 'tools/cli/build/runner.md'
'home/9-tools/cli/build/structures.md': 'tools/cli/build/structures.md'
'home/9-tools/cli/index.md': 'tools/cli/index.md'
'home/9-tools/cli/init.md': 'tools/cli/init.md'
'home/9-tools/cli/pkg.md': 'tools/cli/pkg.md'
'home/9-tools/cli/run.md': 'tools/cli/run.md'
'home/9-tools/cli/show.md': 'tools/cli/show.md'
'home/9-tools/cli/validate.md': 'tools/cli/validate.md'
'home/9-tools/logging.md': 'tools/logging.md'
'home/9-tools/plxt.md': 'tools/plxt.md'
- meta-manager
- glightbox:
touchNavigation: true
loop: false
effect: zoom
slide_effect: slide
width: 100%
height: auto
zoomable: true
draggable: true
auto_caption: false
caption_position: bottom
- llmstxt-md:
sections:
Get Started:
- index.md: "Build & Run AI Methods (landing page)"
- get-started/build-with-claude-code.md: "Build with Claude Code"
- get-started/mthds-language-tutorial.md: "The MTHDS Language Tutorial"
- get-started/configure-ai-providers.md: "Configure AI Providers"
Cookbook Examples:
- cookbook/index.md: "Cookbook Overview"
- cookbook/hello-world.md: "Hello World"
- cookbook/summarize.md: "Summarize"
- cookbook/extract-generic.md: "Extract Generic Document"
- cookbook/extract-invoice.md: "Extract Invoice"
- cookbook/extract-proof-of-purchase.md: "Extract Proof of Purchase"
- cookbook/extract-dpe.md: "Extract DPE (Energy Diagnostic)"
- cookbook/extract-table.md: "Extract Table from Image"
- cookbook/extract-gantt.md: "Extract Gantt Chart"
- cookbook/extract-markdown.md: "Extract Markdown from Document"
- cookbook/extract-slides.md: "Extract Slides from Presentation"
- cookbook/design-slides.md: "Design Slides"
- cookbook/generate-image.md: "Generate Image"
- cookbook/gen-synthetic-data.md: "Generate Synthetic Data"
- cookbook/gen-expense-data.md: "Generate Expense Data with Receipts"
- cookbook/using-inference-plugins.md: "Using Inference Plugins"
Viewpoint:
- viewpoint/viewpoint.md: "The Know-How Graph"
Features:
- features/index.md: "Features Overview"
- features/mthds-language.md: "MTHDS Language"
- features/concepts.md: "Concepts & Structured Types"
- features/pipe-operators.md: "Pipe Operators"
- features/pipeline-orchestration.md: "Pipeline Orchestration"
- features/gateway.md: "Pipelex Gateway & Model Access"
- features/llm-integration.md: "LLM Integration"
- features/document-extraction.md: "Document Extraction"
- features/image-generation.md: "Image Generation"
- features/web-search.md: "Web Search"
- features/claude-code-skills-plugin.md: "Claude Code Skills Plugin"
- features/cli.md: "CLI"
- features/plxt.md: "plxt Formatter & Linter"
- features/execution-graph.md: "Execution Graph Visualization"
- features/validation-dry-run.md: "Validation & Dry Run"
- features/telemetry.md: "Telemetry & Observability"
- features/cloud-storage.md: "Cloud Storage"
- features/cost-tracking.md: "Cost Tracking & Reporting"
- features/configuration.md: "Configuration System"
- features/advanced-customizations.md: "Advanced Customizations"
Building Methods:
- building-methods/kick-off-a-methods-project.md: "Kick off a Method Project"
- building-methods/pipelex-bundle-specification.md: "Pipelex Bundle Specification"
- building-methods/domain.md: "Domain"
- building-methods/concepts/define_your_concepts.md: "Define Your Concepts"
- building-methods/concepts/inline-structures.md: "Inline Structures"
- building-methods/concepts/python-classes.md: "Python Classes"
- building-methods/concepts/native-concepts.md: "Native Concepts"
- building-methods/concepts/refining-concepts.md: "Refining Concepts"
- building-methods/pipes/index.md: "Design and Run Methods Overview"
- building-methods/libraries.md: "Libraries"
- building-methods/packages.md: "Packages"
- building-methods/pipes/executing-pipelines.md: "Executing Pipelines"
- building-methods/pipes/run-modes-and-backends.md: "Run Modes & Backends"
- building-methods/pipes/provide-inputs.md: "Providing Inputs to Pipelines"
- building-methods/pipes/working-memory.md: "Working Memory"
- building-methods/pipes/pipe-output.md: "Pipe Output"
- building-methods/pipes/understanding-multiplicity.md: "Understanding Multiplicity"
- building-methods/pipes/pipe-operators/index.md: "Pipe Operators Overview"
- building-methods/pipes/pipe-operators/PipeLLM.md: "PipeLLM"
- building-methods/pipes/pipe-operators/PipeStructure.md: "PipeStructure"
- building-methods/pipes/pipe-operators/PipeExtract.md: "PipeExtract"
- building-methods/pipes/pipe-operators/PipeImgGen.md: "PipeImgGen"
- building-methods/pipes/pipe-operators/PipeSearch.md: "PipeSearch"
- building-methods/pipes/pipe-operators/PipeCompose.md: "PipeCompose"
- building-methods/pipes/pipe-operators/PipeFunc.md: "PipeFunc"
- building-methods/pipes/pipe-controllers/index.md: "Pipe Controllers Overview"
- building-methods/pipes/pipe-controllers/PipeSequence.md: "PipeSequence"
- building-methods/pipes/pipe-controllers/PipeParallel.md: "PipeParallel"
- building-methods/pipes/pipe-controllers/PipeBatch.md: "PipeBatch"
- building-methods/pipes/pipe-controllers/PipeCondition.md: "PipeCondition"
- building-methods/pipes/signature-pipes.md: "Signature Pipes"
- building-methods/configure-ai-llm-to-optimize-methods.md: "Optimize Cost & Quality"
- building-methods/adapt-to-llm-prompting-style-openai-anthropic-mistral.md: "LLM Prompting Style"
Reference:
- tools/cli/index.md: "CLI Reference Overview"
- tools/cli/init.md: "CLI Init"
- tools/cli/update.md: "CLI Update"
- tools/cli/validate.md: "CLI Validate"
- tools/cli/run.md: "CLI Run"
- tools/cli/show.md: "CLI Show"
- tools/cli/pkg.md: "CLI Pkg"
- tools/cli/build/index.md: "CLI Build Overview"
- tools/cli/build/runner.md: "CLI Build Runner"
- tools/cli/build/structures.md: "CLI Build Structures"
- tools/cli/build/inputs.md: "CLI Build Inputs"
- tools/cli/build/output.md: "CLI Build Output"
- tools/cli/agent-cli.md: "Agent CLI"
- configuration/index.md: "Configuration Overview"
- configuration/config-pipeline-validation/dry-run-config.md: "Dry Run Configuration"
- configuration/config-practical/logging-config.md: "Logging Configuration"
- configuration/config-practical/pipe-run-config.md: "Pipe Run Configuration"
- configuration/config-practical/reporting-config.md: "Reporting Configuration"
- configuration/config-practical/telemetry-config.md: "Telemetry Configuration"
- configuration/config-technical/aws-config.md: "AWS Configuration"
- configuration/config-technical/cogt-config.md: "Cogt Configuration"
- configuration/config-technical/inference-backend-config.md: "LLM Providers & Models Configuration"
- configuration/config-technical/library-config.md: "Library Configuration"
- tools/plxt.md: "plxt (Formatter & Linter)"
- tools/logging.md: "Logging"
- analytics/data-extraction.md: "Observer Data Extraction"
- setup/telemetry.md: "Telemetry"
- setup/gateway-models.md: "Gateway Available Models"
Advanced:
- advanced/index.md: "Advanced Customizations Overview"
- advanced/secrets-provider-injection.md: "Secrets Provider"
- advanced/reporting-delegate-injection.md: "Reporting Delegate"
- advanced/storage-provider-injection.md: "Storage Provider"
- advanced/observer-provider-injection.md: "Observer"
- advanced/content-generator-injection.md: "Content Generator"
- advanced/pipe-router-injection.md: "Pipe Router"
Under the Hood:
- under-the-hood/index.md: "Under the Hood Overview"
- under-the-hood/architecture-overview.md: "Architecture Overview"
- under-the-hood/build-time-elaboration.md: "Build-time Elaboration"
- under-the-hood/dry-run-mock-generation.md: "Dry Run Mock Generation"
- under-the-hood/execution-graph-tracing.md: "Execution Graph Tracing"
- under-the-hood/image-handling-in-llm-prompts.md: "Image Handling in LLM Prompts"
- under-the-hood/reasoning-controls.md: "Reasoning Controls"
- under-the-hood/stuffartefact-and-image-rendering.md: "StuffArtefact & Image Rendering"
- under-the-hood/test-profile-configuration.md: "Test Profile Configuration"
- under-the-hood/init-cli-flows.md: "Init CLI Flows"
- under-the-hood/pipe-routing-and-execution.md: "Pipe Routing & Execution"
- under-the-hood/inference-backend-plugins.md: "Inference Backend Plugins"
- under-the-hood/orchestrator-plugins.md: "Orchestrator Plugins"
- under-the-hood/error-model.md: "Error Model"
- under-the-hood/runtime-bridge-and-transport.md: "Runtime Bridge & Transport"
- under-the-hood/distributed-content-generation.md: "Content Generation Across Boundaries"
Project:
- contributing.md: "Contributing"
- contribute/configuration-defaults-and-overrides.md: "Configuration Internals"
- contribute/keyword-only-arguments.md: "Keyword-Only Arguments"
- changelog.md: "Changelog"
markdown_extensions:
- meta
- sane_lists
- admonition
- attr_list
- md_in_html
- pymdownx.blocks.caption
- pymdownx.highlight:
use_pygments: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets:
base_path: .
check_paths: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra_css:
- stylesheets/mermaid.css
- stylesheets/general.css
# Pages intentionally excluded from the user-facing nav.
#
# - `CLAUDE.md` is a docs-authoring guide for contributors, not a published page.
# - `errors/*.md` are generated reference stubs (one per PipelexError subclass) reached
# via the RFC 7807 `type` URI carried on every ErrorReport. They are not part of any
# guided navigation flow — the only nav entries are the landing page `errors/index.md`
# and the macro listing pages (`errors/authoring-and-language.md`, etc., re-included
# below), and the individual per-class pages live as orphan pages whose existence is
# declared here so `mkdocs build --strict` does not flag them as accidentally unlisted.
# - `agents/*.md` are AI-agent-facing playbooks (debugging workflows, environment
# gotchas) referenced from the root `CLAUDE.md`. They are built and searchable but
# intentionally kept out of the user-facing nav so they don't clutter the reading
# flow for human readers of the docs site.
not_in_nav: |
CLAUDE.md
errors/*.md
!errors/index.md
!errors/authoring-and-language.md
!errors/execution-and-runtime.md
!errors/inference-and-providers.md
!errors/platform-and-tooling.md
agents/*.md
nav:
- Get Started:
- Build & Run AI Methods: index.md
- Build with Claude Code: get-started/build-with-claude-code.md
- The MTHDS Language Tutorial: get-started/mthds-language-tutorial.md
- Configure AI Providers: get-started/configure-ai-providers.md
- Cookbook Examples:
- Overview: cookbook/index.md
- Quick Start:
- Hello World: cookbook/hello-world.md
- Summarize: cookbook/summarize.md
- Document Extraction:
- Generic Document: cookbook/extract-generic.md
- Invoice: cookbook/extract-invoice.md
- Proof of Purchase: cookbook/extract-proof-of-purchase.md
- DPE (Energy Diagnostic): cookbook/extract-dpe.md
- Table from Image: cookbook/extract-table.md
- Gantt Chart: cookbook/extract-gantt.md
- Markdown from Document: cookbook/extract-markdown.md
- Slides from Presentation: cookbook/extract-slides.md
- Visual Generation:
- Design Slides: cookbook/design-slides.md
- Generate Image: cookbook/generate-image.md
- Advanced:
- Synthetic Data: cookbook/gen-synthetic-data.md
- Expense Data with Receipts: cookbook/gen-expense-data.md
- Using Inference Plugins: cookbook/using-inference-plugins.md
- Work in Progress:
- Tweet Optimizer: cookbook/write-tweet.md
- Blog Article Generator: cookbook/blog-article-generator.md
- Advisory Board: cookbook/advisory-board.md
- Discord Newsletter: cookbook/discord-newsletter.md
- Expense Validation: cookbook/validate-expense-data.md
- Viewpoint:
- The Know-How Graph: viewpoint/viewpoint.md
- Guide:
- Features:
- Overview: features/index.md
- Declarative AI Methods:
- MTHDS Language: features/mthds-language.md
- Concepts & Structured Types: features/concepts.md
- Pipe Operators: features/pipe-operators.md
- Pipeline Orchestration: features/pipeline-orchestration.md
- AI Capabilities:
- Pipelex Gateway & Model Access: features/gateway.md
- LLM Integration: features/llm-integration.md
- Document Extraction: features/document-extraction.md
- Image Generation: features/image-generation.md
- Web Search: features/web-search.md
- Developer Tools:
- Claude Code Skills Plugin: features/claude-code-skills-plugin.md
- CLI: features/cli.md
- plxt Formatter & Linter: features/plxt.md
- Execution Graph Visualization: features/execution-graph.md
- Production & Operations:
- Validation & Dry Run: features/validation-dry-run.md
- Distributed Execution: features/distributed-execution.md
- Telemetry & Observability: features/telemetry.md
- Cloud Storage: features/cloud-storage.md
- Cost Tracking & Reporting: features/cost-tracking.md
- Configuration & Extensibility:
- Configuration System: features/configuration.md
- Advanced Customizations: features/advanced-customizations.md
- Build Reliable AI Methods:
- Kick off a Method Project: building-methods/kick-off-a-methods-project.md
- Pipelex Bundle Specification: building-methods/pipelex-bundle-specification.md
- Domain: building-methods/domain.md
- Concepts:
- Define Your Concepts: building-methods/concepts/define_your_concepts.md
- Inline structures: building-methods/concepts/inline-structures.md
- Python classes: building-methods/concepts/python-classes.md
- Native Concepts: building-methods/concepts/native-concepts.md
- Refining Concepts: building-methods/concepts/refining-concepts.md
- Design and Run Methods:
- Overview: building-methods/pipes/index.md
- Libraries: building-methods/libraries.md
- Packages: building-methods/packages.md
- Executing Pipelines: building-methods/pipes/executing-pipelines.md
- Run Modes & Backends: building-methods/pipes/run-modes-and-backends.md
- Providing Inputs to Pipelines: building-methods/pipes/provide-inputs.md
- Working Memory: building-methods/pipes/working-memory.md
- Pipe Output: building-methods/pipes/pipe-output.md
- CSV Input & Output: building-methods/pipes/csv-input-and-output.md
- Understanding Multiplicity: building-methods/pipes/understanding-multiplicity.md
- Pipe Operators:
- Overview: building-methods/pipes/pipe-operators/index.md
- PipeLLM: building-methods/pipes/pipe-operators/PipeLLM.md
- PipeStructure: building-methods/pipes/pipe-operators/PipeStructure.md
- PipeExtract: building-methods/pipes/pipe-operators/PipeExtract.md
- PipeImgGen: building-methods/pipes/pipe-operators/PipeImgGen.md
- PipeSearch: building-methods/pipes/pipe-operators/PipeSearch.md
- PipeCompose: building-methods/pipes/pipe-operators/PipeCompose.md
- PipeFunc: building-methods/pipes/pipe-operators/PipeFunc.md
- Pipe Controllers:
- Overview: building-methods/pipes/pipe-controllers/index.md
- PipeSequence: building-methods/pipes/pipe-controllers/PipeSequence.md
- PipeParallel: building-methods/pipes/pipe-controllers/PipeParallel.md
- PipeBatch: building-methods/pipes/pipe-controllers/PipeBatch.md
- PipeCondition: building-methods/pipes/pipe-controllers/PipeCondition.md
- Signature Pipes: building-methods/pipes/signature-pipes.md
- Optimize Cost & Quality: building-methods/configure-ai-llm-to-optimize-methods.md
- LLM Prompting Style: building-methods/adapt-to-llm-prompting-style-openai-anthropic-mistral.md
- Retries & Resilience:
- Overview: reliability/retries-and-resilience.md
- Automatic Retries: reliability/automatic-retries.md
- Failure Classification: reliability/failure-classification.md
- Durable Execution: reliability/durable-execution.md
- Distributed Execution: distributed-execution/index.md
- Reference:
- Gateway Available Models: setup/gateway-models.md
- CLI Reference:
- Overview: tools/cli/index.md
- Init: tools/cli/init.md
- Update: tools/cli/update.md
- Validate: tools/cli/validate.md
- Run: tools/cli/run.md
- Show: tools/cli/show.md
- Pkg: tools/cli/pkg.md
- Build:
- Overview: tools/cli/build/index.md
- Runner: tools/cli/build/runner.md
- Structures: tools/cli/build/structures.md
- Inputs: tools/cli/build/inputs.md
- Output: tools/cli/build/output.md
- Agent CLI: tools/cli/agent-cli.md
- Tools:
- plxt (Formatter & Linter): tools/plxt.md
- Logging: tools/logging.md
- Analytics:
- Observer Data Extraction: analytics/data-extraction.md
- Telemetry: setup/telemetry.md
- Error Reference:
- Overview: errors/index.md
- Authoring & language: errors/authoring-and-language.md
- Execution & runtime: errors/execution-and-runtime.md
- Inference & providers: errors/inference-and-providers.md
- Platform & tooling: errors/platform-and-tooling.md
- Configuration (TOML reference):
- Overview: configuration/index.md
- Pipeline Validation Configuration:
- Dry Run: configuration/config-pipeline-validation/dry-run-config.md
- Practical Configuration:
- Logging: configuration/config-practical/logging-config.md
- Pipe Run: configuration/config-practical/pipe-run-config.md
- Reporting: configuration/config-practical/reporting-config.md
- Telemetry: configuration/config-practical/telemetry-config.md
- Technical Configuration:
- AWS: configuration/config-technical/aws-config.md
- Cogt: configuration/config-technical/cogt-config.md
- LLM Providers & Models: configuration/config-technical/inference-backend-config.md
- Library: configuration/config-technical/library-config.md
- Advanced:
- Advanced Customizations:
- Overview: advanced/index.md
- Secrets Provider: advanced/secrets-provider-injection.md
- Reporting Delegate: advanced/reporting-delegate-injection.md
- Storage Provider: advanced/storage-provider-injection.md
- Observer: advanced/observer-provider-injection.md
- Content Generator: advanced/content-generator-injection.md
- Pipe Router: advanced/pipe-router-injection.md
- Under the Hood:
- Overview: under-the-hood/index.md
- Architecture Overview: under-the-hood/architecture-overview.md
- Build-time Elaboration: under-the-hood/build-time-elaboration.md
- Dry Run Mock Generation: under-the-hood/dry-run-mock-generation.md
- Execution Graph Tracing: under-the-hood/execution-graph-tracing.md
- Image Handling in LLM Prompts: under-the-hood/image-handling-in-llm-prompts.md
- Reasoning Controls: under-the-hood/reasoning-controls.md
- StuffArtefact & Image Rendering: under-the-hood/stuffartefact-and-image-rendering.md
- Test Profile Configuration: under-the-hood/test-profile-configuration.md
- Init CLI Flows: under-the-hood/init-cli-flows.md
- Pipe Routing & Execution: under-the-hood/pipe-routing-and-execution.md
- Inference Backend Plugins: under-the-hood/inference-backend-plugins.md
- Orchestrator Plugins: under-the-hood/orchestrator-plugins.md
- Error Model: under-the-hood/error-model.md
- Runtime Bridge & Transport: under-the-hood/runtime-bridge-and-transport.md
- Content Generation Across Boundaries: under-the-hood/distributed-content-generation.md
- Project:
- Contributing: contributing.md
- Configuration Internals: contribute/configuration-defaults-and-overrides.md
- Keyword-Only Arguments: contribute/keyword-only-arguments.md
- Code of Conduct: CODE_OF_CONDUCT.md
- License: license.md
- Changelog: changelog.md
- API: https://pipelex.github.io/pipelex-api/