feat: Add Literal["*"] option to required_variables in ChatPrompBuilder and PromptBuilder #8572
+56
−17
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
sjrl
requested review from
dfokina and
julian-risch
and removed request for
a team
github-actions
bot
added
topic:tests
type:documentation
Pull Request Test Coverage Report for Build 11973875336Details
💛 - Coveralls |
| @@ -211,12 +213,16 @@ def _validate_variables(self, provided_variables: Set[str]): | |||
| :raises ValueError: | |||
| If no template is provided or if all the required template variables are not provided. | |||
| """ | |||
| missing_variables = [var for var in self.required_variables if var not in provided_variables] | |||
| if self.required_variables == "*": | |||
| required_variables = sorted(self.variables) | |||
There was a problem hiding this comment.
Any specific reason why we want to sort the variables here? self.required_variables is also not sorted right?
There was a problem hiding this comment.
Yeah specifically here b/c self.variables is a list but is created from a Set. So in this specific scenario it's possible for the order of required_variables to change when inheriting from self.variables which causes the Error message to be inconsistent. We look for an exact string match for one of the tests so without the sort the test would become unreliable.
There was a problem hiding this comment.
self.required_variables doesn't need to be sorted because if it comes in as a List we have no issue in regards to order.
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.
Related Issues
"*"to require all defined jinja variables #8395Proposed Changes:
Based on the discussion we added the ability to pass
"*"as a Literal option torequired_variablesin the ChatPromptBuilder and PromptBuilder to automatically set all variables in the template as required without needing to specify them manually.How did you test it?
added unit tests
Notes for the reviewer
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.