Skip to content
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.

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

Explain how PromptBuilder, OutputAdapter, ConditionalRouter differ in waiting for other inputs to be received before running #8620

Open
julian-risch opened this issue Dec 10, 2024 · 0 comments
Assignees
Labels
P2 Medium priority, add to the next sprint if no P1 available type:documentation Improvements on the docs

Comments

@julian-risch
Copy link
Member

julian-risch commented Dec 10, 2024

Is your feature request related to a problem? Please describe.
For users it can be unclear if PromptBuilder waits for inputs before running or if it runs once the first input is received. Similarly, the behavior of OutputAdapter and ConditionalRouter can be difficult to understand.

Describe the solution you'd like
We could extend the docs page of PromptBuilder and explain the parameters required_variables and variables of the component's init method and how it's decided if the component is ready to run. The latter can be done for the other two components too. https://docs.haystack.deepset.ai/docs/promptbuilder
We could also extend the docs page about pipelines and explain how it's decided when a component runs in general. https://docs.haystack.deepset.ai/docs/pipelines#data-flow
We could extend the docstrings of the components and explain how it's decided if the component is ready to run.

Describe alternatives you've considered

Additional context
@mathislucka brought up this topic

Technically, the difference of the three components is in how the set input types,
component.set_input_type(self, var, Any) / component.set_input_types(self, **{var: Any for var in input_types})

@julian-risch julian-risch added type:documentation Improvements on the docs P2 Medium priority, add to the next sprint if no P1 available labels Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 Medium priority, add to the next sprint if no P1 available type:documentation Improvements on the docs
Projects
None yet
Development

No branches or pull requests

3 participants