Skip to content

docs: sync Haystack API reference on Docusaurus #13288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Oct 16, 2026
Merged

docs: sync Haystack API reference on Docusaurus #13288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs-website/reference/haystack-api/joiners_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,11 @@ A component that merges multiple input branches of a pipeline into a single outp
`BranchJoiner` receives multiple inputs of the same data type and forwards the first received value
to its output. This is useful for scenarios where multiple branches need to converge before proceeding.

Only one of the connected branches should produce output in each run. `BranchJoiner` runs as soon as it receives
a value, so if several branches produce output, it runs once per value and the components after it run multiple
times too. To collect the outputs of several branches, use a joiner that waits for all of them, such as
`ListJoiner` or `DocumentJoiner`.

### Common Use Cases:

- **Loop Handling:** `BranchJoiner` helps close loops in pipelines. For example, if a pipeline component validates
Expand Down