Skip to content

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: update search docs for PipeSearch params, backend config, and native concepts

Louis Choquel5b5bb5147a68
diff --git a/docs/home/6-build-reliable-ai-workflows/concepts/native-concepts.md b/docs/home/6-build-reliable-ai-workflows/concepts/native-concepts.md
index 264255cb6..82a08c686 100644
--- a/docs/home/6-build-reliable-ai-workflows/concepts/native-concepts.md
+++ b/docs/home/6-build-reliable-ai-workflows/concepts/native-concepts.md
@@ -103,8 +103,15 @@ Combines text with one or more images:
class TextAndImagesContent(StuffContent):
text: Optional[TextContent]
images: Optional[List[ImageContent]]
+ raw_html: Optional[str]
```
+**Fields:**
+
+- `text`: The text content
+- `images`: A list of images extracted from the content
+- `raw_html`: The raw HTML of the fetched page, when requested via `include_raw_html`
+
**Use for:** Rich content combining text and visuals, extracted document content, reports with diagrams.
### PageContent
diff --git a/docs/home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeSearch.md b/docs/home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeSearch.md
index 5b16495f9..97eeb6470 100644
--- a/docs/home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeSearch.md
+++ b/docs/home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeSearch.md
@@ -20,7 +20,7 @@ The output is a `SearchResult` (or a concept that refines it), which contains:
PipeSearch uses the unified inference backend system to manage search providers. This means you can:
- Use different search providers (e.g., Linkup)
-- Configure search depth (standard vs deep) through presets
+- Choose between standard and deep search models, with presets for each
- Route search requests through the same backend system as LLMs and other operators
Common search presets:
@@ -38,6 +38,12 @@ Common search presets:
| `output` | string | The output concept produced by the search. Must be `SearchResult` or a concept that refines `SearchResult`. | Yes |
| `model` | string | The search model preset to use (e.g., `"$standard"`, `"$deep"`). Defaults to the model specified in the global config. | No |
| `prompt` | string | The search query. Can be a static string or reference input variables using `$` prefix (e.g., `"What is $topic?"`). | Yes |
+| `include_images` | boolean | Whether to include images in search results. Overrides the preset setting. | No |
+| `max_results` | integer | Maximum number of results to return. Overrides the preset setting. | No |
+| `from_date` | string | Start date filter in YYYY-MM-DD format. Only return results from this date onwards. | No |
+| `to_date` | string | End date filter in YYYY-MM-DD format. Only return results up to this date. | No |
+| `include_domains` | list of strings | Restrict search to these domains only. | No |
+| `exclude_domains` | list of strings | Exclude results from these domains. | No |
### Example: Static search query
@@ -80,4 +86,20 @@ model = "$deep"
prompt = "What are the main details about $topic?"
```
+### Example: Filtering by date and domain
+
+Use date filters and domain restrictions to narrow search results.
+
+```toml
+[pipe.search_recent_from_sources]
+type = "PipeSearch"
+description = "Search specific sources for recent news"
+inputs = { topic = "Text" }
+output = "SearchResult"
+model = "$standard"
+prompt = "What are the latest developments about $topic?"
+from_date = "2026-01-01"
+include_domains = ["reuters.com", "apnews.com", "bbc.com"]
+```
+
The output of PipeSearch must be `SearchResult` or a concept that refines `SearchResult`. After execution, the output contains the synthesized `answer` and a list of `sources` with their names, URLs, and snippets.
diff --git a/docs/home/6-build-reliable-ai-workflows/pipes/pipe-operators/index.md b/docs/home/6-build-reliable-ai-workflows/pipes/pipe-operators/index.md
index 1c77ba2a8..28c17c495 100644
--- a/docs/home/6-build-reliable-ai-workflows/pipes/pipe-operators/index.md
+++ b/docs/home/6-build-reliable-ai-workflows/pipes/pipe-operators/index.md
@@ -88,4 +88,4 @@ Searches the web and returns structured results with sources.
- Web search via configurable providers
- Structured results with answer and source citations
- Dynamic prompt templates with `$variable` syntax
-- Configurable search depth (standard vs deep)
+- Standard and deep search models
diff --git a/docs/home/7-configuration/config-technical/inference-backend-config.md b/docs/home/7-configuration/config-technical/inference-backend-config.md
index 9ac2f24f4..ad3ed6528 100644
--- a/docs/home/7-configuration/config-technical/inference-backend-config.md
+++ b/docs/home/7-configuration/config-technical/inference-backend-config.md
@@ -65,12 +65,14 @@ All inference backend configurations are stored in the `.pipelex/inference/` dir
│ ├── mistral.toml # Mistral models (LLMs, OCR)
│ ├── vertexai.toml # Google Vertex AI models (LLMs)
│ ├── fal.toml # FAL models (image generation)
+ │ ├── linkup.toml # Linkup models (web search)
│ ├── internal.toml # Internal/local models (OCR)
│ └── ...
└── deck/ # Model deck configurations
├── 1_llm_deck.toml # LLM aliases & presets
├── 2_img_gen_deck.toml # Image generation config
├── 3_extract_deck.toml # Document extraction config
+ ├── 4_search_deck.toml # Web search config
├── x_custom_llm_deck.toml # Custom LLM waterfalls/overrides
└── x_custom_extract_deck.toml # Custom extract waterfalls
```
@@ -251,6 +253,8 @@ GCP_LOCATION=
GCP_CREDENTIALS_FILE_PATH=gcp_credentials.json
FAL_API_KEY=
+
+LINKUP_API_KEY=
# ... (see .env.example for full list)
```
@@ -275,6 +279,10 @@ api_key = "${MISTRAL_API_KEY}"
enabled = true
api_key = "${FAL_API_KEY}"
+[linkup]
+enabled = true
+api_key = "${LINKUP_API_KEY}"
+
[internal]
enabled = true
# No API key needed for internal/local processing
@@ -513,6 +521,29 @@ model = "$gen-image-fast" # Uses fast image generation preset
model = "$gen-image-high-quality" # Uses high quality image generation preset
```
+### Search Presets
+
+Search presets combine a search model with result options. Defined in `.pipelex/inference/deck/4_search_deck.toml`:
+
+```toml
+[search.presets]
+standard = { model = "linkup-standard", include_images = false, include_inline_citations = true }
+deep = { model = "linkup-deep", include_images = false, include_inline_citations = true }
+```
+
+When using search presets in `.mthds` files, prefix them with `$`:
+
+```toml
+model = "$standard" # Standard web search
+model = "$deep" # More thorough web search
+```
+
+Search presets support the following options:
+
+- `model`: The search model to use (e.g., `linkup-standard`, `linkup-deep`)
+- `include_images`: Whether to include images in search results
+- `include_inline_citations`: Whether to include inline citations in the answer
+
### Default Choices
Set default models for different types of AI operations:
@@ -527,6 +558,9 @@ choice_default = "@default-extract-document"
[img_gen]
choice_default = "$gen-image"
+
+[search]
+choice_default = "@default-search"
```
Note the sigil prefixes: `@` for aliases and `$` for presets.