Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #392 +/- ##
=======================================
Coverage 54.49% 54.49%
=======================================
Files 61 61
Lines 5652 5652
Branches 530 530
=======================================
Hits 3080 3080
Misses 2526 2526
Partials 46 46
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the execution-basics examples and documentation to better reflect Azure OpenAI deployment naming and to replace outdated Azure client config keys with the ones expected by the current OpenAI/Azure client initialization.
Changes:
- Update example JSON5 configs to use
client_kwargs.api_key/client_kwargs.api_version(instead ofazure_api_key/azure_version) and clarify Azure deployment naming. - Add an IMPORTANT note to the execution-basics README about Azure deployment model naming.
- Add a similar IMPORTANT note to the
process_jurisdictions_with_openaidocstring.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| examples/execution_basics/config_recommended.json5 | Updates example Azure client config keys and clarifies deployment naming. |
| examples/execution_basics/config_kitchen_sink.json5 | Same key updates across multiple model entries; adds clarifying comments for Azure vs OpenAI naming. |
| examples/execution_basics/README.rst | Adds an IMPORTANT note about Azure deployment model naming in configs. |
| compass/scripts/process.py | Adds an IMPORTANT note to the public docstring about Azure deployment model naming. |
You can also share your feedback on Copilot code review. Take the survey.
This file contains hidden or 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
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.
Clarify model name in documentation and examples, and update outdated config keys. Thanks @castelao for pointing all of these out!