Use OpenAI's Structured Outputs feature to prevent validation errors #514
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
| openai_messages = list(chain(*(self._map_message(m) for m in messages))) | ||
|
|
||
| model_settings = model_settings or {} | ||
|
|
||
| return await self.client.chat.completions.create( | ||
| response = await self.client.chat.completions.create( |
There was a problem hiding this comment.
you don't need this change.
| else: | ||
| tool_choice = 'auto' | ||
|
|
||
| tool_choice = 'auto' if self.tools else None |
There was a problem hiding this comment.
We have to respect allow_text_result, I think right now you're not.
dmontagu
reviewed
Dec 23, 2024
| allow_text_result, | ||
| tools, | ||
| ) | ||
| response_format = self._map_response_format(result_tools[0]) if result_tools else None |
There was a problem hiding this comment.
If there are multiple result tools (which I believe is the case when the result type is a union), we would definitely need to ensure that all the tool calls are present in the final response_format
There was a problem hiding this comment.
Also
Suggested change
| response_format = self._map_response_format(result_tools[0]) if result_tools else None | |
| response_format = self._map_response_format(result_tools[0]) if result_tools and not allow_text_result else None |
(Or, find a way for the response format to allow raw strings)
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.
Used the result_tools parameter to generate a json_schema which is passed to the OpenAI client as response_format. This guides the model to format it's responses according to the given schema, preventing validation errors.