Update documentation about ignored user input #120
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
willtai
reviewed
Sep 5, 2024
a-s-g93
pushed a commit
to a-s-g93/neo4j-genai-python-dev
that referenced
this pull request
Sep 13, 2024
* Update documentation * Explicit `input_config` parameter
a-s-g93
pushed a commit
to a-s-g93/neo4j-genai-python-dev
that referenced
this pull request
Sep 13, 2024
* Update documentation * Explicit `input_config` parameter
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Make it clear in the documentation that in case input is defined both through an
input_configwhen building the pipeline and through a static user input in thePipeline.runmethod, then the user input is ignored.Note: we could change this behaviour to make the user input a default value in case the value is null in the component's output? But that'd be future work.
Type of Change
Complexity
Complexity: Low
How Has This Been Tested?
Checklist
The following requirements should have been met (depending on the changes in the branch):