Skip to content

docs: Update component and pipeline tool docs#11237

Merged
sjrl merged 4 commits into
mainfrom
update-comp-and-pipe-tool
May 4, 2026
Merged

docs: Update component and pipeline tool docs#11237
sjrl merged 4 commits into
mainfrom
update-comp-and-pipe-tool

Conversation

@sjrl
Copy link
Copy Markdown
Contributor

@sjrl sjrl commented May 4, 2026

Related Issues

Proposed Changes:

  • expanded docs for component and pipeline tool to explain what all init parameters can do
  • Updated example model in examples to gpt-5.4-nano instead of gpt-5-nano.
  • dded tips to suggest users to use these tools with Agent
  • Updated additional resources section to include more recent tutorials on agents that use the respective tool. No tutorial/cookbook uses PipelineTool so I omitted the section
  • added package name to follow what was done for other components in our docs so users can easily see how to install the tool type

How did you test it?

Ran code blocks locally to make sure they worked.

Notes for the reviewer

The inspiration for this update was to help users and agents identify recommended patterns for tool use in Haystack.

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 4, 2026

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

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment May 4, 2026 0:26am

Request Review

@sjrl sjrl self-assigned this May 4, 2026
@sjrl sjrl marked this pull request as ready for review May 4, 2026 12:12
@sjrl sjrl requested a review from a team as a code owner May 4, 2026 12:12
@sjrl sjrl requested review from davidsbatista and removed request for a team May 4, 2026 12:12
@claude
Copy link
Copy Markdown

claude Bot commented May 4, 2026

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@claude
Copy link
Copy Markdown

claude Bot commented May 4, 2026

Deleting test comment

@claude
Copy link
Copy Markdown

claude Bot commented May 4, 2026

Deleting - wrong comment type

Copy link
Copy Markdown
Contributor

@davidsbatista davidsbatista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@sjrl sjrl merged commit 314bed1 into main May 4, 2026
20 checks passed
@sjrl sjrl deleted the update-comp-and-pipe-tool branch May 4, 2026 14:24
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.

2 participants