langchain-ai/docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/docs.git synced 2026-07-21 20:05:30 -04:00
Code Issues 490 Packages Projects Releases Wiki Activity

[PR #3787] [MERGED] docs(integrations): catch up Parallel pages to langchain-parallel 0.4.0 #3806

New Issue
Closed
opened 2026-06-05 18:53:12 -04:00 by yindo · 0 comments
yindo commented 2026-06-05 18:53:12 -04:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/3787
Author: @NormallyGaussian
Created: 4/28/2026
Status: ✅ Merged
Merged: 4/29/2026
Merged by: @mdrxy

Base: main ← Head: parallel-0.4.0-docs

📝 Commits (9)

  • 9733f91 docs(integrations): catch up Parallel pages to langchain-parallel 0.4.0
  • b17109c docs(integrations): fix Task output access + Monitor simulate_event note + latency notes
  • 4942810 Update src/oss/python/integrations/retrievers/parallel.mdx
  • cef4a7d Update src/oss/python/integrations/tools/parallel_extract.mdx
  • f649166 Update src/oss/python/integrations/tools/parallel_search.mdx
  • 31277eb Update src/oss/python/integrations/tools/parallel_task.mdx
  • 9c66122 Merge branch 'main' into parallel-0.4.0-docs
  • 1bfb44b docs(integrations): drop link_map edits; replace @[] with explicit links
  • ba1b1d3 Revert "docs(integrations): drop link_map edits; replace @[] with explicit links"

📊 Changes

11 files changed (+1094 additions, -402 deletions)

View changed files

📝 pipeline/preprocessors/link_map.py (+10 -0)
📝 src/oss/python/integrations/chat/parallel.mdx (+92 -105)
📝 src/oss/python/integrations/providers/parallel.mdx (+28 -11)
📝 src/oss/python/integrations/retrievers/index.mdx (+2 -0)
➕ src/oss/python/integrations/retrievers/parallel.mdx (+134 -0)
📝 src/oss/python/integrations/tools/index.mdx (+3 -0)
📝 src/oss/python/integrations/tools/parallel_extract.mdx (+97 -91)
➕ src/oss/python/integrations/tools/parallel_findall.mdx (+204 -0)
➕ src/oss/python/integrations/tools/parallel_monitor.mdx (+172 -0)
📝 src/oss/python/integrations/tools/parallel_search.mdx (+99 -195)
➕ src/oss/python/integrations/tools/parallel_task.mdx (+253 -0)

📄 Description

Overview

Bring the Parallel integration pages current with 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 · 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

Checklist

  • I have read the contributing guidelines, including the language policy
  • 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
  • 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)
  • I have used root relative paths for internal links (/oss/...)
  • 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 Runnables/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.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/docs/pull/3787 **Author:** [@NormallyGaussian](https://github.com/NormallyGaussian) **Created:** 4/28/2026 **Status:** ✅ Merged **Merged:** 4/29/2026 **Merged by:** [@mdrxy](https://github.com/mdrxy) **Base:** `main` ← **Head:** `parallel-0.4.0-docs` --- ### 📝 Commits (9) - [`9733f91`](https://github.com/langchain-ai/docs/commit/9733f918512ac72d4c47cac82c9219618705a58d) docs(integrations): catch up Parallel pages to langchain-parallel 0.4.0 - [`b17109c`](https://github.com/langchain-ai/docs/commit/b17109c8527547b568784a8fe1cbb13b0c6b033e) docs(integrations): fix Task output access + Monitor simulate_event note + latency notes - [`4942810`](https://github.com/langchain-ai/docs/commit/4942810742a777e8798da2d962aa3e4f056b71ea) Update src/oss/python/integrations/retrievers/parallel.mdx - [`cef4a7d`](https://github.com/langchain-ai/docs/commit/cef4a7da646294b10d361054b868f0afdca75658) Update src/oss/python/integrations/tools/parallel_extract.mdx - [`f649166`](https://github.com/langchain-ai/docs/commit/f649166cac5245595cc0be7af4c3bff07c84f529) Update src/oss/python/integrations/tools/parallel_search.mdx - [`31277eb`](https://github.com/langchain-ai/docs/commit/31277ebb4a31b6f24a771481668c9bd347fd241f) Update src/oss/python/integrations/tools/parallel_task.mdx - [`9c66122`](https://github.com/langchain-ai/docs/commit/9c661229716c5a588352e558c6351d06696abdee) Merge branch 'main' into parallel-0.4.0-docs - [`1bfb44b`](https://github.com/langchain-ai/docs/commit/1bfb44b879afb163051aa61b9afd788e58766669) docs(integrations): drop link_map edits; replace @[] with explicit links - [`ba1b1d3`](https://github.com/langchain-ai/docs/commit/ba1b1d3aab75a37eb6638d2c2722c2aa593c87f2) Revert "docs(integrations): drop link_map edits; replace @[] with explicit links" ### 📊 Changes **11 files changed** (+1094 additions, -402 deletions) <details> <summary>View changed files</summary> 📝 `pipeline/preprocessors/link_map.py` (+10 -0) 📝 `src/oss/python/integrations/chat/parallel.mdx` (+92 -105) 📝 `src/oss/python/integrations/providers/parallel.mdx` (+28 -11) 📝 `src/oss/python/integrations/retrievers/index.mdx` (+2 -0) ➕ `src/oss/python/integrations/retrievers/parallel.mdx` (+134 -0) 📝 `src/oss/python/integrations/tools/index.mdx` (+3 -0) 📝 `src/oss/python/integrations/tools/parallel_extract.mdx` (+97 -91) ➕ `src/oss/python/integrations/tools/parallel_findall.mdx` (+204 -0) ➕ `src/oss/python/integrations/tools/parallel_monitor.mdx` (+172 -0) 📝 `src/oss/python/integrations/tools/parallel_search.mdx` (+99 -195) ➕ `src/oss/python/integrations/tools/parallel_task.mdx` (+253 -0) </details> ### 📄 Description ## 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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 18:53:12 -04:00
yindo closed this issue 2026-06-05 18:53:12 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
deepagents
docs-infra
external
external
help wanted
integration
internal
internal
javascript
js/ts
langchain
langgraph
langsmith
needs-title
pull-request
Mirrored from GitHub Pull Request
 python
reference
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#3806
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?