Commit e5b010d
docs(integrations): catch up Parallel pages to langchain-parallel 0.4.0 (#3787)
## Overview
Bring the Parallel integration pages current with
[`langchain-parallel`](https://github.com/parallel-web/langchain-parallel)
0.4.0 (now on PyPI). 0.4.0 adds five new public surfaces (Retriever,
FindAll, Task API, Monitor) and renames the two pre-0.4 classes to
canonical names (`ChatParallel`, `ParallelSearchTool`; the old names
remain importable as aliases). Existing pages were stuck on the 0.2.x
surface.
FYI - I am working with Karan and submitting this PR on behalf of
Parallel Web Systems.
Package:
[github.com/parallel-web/langchain-parallel](https://github.com/parallel-web/langchain-parallel)
·
[pypi.org/project/langchain-parallel](https://pypi.org/project/langchain-parallel/)
## Type of change
**Type:** New documentation page + Update existing documentation
- 4 new pages: `retrievers/parallel.mdx`, `tools/parallel_findall.mdx`,
`tools/parallel_task.mdx`, `tools/parallel_monitor.mdx`
- 5 updated pages: `chat/parallel.mdx`, `tools/parallel_search.mdx`,
`tools/parallel_extract.mdx`, `providers/parallel.mdx`, plus the index
pages `tools/index.mdx` and `retrievers/index.mdx`
- 1 plumbing change: `pipeline/preprocessors/link_map.py` adds
`@[ClassName]` entries for the 0.4.0 classes
## Related issues/PRs
- GitHub issue: n/a
- Feature PR: n/a
- Source package:
[parallel-web/langchain-parallel](https://github.com/parallel-web/langchain-parallel)
## Checklist
- [x] I have read the [contributing guidelines](README.md), including
the [language
policy](https://docs.langchain.com/oss/python/contributing/overview#language-policy)
- [x] I have tested my changes locally using `docs dev` — built via
`pipeline build`, served with `mint dev`, browsed all 8 pages in a real
browser via Playwright
- [x] All code examples have been tested and work correctly — every
Python snippet across all 8 pages was executed live against the Parallel
API (and Anthropic, for the `create_agent` chaining examples)
- [x] I have used **root relative** paths for internal links
(`/oss/...`)
- [x] I have updated navigation in `src/docs.json` if needed — n/a for
individual integration component pages (they surface through
`chat/index`, `tools/index`, `retrievers/index`, `providers/parallel`);
the relevant index pages and the provider page were updated to list the
new entries
## Additional notes
### Detailed scope
**New pages**
- `retrievers/parallel.mdx` — `ParallelSearchRetriever`
(`BaseRetriever`).
- `tools/parallel_findall.mdx` — `ParallelFindAllTool`.
- `tools/parallel_task.mdx` — unified Task API page covering
`ParallelTaskRunTool`, `ParallelDeepResearch`, `ParallelTaskGroup`,
`ParallelEnrichment`, plus the helpers (`parse_basis`,
`build_task_spec`, `verify_webhook`, BYOMCP via `McpServer`).
- `tools/parallel_monitor.mdx` — `ParallelMonitor`.
**Updated pages**
- `chat/parallel.mdx` — refreshed for canonical `ChatParallel`; new
sections for `with_structured_output()`, citations / `interaction_id`,
and a model decision table (`speed` vs `lite` / `base` / `core`).
- `tools/parallel_search.mdx` — refreshed for canonical
`ParallelSearchTool`; documents the GA shape (`search_queries` required,
`mode='basic'`/`'advanced'`, new `SourcePolicy` pydantic model, GA
forwarding params).
- `tools/parallel_extract.mdx` — `Optional[ExcerptSettings]` and
`full_content` precedence; cross-link to search.
- `providers/parallel.mdx` — surfaces all six current Parallel
components.
- `tools/index.mdx`, `retrievers/index.mdx` — list entries for the new
pages.
### Areas worth careful review
1. **Unified Task API page.** `ParallelTaskRunTool` is a `BaseTool`;
`ParallelDeepResearch`, `ParallelTaskGroup`, and `ParallelEnrichment`
are `Runnable`s/plain classes. Putting all four on one page under
`/tools/` is intentional — they share the same processor menu,
basis-citation shape, and webhook-verification helpers, and a typical
reader picking between them benefits from comparing in one place. The
page leads with a "Which surface should I use?" decision blurb and a
four-row integration-details table. Happy to split if you'd rather.
2. **`ParallelMonitor` placement.** Strictly, Monitor is a stateful CRUD
client (create/retrieve/list/delete/list_events/simulate_event), not a
`BaseTool`. We placed it under `/tools/` because that's the most
discoverable home in the current integration taxonomy.
3. **`@[ClassName]` link-map entries for the new 0.4.0 surfaces** point
at `reference.langchain.com/python/langchain-parallel/...` paths that
will only resolve once the reference site rebuilds against PyPI 0.4.0
(already published). Forward-correct, not broken in CI behavior —
flagging for awareness.
### Validation
- `scripts/check_cross_refs.py` — ✅ all references resolve.
- `make lint_prose` (Vale) on the touched files — ✅ 0 errors, 0
warnings, 0 suggestions.
- `make broken-links` — 0 of the build's broken links touch any of the
changed/added Parallel files.
- `pipeline/preprocessors/link_map.py` passes `ruff format --check`,
`ruff check`, and `ty check` individually.
- All `docs.parallel.ai/...` URLs in the new content audited live —
10/10 HTTP 200.
- All 8 pages browsed in `mint dev` via Playwright: components, tables,
code blocks, callouts, cross-links, output blocks render correctly.
- Every Python snippet across all 8 pages exercised live against the
Parallel API. This includes the multi-minute surfaces:
`ParallelFindAllTool` `core` generator (38 candidates returned),
`ParallelDeepResearch` `pro-fast` (default processor, structured
30-citation report), and the full `ParallelMonitor` CRUD lifecycle. The
`create_agent` chaining examples were exercised against Anthropic.
### AI agent disclosure
This PR was authored with substantial assistance from an AI agent
(Claude). All content was reviewed by the human contributor; code
examples were verified against the package source and exercised live
against the Parallel API.
---------
Co-authored-by: Mason Daugherty <github@mdrxy.com>
Co-authored-by: Mason Daugherty <mason@langchain.dev>1 parent cde99bb commit e5b010d
11 files changed
Lines changed: 1094 additions & 402 deletions
File tree
- pipeline/preprocessors
- src/oss/python/integrations
- chat
- providers
- retrievers
- tools
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
178 | 178 | | |
179 | 179 | | |
180 | 180 | | |
| 181 | + | |
181 | 182 | | |
| 183 | + | |
182 | 184 | | |
183 | 185 | | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
184 | 194 | | |
185 | 195 | | |
186 | 196 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
| 2 | + | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | | - | |
9 | | - | |
| 8 | + | |
10 | 9 | | |
11 | | - | |
12 | | - | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
19 | | - | |
20 | | - | |
| 19 | + | |
| 20 | + | |
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
26 | | - | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
27 | 38 | | |
28 | 39 | | |
29 | 40 | | |
30 | | - | |
| 41 | + | |
31 | 42 | | |
32 | 43 | | |
33 | 44 | | |
| |||
42 | 53 | | |
43 | 54 | | |
44 | 55 | | |
45 | | - | |
| 56 | + | |
46 | 57 | | |
47 | 58 | | |
48 | 59 | | |
49 | 60 | | |
50 | 61 | | |
51 | 62 | | |
52 | | - | |
| 63 | + | |
53 | 64 | | |
54 | 65 | | |
55 | 66 | | |
56 | 67 | | |
57 | | - | |
58 | | - | |
59 | 68 | | |
60 | | - | |
| 69 | + | |
61 | 70 | | |
62 | | - | |
| 71 | + | |
63 | 72 | | |
64 | | - | |
65 | | - | |
66 | 73 | | |
67 | 74 | | |
68 | | - | |
69 | | - | |
70 | | - | |
| 75 | + | |
| 76 | + | |
71 | 77 | | |
72 | 78 | | |
73 | 79 | | |
74 | | - | |
75 | | - | |
76 | | - | |
77 | | - | |
78 | | - | |
79 | | - | |
80 | | - | |
81 | | - | |
82 | | - | |
| 80 | + | |
83 | 81 | | |
84 | 82 | | |
85 | 83 | | |
86 | 84 | | |
87 | 85 | | |
88 | | - | |
89 | | - | |
90 | | - | |
91 | | - | |
| 86 | + | |
92 | 87 | | |
93 | 88 | | |
94 | 89 | | |
95 | | - | |
96 | | - | |
97 | | - | |
98 | | - | |
99 | | - | |
100 | | - | |
101 | | - | |
102 | | - | |
103 | 90 | | |
104 | 91 | | |
105 | 92 | | |
106 | | - | |
107 | | - | |
108 | | - | |
109 | | - | |
110 | | - | |
111 | | - | |
112 | 93 | | |
113 | 94 | | |
114 | | - | |
| 95 | + | |
115 | 96 | | |
116 | 97 | | |
117 | 98 | | |
| |||
120 | 101 | | |
121 | 102 | | |
122 | 103 | | |
123 | | - | |
124 | | - | |
| 104 | + | |
| 105 | + | |
125 | 106 | | |
126 | 107 | | |
127 | 108 | | |
| |||
131 | 112 | | |
132 | 113 | | |
133 | 114 | | |
134 | | - | |
| 115 | + | |
135 | 116 | | |
136 | 117 | | |
137 | 118 | | |
138 | 119 | | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
139 | 136 | | |
140 | | - | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
141 | 161 | | |
142 | | - | |
143 | 162 | | |
144 | 163 | | |
145 | 164 | | |
146 | | - | |
| 165 | + | |
147 | 166 | | |
148 | 167 | | |
149 | 168 | | |
150 | 169 | | |
151 | 170 | | |
152 | 171 | | |
153 | | - | |
154 | | - | |
155 | 172 | | |
156 | 173 | | |
157 | | - | |
158 | | - | |
159 | 174 | | |
160 | | - | |
161 | 175 | | |
162 | 176 | | |
163 | | - | |
164 | 177 | | |
165 | 178 | | |
166 | 179 | | |
167 | 180 | | |
168 | | - | |
169 | | - | |
170 | 181 | | |
171 | 182 | | |
172 | | - | |
173 | | - | |
174 | | - | |
175 | | - | |
176 | | - | |
| 183 | + | |
177 | 184 | | |
178 | 185 | | |
179 | 186 | | |
180 | 187 | | |
| 188 | + | |
181 | 189 | | |
182 | 190 | | |
183 | | - | |
184 | | - | |
185 | | - | |
186 | | - | |
187 | | - | |
188 | | - | |
189 | 191 | | |
190 | 192 | | |
191 | | - | |
192 | | - | |
193 | 193 | | |
194 | 194 | | |
195 | 195 | | |
| 196 | + | |
196 | 197 | | |
197 | 198 | | |
198 | | - | |
199 | | - | |
200 | | - | |
201 | | - | |
202 | | - | |
| 199 | + | |
203 | 200 | | |
204 | 201 | | |
205 | 202 | | |
206 | | - | |
| 203 | + | |
207 | 204 | | |
208 | 205 | | |
209 | | - | |
| 206 | + | |
210 | 207 | | |
211 | 208 | | |
212 | | - | |
| 209 | + | |
213 | 210 | | |
214 | 211 | | |
215 | 212 | | |
| |||
218 | 215 | | |
219 | 216 | | |
220 | 217 | | |
221 | | - | |
222 | | - | |
223 | 218 | | |
224 | 219 | | |
225 | | - | |
226 | | - | |
227 | | - | |
228 | | - | |
229 | | - | |
| 220 | + | |
230 | 221 | | |
231 | 222 | | |
232 | | - | |
| 223 | + | |
233 | 224 | | |
234 | | - | |
235 | | - | |
| 225 | + | |
236 | 226 | | |
237 | 227 | | |
238 | 228 | | |
239 | 229 | | |
240 | 230 | | |
241 | 231 | | |
242 | 232 | | |
243 | | - | |
| 233 | + | |
244 | 234 | | |
245 | 235 | | |
246 | 236 | | |
247 | | - | |
| 237 | + | |
248 | 238 | | |
249 | 239 | | |
250 | 240 | | |
251 | | - | |
| 241 | + | |
252 | 242 | | |
253 | 243 | | |
254 | 244 | | |
255 | 245 | | |
256 | | - | |
| 246 | + | |
257 | 247 | | |
258 | 248 | | |
259 | 249 | | |
260 | | - | |
| 250 | + | |
261 | 251 | | |
262 | 252 | | |
263 | | - | |
264 | 253 | | |
265 | 254 | | |
266 | 255 | | |
267 | | - | |
268 | | - | |
269 | 256 | | |
270 | 257 | | |
271 | | - | |
| 258 | + | |
0 commit comments