Add Structured Output #1443
Open
Add Structured Output #1443
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
Codecov ReportAttention: Patch coverage is
📢 Thoughts on this report? Let us know! |
collindutter
force-pushed
the
feature/structured-output
branch
3 times, most recently
from
a7ed072 to
f74e2e6
Compare
collindutter
force-pushed
the
feature/structured-output
branch
15 times, most recently
from
d2c0827 to
d07d699
Compare
|
@dylanholmes @vachillo still working through docs and some final cleanup, but the PR is certainly developed/large enough for first pass of reviews. |
collindutter
commented
Dec 24, 2024
Comment on lines
+300
to
+328
| def _add_native_schema_to_prompt_stack(self, stack: PromptStack, rulesets: list[Ruleset]) -> None: | ||
| # Need to separate JsonSchemaRules from other rules, removing them in the process | ||
| json_schema_rules = [rule for ruleset in rulesets for rule in ruleset.rules if isinstance(rule, JsonSchemaRule)] | ||
| non_json_schema_rules = [ | ||
| [rule for rule in ruleset.rules if not isinstance(rule, JsonSchemaRule)] for ruleset in rulesets | ||
| ] | ||
| for ruleset, non_json_rules in zip(rulesets, non_json_schema_rules): | ||
| ruleset.rules = non_json_rules | ||
|
|
||
| schemas = [rule.value for rule in json_schema_rules if isinstance(rule.value, Schema)] | ||
|
|
||
| if len(json_schema_rules) != len(schemas): | ||
| warnings.warn( | ||
| "Not all provided `JsonSchemaRule`s include a `schema.Schema` instance. These will be ignored with `use_native_structured_output`.", | ||
| stacklevel=2, | ||
| ) | ||
|
|
||
| if schemas: | ||
| stack.output_schema = schemas[0] if len(schemas) == 1 else Schema(Or(*schemas)) |
There was a problem hiding this comment.
Really don't like this method. Very open to suggestions on improvements.
collindutter
commented
Dec 24, 2024
Comment on lines
-95
to
+108
| system_template = self.generate_system_template(self) | ||
| if system_template: | ||
| stack.add_system_message(system_template) | ||
| rulesets = self.rulesets | ||
| system_artifacts = [TextArtifact(self.generate_system_template(self))] | ||
| if self.prompt_driver.use_native_structured_output: | ||
| self._add_native_schema_to_prompt_stack(stack, rulesets) | ||
|
|
||
| # Ensure there is at least one Ruleset that has non-empty `rules`. | ||
| if any(len(ruleset.rules) for ruleset in rulesets): | ||
| system_artifacts.append(TextArtifact(J2("rulesets/rulesets.j2").render(rulesets=rulesets))) | ||
|
|
||
| # Ensure there is at least one system Artifact that has a non-empty value. | ||
| has_system_artifacts = any(system_artifact.value for system_artifact in system_artifacts) | ||
| if has_system_artifacts: | ||
| stack.add_system_message(ListArtifact(system_artifacts)) |
There was a problem hiding this comment.
collindutter
force-pushed
the
feature/structured-output
branch
from
d07d699 to
896e534
Compare
collindutter
force-pushed
the
feature/structured-output
branch
from
896e534 to
3a07430
Compare
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.
Describe your changes
Issue ticket number and link
Closes #1468
Closes #1467