-
Notifications
You must be signed in to change notification settings - Fork 2.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Python: OpenAPI plugin enhance #6279
Merged
eavanvalkenburg
merged 4 commits into
microsoft:main
from
moonbox3:openapi_plugin_enhance
May 16, 2024
Merged
Python: OpenAPI plugin enhance #6279
eavanvalkenburg
merged 4 commits into
microsoft:main
from
moonbox3:openapi_plugin_enhance
May 16, 2024
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
…s both during function creating and during function calling.
markwallace-microsoft
added
the
python
Pull requests for the Python Semantic Kernel
label
May 15, 2024
moonbox3
changed the title
Python: OpenAPI plugin enhance
Python: OpenAPI plugin enhance to properly form function calling args
May 15, 2024
github-actions
bot
changed the title
Python: OpenAPI plugin enhance to properly form function calling args
Python: OpenAPI plugin enhance
May 15, 2024
Python 3.10 Test Coverage Report •
Python 3.10 Unit Test Overview
|
alliscode
approved these changes
May 16, 2024
eavanvalkenburg
approved these changes
May 16, 2024
bochris
pushed a commit
to bochris/semantic-kernel
that referenced
this pull request
May 16, 2024
### Motivation and Context Python's OpenAPI manager `run_openapi_operation` was hard-coded to use certain parameters that would ultimately be built up to make an API request. This didn't allow the model to know which parameters were actually defined as required in the OpenAPI spec and would cause errors during function calling. <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> ### Description This PR does a quite major overhaul on the openapi manager, with the caveat that the code is going to be refactored / cleaned up in a next iteration (we're pressed for time right now). In the `_create_function_from_operation` method, the `rest_operation_params` are now built up from the operation which means we included the required parameters and will have them during function calling. This allows us to properly build up the url, headers, request body and paths to make the API call. - The concept samples were updated and are functioning with this latest code. - function calling was tested with the AzureKeyVault OpenAPI example and the model was able to automatically create a secret in a test key vault. - Old unit tests were removed. Note: in the next iteration new unit tests for all of the new functionality will be added. - In the next iteration, the entire `openapi_manager.py` file will be broken apart to separate files for classes/moels to clean it up. - Closes microsoft#6261 <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [X] The code builds clean without any errors or warnings - [X] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [X] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄
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.
Motivation and Context
Python's OpenAPI manager
run_openapi_operation
was hard-coded to use certain parameters that would ultimately be built up to make an API request. This didn't allow the model to know which parameters were actually defined as required in the OpenAPI spec and would cause errors during function calling.Description
This PR does a quite major overhaul on the openapi manager, with the caveat that the code is going to be refactored / cleaned up in a next iteration (we're pressed for time right now). In the
_create_function_from_operation
method, therest_operation_params
are now built up from the operation which means we included the required parameters and will have them during function calling. This allows us to properly build up the url, headers, request body and paths to make the API call.openapi_manager.py
file will be broken apart to separate files for classes/moels to clean it up.Contribution Checklist