Build AI methods with your coding agent, then run them anywhere: as an MCP for chatbots, as a webapp for people, or via API for your software.
Docs/readme and docs (#403)
Louis Choquel76c58fae359c
diff --git a/.badges/tests.json b/.badges/tests.jsonindex b4577a5a0..277b19238 100644--- a/.badges/tests.json+++ b/.badges/tests.json@@ -1,7 +1,7 @@{"schemaVersion": 1,"label": "tests",- "message": "1381",+ "message": "1389","color": "blue","cacheSeconds": 300}\ No newline at end of filediff --git a/.pipelex/inference/backends.toml b/.pipelex/inference/backends.tomlindex f330e0513..baa5cb563 100644--- a/.pipelex/inference/backends.toml+++ b/.pipelex/inference/backends.toml@@ -1,3 +1,15 @@+####################################################################################################+# Pipelex Inference Backends Configuration+####################################################################################################+#+# This file configures the inference backends available to Pipelex.+# Each backend connects to a different AI service provider (OpenAI, Anthropic, Google, etc.).+#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#+####################################################################################################+[pipelex_inference]display_name = "⭐ Pipelex Inference"enabled = true@@ -12,7 +24,7 @@ api_key = "${AZURE_API_KEY}"api_version = "${AZURE_API_VERSION}"[bedrock]-display_name = "AWS Bedrock"+display_name = "Amazon Bedrock"enabled = trueaws_region = "${AWS_REGION}"diff --git a/.pipelex/inference/backends/anthropic.toml b/.pipelex/inference/backends/anthropic.tomlindex e0daf1c3a..4b57964c4 100644--- a/.pipelex/inference/backends/anthropic.toml+++ b/.pipelex/inference/backends/anthropic.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["claude-3.5-sonnet"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/azure_openai.toml b/.pipelex/inference/backends/azure_openai.tomlindex 5943007c4..135638ad5 100644--- a/.pipelex/inference/backends/azure_openai.toml+++ b/.pipelex/inference/backends/azure_openai.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gpt-4.1"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/bedrock.toml b/.pipelex/inference/backends/bedrock.tomlindex e572302c8..c27baf0b5 100644--- a/.pipelex/inference/backends/bedrock.toml+++ b/.pipelex/inference/backends/bedrock.toml@@ -1,16 +1,19 @@################################################################################-# AWS Bedrock Backend Configuration+# Amazon Bedrock Backend Configuration#################################################################################-# This file defines the model specifications for AWS Bedrock models.+# This file defines the model specifications for Amazon Bedrock models.# It contains model definitions for various language models-# accessible through the AWS Bedrock service.+# accessible through the Amazon Bedrock service.## Configuration structure:# - Each model is defined in its own section with the model name as the header# - Headers with dots must be quoted (e.g., ["claude-3.5-sonnet"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/blackboxai.toml b/.pipelex/inference/backends/blackboxai.tomlindex 4202fd79b..916603304 100644--- a/.pipelex/inference/backends/blackboxai.toml+++ b/.pipelex/inference/backends/blackboxai.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gpt-4.5-preview"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/fal.toml b/.pipelex/inference/backends/fal.tomlindex ed15e6bd3..d54a25fcc 100644--- a/.pipelex/inference/backends/fal.toml+++ b/.pipelex/inference/backends/fal.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["flux-pro/v1.1"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/google.toml b/.pipelex/inference/backends/google.tomlindex 7fdc6cd64..68c39d9d5 100644--- a/.pipelex/inference/backends/google.toml+++ b/.pipelex/inference/backends/google.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gemini-2.0-flash"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/internal.toml b/.pipelex/inference/backends/internal.tomlindex 0dbd6e7be..5bb968356 100644--- a/.pipelex/inference/backends/internal.toml+++ b/.pipelex/inference/backends/internal.toml@@ -9,6 +9,9 @@# - Each model is defined in its own section with the model name as the header# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/mistral.toml b/.pipelex/inference/backends/mistral.tomlindex 634736c74..97e40d0d0 100644--- a/.pipelex/inference/backends/mistral.toml+++ b/.pipelex/inference/backends/mistral.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["ministral-3b"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/ollama.toml b/.pipelex/inference/backends/ollama.tomlindex 7a56b7384..ab0f51617 100644--- a/.pipelex/inference/backends/ollama.toml+++ b/.pipelex/inference/backends/ollama.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["mistral-small3.1-24b"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/openai.toml b/.pipelex/inference/backends/openai.tomlindex 4eabe7491..4f1148144 100644--- a/.pipelex/inference/backends/openai.toml+++ b/.pipelex/inference/backends/openai.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gpt-4.1"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/perplexity.toml b/.pipelex/inference/backends/perplexity.tomlindex ea905512c..3fa52fccf 100644--- a/.pipelex/inference/backends/perplexity.toml+++ b/.pipelex/inference/backends/perplexity.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["sonar-pro"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/pipelex_inference.toml b/.pipelex/inference/backends/pipelex_inference.tomlindex c04fe8563..805b761ad 100644--- a/.pipelex/inference/backends/pipelex_inference.toml+++ b/.pipelex/inference/backends/pipelex_inference.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gpt-4.1"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/vertexai.toml b/.pipelex/inference/backends/vertexai.tomlindex cb8edb13e..da01d4f1e 100644--- a/.pipelex/inference/backends/vertexai.toml+++ b/.pipelex/inference/backends/vertexai.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gemini-2.0-flash"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/backends/xai.toml b/.pipelex/inference/backends/xai.tomlindex 545b905f2..a4bb433ad 100644--- a/.pipelex/inference/backends/xai.toml+++ b/.pipelex/inference/backends/xai.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["grok-3"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/.pipelex/inference/deck/base_deck.toml b/.pipelex/inference/deck/base_deck.tomlindex 7a52ca603..ff09ecf6d 100644--- a/.pipelex/inference/deck/base_deck.toml+++ b/.pipelex/inference/deck/base_deck.toml@@ -1,5 +1,16 @@--# Base model deck+####################################################################################################+# Pipelex Model Deck - Base Configuration+####################################################################################################+#+# This file defines model aliases and presets for:+# - LLMs (language models for text generation and structured output)+# - Image generation models (for creating images from text prompts)+# - Document extraction models (OCR and text extraction from PDFs/images)+#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#+######################################################################################################################################################################################################### Aliasesdiff --git a/.pipelex/inference/deck/overrides.toml b/.pipelex/inference/deck/overrides.tomlindex a6e8a49c6..08814dbc2 100644--- a/.pipelex/inference/deck/overrides.toml+++ b/.pipelex/inference/deck/overrides.toml@@ -1,4 +1,14 @@-+####################################################################################################+# Pipelex Model Deck - Overrides+####################################################################################################+#+# This file allows you to override the default model choices defined in base_deck.toml.+# You can customize presets for LLMs, image generation, and document extraction models.+#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#+######################################################################################################################################################################################################### LLM Deck overridesdiff --git a/.pipelex/inference/routing_profiles.toml b/.pipelex/inference/routing_profiles.tomlindex 40138b702..e35566fef 100644--- a/.pipelex/inference/routing_profiles.toml+++ b/.pipelex/inference/routing_profiles.toml@@ -3,6 +3,9 @@# This file controls which backend serves which model.# Simply change the 'active' field to switch profiles,# or you can add your own custom profiles.+#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord# ================================================# Which profile to use (change this to switch routing)diff --git a/.pipelex/pipelex.toml b/.pipelex/pipelex.tomlindex 5dc8a89b1..570dae25e 100644--- a/.pipelex/pipelex.toml+++ b/.pipelex/pipelex.toml@@ -21,6 +21,9 @@# - Feature flags for tracking and reporting# - Observer and reporting output directories#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#####################################################################################################[pipelex.scan_config]diff --git a/.pipelex/telemetry.toml b/.pipelex/telemetry.tomlindex 327955340..af98b57e8 100644--- a/.pipelex/telemetry.toml+++ b/.pipelex/telemetry.toml@@ -1,3 +1,15 @@+####################################################################################################+# Pipelex Telemetry Configuration+####################################################################################################+#+# This file controls telemetry settings for Pipelex usage analytics.+# Telemetry helps us improve Pipelex by understanding how it's used.+#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#+####################################################################################################+telemetry_mode = "anonymous" # Values: "off" | "anonymous" | "identified"host = "https://eu.i.posthog.com"project_api_key = "phc_HPJnNKpIXh0SxNDYyTAyUtnq9KxNNZJWQszynsWVx4Y"diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 2a7739ade..ea69d0843 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -2,7 +2,22 @@## Unreleased-- Added a method to provide the template inputs for a pipe in JSON.+### Added+ - **`pipelex doctor` command**: Diagnoses and fixes common configuration issues including missing files, invalid telemetry settings, and unset environment variables for enabled backends.+ - **Interactive backend selection in `pipelex init`**: Multi-select menu for enabling/disabling inference backends (OpenAI, Anthropic, Amazon Bedrock, etc.).+ - **JSON input support**: `pipelex run --inputs` flag accepts a JSON file path for passing structured data to pipelines.+ - **`pretty_print` methods**: Added to `PipeSpec`, `ConceptSpec`, and `Stuff` objects for readable debugging output.+ - **VS Code debug configuration**: "Debug run pipe" launch configuration for debugging pipeline executions.+ - **`display_name` attribute**: Added to all inference backends in `backends.toml` for better UI presentation.+ - **Documentation headers**: All default `.toml` configuration files now include headers with links to documentation and support channels.++### Changed+ - **`pipelex init` redesign**: Transformed into a unified, interactive setup wizard with rich terminal UI for configuration files, backend selection, and telemetry preferences. Telemetry is now configured here instead of via first-run prompt.+ - **`README.md` rewrite**: Complete overhaul featuring a simplified 5-step quick-start guide highlighting the `pipelex build` command.+ - **Documentation updates**: "Quick Start" guide renamed to "Writing Workflows" with simplified content. Python examples updated to use JSON input method, removing manual `Stuff` and `WorkingMemory` object creation boilerplate. Developer guides and AI assistant rules now recommend `pipelex validate` over `make validate`. Added instructions emphasizing `.venv` activation before running commands.+ - **Error handling improvements**: Pipelines now validate required inputs upfront and fail early with `PipeRunInputsError`. `pipelex run` prints full rich-formatted exception tracebacks on error.+ - **Default enabled backends**: Amazon Bedrock, Google AI, and Google Vertex AI are now enabled by default.+ - **Naming consistency**: "AWS Bedrock" renamed to "Amazon Bedrock" throughout codebase, configuration, and documentation.## [v0.13.2] - 2025-10-25@@ -314,7 +329,7 @@ This is all in the spirit of making Pipelex a declarative language, where you exWe've completely redesigned how LLMs are configured and accessed in Pipelex, making it more flexible and easier to get started:- **Get started in seconds** with [Pipelex Inference](pages/configuration/config-technical/inference-backend-config.md): Use a single API key to access all major LLM providers (OpenAI, Anthropic, Google, Mistral, and more)-- **Flexible backend configuration**: Configure multiple inference backends (Azure OpenAI, AWS Bedrock, Vertex AI, etc.) through simple TOML files in `.pipelex/inference/`+- **Flexible backend configuration**: Configure multiple inference backends (Azure OpenAI, Amazon Bedrock, Vertex AI, etc.) through simple TOML files in `.pipelex/inference/`- **Smart model routing**: Automatically route models to the right backend using [routing profiles](pages/configuration/config-technical/inference-backend-config.md#routing-profiles) with pattern matching- **User-friendly aliases**: Define shortcuts like `best-claude` → `claude-4.1-opus` with optional fallback chains- **Cost-aware model specs**: Each model includes detailed pricing, capabilities, and constraints for better cost management@@ -324,7 +339,7 @@ For complete details, see the [Inference Backend Configuration](pages/configurat### Added- New inference backend configuration system in `.pipelex/inference/` directory-- Support for 10+ inference backends: OpenAI, Anthropic, Azure OpenAI, AWS Bedrock, Mistral, Vertex AI, XAI, BlackboxAI, Perplexity, Ollama, and **Pipelex Inference**+- Support for 10+ inference backends: OpenAI, Anthropic, Azure OpenAI, Amazon Bedrock, Mistral, Vertex AI, XAI, BlackboxAI, Perplexity, Ollama, and **Pipelex Inference**- Model routing profiles with pattern matching (`*model*`, `model*`, `*model`)- Model aliases with waterfall fallback chains- Environment variable and secret substitution in TOML configs (`${VAR}` and `${secret:KEY}`)diff --git a/README.md b/README.mdindex 3e7a8254c..643f81fc0 100644--- a/README.md+++ b/README.md@@ -1,12 +1,9 @@<div align="center"><a href="https://www.pipelex.com/"><img src="https://raw.githubusercontent.com/Pipelex/pipelex/main/.github/assets/logo.png" alt="Pipelex Logo" width="400" style="max-width: 100%; height: auto;"></a>- <h2 align="center">Open-source language for repeatable AI workflows</h2>-Pipelex is an open-source devtool that transforms how you build repeatable AI workflows. Think of it as Docker or SQL for AI operations.--Create modular "pipes", each using a different LLM and guaranteeing structured outputs. Connect them like LEGO blocks sequentially, in parallel, or conditionally, to build complex knowledge transformations from simple, reusable components.--Stop reinventing AI workflows from scratch. With Pipelex, your proven methods become shareable, versioned artifacts that work across different LLMs. What took weeks to perfect can now be forked, adapted, and scaled instantly.+ <h2 align="center">AI Workflows That Agents Build & Run</h2>+ <p align="center">Pipelex is developing the open standard for repeatable AI workflows.<br/>+Write business logic, not API calls.</p><div><a href="https://go.pipelex.com/demo"><strong>Demo</strong></a> -@@ -22,7 +19,6 @@ Stop reinventing AI workflows from scratch. With Pipelex, your proven methods be<img src="https://img.shields.io/pypi/v/pipelex?logo=pypi&logoColor=white&color=blue&style=flat-square"alt="PyPI – latest release"><br/>- <br/><a href="https://go.pipelex.com/discord"><img src="https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white" alt="Discord"></a><a href="https://www.youtube.com/@PipelexAI"><img src="https://img.shields.io/badge/YouTube-FF0000?logo=youtube&logoColor=white" alt="YouTube"></a><a href="https://pipelex.com"><img src="https://img.shields.io/badge/Homepage-03bb95?logo=google-chrome&logoColor=white&style=flat" alt="Website"></a>@@ -33,354 +29,337 @@ Stop reinventing AI workflows from scratch. With Pipelex, your proven methods be<br/></div>-<div align="center">- <h2 align="center">📜 The Knowledge Pipeline Manifesto</h2>- <p align="center">- <a href="https://go.pipelex.com/manifesto"><strong>Read why we built Pipelex to transform unreliable AI workflows into deterministic pipelines 🔗</strong></a>- </p>-- <h2 align="center">🚀 See Pipelex in Action</h2>-- <table align="center">- <tr>- <td align="center" width="50%">- <h3>From Whiteboard to AI Workflow in less than 5 minutes with no hands (2025-07)</h3>- <a href="https://go.pipelex.com/demo">- <img src="https://go.pipelex.com/demo-thumbnail" alt="Pipelex Demo" width="100%" style="max-width: 500px; height: auto;">- </a>- </td>- <td align="center" width="50%">- <h3>The AI workflow that writes an AI workflow in 64 seconds (2025-09)</h3>- <a href="https://go.pipelex.com/Demo-Live">- <img src="https://d2cinlfp2qnig1.cloudfront.net/banners/pipelex_play_video_demo_live.jpg" alt="Pipelex Live Demo" width="100%" style="max-width: 500px; height: auto;">- </a>- </td>- </tr>- </table>--</div>--# 📑 Table of Contents--- [Introduction](#introduction)-- [Quick start](#-quick-start)- - [Prerequisites](#prerequisites)- - [Installation](#installation)- - [API Key Configuration](#api-key-configuration)- - [Optional features](#optional-features)-- [Contributing](#-contributing)-- [Support](#-support)-- [License](#-license)--# Introduction--Pipelex makes it easy for developers to define and run repeatable AI workflows. At its core is a clear, declarative pipeline language specifically crafted for knowledge-processing tasks.--Build **pipelines** from modular pipes that snap together. Each pipe can use different AI models - language models (LLMs) for text generation, OCR models for document processing, or image generation models for creating visuals. Pipes consistently deliver **structured, predictable outputs** at each stage.--Pipelex uses its own syntax PLX, based on TOML, making workflows readable and shareable. Business professionals, developers, and AI coding agents can all understand and modify the same pipeline definitions.--Example:-```plx-[concept]-Buyer = "The person who made the purchase"-PurchaseDocumentText = "Transcript of a receipt, invoice, or order confirmation"--[pipe.extract_buyer]-type = "PipeLLM"-description = "Extract buyer from purchase document"-inputs = { purchase_document_text = "PurchaseDocumentText" }-output = "Buyer"-model = "llm_to_extract_info"-prompt = """-Extract the first and last name of the buyer from this purchase document:-@purchase_document_text-"""-```--Pipes are modular building blocks that **connect sequentially, run in parallel, or call sub-pipes.** Like function calls in traditional programming, but with a clear contract: knowledge-in, knowledge-out. This modularity makes pipelines perfect for sharing: fork someone's invoice processor, adapt it for receipts, share it back.--Pipelex is an **open-source Python library** with a hosted API launching soon. It integrates seamlessly into existing systems and automation frameworks. Plus, it works as an [MCP server](https://github.com/Pipelex/pipelex-mcp) so AI agents can use pipelines as tools.-# 🚀 Quick start-> :books: Note that you can check out the [Pipelex Documentation](https://docs.pipelex.com/) for more information and clone the [Pipelex Cookbook](https://github.com/Pipelex/pipelex-cookbook) repository for ready-to-run examples.+## 1. Install Pipelex-Follow these steps to get started:--## Installation+```bash+pip install pipelex+pipelex init+```-### Prerequisites+## 2. Get Your API Key (Free)-- Python ≥3.10-- [pip](https://pip.pypa.io/en/stable/), [poetry](https://python-poetry.org/), or [uv](https://github.com/astral-sh/uv) package manager+To use AI models, you need an API key:-We **highly** recommend installing our own extension for PLX files into your IDE of choice. You can find it in the [Open VSX Registry](https://open-vsx.org/extension/Pipelex/pipelex). It's coming soon to VS Code marketplace too and if you are using Cursor, Windsurf or another VS Code fork, you can search for it directly in your extensions tab.+- **Free Pipelex API Key**: Join our [Discord community](https://go.pipelex.com/discord) and request your **free API key** (no credit card required) in the [🔑・free-api-key](https://discord.com/channels/1369447918955921449/1418228010431025233) channel.+- **Bring your own API keys**: OpenAI, Anthropic, Google, Mistral)+- **Local AI**: Ollama, vLLM, LM Studio, llama.cpp... any endpoint based on the OpenAI API or not, as you can plug-in your own non-standard APIs.-### Option #1: Run examples+See [Configure AI Providers](https://docs.pipelex.com/pages/setup/configure-ai-providers/) for details.-Visit the-[](https://github.com/Pipelex/pipelex-cookbook/): you can clone it, fork it, play with it+## 3. Generate Your First Workflow-### Option #2: Install the package+Create a complete AI workflow with a single command:```bash-# Using pip-pip install pipelex--# Using Poetry-poetry add pipelex--# Using uv (Recommended)-uv pip install pipelex+pipelex build pipe "Take a CV and Job offer in PDF, analyze if they match and generate 5 questions for the interview" --output results/cv_match.plx```-### API Key Configuration+This command generates a production-ready `.plx` file with domain definitions, concepts, and multiple processing steps that analyzes CV-job fit and prepares interview questions.-Pipelex supports two approaches for accessing AI models:+**cv_match.plx**+```toml+domain = "cv_match"+description = "Matching CVs with job offers and generating interview questions"+main_pipe = "analyze_cv_job_match_and_generate_questions"-#### Option A: Pipelex Inference (Optional & Free)--Get a single API key that works with all providers (OpenAI, Anthropic, Google, Mistral, FAL, and more):+[concept.MatchAnalysis]+description = """+Analysis of alignment between a candidate and a position, including strengths, gaps, and areas requiring further exploration.+"""-1. **Get your API key:**- - Join our Discord community: [https://go.pipelex.com/discord](https://go.pipelex.com/discord)- - Request your free API key (no credit card required, limited time offer) in the [🔑・free-api-key](https://discord.com/channels/1369447918955921449/1418228010431025233) channel+[concept.MatchAnalysis.structure]+strengths = { type = "text", description = "Areas where the candidate's profile aligns well with the requirements", required = true }+gaps = { type = "text", description = "Areas where the candidate's profile does not meet the requirements or lacks evidence", required = true }+areas_to_probe = { type = "text", description = "Topics or competencies that need clarification or deeper assessment during the interview", required = true }-2. **Configure environment variables:**- ```bash- # Copy the example file- cp .env.example .env-- # Edit .env and add your Pipelex Inference API key- # PIPELEX_INFERENCE_API_KEY="your-api-key"- ```-- > **Note:** Pipelex automatically loads environment variables from `.env` files. No need to manually source or export them.+[concept.Question]+description = "A single interview question designed to assess a candidate."+refines = "Text"-3. **Verify backend configuration:**- - The `pipelex_inference` backend is already enabled in `.pipelex/inference/backends.toml`- - The default routing profile `pipelex_first` is configured to use Pipelex Inference+[pipe.analyze_cv_job_match_and_generate_questions]+type = "PipeSequence"+description = """+Main pipeline that orchestrates the complete CV-job matching and interview question generation workflow. Takes a candidate's CV and a job offer as PDF documents, extracts their content, performs a comprehensive match analysis identifying strengths, gaps, and areas to probe, and generates exactly 5 targeted interview questions based on the analysis results.+"""+inputs = { cv_pdf = "PDF", job_offer_pdf = "PDF" }+output = "Question[5]"+steps = [+ { pipe = "extract_documents_parallel", result = "extracted_documents" },+ { pipe = "analyze_match", result = "match_analysis" },+ { pipe = "generate_interview_questions", result = "interview_questions" },+]+```-#### Option B: Bring Your Own Keys+<details>+<summary><b>📄 Click to view the supporting pipes implementation</b></summary>-Use your own API keys from individual providers (OpenAI, Anthropic, Google, Mistral, AWS Bedrock, Azure OpenAI, FAL):+```toml+[pipe.extract_documents_parallel]+type = "PipeParallel"+description = """+Executes parallel extraction of text content from both the CV PDF and job offer PDF simultaneously to optimize processing time.+"""+inputs = { cv_pdf = "PDF", job_offer_pdf = "PDF" }+output = "Dynamic"+parallels = [+ { pipe = "extract_cv_text", result = "cv_pages" },+ { pipe = "extract_job_offer_text", result = "job_offer_pages" },+]+add_each_output = true-1. **Configure environment variables:**- ```bash- # Copy the example file- cp .env.example .env-- # Edit .env and add your provider API keys- # OPENAI_API_KEY="your-openai-key"- # ANTHROPIC_API_KEY="your-anthropic-key"- # GOOGLE_API_KEY="your-google-key"- # ... (add the keys you need)- ```+[pipe.extract_cv_text]+type = "PipeExtract"+description = """+Extracts text content from the candidate's CV PDF document using OCR technology, converting all pages into machine-readable text format for subsequent analysis.+"""+inputs = { cv_pdf = "PDF" }+output = "Page[]"+model = "extract_text_from_pdf"++[pipe.extract_job_offer_text]+type = "PipeExtract"+description = """+Extracts text content from the job offer PDF document using OCR technology, converting all pages into machine-readable text format for subsequent analysis.+"""+inputs = { job_offer_pdf = "PDF" }+output = "Page[]"+model = "extract_text_from_pdf"-2. **Configure backends:**- - Edit `.pipelex/inference/backends.toml` to enable/disable backends- - Set `enabled = true` for the backends you want to use- - Set `enabled = false` for backends you don't need+[pipe.analyze_match]+type = "PipeLLM"+description = """+Performs comprehensive analysis comparing the candidate's CV against the job offer requirements. Identifies and structures: (1) strengths where the candidate's profile aligns well with requirements, (2) gaps where the profile lacks evidence or doesn't meet requirements, and (3) specific areas requiring deeper exploration or clarification during the interview process.+"""+inputs = { cv_pages = "Page[]", job_offer_pages = "Page[]" }+output = "MatchAnalysis"+model = "llm_to_answer_hard_questions"+system_prompt = """+You are an expert HR analyst and recruiter specializing in candidate-job fit assessment. Your task is to generate a structured MatchAnalysis comparing a candidate's CV against job requirements.+"""+prompt = """+Analyze the match between the candidate's CV and the job offer requirements.-3. **Select routing profile:**- - Edit `.pipelex/inference/routing_profiles.toml`- - Set `active = "custom_routing"` or create your own profile- - Configure which backend handles which models+Candidate CV:+@cv_pages-#### Option C: Mix & Match (Custom Routing)+Job Offer:+@job_offer_pages-Combine Pipelex Inference with your own keys for maximum flexibility:+Perform a comprehensive comparison and provide a structured analysis.+"""-1. **Configure environment variables:**- ```bash- # Copy and edit .env with both Pipelex and provider keys- cp .env.example .env- ```+[pipe.generate_interview_questions]+type = "PipeLLM"+description = """+Generates exactly 5 targeted, relevant interview questions based on the match analysis results. Questions are designed to probe identified gaps, clarify areas of uncertainty, validate strengths, and assess competencies that require deeper evaluation to determine candidate-position fit.+"""+inputs = { match_analysis = "MatchAnalysis" }+output = "Question[5]"+model = "llm_to_write_questions"+system_prompt = """+You are an expert HR interviewer and talent assessment specialist. Your task is to generate structured interview questions based on candidate-position match analysis.+"""+prompt = """+Based on the following match analysis between a candidate and a position, generate exactly 5 targeted interview questions.-2. **Enable multiple backends:**- - Keep `pipelex_inference` enabled in `.pipelex/inference/backends.toml`- - Enable specific provider backends (e.g., `openai`, `fal`)+@match_analysis-3. **Create custom routing:**- - Edit `.pipelex/inference/routing_profiles.toml`- - Set up a hybrid profile routing some models to Pipelex, others to your backends+The questions should:+- Probe the identified gaps to assess if they are deal-breakers or can be mitigated+- Clarify areas that require deeper exploration+- Validate the candidate's strengths with concrete examples+- Be open-ended and behavioral when appropriate+- Help determine overall candidate-position fit-See the [configuration documentation](https://docs.pipelex.com/pages/configuration/config-technical/inference-backend-config/) for detailed setup instructions.+Generate exactly 5 interview questions.+"""+```+</details>-### Optional Features-The package supports the following additional features:+**View the pipeline flowchart:**-- `anthropic`: Anthropic/Claude support for text generation-- `google`: Google models (Vertex) support for text generation-- `mistralai`: Mistral AI support for text generation and OCR-- `bedrock`: AWS Bedrock support for text generation-- `fal`: Image generation with Black Forest Labs "FAL" service+```mermaid+flowchart TD+ subgraph PAR["extract_documents_parallel (PipeParallel)"]+ direction LR+ EXTRACT_CV["extract_cv_text (PipeExtract)"]+ EXTRACT_JOB["extract_job_offer_text (PipeExtract)"]+ end+ subgraph MAIN["analyze_cv_job_match_and_generate_questions (PipeSequence)"]+ direction TB+ PAR+ CV_PAGES[["cv_pages: Page"]]+ JOB_PAGES[["job_offer_pages: Page"]]+ ANALYZE["analyze_match (PipeLLM)"]+ MATCH[["MatchAnalysis"]]+ GENERATE["generate_interview_questions (PipeLLM)"]+ OUT[["Question"]]+ end+ CV_IN[["cv_pdf: PDF"]] --> EXTRACT_CV+ JOB_IN[["job_offer_pdf: PDF"]] --> EXTRACT_JOB+ EXTRACT_CV --> CV_PAGES+ EXTRACT_JOB --> JOB_PAGES+ CV_PAGES --> ANALYZE+ JOB_PAGES --> ANALYZE+ ANALYZE --> MATCH+ MATCH --> GENERATE+ GENERATE --> OUT+ classDef default stroke:#1976D2,stroke-width:2px,fill:#E3F2FD,color:#0D47A1+ style EXTRACT_CV stroke:#1565C0,fill:#BBDEFB,color:#0D47A1+ style EXTRACT_JOB stroke:#1565C0,fill:#BBDEFB,color:#0D47A1+ style PAR fill:#FFF9C4,stroke:#F57C00,stroke-width:2px+ style CV_PAGES stroke:#2E7D32,fill:#C8E6C9,color:#1B5E20+ style JOB_PAGES stroke:#2E7D32,fill:#C8E6C9,color:#1B5E20+ style ANALYZE stroke:#1565C0,fill:#BBDEFB,color:#0D47A1+ style MATCH stroke:#2E7D32,fill:#C8E6C9,color:#1B5E20+ style GENERATE stroke:#1565C0,fill:#BBDEFB,color:#0D47A1+ style OUT stroke:#2E7D32,fill:#C8E6C9,color:#1B5E20+ style CV_IN stroke:#2E7D32,fill:#C8E6C9,color:#1B5E20+ style JOB_IN stroke:#2E7D32,fill:#C8E6C9,color:#1B5E20+ style MAIN fill:#F3E5F5,stroke:#7B1FA2,stroke-width:2px+```+## 4. Run Your Pipeline-Install all extras:+**Via CLI:**-Using `pip`:```bash-pip install "pipelex[anthropic,google,google-genai,mistralai,bedrock,fal]"+# Run with input file+pipelex run results/cv_match.plx --inputs inputs.json```-Using `poetry`:-```bash-poetry add "pipelex[anthropic,google,google-genai,mistralai,bedrock,fal]"+Create an `inputs.json` file with your PDF URLs:++```json+{+ "cv_pdf": {+ "concept": "PDF",+ "content": {+ "url": "https://pipelex-web.s3.amazonaws.com/demo/John-Doe-CV.pdf"+ }+ },+ "job_offer_pdf": {+ "concept": "PDF",+ "content": {+ "url": "https://pipelex-web.s3.amazonaws.com/demo/Job-Offer.pdf"+ }+ }+}```-Using `uv`:-```bash-uv pip install "pipelex[anthropic,google,google-genai,mistralai,bedrock,fal]"-```+**Via Python:**-### Privacy & Telemetry+```python+import asyncio+import json+from pipelex.pipeline.execute import execute_pipeline+from pipelex.pipelex import Pipelex-Pipelex collects optional, anonymous usage data to help improve the product. On first run, you'll be prompted to choose your telemetry preference:+async def run_pipeline():+ with open("inputs.json", encoding="utf-8") as f:+ inputs = json.load(f)-- **Off**: No telemetry data collected-- **Anonymous**: Anonymous usage data only (command usage, performance metrics, feature usage)-- **Identified**: Usage data with user identification (helps us provide better support)+ pipe_output = await execute_pipeline(+ pipe_code="cv_match",+ inputs=inputs+ )+ print(pipe_output.main_stuff_as_str)-Your prompts, LLM responses, file paths, and URLs are automatically redacted and never transmitted. You can change your preference at any time or disable telemetry completely by setting the `DO_NOT_TRACK` environment variable.+Pipelex.make()+asyncio.run(run_pipeline())+```-For more details, see the [Telemetry Documentation](https://docs.pipelex.com/pages/setup/telemetry/).+## 5. Iterate with AI Assistance----+Install AI assistant rules to easily modify your pipelines:++```bash+pipelex kit rules+```-## Example: optimizing a tweet in 2 steps+This installs rules for Cursor, Claude, OpenAI Codex, GitHub Copilot, Windsurf, and Blackbox AI. Now you can refine pipelines with natural language:-Example with the extension you can download now on Cursor, Windsurf or another VS Code fork. (Coming soon for VS Code Marketplace)+- "Include confidence scores between 0 and 100 in the match analysis"+- "Write a recap email at the end"+- "Add error handling for invalid inputs"<div>-<a href="https://open-vsx.org/extension/Pipelex/pipelex">-<img src="https://raw.githubusercontent.com/Pipelex/pipelex/main/.github/assets/sample_code.png" alt="Pipelex Code Sample" style="max-width: 100%; height: auto;">-</a>+ <h2 align="center">🚀 See Pipelex in Action</h2>++ <table align="center">+ <tr>+ <td align="center" width="50%">+ <h3>From Whiteboard to AI Workflow in less than 5 minutes with no hands (2025-07)</h3>+ <a href="https://go.pipelex.com/demo">+ <img src="https://go.pipelex.com/demo-thumbnail" alt="Pipelex Demo" width="100%" style="max-width: 500px; height: auto;">+ </a>+ </td>+ <td align="center" width="50%">+ <h3>The AI workflow that writes an AI workflow in 64 seconds (2025-09)</h3>+ <a href="https://go.pipelex.com/Demo-Live">+ <img src="https://d2cinlfp2qnig1.cloudfront.net/banners/pipelex_play_video_demo_live.jpg" alt="Pipelex Live Demo" width="100%" style="max-width: 500px; height: auto;">+ </a>+ </td>+ </tr>+ </table>+</div>-### 1. Define the pipeline in PLX+## 💡 What is Pipelex?-```plx-domain = "tech_tweet"-description = "A pipeline for optimizing tech tweets using Twitter/X best practices"+Pipelex is an open-source language that enables you to build and run **repeatable AI workflows**. Instead of cramming everything into one complex prompt, you break tasks into focused steps, each pipe handling one clear transformation.-[concept]-DraftTweet = "A draft version of a tech tweet that needs optimization"-OptimizedTweet = "A tweet optimized for Twitter/X engagement following best practices"-TweetAnalysis = "Analysis of the tweet's structure and potential improvements"-WritingStyle = "A style of writing"+Each pipe processes information using **Concepts** (typing with meaning) to ensure your pipelines make sense. The Pipelex language (`.plx` files) is simple and human-readable, even for non-technical users. Each step can be structured and validated, giving you the reliability of software with the intelligence of AI.-[pipe]-[pipe.analyze_tweet]-type = "PipeLLM"-description = "Analyze the draft tweet and identify areas for improvement"-inputs = { draft_tweet = "DraftTweet" }-output = "TweetAnalysis"-model = "llm_for_writing_analysis"-system_prompt = """-You are an expert in social media optimization, particularly for tech content on Twitter/X.-Your role is to analyze tech tweets and check if they display typical startup communication pitfalls.-"""-prompt = """-Evaluate the tweet for these key issues:+## 📖 Next Steps-**Fluffiness** - Overuse of buzzwords without concrete meaning (e.g., "synergizing disruptive paradigms")+**Learn More:**+- [Writing Workflows Tutorial](https://docs.pipelex.com/pages/writing-workflows/) - Complete guide with examples+- [Build Reliable AI Workflows](https://docs.pipelex.com/pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-pipelex-workflow-project/) - Deep dive into Pipelex+- [Configuration Guide](https://docs.pipelex.com/pages/setup/configure-ai-providers/) - Set up AI providers and models-**Cringiness** - Content that induces secondhand embarrassment (overly enthusiastic, trying too hard to be cool, excessive emoji use)+## 🔧 IDE Extension-**Humblebragginess** - Disguising boasts as casual updates or false modesty ("just happened to close our $ 10M round 🤷")+We **highly** recommend installing our extension for `.plx` files into your IDE. You can find it in the [Open VSX Registry](https://open-vsx.org/extension/Pipelex/pipelex). It's coming soon to VS Code marketplace too. If you're using Cursor, Windsurf or another VS Code fork, you can search for it directly in your extensions tab.-**Vagueness** - Failing to clearly communicate what the product/service actually does+## 📚 Examples & Cookbook-For each criterion, provide:-1. A score (1-5) where 1 = not present, 5 = severely present-2. If the problem is not present, no comment. Otherwise, explain of the issue and give concise guidance on fixing it,-without providing an actual rewrite+Explore real-world examples in our **Cookbook** repository:-@draft_tweet-"""+[](https://github.com/Pipelex/pipelex-cookbook/)-[pipe.optimize_tweet]-type = "PipeLLM"-description = "Optimize the tweet based on the analysis"-inputs = { draft_tweet = "DraftTweet", tweet_analysis = "TweetAnalysis", writing_style = "WritingStyle" }-output = "OptimizedTweet"-model = "llm_for_social_post_writing"-system_prompt = """-You are an expert in writing engaging tech tweets that drive meaningful discussions and engagement.-Your goal is to rewrite tweets to be impactful and avoid the pitfalls identified in the analysis.-"""-prompt = """-Rewrite this tech tweet to be more engaging and effective, based on the analysis:+Clone it, fork it, and experiment with production-ready pipelines for various use cases.-Original tweet:-@draft_tweet+## 🎯 Optional Features-Analysis:-@tweet_analysis--Requirements:-- Include a clear call-to-action-- Make it engaging and shareable-- Use clear, concise language--### Reference style example--@writing_style+The package supports the following additional features:-### Additional style instructions+- `anthropic`: Anthropic/Claude support for text generation+- `google`: Google models (Vertex) support for text generation+- `mistralai`: Mistral AI support for text generation and OCR+- `bedrock`: Amazon Bedrock support for text generation+- `fal`: Image generation with Black Forest Labs "FAL" service-No hashtags.-Minimal emojis.-Keep the core meaning of the original tweet.-"""+Install all extras:-[pipe.optimize_tweet_sequence]-type = "PipeSequence"-description = "Analyze and optimize a tech tweet in sequence"-inputs = { draft_tweet = "DraftTweet", writing_style = "WritingStyle" }-output = "OptimizedTweet"-steps = [- { pipe = "analyze_tweet", result = "tweet_analysis" },- { pipe = "optimize_tweet", result = "optimized_tweet" },-]+Using `pip`:+```bash+pip install "pipelex[anthropic,google,google-genai,mistralai,bedrock,fal]"```-### 2. Run the pipeline+## Privacy & Telemetry-Here is the flowchart generated during this run:-```mermaid-----config:- layout: dagre- theme: base-----flowchart LR- subgraph "optimize_tweet_sequence"- direction LR- FGunn["draft_tweet:<br>**Draft tweet**"]- EWhtJ["tweet_analysis:<br>**Tweet analysis**"]- 65Eb2["optimized_tweet:<br>**Optimized tweet**"]- i34D5["writing_style:<br>**Writing style**"]- end-class optimize_tweet_sequence sub_a;-- classDef sub_a fill:#e6f5ff,color:#333,stroke:#333;-- classDef sub_b fill:#fff5f7,color:#333,stroke:#333;-- classDef sub_c fill:#f0fff0,color:#333,stroke:#333;- FGunn -- "Analyze tweet" ----> EWhtJ- FGunn -- "Optimize tweet" ----> 65Eb2- EWhtJ -- "Optimize tweet" ----> 65Eb2- i34D5 -- "Optimize tweet" ----> 65Eb2-```+Pipelex collects optional, anonymous usage data to help improve the product. On first run, you'll be prompted to choose your telemetry preference:+- **Off**: No telemetry data collected+- **Anonymous**: Anonymous usage data only (command usage, performance metrics, feature usage)+- **Identified**: Usage data with user identification (helps us provide better support)-### 3. wait… no, there is no step 3, you're done!+Your prompts, LLM responses, file paths, and URLs are automatically redacted and never transmitted. You can change your preference at any time or disable telemetry completely by setting the `DO_NOT_TRACK` environment variable.----+For more details, see the [Telemetry Documentation](https://docs.pipelex.com/pages/setup/telemetry/) or read our [Privacy Policy](https://www.pipelex.com/privacy-policy).## 🤝 Contributingdiff --git a/docs/index.md b/docs/index.mdindex 6dbf4c317..f2635ddc4 100644--- a/docs/index.md+++ b/docs/index.md@@ -13,48 +13,38 @@ pip install pipelexpipelex init```-## Set your API key(s)--```bash-# Linux/MacOS-export PIPELEX_INFERENCE_API_KEY=###-# Windows PowerShell-$env:PIPELEX_INFERENCE_API_KEY="###"-# Windows CMD-set PIPELEX_INFERENCE_API_KEY=###--# Note: Pipelex automatically loads environment variables from `.env` files, that works too.-```--**Where to get an API key:**-+To use AI models, you need API key(s):- The `PIPELEX_INFERENCE_API_KEY` key provides access to all the AI models. To get your key, join our Discord community: [https://go.pipelex.com/discord](https://go.pipelex.com/discord), then request your **free API key** (no credit card required, limited time offer) in the [🔑・free-api-key](https://discord.com/channels/1369447918955921449/1418228010431025233) channel.-- You can also use other AI routing services like [BlackBox AI](https://docs.blackbox.ai/), or you can bring your own API keys (OpenAI, Anthropic, Google, Mistral,etc.), or run local AI (no key needed).+- You can also use other AI routing services like [BlackBox AI](https://docs.blackbox.ai/), or you can bring your own API keys (OpenAI, Anthropic, Google, Mistral, etc.), or run local AI (no key needed).See [Configure AI Providers](pages/setup/configure-ai-providers.md) for details. If you are using non-standard APIs, that's OK too, don't hesitate to join our [Discord](https://go.pipelex.com/discord) for guidance.-## Generate your first pipe+## Generate your first Pipelex workflow```bashpipelex build pipe "Imagine a cute animal mascot for a startup based on its elevator pitch"+pipelex build pipe "Take a theme, write a joke about it, then roast the joke" --output results/self_roaster.plx```**Other useful use-cases for business:**```bashpipelex build pipe "Given an expense report, apply company rules" --output results/expense.plx-pipelex build pipe "Take a resume PDF, a Job offer text, and analyze if they match" --output results/resume_match.plx-pipelex build pipe "Take a theme, write a joke about it, then roast the joke" --output results/self_roaster.plx+pipelex build pipe "Take a CV and Job offer in PDF, analyze if they match and generate 5 questions for the interview" --output results/cv_match.plx```Each of these commands generates a complete production-ready script in our Pipelex language, saved as `.plx` file including domain definition, concepts, and the multiple _pipe_ steps to take to achieve the goal.+!!! tip "Pipe Builder Requirements"+ For now, the pipe builder requires access to **Claude 4.5 Sonnet**, either through Pipelex Inference, or using your own key through Anthropic, Amazon Bedrock or BlackboxAI. Don't hesitate to join our [Discord](https://go.pipelex.com/discord) to get a key, otherwise, you can also create the workflows yourself, following our [documentation guide](pages/writing-workflows/index.md).++## Run your pipeline**CLI:**```bash# Run a pipe by code-pipelex run results/resume_match.plx --inputs inputs.json+pipelex run results/cv_match.plx --inputs inputs.jsonpipelex run results/self_roaster.plx --inputs '{"theme": "the prisoner dilemma"}'```@@ -68,10 +58,13 @@ Learn more: [Executing Pipelines with Inputs](pages/build-reliable-ai-workflows-import asynciofrom pipelex.pipeline.execute import execute_pipelinefrom pipelex.pipelex import Pipelex+import jsonasync def run_pipeline():- pipe_output = await execute_pipeline(pipe_code="your_pipe_code")- print(pipe_output.main_stuff_as_str)+ with open("inputs.json", "r", encoding="utf-8") as json_file:+ inputs = json.load(json_file)+ pipe_output = await execute_pipeline(pipe_code="analyze_cv_and_prepare_interview", inputs=inputs)+ print(pipe_output.main_stuff)Pipelex.make()asyncio.run(run_pipeline())@@ -79,7 +72,7 @@ asyncio.run(run_pipeline())## Easily iterate on your pipe-Now, thanks to our Pipelex language, you can easily edit the pipeline, even if you're not a coder. Better yet, you can get assisted in making changes with the help of your favorite AI coding assistant. To that end, we have prepared comprehensive guides for the most popular AI coding assistants and you can install them with one call:+Now, thanks to our Pipelex language, you can easily edit the pipeline, even if you're not a coder. Better yet, you can get assisted in making changes with the help of your favorite AI coding assistant. To that end, we have prepared comprehensive rules meant for the most popular AI coding assistants. You can install those rules with one call:```bashpipelex kit rules@@ -87,14 +80,14 @@ pipelex kit rulesThis installs Pipelex rules for Cursor, Claude Code, OpenAI Codex, GitHub Copilot, Windsurf, and Blackbox AI.-Now refine your pipeline with natural language:+Now refine your pipeline with natural language directly in your AI assistant's chatbot:- "Include confidence scores between 0 and 100 in the match analysis"- "Write a recap email at the end"## IDE Support-By the way, we **highly** recommend installing our own extension for PLX files into your IDE of choice. You can find it in the [Open VSX Registry](https://open-vsx.org/extension/Pipelex/pipelex). It's coming soon to the VS Code marketplace too and if you are using Cursor, Windsurf or another VS Code fork, you can search for it directly in your extensions tab.+By the way, we **highly** recommend installing our own extension for PLX files into your IDE of choice. You can find it in the [Open VSX Registry](https://open-vsx.org/extension/Pipelex/pipelex) and download it directly using [this link](https://open-vsx.org/api/Pipelex/pipelex/0.2.1/file/Pipelex.pipelex-0.2.1.vsix). It's coming soon to the VS Code marketplace too and if you are using Cursor, Windsurf or another VS Code fork, you can search for it directly in your extensions tab.## Examples@@ -106,7 +99,7 @@ Visit the## What is Pipelex?-Pipelex is an open-source Python framework for building **repeatable AI workflows**. Instead of cramming everything into one complex prompt, you break tasks into focused steps, each pipe handling one clear transformation.+Pipelex is an open-source language that enables agents to build and run **repeatable AI workflows**. Instead of cramming everything into one complex prompt, you break tasks into focused steps, each pipe handling one clear transformation.Each pipe processes information using **Concepts** (typing with meaning) to ensure your pipelines make sense. The Pipelex language (`.plx` files) is simple and human-readable, even for non-technical users.@@ -118,9 +111,9 @@ Each step can be structured and validated, so you benefit from the reliability o**Learn More:**-- [Full Tutorial](pages/quick-start/index.md) - Complete guide with examples+- [Writing Workflows Tutorial](pages/writing-workflows/index.md) - Complete guide with examples- [Cookbook Examples](pages/cookbook-examples/index.md) - Real-world patterns-- [Build Reliable AI Workflows](pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-knowledge-pipeline-project.md) - Deep dive+- [Build Reliable AI Workflows](pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-pipelex-workflow-project.md) - Deep dive**Understand the Philosophy:**diff --git a/docs/pages/advanced-customization/activity-manager-injection.md b/docs/pages/advanced-customization/activity-manager-injection.mddeleted file mode 100644index 700663965..000000000--- a/docs/pages/advanced-customization/activity-manager-injection.md+++ /dev/null@@ -1,3 +0,0 @@-# Activity Manager Injection--⚠️ Under constructiondiff --git a/docs/pages/advanced-customization/content-generator-injection.md b/docs/pages/advanced-customization/content-generator-injection.mdindex e6724ce7c..dad784bac 100644--- a/docs/pages/advanced-customization/content-generator-injection.md+++ b/docs/pages/advanced-customization/content-generator-injection.md@@ -1,3 +1,4 @@# Content Generator Injection-⚠️ Under construction+!!! warning "Under Construction"+ This section is currently under development.diff --git a/docs/pages/advanced-customization/index.md b/docs/pages/advanced-customization/index.mdindex f7719ee1b..18440174f 100644--- a/docs/pages/advanced-customization/index.md+++ b/docs/pages/advanced-customization/index.md@@ -16,7 +16,6 @@ from pipelex import Pipelexpipelex = Pipelex.make(template_provider=MyTemplateProvider(),pipeline_tracker=MyPipelineTracker(),- activity_manager=MyActivityManager(),reporting_delegate=MyReportingDelegate(),secrets_provider=MySecretsProvider(),content_generator=MyContentGenerator(),@@ -67,43 +66,36 @@ When a feature is disabled, the corresponding NoOp implementation is used automaPipelex supports injection of the following components:-1. **Template Provider** (`TemplateLibrary`)+**Template Provider** (`TemplateLibrary`)- - Protocol: `TemplateProviderAbstract`- - Default: `TemplateLibrary`- - [Details](template-provider-injection.md)+ - Protocol: `TemplateProviderAbstract`+ - Default: `TemplateLibrary`+ - [Details](template-provider-injection.md)-2. **Reporting Delegate** (`ReportingManager`)+**Reporting Delegate** (`ReportingManager`)- - Protocol: `ReportingProtocol`- - Default: `ReportingManager` or `ReportingNoOp` if disabled- - [Details](reporting-delegate-injection.md)+ - Protocol: `ReportingProtocol`+ - Default: `ReportingManager` or `ReportingNoOp` if disabled+ - [Details](reporting-delegate-injection.md)-3. **Pipeline Tracker** (`PipelineTracker`)+**Pipeline Tracker** (`PipelineTracker`)- - Protocol: `PipelineTrackerProtocol`- - Default: `PipelineTracker` or `PipelineTrackerNoOp` if disabled- - [Details](pipeline-tracker-injection.md)+ - Protocol: `PipelineTrackerProtocol`+ - Default: `PipelineTracker` or `PipelineTrackerNoOp` if disabled+ - [Details](pipeline-tracker-injection.md)-4. **Activity Manager** (`ActivityManager`)+**Secrets Provider** (`EnvSecretsProvider`)- - Protocol: `ActivityManagerProtocol`- - Default: `ActivityManager` or `ActivityManagerNoOp` if disabled- - [Details](activity-manager-injection.md)+ - Protocol: `SecretsProviderAbstract`+ - Default: `EnvSecretsProvider`+ - [Details](secrets-provider-injection.md)-5. **Secrets Provider** (`EnvSecretsProvider`)-- - Protocol: `SecretsProviderAbstract`- - Default: `EnvSecretsProvider`- - [Details](secrets-provider-injection.md)--6. **Content Generator** (`ContentGenerator`)-- - Protocol: `ContentGeneratorProtocol`- - Default: `ContentGenerator`- - [Details](content-generator-injection.md)--7. **Pipe Router** (`PipeRouter`)+**Content Generator** (`ContentGenerator`)+ - Protocol: `ContentGeneratorProtocol`+ - Default: `ContentGenerator`+ - [Details](content-generator-injection.md)++**Pipe Router** (`PipeRouter`)- Protocol: `PipeRouterProtocol`- Default: `PipeRouter`diff --git a/docs/pages/advanced-customization/pipe-router-injection.md b/docs/pages/advanced-customization/pipe-router-injection.mdindex 7c8332535..9cc3929f8 100644--- a/docs/pages/advanced-customization/pipe-router-injection.md+++ b/docs/pages/advanced-customization/pipe-router-injection.md@@ -1,3 +1,4 @@-# Pipe Router Injection+# Pipe Router Injection-⚠️ Under construction+!!! warning "Under Construction"+ This section is currently under development.diff --git a/docs/pages/advanced-customization/pipeline-tracker-injection.md b/docs/pages/advanced-customization/pipeline-tracker-injection.mdindex 4c99287d8..928ccb004 100644--- a/docs/pages/advanced-customization/pipeline-tracker-injection.md+++ b/docs/pages/advanced-customization/pipeline-tracker-injection.md@@ -1,3 +1,4 @@# Pipeline Tracker Injection-⚠️ Under construction+!!! warning "Under Construction"+ This section is currently under development.diff --git a/docs/pages/advanced-customization/plugin-manager-injection.md b/docs/pages/advanced-customization/plugin-manager-injection.mddeleted file mode 100644index 4811fb0c5..000000000--- a/docs/pages/advanced-customization/plugin-manager-injection.md+++ /dev/null@@ -1,3 +0,0 @@-# Plugin Manager Injection--⚠️ Under constructiondiff --git a/docs/pages/advanced-customization/reporting-delegate-injection.md b/docs/pages/advanced-customization/reporting-delegate-injection.mdindex 8326a126d..3d9fe0a65 100644--- a/docs/pages/advanced-customization/reporting-delegate-injection.md+++ b/docs/pages/advanced-customization/reporting-delegate-injection.md@@ -1,3 +1,4 @@# Reporting Delegate Injection-⚠️ Under construction+!!! warning "Under Construction"+ This section is currently under development.diff --git a/docs/pages/advanced-customization/secrets-provider-injection.md b/docs/pages/advanced-customization/secrets-provider-injection.mdindex cfeb5cde5..a8b79188f 100644--- a/docs/pages/advanced-customization/secrets-provider-injection.md+++ b/docs/pages/advanced-customization/secrets-provider-injection.md@@ -1,3 +1,4 @@# Secrets Provider Injection-⚠️ Under construction+!!! warning "Under Construction"+ This section is currently under development.diff --git a/docs/pages/advanced-customization/storage-provider-injection.md b/docs/pages/advanced-customization/storage-provider-injection.mdindex e380c52e1..4d93eafd8 100644--- a/docs/pages/advanced-customization/storage-provider-injection.md+++ b/docs/pages/advanced-customization/storage-provider-injection.md@@ -1,3 +1,4 @@# Storage Provider Injection-⚠️ Under construction+!!! warning "Under Construction"+ This section is currently under development.diff --git a/docs/pages/advanced-customization/template-provider-injection.md b/docs/pages/advanced-customization/template-provider-injection.mdindex 79fc31655..920498b61 100644--- a/docs/pages/advanced-customization/template-provider-injection.md+++ b/docs/pages/advanced-customization/template-provider-injection.md@@ -1,3 +1,4 @@# Template Provider Injection-⚠️ Under construction+!!! warning "Under Construction"+ This section is currently under development.diff --git a/docs/pages/api/index.md b/docs/pages/api/index.mdindex a64d00dbd..ae74539d6 100644--- a/docs/pages/api/index.md+++ b/docs/pages/api/index.md@@ -6,9 +6,9 @@ This guide covers everything you need to know about using the Pipelex API to exe1. [Quick Reference](#quick-reference)2. [Execute Pipeline](#execute-pipeline)-3. [Input Format: PipelineInputs](#input-format-implicitmemory)+3. [Input Format: PipelineInputs](#input-format-pipelineinputs)- [Case 1: Direct Content Format](#case-1-direct-content-format)- - [Case 2: Explicit Format](#case-2-explicit-format-concept--content)+ - [Case 2: Explicit Format](#case-2-explicit-format-concept-content)4. [Search Domains Explained](#search-domains-explained)5. [PLX Content: Execute Pipelines Inline](#plx-content-execute-pipelines-inline)6. [Error Handling](#error-handling)@@ -94,7 +94,7 @@ Execute a Pipelex pipeline with flexible inputs.```**Request Fields:**-- `inputs` (PipelineInputs): Flexible input format - see [Input Format](#input-format-implicitmemory) below+- `inputs` (PipelineInputs): Flexible input format - see [Input Format](#input-format-pipelineinputs) below- `output_name` (string, optional): Name for the output slot- `output_multiplicity` (string, optional): Output multiplicity setting- `dynamic_output_concept_code` (string, optional): Override output concept@@ -668,7 +668,8 @@ When you provide `plx_content`:3. The pipeline is executed if valid4. Errors are returned if the pipeline definition is invalid-**Important:** `plx_content` and `pipe_code` are mutually exclusive. Use one or the other, not both.+!!! important "Mutually Exclusive Parameters"+ `plx_content` and `pipe_code` are mutually exclusive. Use one or the other, not both.---diff --git a/docs/pages/build-reliable-ai-workflows-with-pipelex/configure-ai-llm-to-optimize-workflows.md b/docs/pages/build-reliable-ai-workflows-with-pipelex/configure-ai-llm-to-optimize-workflows.mdindex c17b8f53b..4105d5324 100644--- a/docs/pages/build-reliable-ai-workflows-with-pipelex/configure-ai-llm-to-optimize-workflows.md+++ b/docs/pages/build-reliable-ai-workflows-with-pipelex/configure-ai-llm-to-optimize-workflows.md@@ -31,7 +31,8 @@ base-gpt = "gpt-5"The system first looks for direct model names, then checks aliases if no direct match is found. The system handles model routing through backends automatically.-💡 Defining an alias is always meant to describe what model it is. Never define an alias to describe what it is for or what it's good at. LLM Presets are for that.+!!! tip "Alias Naming Convention"+ Defining an alias is always meant to describe what model it is. Never define an alias to describe what it is for or what it's good at. LLM Presets are for that.## LLM Settings & LLM Presetsdiff --git a/docs/pages/build-reliable-ai-workflows-with-pipelex/define_your_concepts.md b/docs/pages/build-reliable-ai-workflows-with-pipelex/define_your_concepts.mdindex 1ca81085b..1a978c6bc 100644--- a/docs/pages/build-reliable-ai-workflows-with-pipelex/define_your_concepts.md+++ b/docs/pages/build-reliable-ai-workflows-with-pipelex/define_your_concepts.md@@ -50,7 +50,7 @@ Those concepts will be Text-based by default. If you want to use sutrctured outp### Organizing Related Concepts-Group concepts that naturally belong together in the same domain. A domain acts as a namespace for a set of related concepts and pipes, helping you organize and reuse your pipeline components. You can learn more about them in [Kick off a Knowledge Pipeline Project](kick-off-a-knowledge-pipeline-project.md#what-are-domains).+Group concepts that naturally belong together in the same domain. A domain acts as a namespace for a set of related concepts and pipes, helping you organize and reuse your pipeline components. You can learn more about them in [Kick off a Pipelex Workflow Project](kick-off-a-pipelex-workflow-project.md#what-are-domains).```plx# finance.plxdiff --git a/docs/pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-knowledge-pipeline-project.md b/docs/pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-pipelex-workflow-project.mdsimilarity index 99%rename from docs/pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-knowledge-pipeline-project.mdrename to docs/pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-pipelex-workflow-project.mdindex f5ddefddd..b070febef 100644--- a/docs/pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-knowledge-pipeline-project.md+++ b/docs/pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-pipelex-workflow-project.md@@ -1,4 +1,4 @@-# Kicking off a Knowledge Pipeline Project+# Kicking off a Pipelex Workflow Project## Creating Your First Pipelinediff --git a/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-controllers/PipeCondition.md b/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-controllers/PipeCondition.mdindex ece06b821..661a8ca33 100644--- a/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-controllers/PipeCondition.md+++ b/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-controllers/PipeCondition.md@@ -29,8 +29,8 @@ The `PipeCondition` controller adds branching logic to your pipelines. It evalua| `default_pipe_code` | string | The name of a pipe to execute if the expression result does not match any key in `pipe_map`. | No || `add_alias_from_expression_to` | string | An advanced feature. If provided, the string result of the expression evaluation is added to the working memory as an alias with this name. | No |--**Important**: The output concept of the `PipeCondition` has to match the output of all the pipes in the `pipe_map`.+!!! important "Output Concept Matching"+ The output concept of the `PipeCondition` has to match the output of all the pipes in the `pipe_map`.### Example: Simple routing based on categorydiff --git a/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-controllers/PipeSequence.md b/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-controllers/PipeSequence.mdindex 8f71a13c5..22cdfd514 100644--- a/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-controllers/PipeSequence.md+++ b/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-controllers/PipeSequence.md@@ -33,7 +33,8 @@ Each entry in the `steps` array is a table with the following keys:| `pipe` | string | The name of the pipe to execute for this step. | Yes || `result` | string | The name to give to the output of this step in the working memory. | Yes |-**Important**: The output concept of the `PipeSequence` has to match the output of the last pipe in the sequence.+!!! important "Output Concept Matching"+ The output concept of the `PipeSequence` has to match the output of the last pipe in the sequence.### Examplediff --git a/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-operators/PipeLLM.md b/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-operators/PipeLLM.mdindex 99ea96c26..8777ec3db 100644--- a/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-operators/PipeLLM.md+++ b/docs/pages/build-reliable-ai-workflows-with-pipelex/pipe-operators/PipeLLM.md@@ -32,7 +32,8 @@ Describe the provided image in great detail."""```-**Important**: It is necessary to tag the image variable in the prompt with `@image` or `$image`, just like with regular objects.+!!! important "Image Variable Tagging"+ It is necessary to tag the image variable in the prompt with `@image` or `$image`, just like with regular objects.**Flexible Image Inputs**diff --git a/docs/pages/build-reliable-ai-workflows-with-pipelex/pipeline-creation.md b/docs/pages/build-reliable-ai-workflows-with-pipelex/pipeline-creation.mdindex 0581ab2f6..4d585db82 100644--- a/docs/pages/build-reliable-ai-workflows-with-pipelex/pipeline-creation.md+++ b/docs/pages/build-reliable-ai-workflows-with-pipelex/pipeline-creation.md@@ -1,14 +1,15 @@-# Pipeline Creation+# Pipeline Creation using the Pipe BuilderPipelex provides powerful tools to automatically generate complete, working pipelines from natural language requirements. This feature leverages AI to translate your ideas into fully functional pipeline code, dramatically speeding up development.+!!! tip "Pipe Builder Requirements"+ For now, the pipe builder requires access to **Claude 4.5 Sonnet**, either through Pipelex Inference, or using your own key through Anthropic, Amazon Bedrock or BlackboxAI. Don't hesitate to join our [Discord](https://go.pipelex.com/discord) to get a key or see [Configure AI Providers](../setup/configure-ai-providers.md) for details. Otherwise, you can also create the workflows yourself, following our [documentation guide](kick-off-a-pipelex-workflow-project.md).+## OverviewThe pipeline creation system can generate pipelines in different modes depending on your needs - from quick one-shot generation to validated, production-ready pipelines that have been automatically tested and fixed.-## Core Commands--### Build Pipe (Recommended)+## Build PipeGenerate a validated pipeline with automatic fixing of deterministic issues:@@ -30,42 +31,6 @@ pipelex build pipe "Take a photo as input, and render the opposite of the photo"- `--output, -o`: Output path for generated PLX file- `--no-output`: Skip saving the pipeline to file-### Build One-Shot (Fast)--Generate a pipeline quickly without validation:--```bash-pipelex build one-shot "BRIEF IN NATURAL LANGUAGE" [OPTIONS]-```--This command generates the pipeline in a single pass without validation. It's faster but may produce pipelines that need manual fixes.--**Example:**--```bash-pipelex build one-shot "Extract invoice data from PDF documents" \- -o results/invoice_extractor.plx-```--**Use when:** You want to quickly iterate on ideas or plan to manually review/modify the pipeline.--### Build Partial (Debug)--Generate a partial pipeline specification as JSON for debugging:--```bash-pipelex build partial "BRIEF IN NATURAL LANGUAGE" [OPTIONS]-```--This outputs the internal pipeline specification in JSON format, useful for debugging and understanding how Pipelex interprets your requirements.--**Example:**--```bash-pipelex build partial "Analyze sentiment from customer reviews" \- -o results/debug_spec.json-```-## Quick Start ExampleThe simplest way to create a pipeline is to use the `build pipe` command with a clear description:diff --git a/docs/pages/build-reliable-ai-workflows-with-pipelex/structuring-concepts.md b/docs/pages/build-reliable-ai-workflows-with-pipelex/structuring-concepts.mdindex 19d1c9b60..30f8604fe 100644--- a/docs/pages/build-reliable-ai-workflows-with-pipelex/structuring-concepts.md+++ b/docs/pages/build-reliable-ai-workflows-with-pipelex/structuring-concepts.md@@ -426,6 +426,6 @@ This will enable building complex, nested data models entirely within `.plx` fil## Related Documentation- [Define Your Concepts](define_your_concepts.md) - Learn about concept semantics and naming-- [Quick Start](../quick-start/index.md) - Get started with structured outputs+- [Writing Workflows Tutorial](../writing-workflows/index.md) - Get started with structured outputs- [Design and Run Pipelines](design_and_run_pipelines.md) - Use structured concepts in pipesdiff --git a/docs/pages/configuration/config-practical/reporting-config.md b/docs/pages/configuration/config-practical/reporting-config.mdindex cf087f0dc..378dc0394 100644--- a/docs/pages/configuration/config-practical/reporting-config.md+++ b/docs/pages/configuration/config-practical/reporting-config.md@@ -86,4 +86,5 @@ cost_report_unit_scale = 1000.0## Best Practices-⚠️ Under construction+!!! warning "Under Construction"+ This section is currently under development.diff --git a/docs/pages/configuration/config-technical/aws-config.md b/docs/pages/configuration/config-technical/aws-config.mdindex e845b81ee..15a7ef5f7 100644--- a/docs/pages/configuration/config-technical/aws-config.md+++ b/docs/pages/configuration/config-technical/aws-config.md@@ -34,10 +34,12 @@ When using `api_key_method = "secret_provider"`, Pipelex will:- `AWS_SECRET_ACCESS_KEY`- `AWS_REGION`-⚠️ **Important**: To use the secret provider method, you must:-1. Configure a secret provider in your project using the `SecretsProviderAbstract`: See more in the [Secrets](../../advanced-customization/secrets-provider-injection.md) documentation.-2. Store your AWS credentials in your secret provider-3. Ensure your secret provider is properly authenticated+!!! warning "Secret Provider Requirements"+ To use the secret provider method, you must:++ 1. Configure a secret provider in your project using the `SecretsProviderAbstract`: See more in the [Secrets](../../advanced-customization/secrets-provider-injection.md) documentation.+ 2. Store your AWS credentials in your secret provider+ 3. Ensure your secret provider is properly authenticated## Dependency Injection@@ -51,4 +53,5 @@ For detailed information about dependency injection, including examples and best## Best Practices-⚠️ Under construction+!!! warning "Under Construction"+ This section is currently under development.diff --git a/docs/pages/configuration/config-technical/inference-backend-config.md b/docs/pages/configuration/config-technical/inference-backend-config.mdindex 099d282e7..449c28022 100644--- a/docs/pages/configuration/config-technical/inference-backend-config.md+++ b/docs/pages/configuration/config-technical/inference-backend-config.md@@ -58,7 +58,7 @@ All inference backend configurations are stored in the `.pipelex/inference/` dir├── backends/ # Individual backend model specifications│ ├── openai.toml # OpenAI models (LLMs, image generation)│ ├── anthropic.toml # Anthropic models (LLMs)- │ ├── bedrock.toml # AWS Bedrock models (LLMs)+ │ ├── bedrock.toml # Amazon Bedrock models (LLMs)│ ├── mistral.toml # Mistral models (LLMs, OCR)│ ├── vertexai.toml # Google Vertex AI models (LLMs)│ ├── fal.toml # FAL models (image generation)@@ -170,7 +170,7 @@ PIPELEX_INFERENCE_API_KEY=OPENAI_API_KEY=-# AWS Bedrock - For accessing models via Amazon Bedrock+# Amazon Bedrock - For accessing models via Amazon BedrockAWS_ACCESS_KEY_ID=AWS_SECRET_ACCESS_KEY=AWS_REGION=diff --git a/docs/pages/configuration/index.md b/docs/pages/configuration/index.mdindex e43037c86..0fcec5b96 100644--- a/docs/pages/configuration/index.md+++ b/docs/pages/configuration/index.md@@ -8,10 +8,9 @@ Pipelex uses a TOML-based configuration system. The main configuration file `pippipelex init config```-💡 **Important Notes**:--1. `pipelex init config` creates a **template** configuration file with sample settings. It does not include all possible configuration options - it's meant as a starting point.-2. Using `pipelex init config --reset` will **overwrite** your existing `pipelex.toml` file without warning. Make sure to backup your configuration before using this flag.+!!! important "Configuration Setup Notes"+ 1. `pipelex init config` creates a **template** configuration file with sample settings. It does not include all possible configuration options - it's meant as a starting point.+ 2. Using `pipelex init config --reset` will **overwrite** your existing `pipelex.toml` file without warning. Make sure to backup your configuration before using this flag.For a complete list of all possible configuration options, refer to the configuration group documentation below.diff --git a/docs/pages/cookbook-examples/hello-world.md b/docs/pages/cookbook-examples/hello-world.mdindex e9fd824b4..644769c5f 100644--- a/docs/pages/cookbook-examples/hello-world.md+++ b/docs/pages/cookbook-examples/hello-world.md@@ -71,7 +71,7 @@ Write a haiku about Hello World.```2. Install dependencies:```bash- make install+ pip install -r requirements.txt```3. Set up your environment variables by copying `.env.example` to `.env` and adding your API keys.4. Run the example:diff --git a/docs/pages/setup/configure-ai-providers.md b/docs/pages/setup/configure-ai-providers.mdindex 05d77b292..dae42dfaf 100644--- a/docs/pages/setup/configure-ai-providers.md+++ b/docs/pages/setup/configure-ai-providers.md@@ -64,7 +64,7 @@ AZURE_API_KEY=...AZURE_API_BASE=...AZURE_API_VERSION=...-# AWS Bedrock+# Amazon BedrockAWS_ACCESS_KEY_ID=...AWS_SECRET_ACCESS_KEY=...AWS_REGION=...@@ -147,9 +147,10 @@ Learn more in our [Inference Backend Configuration](../configuration/config-techNow that you have your backend configured:1. **Organize your project**: [Project Organization](project-organization.md)-2. **Learn the concepts**: [Full Tutorial](../quick-start/index.md)+2. **Learn the concepts**: [Writing Workflows Tutorial](../writing-workflows/index.md)3. **Explore examples**: [Cookbook Repository](https://github.com/Pipelex/pipelex-cookbook)-4. **Deep dive**: [Build Reliable AI Workflows](../build-reliable-ai-workflows-with-pipelex/kick-off-a-knowledge-pipeline-project.md)+4. **Deep dive**: [Build Reliable AI Workflows](../build-reliable-ai-workflows-with-pipelex/kick-off-a-pipelex-workflow-project.md)-💡 For detailed backend configuration options, see [Inference Backend Configuration](../configuration/config-technical/inference-backend-config.md).+!!! tip "Advanced Configuration"+ For detailed backend configuration options, see [Inference Backend Configuration](../configuration/config-technical/inference-backend-config.md).diff --git a/docs/pages/setup/project-organization.md b/docs/pages/setup/project-organization.mdindex 2126a156e..42f9fc27e 100644--- a/docs/pages/setup/project-organization.md+++ b/docs/pages/setup/project-organization.md@@ -35,7 +35,7 @@ your_project/└── pipelex.toml```-Learn more in our [Project Structure documentation](../build-reliable-ai-workflows-with-pipelex/kick-off-a-knowledge-pipeline-project.md).+Learn more in our [Project Structure documentation](../build-reliable-ai-workflows-with-pipelex/kick-off-a-pipelex-workflow-project.md).---@@ -51,7 +51,7 @@ Learn more in our [Project Structure documentation](../build-reliable-ai-workfloNow that you understand project organization:1. **Start building**: [Get Started](../../index.md)-2. **Learn the concepts**: [Full Tutorial](../quick-start/index.md)+2. **Learn the concepts**: [Writing Workflows Tutorial](../writing-workflows/index.md)3. **Explore examples**: [Cookbook Repository](https://github.com/Pipelex/pipelex-cookbook)-4. **Deep dive**: [Build Reliable AI Workflows](../build-reliable-ai-workflows-with-pipelex/kick-off-a-knowledge-pipeline-project.md)+4. **Deep dive**: [Build Reliable AI Workflows](../build-reliable-ai-workflows-with-pipelex/kick-off-a-pipelex-workflow-project.md)diff --git a/docs/pages/tools/cli.md b/docs/pages/tools/cli.mdindex ad6e30bd0..c6e5ffde8 100644--- a/docs/pages/tools/cli.md+++ b/docs/pages/tools/cli.md@@ -156,7 +156,8 @@ pipelex validate --bundle my_pipeline.plx --pipe extract_invoicepipelex validate --bundle invoice_processor.plx --pipe validate_amounts```-**Important:** The specified pipe must be defined in the bundle. This is useful when you want to validate a bundle and confirm a specific pipe is present and valid within it. However, the entire bundle will be validated regardless.+!!! important "Bundle Validation Behavior"+ The specified pipe must be defined in the bundle. This is useful when you want to validate a bundle and confirm a specific pipe is present and valid within it. However, the entire bundle will be validated regardless.### What Validation Checksdiff --git a/docs/pages/quick-start/character_sheet.png b/docs/pages/writing-workflows/character_sheet.pngsimilarity index 100%rename from docs/pages/quick-start/character_sheet.pngrename to docs/pages/writing-workflows/character_sheet.pngdiff --git a/docs/pages/quick-start/extracted_character_metadata.png b/docs/pages/writing-workflows/extracted_character_metadata.pngsimilarity index 100%rename from docs/pages/quick-start/extracted_character_metadata.pngrename to docs/pages/writing-workflows/extracted_character_metadata.pngdiff --git a/docs/pages/quick-start/index.md b/docs/pages/writing-workflows/index.mdsimilarity index 69%rename from docs/pages/quick-start/index.mdrename to docs/pages/writing-workflows/index.mdindex 06f19abf0..8828b04e9 100644--- a/docs/pages/quick-start/index.md+++ b/docs/pages/writing-workflows/index.md@@ -1,14 +1,13 @@-# Quick-start--## Understanding How It Works+# Writing WorkflowsReady to dive deeper? This section shows you how to manually create pipelines and understand the `.plx` language.-### Your First LLM Call with Pipelex+!!! tip "Prefer Automated Workflow Generation?"+ If you have access to **Claude 4.5 Sonnet** (via Pipelex Inference, Anthropic, Amazon Bedrock, or BlackBox AI), you can use our **pipe builder** to generate workflows from natural language descriptions. See the [Getting Started guide](../../index.md) to learn how to use `pipelex build pipe` commands. This tutorial is for those who want to write workflows manually or understand the `.plx` language in depth.Let's build a **character generator** to understand the basics.-#### Write Your First Pipeline+## Write Your First PipelineCreate a `.plx` file anywhere in your project (we recommend a `pipelines` directory):@@ -34,7 +33,15 @@ This pipeline:- Outputs plain `Text`- Uses a simple prompt-#### Run Your First Pipelex Script+## Run Your First Pipelex Script++**CLI:**++```bash+pipelex run create_character+```++**Python:**Create a Python file to execute the pipeline:@@ -59,17 +66,19 @@ Pipelex.make()asyncio.run(create_character())```-#### Get Your First Pipelex Result+Then run:```bashpython character.py```+## Get Your First Pipelex Result+-### Using Specific LLMs+## Using Specific LLMs-#### Indicate Your LLM Selection Explicitly+### Indicate Your LLM Selection Explicitly```plx[pipe.create_character]@@ -83,7 +92,7 @@ Think of it and then output the character description."""```-#### Or Use an LLM Preset from the LLM Deck+### Or Use an LLM Preset from the LLM Deck```plx[pipe.create_character]@@ -97,19 +106,20 @@ Think of it and then output the character description."""# The llm choice above is defined in `.pipelex/inference/deck/base_deck.toml` as:-# llm_for_creative_writing = { model = "best-claude", temperature = 0.9 }+# llm_for_creative_writing = { model = "base-gpt", temperature = 0.9 }# it's a base preset that we provide. you can add your own presets, too.```-💡 We have many [LLM presets available by default](https://github.com/Pipelex/pipelex/tree/main/.pipelex/inference/deck/base_deck.toml).+!!! tip "LLM Presets"+ We have many [LLM presets available by default](https://github.com/Pipelex/pipelex/tree/main/.pipelex/inference/deck/base_deck.toml).Learn more in our [LLM Configuration Guide](../build-reliable-ai-workflows-with-pipelex/configure-ai-llm-to-optimize-workflows.md).-### Generate Structured Outputs+## Generate Structured OutputsLet's create a rigorously structured `Character` object instead of plain text.-#### Define the Structure+### Define the Structure using Pydantic BaseModelUsing [Pydantic BaseModel](https://docs.pydantic.dev/latest/) syntax:@@ -129,7 +139,7 @@ class Character(StructuredContent):!!! tip "Keep Structure Files Clean"Keep your `StructuredContent` classes in dedicated files with minimal module-level code. Pipelex imports these modules during auto-discovery, so any module-level code will be executed.-💡 **Alternative: Inline Structure Definition**+### Define the Structure using Inline Structure DefinitionDefine structures directly in your `.plx` file:@@ -146,7 +156,7 @@ description = "A description of the character"Learn more in [Structuring Concepts](../build-reliable-ai-workflows-with-pipelex/structuring-concepts.md).-#### Improve the Pipeline+### Use your Structured Concept in Your PipeSpecify that your output is a `Character` instance:@@ -168,9 +178,11 @@ Think of it and then output the character description."""```-💡 The concept name matches the class name (`Character`), so Pipelex automatically links them.+!!! tip "Concept Naming"+ The concept name matches the class name (`Character`), so Pipelex automatically links them.-💡 Defining concepts removes ambiguity—"character" could mean a letter or symbol, but here it clearly means a fictional person.+!!! tip "Semantic Clarity"+ Defining concepts removes ambiguity—"character" could mean a letter or symbol, but here it clearly means a fictional person.#### Run Your Pipeline@@ -207,7 +219,8 @@ class CharacterMetadata(StructuredContent):#### Use a Template to Fill Prompts with Data-💡 Our template syntax is based on [Jinja2](https://jinja.palletsprojects.com/en/stable/). Use `{{ double.curly.braces }}` or the simpler `@` prefix (recommended).+!!! tip "Template Syntax"+ Our template syntax is based on [Jinja2](https://jinja.palletsprojects.com/en/stable/). Use `{{ double.curly.braces }}` or the simpler `@` prefix (recommended).```plx[concept]@@ -228,56 +241,55 @@ Your task is to extract specific data from the following description."""```-💡 `@character.description` grabs the `character` stuff from working memory and uses its `description` attribute.+!!! tip "Template Variables"+ `@character.description` grabs the `character` stuff from working memory and uses its `description` attribute.Learn more about Jinja in the [PipeLLM documentation](../build-reliable-ai-workflows-with-pipelex/pipe-operators/PipeLLM.md).#### Execute from Python+First, create an inputs JSON file:++`character_inputs.json`+```json+{+ "character": {+ "concept": "character.Character",+ "content": {+ "name": "Elias",+ "age": 38,+ "gender": "man",+ "occupation": "explorer",+ "description": "Elias Varrin is a 38-year-old man, standing at approximately 1.85 meters tall, with a lean, weathered frame shaped by decades of travel through remote and often unforgiving landscapes. His name, though not widely known, carries weight among historians, explorers, and those who trade in whispered legends. Elias has piercing storm-gray eyes that scan every environment with sharp precision, and his ash-blond hair—flecked with early streaks of grey—is usually tucked beneath a wide-brimmed, timeworn hat."+ }+ }+}+```++Then load and execute:+```pythonimport asyncio--from pipelex.core.stuffs.stuff_factory import StuffFactory-from pipelex.core.memory.working_memory_factory import WorkingMemoryFactory-from pipelex.pipelex import Pipelex+import jsonfrom pipelex.pipeline.execute import execute_pipeline+from pipelex.pipelex import Pipelex-from character_model import Character, CharacterMetadata+from character_model import CharacterMetadataasync def process_existing_character():- # Your existing data- character = Character(- name="Elias",- age=38,- gender="man",- occupation="explorer",- description="""Elias Varrin is a 38-year-old man, standing at approximately 1.85 meters tall, with a lean,- weathered frame shaped by decades of travel through remote and often unforgiving landscapes.- His name, though not widely known, carries weight among historians, explorers, and those who trade in whispered legends.- Elias has piercing storm-gray eyes that scan every environment with sharp precision, and his ash-blond hair—flecked with- early streaks of grey—is usually tucked beneath a wide-brimmed, timeworn hat.His hands are etched with fine scars and stained- with ink, each mark a silent record of years spent charting unrecorded lands and handling fragile relics of lost civilizations.- He moves with quiet purpose and speaks with a calm, thoughtful cadence that suggests he's always listening for more than just what's said.""",- )- # Wrap it into a stuff object- character_stuff = StuffFactory.make_from_concept_string(- concept_string="character.Character", # <- `character` is the domain, `Character` is the concept name- name="character",- content=character,- )- # Add it to the working memory- working_memory = WorkingMemoryFactory.make_from_single_stuff(- stuff=character_stuff,- )- # Run the pipe identified by its pipe_code (it's the name of the pipe)+ # Load inputs from JSON file+ with open("character_inputs.json", "r", encoding="utf-8") as f:+ inputs = json.load(f)++ # Run the pipe with loaded inputspipe_output = await execute_pipeline(pipe_code="extract_character_1",- working_memory=working_memory,+ inputs=inputs,)# Get the result as a properly typed instance- extracted_metadata = pipe_output.main_stuff_as(content_type=CharacterMetadata) # <- This is the output of your pipe, properly typed+ extracted_metadata = pipe_output.main_stuff_as(content_type=CharacterMetadata)print(extracted_metadata)@@ -299,7 +311,7 @@ Now that you understand the basics, explore more:**Learn More:**- [Cookbook Examples](../cookbook-examples/index.md) - Real-world examples and patterns-- [Build Reliable AI Workflows](../build-reliable-ai-workflows-with-pipelex/kick-off-a-knowledge-pipeline-project.md) - Deep dive into pipeline design+- [Build Reliable AI Workflows](../build-reliable-ai-workflows-with-pipelex/kick-off-a-pipelex-workflow-project.md) - Deep dive into pipeline design- [Pipe Operators](../build-reliable-ai-workflows-with-pipelex/pipe-operators/index.md) - PipeLLM, PipeExtract, PipeCompose, and more- [Pipe Controllers](../build-reliable-ai-workflows-with-pipelex/pipe-controllers/index.md) - PipeSequence, PipeParallel, PipeBatch, PipeConditiondiff --git a/docs/pages/quick-start/structured_character_sheet.png b/docs/pages/writing-workflows/structured_character_sheet.pngsimilarity index 100%rename from docs/pages/quick-start/structured_character_sheet.pngrename to docs/pages/writing-workflows/structured_character_sheet.pngdiff --git a/docs/pages/quick-start/structured_character_sheet_json.png b/docs/pages/writing-workflows/structured_character_sheet_json.pngsimilarity index 100%rename from docs/pages/quick-start/structured_character_sheet_json.pngrename to docs/pages/writing-workflows/structured_character_sheet_json.pngdiff --git a/mkdocs.yml b/mkdocs.ymlindex 16bcd4a78..797964ee9 100644--- a/mkdocs.yml+++ b/mkdocs.yml@@ -66,6 +66,7 @@ plugins:markdown_extensions:- meta+ - admonition- attr_list- md_in_html- pymdownx.blocks.caption@@ -85,7 +86,7 @@ markdown_extensions:nav:- Home:- Welcome: index.md- - Quick-start: pages/quick-start/index.md+ - Writing Workflows: pages/writing-workflows/index.md- Setup:- Configure AI Providers: pages/setup/configure-ai-providers.md- Project Organization: pages/setup/project-organization.md@@ -109,7 +110,7 @@ nav:- Screenplay Generator (wip): pages/cookbook-examples/write-screenplay.md- Tweet Optimizer (wip): pages/cookbook-examples/write-tweet.md- Build Reliable AI Workflows:- - Kick off a Pipeline Project: pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-knowledge-pipeline-project.md+ - Kick off a Pipeline Project: pages/build-reliable-ai-workflows-with-pipelex/kick-off-a-pipelex-workflow-project.md- Define Your Concepts: pages/build-reliable-ai-workflows-with-pipelex/define_your_concepts.md- Structuring Concepts: pages/build-reliable-ai-workflows-with-pipelex/structuring-concepts.md- Design and Run Pipelines: pages/build-reliable-ai-workflows-with-pipelex/design_and_run_pipelines.md@@ -165,12 +166,10 @@ nav:- Secrets Provider: pages/advanced-customization/secrets-provider-injection.md- Reporting Delegate: pages/advanced-customization/reporting-delegate-injection.md- Pipeline Tracker: pages/advanced-customization/pipeline-tracker-injection.md- - Activity Manager: pages/advanced-customization/activity-manager-injection.md- Storage Provider: pages/advanced-customization/storage-provider-injection.md- Template Provider: pages/advanced-customization/template-provider-injection.md- Content Generator: pages/advanced-customization/content-generator-injection.md- Pipe Router: pages/advanced-customization/pipe-router-injection.md- - Plugin Manager: pages/advanced-customization/plugin-manager-injection.md- License: license.md- Contributing: contributing.md- Code of Conduct: CODE_OF_CONDUCT.mddiff --git a/pipelex/cli/commands/doctor_cmd.py b/pipelex/cli/commands/doctor_cmd.pyindex 874f1f295..d961cd437 100644--- a/pipelex/cli/commands/doctor_cmd.py+++ b/pipelex/cli/commands/doctor_cmd.py@@ -240,51 +240,63 @@ def display_health_report(# Recommended actionsif not all_healthy:- console.print("[bold]Recommended Actions[/bold]")-# Check what can be auto-fixedcan_auto_fix_config = not config_healthy and config_missing_count > 0can_auto_fix_telemetry = not telemetry_healthy and "not found" in telemetry_message.lower()+ has_telemetry_validation_error = not telemetry_healthy and "not found" not in telemetry_message.lower()- if can_auto_fix_config:- console.print(" • Run [cyan]pipelex init config[/cyan] to install missing configuration files")+ # Determine if we have any recommendations to show+ has_recommendations = (+ can_auto_fix_config or can_auto_fix_telemetry or has_telemetry_validation_error or (not backends_healthy and backend_reports)+ )- if can_auto_fix_telemetry:- console.print(" • Run [cyan]pipelex init telemetry[/cyan] to configure telemetry preferences")+ if has_recommendations:+ console.print("[bold]Recommended Actions[/bold]")- if not backends_healthy and backend_reports:- # Collect all missing and placeholder vars- all_missing_vars: set[str] = set()- all_placeholder_vars: set[str] = set()+ if can_auto_fix_config:+ console.print(" • Run [cyan]pipelex init config[/cyan] to install missing configuration files")- for backend_report in backend_reports.values():- if not backend_report.all_credentials_valid:- all_missing_vars.update(backend_report.missing_vars)- all_placeholder_vars.update(backend_report.placeholder_vars)+ if can_auto_fix_telemetry:+ console.print(" • Run [cyan]pipelex init telemetry[/cyan] to configure telemetry preferences")- if all_missing_vars:- console.print(" • Set the following environment variables:")- for var_name in sorted(all_missing_vars):- console.print(f" - {var_name}")+ if has_telemetry_validation_error:+ console.print(" • Fix validation errors in [cyan].pipelex/telemetry.toml[/cyan]")+ console.print(" or run [cyan]pipelex init telemetry --reset[/cyan] to regenerate")- if all_placeholder_vars:- console.print(" • Replace placeholder values for:")- for var_name in sorted(all_placeholder_vars):- console.print(f" - {var_name}")+ if not backends_healthy and backend_reports:+ # Collect all missing and placeholder vars+ all_missing_vars: set[str] = set()+ all_placeholder_vars: set[str] = set()- console.print()+ for backend_report in backend_reports.values():+ if not backend_report.all_credentials_valid:+ all_missing_vars.update(backend_report.missing_vars)+ all_placeholder_vars.update(backend_report.placeholder_vars)++ if all_missing_vars:+ console.print(" • Set the following environment variables:")+ for var_name in sorted(all_missing_vars):+ console.print(f" - {var_name}")++ if all_placeholder_vars:+ console.print(" • Replace placeholder values for:")+ for var_name in sorted(all_placeholder_vars):+ console.print(f" - {var_name}")- # Only suggest --fix if there are auto-fixable issues- if can_auto_fix_config or can_auto_fix_telemetry:- console.print("[dim]Run[/dim] [cyan]pipelex doctor --fix[/cyan] [dim]to interactively fix auto-fixable issues.[/dim]")console.print()+ # Only suggest --fix if there are auto-fixable issues+ if can_auto_fix_config or can_auto_fix_telemetry:+ console.print("[dim]Run[/dim] [cyan]pipelex doctor --fix[/cyan] [dim]to interactively fix auto-fixable issues.[/dim]")+ console.print()+# Show Discord support for manual-fix issues (regardless of --fix flag)has_config_validation_error = not config_healthy and config_missing_count == 0has_backend_credential_issues = not backends_healthy and backend_reports- if has_config_validation_error or has_backend_credential_issues:- console.print("[dim]If you need help with manual fixes, join our Discord community:[/dim]")- console.print("[cyan]https://go.pipelex.com/discord[/cyan]")+ if has_config_validation_error or has_backend_credential_issues or has_telemetry_validation_error:+ console.print("[dim]If you need help with manual fixes:[/dim]")+ console.print(" [cyan]https://docs.pipelex.com[/cyan] - Documentation")+ console.print(" [cyan]https://go.pipelex.com/discord[/cyan] - Discord Community")console.print()@@ -330,6 +342,7 @@ def doctor_cmd(# Determine what requires manual fixeshas_config_validation_error = not config_healthy and config_missing_count == 0+ has_telemetry_validation_error = not telemetry_healthy and "not found" not in telemetry_message.lower()has_backend_credential_issues = not backends_healthy and backend_reports# If --fix flag is provided, offer to fix auto-fixable issues@@ -360,7 +373,7 @@ def doctor_cmd(console.print()# Handle issues that can't be auto-fixed- if has_config_validation_error or has_backend_credential_issues:+ if has_config_validation_error or has_telemetry_validation_error or has_backend_credential_issues:console.print("[bold yellow]Manual Fixes Required[/bold yellow]")console.print()@@ -373,6 +386,15 @@ def doctor_cmd(console.print("or run [cyan]pipelex init config --reset[/cyan] to regenerate from template.")console.print()+ # Telemetry validation errors+ if has_telemetry_validation_error:+ console.print("[bold]Telemetry validation error:[/bold]")+ console.print(f" {telemetry_message}")+ console.print()+ console.print("You can fix this manually by editing [cyan].pipelex/telemetry.toml[/cyan]")+ console.print("or run [cyan]pipelex init telemetry --reset[/cyan] to regenerate from template.")+ console.print()+# Backend credentialsif has_backend_credential_issues:all_missing_vars: set[str] = set()@@ -421,7 +443,8 @@ def doctor_cmd(console.print()console.print(f"[red]✗ Unexpected error: {exc!s}[/red]")console.print()- console.print("[dim]If you need help, join our Discord community:[/dim]")- console.print("[cyan]https://go.pipelex.com/discord[/cyan]")+ console.print("[dim]If you need help:[/dim]")+ console.print(" [cyan]https://docs.pipelex.com[/cyan] - Documentation")+ console.print(" [cyan]https://go.pipelex.com/discord[/cyan] - Discord Community")console.print()sys.exit(1)diff --git a/pipelex/kit/configs/inference/backends.toml b/pipelex/kit/configs/inference/backends.tomlindex 62e51ab9a..027d9fee0 100644--- a/pipelex/kit/configs/inference/backends.toml+++ b/pipelex/kit/configs/inference/backends.toml@@ -1,3 +1,15 @@+####################################################################################################+# Pipelex Inference Backends Configuration+####################################################################################################+#+# This file configures the inference backends available to Pipelex.+# Each backend connects to a different AI service provider (OpenAI, Anthropic, Google, etc.).+#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#+####################################################################################################+[pipelex_inference]display_name = "⭐ Pipelex Inference"enabled = true@@ -12,7 +24,7 @@ api_key = "${AZURE_API_KEY}"api_version = "${AZURE_API_VERSION}"[bedrock]-display_name = "AWS Bedrock"+display_name = "Amazon Bedrock"enabled = falseaws_region = "${AWS_REGION}"diff --git a/pipelex/kit/configs/inference/backends/anthropic.toml b/pipelex/kit/configs/inference/backends/anthropic.tomlindex e0daf1c3a..4b57964c4 100644--- a/pipelex/kit/configs/inference/backends/anthropic.toml+++ b/pipelex/kit/configs/inference/backends/anthropic.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["claude-3.5-sonnet"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/azure_openai.toml b/pipelex/kit/configs/inference/backends/azure_openai.tomlindex 5943007c4..135638ad5 100644--- a/pipelex/kit/configs/inference/backends/azure_openai.toml+++ b/pipelex/kit/configs/inference/backends/azure_openai.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gpt-4.1"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/bedrock.toml b/pipelex/kit/configs/inference/backends/bedrock.tomlindex e572302c8..c27baf0b5 100644--- a/pipelex/kit/configs/inference/backends/bedrock.toml+++ b/pipelex/kit/configs/inference/backends/bedrock.toml@@ -1,16 +1,19 @@################################################################################-# AWS Bedrock Backend Configuration+# Amazon Bedrock Backend Configuration#################################################################################-# This file defines the model specifications for AWS Bedrock models.+# This file defines the model specifications for Amazon Bedrock models.# It contains model definitions for various language models-# accessible through the AWS Bedrock service.+# accessible through the Amazon Bedrock service.## Configuration structure:# - Each model is defined in its own section with the model name as the header# - Headers with dots must be quoted (e.g., ["claude-3.5-sonnet"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/blackboxai.toml b/pipelex/kit/configs/inference/backends/blackboxai.tomlindex 4202fd79b..916603304 100644--- a/pipelex/kit/configs/inference/backends/blackboxai.toml+++ b/pipelex/kit/configs/inference/backends/blackboxai.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gpt-4.5-preview"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/fal.toml b/pipelex/kit/configs/inference/backends/fal.tomlindex ed15e6bd3..d54a25fcc 100644--- a/pipelex/kit/configs/inference/backends/fal.toml+++ b/pipelex/kit/configs/inference/backends/fal.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["flux-pro/v1.1"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/google.toml b/pipelex/kit/configs/inference/backends/google.tomlindex 7fdc6cd64..68c39d9d5 100644--- a/pipelex/kit/configs/inference/backends/google.toml+++ b/pipelex/kit/configs/inference/backends/google.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gemini-2.0-flash"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/internal.toml b/pipelex/kit/configs/inference/backends/internal.tomlindex 0dbd6e7be..5bb968356 100644--- a/pipelex/kit/configs/inference/backends/internal.toml+++ b/pipelex/kit/configs/inference/backends/internal.toml@@ -9,6 +9,9 @@# - Each model is defined in its own section with the model name as the header# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/mistral.toml b/pipelex/kit/configs/inference/backends/mistral.tomlindex 634736c74..97e40d0d0 100644--- a/pipelex/kit/configs/inference/backends/mistral.toml+++ b/pipelex/kit/configs/inference/backends/mistral.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["ministral-3b"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/ollama.toml b/pipelex/kit/configs/inference/backends/ollama.tomlindex 7a56b7384..ab0f51617 100644--- a/pipelex/kit/configs/inference/backends/ollama.toml+++ b/pipelex/kit/configs/inference/backends/ollama.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["mistral-small3.1-24b"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/openai.toml b/pipelex/kit/configs/inference/backends/openai.tomlindex 4eabe7491..4f1148144 100644--- a/pipelex/kit/configs/inference/backends/openai.toml+++ b/pipelex/kit/configs/inference/backends/openai.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gpt-4.1"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/perplexity.toml b/pipelex/kit/configs/inference/backends/perplexity.tomlindex ea905512c..3fa52fccf 100644--- a/pipelex/kit/configs/inference/backends/perplexity.toml+++ b/pipelex/kit/configs/inference/backends/perplexity.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["sonar-pro"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/pipelex_inference.toml b/pipelex/kit/configs/inference/backends/pipelex_inference.tomlindex c04fe8563..805b761ad 100644--- a/pipelex/kit/configs/inference/backends/pipelex_inference.toml+++ b/pipelex/kit/configs/inference/backends/pipelex_inference.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gpt-4.1"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/vertexai.toml b/pipelex/kit/configs/inference/backends/vertexai.tomlindex cb8edb13e..da01d4f1e 100644--- a/pipelex/kit/configs/inference/backends/vertexai.toml+++ b/pipelex/kit/configs/inference/backends/vertexai.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["gemini-2.0-flash"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/backends/xai.toml b/pipelex/kit/configs/inference/backends/xai.tomlindex 545b905f2..a4bb433ad 100644--- a/pipelex/kit/configs/inference/backends/xai.toml+++ b/pipelex/kit/configs/inference/backends/xai.toml@@ -11,6 +11,9 @@# - Headers with dots must be quoted (e.g., ["grok-3"])# - Model costs are in USD per million tokens (input/output)#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#################################################################################################################################################################diff --git a/pipelex/kit/configs/inference/deck/base_deck.toml b/pipelex/kit/configs/inference/deck/base_deck.tomlindex 7a52ca603..ff09ecf6d 100644--- a/pipelex/kit/configs/inference/deck/base_deck.toml+++ b/pipelex/kit/configs/inference/deck/base_deck.toml@@ -1,5 +1,16 @@--# Base model deck+####################################################################################################+# Pipelex Model Deck - Base Configuration+####################################################################################################+#+# This file defines model aliases and presets for:+# - LLMs (language models for text generation and structured output)+# - Image generation models (for creating images from text prompts)+# - Document extraction models (OCR and text extraction from PDFs/images)+#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#+######################################################################################################################################################################################################### Aliasesdiff --git a/pipelex/kit/configs/inference/deck/overrides.toml b/pipelex/kit/configs/inference/deck/overrides.tomlindex a6e8a49c6..08814dbc2 100644--- a/pipelex/kit/configs/inference/deck/overrides.toml+++ b/pipelex/kit/configs/inference/deck/overrides.toml@@ -1,4 +1,14 @@-+####################################################################################################+# Pipelex Model Deck - Overrides+####################################################################################################+#+# This file allows you to override the default model choices defined in base_deck.toml.+# You can customize presets for LLMs, image generation, and document extraction models.+#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#+######################################################################################################################################################################################################### LLM Deck overridesdiff --git a/pipelex/kit/configs/inference/routing_profiles.toml b/pipelex/kit/configs/inference/routing_profiles.tomlindex 40138b702..e35566fef 100644--- a/pipelex/kit/configs/inference/routing_profiles.toml+++ b/pipelex/kit/configs/inference/routing_profiles.toml@@ -3,6 +3,9 @@# This file controls which backend serves which model.# Simply change the 'active' field to switch profiles,# or you can add your own custom profiles.+#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord# ================================================# Which profile to use (change this to switch routing)diff --git a/pipelex/kit/configs/pipelex.toml b/pipelex/kit/configs/pipelex.tomlindex 5dc8a89b1..570dae25e 100644--- a/pipelex/kit/configs/pipelex.toml+++ b/pipelex/kit/configs/pipelex.toml@@ -21,6 +21,9 @@# - Feature flags for tracking and reporting# - Observer and reporting output directories#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#####################################################################################################[pipelex.scan_config]diff --git a/pipelex/kit/configs/telemetry.toml b/pipelex/kit/configs/telemetry.tomlindex bf3ea0e5b..8c613294d 100644--- a/pipelex/kit/configs/telemetry.toml+++ b/pipelex/kit/configs/telemetry.toml@@ -1,3 +1,15 @@+####################################################################################################+# Pipelex Telemetry Configuration+####################################################################################################+#+# This file controls telemetry settings for Pipelex usage analytics.+# Telemetry helps us improve Pipelex by understanding how it's used.+#+# Documentation: https://docs.pipelex.com+# Support: https://go.pipelex.com/discord+#+####################################################################################################+telemetry_mode = "off" # Values: "off" | "anonymous" | "identified"host = "https://eu.i.posthog.com"project_api_key = "phc_HPJnNKpIXh0SxNDYyTAyUtnq9KxNNZJWQszynsWVx4Y"