Skip to content
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: Json schema improvements for Union and Optional #7367

Merged
merged 8 commits into from
Jul 23, 2024

Conversation

moonbox3
Copy link
Contributor

Motivation and Context

We have some gaps in how we build the JSON schema for function calling related to Union and Optional types. There is also some work to do related to handling Optional versus param | None = None.

Description

This PR improves the JSON schema building for the Union and Optional types. It adds additional tests and improves some existing tests.

Contribution Checklist

@moonbox3 moonbox3 requested a review from a team as a code owner July 19, 2024 20:20
@markwallace-microsoft markwallace-microsoft added the python Pull requests for the Python Semantic Kernel label Jul 22, 2024
@moonbox3 moonbox3 enabled auto-merge July 22, 2024 18:11
@moonbox3 moonbox3 added this pull request to the merge queue Jul 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 22, 2024
@moonbox3 moonbox3 added this pull request to the merge queue Jul 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 22, 2024
@moonbox3 moonbox3 enabled auto-merge July 22, 2024 20:24
@markwallace-microsoft
Copy link
Member

Py3.10 Test Coverage

Python 3.10 Test Coverage Report
FileStmtsMissCoverMissing
semantic_kernel
   kernel.py157994%145, 156, 160, 200–201, 310–313, 422
semantic_kernel/connectors
   telemetry.py16288%18–19
semantic_kernel/connectors/ai/azure_ai_inference/services
   azure_ai_inference_chat_completion.py149497%169, 312, 416, 430
semantic_kernel/connectors/ai/embeddings
   embedding_generator_base.py8188%50
semantic_kernel/connectors/ai/hugging_face/services
   hf_text_completion.py54394%95, 103, 134
   hf_text_embedding.py32584%77–81
semantic_kernel/connectors/openapi_plugin
   openapi_manager.py58297%110–111
   openapi_parser.py88199%127
   openapi_runner.py105298%181–182
semantic_kernel/connectors/openapi_plugin/models
   rest_api_operation.py129199%240
semantic_kernel/functions
   kernel_function_decorator.py98199%102
   kernel_function_from_method.py96199%153
   kernel_function_from_prompt.py154795%165–166, 180, 200, 218, 238, 321
   kernel_plugin.py187299%472, 475
semantic_kernel/planners
   plan.py2344581%52, 161–163, 195, 212–225, 262, 267, 275–276, 286–289, 306, 311, 327, 330–335, 353, 358, 361, 363, 370, 384–386, 391–395
semantic_kernel/planners/function_calling_stepwise_planner
   function_calling_stepwise_planner.py116497%143, 187–188, 196
semantic_kernel/planners/sequential_planner
   sequential_planner.py64691%69, 73, 107, 123, 132–133
   sequential_planner_extensions.py50982%29–30, 52, 106–120
   sequential_planner_parser.py771284%64–72, 91, 115–118
semantic_kernel/schema
   kernel_json_schema_builder.py119596%48, 82, 204, 208–209
semantic_kernel/template_engine/blocks
   code_block.py77199%119
   named_arg_block.py43198%98
TOTAL706112498% 

Python 3.10 Unit Test Overview

Tests Skipped Failures Errors Time
1903 1 💤 0 ❌ 0 🔥 32.165s ⏱️

@moonbox3 moonbox3 added this pull request to the merge queue Jul 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 22, 2024
@moonbox3 moonbox3 added this pull request to the merge queue Jul 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 22, 2024
@moonbox3 moonbox3 added this pull request to the merge queue Jul 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 22, 2024
@moonbox3 moonbox3 added this pull request to the merge queue Jul 22, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 22, 2024
@eavanvalkenburg eavanvalkenburg added this pull request to the merge queue Jul 23, 2024
Merged via the queue into microsoft:main with commit 5f49880 Jul 23, 2024
24 checks passed
LudoCorporateShark pushed a commit to LudoCorporateShark/semantic-kernel that referenced this pull request Aug 25, 2024
### Motivation and Context

We have some gaps in how we build the JSON schema for function calling
related to Union and Optional types. There is also some work to do
related to handling `Optional` versus `param | None = None`.

<!-- 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 improves the JSON schema building for the Union and Optional
types. It adds additional tests and improves some existing tests.
- Closes microsoft#7297 
- Closes microsoft#7298

<!-- 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
- [X] I didn't break anyone 😄
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
python Pull requests for the Python Semantic Kernel
Projects
Archived in project
4 participants