Explain how PromptBuilder, OutputAdapter, ConditionalRouter differ in waiting for other inputs to be received before running #8620
Labels
P2
Medium priority, add to the next sprint if no P1 available
type:documentation
Improvements on the docs
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 ofOutputAdapter
andConditionalRouter
can be difficult to understand.Describe the solution you'd like
We could extend the docs page of
PromptBuilder
and explain the parametersrequired_variables
andvariables
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/promptbuilderWe 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})
The text was updated successfully, but these errors were encountered: