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.
Adding response_format to allow for Structure Output when using some OpenAi models
What changes are proposed in this pull request?
Adding a variable
response_format
to allowresponse_format
to be passed to openAI models such as gpt4o.Example: https://community.openai.com/t/how-do-i-use-the-new-json-mode/475890/2
Specifically, try to answer the two following questions:
major changes to allow the reader to quickly understand the PR without having
to look at the code.
A variable
response_format
has been added to bothquery
functions. If statements have been added to bothquery
functions to handle the case whenresponse_format
is not passed.reader might be missing. For example, were there any decisions behind the
change that are not reflected in the code itself?
Adding the
response_format
variable in this way will allow aresponse_format
to be passed to openAI models such as gpt4o.The “why part” is the most important of the two as it usually cannot be
inferred from the code itself. A well-written PR description will help future
developers (including your future self) to know how to interact and update your
code.
How is this tested?
Describe any tests you have done; especially if test tests are not part of
the unit tests (e.g. local tests).
I have NOT tested this edit.
ALWAYS ANSWER THIS QUESTION: Answer with "N/A" if tests are not applicable
to your PR (e.g. if the PR only modifies comments). Do not be afraid of
answering "Not tested" if the PR has not been tested. Being clear about what
has been done and not done provides important context to the reviewers.
NO_CHANGELOG=true