Skip to content

docs: document Pipeline.stream(), ChatPromptBuilder insert tag, and Toolset run-scoped copies#11871

Draft
julian-risch wants to merge 1 commit into
v3from
docs/v3-simple-doc-updates-2
Draft

docs: document Pipeline.stream(), ChatPromptBuilder insert tag, and Toolset run-scoped copies#11871
julian-risch wants to merge 1 commit into
v3from
docs/v3-simple-doc-updates-2

Conversation

@julian-risch

@julian-risch julian-risch commented Jul 5, 2026

Copy link
Copy Markdown
Member

Related Issues

Proposed Changes:

  • feat: expose AsyncPipeline.stream for chunk-by-chunk consumption #11258AsyncPipeline docs: new "Streaming (stream)" execution method section with a runnable example — iterate the returned handle with async for to consume StreamingChunks, read the final output from handle.result, restrict sources via streaming_components, and control abandonment behavior with cancel_on_abandon. Note: the example uses Pipeline, matching the v3 merge of AsyncPipeline into Pipeline; the rest of the (stale) page is left for the MIGRATION.md-driven docs pass, which issue Introduce Preprocessor class that does splitting and cleaning  #381 explicitly does not track.
  • feat: Extend ChatPromptBuilder with insert tag #11486ChatPromptBuilder docs: new "The insert Tag" subsection under String Templates, documenting {% insert %} with a runnable example, expression/slice/index support, lossless round-tripping of all content types, and multiple-tag usage.
  • fix: Fix usage of SearchableToolset with Agent when selecting a subset of tools to be active #11564Toolset docs: new "Run-Scoped Copies and Tool Selection" section covering spawn() and get_selectable_tools(), per-run isolation (concurrent runs sharing a Toolset are safe), and runtime name-based selection via Agent.run(tools=[...]) keeping toolsets live. Also updated the SearchableToolset "Reusing the toolset across multiple agent runs" section, which still advised calling clear() between runs — discovered tools no longer persist across Agent runs.

How did you test it?

Notes for the reviewer

Checklist

🤖 Generated with Claude Code

…oolset run-scoped copies with name-based selection

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jul 5, 2026 1:01pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant