.Net: Issue 11562 (add plugin description) #11601
Merged
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
The current ApiManifestKernelExtensions implementations (
ImportPluginFromApiManifestAsync
andCreatePluginFromApiManifestAsync
) in Microsoft.SemanticKernel.Plugins.OpenApi.Extensions lack the capability to provide a description for the newly created KernelPlugin. Plugins should have a description to provide adequate context to the LLM regarding their purpose and use.Ideally, the description is derived from the ApiManifestDocument, but the current
Microsoft.OpenApi.ApiManifest.ApiManifestDocument
implementation does not support a Description property.This PR addresses issue #11562
Description
To get around this limitation, I've modified the
CreatePluginFromApiManifestAsync
implementation to accept a description parameter which is passed to theKernelPluginFactory.CreateFromFunctions()
call and added two new method signatures to ensure backwards compatibility.I've also added a new testclass (
ApiManifestKernelExtensionsTests.cs
) and apimanifest.json sample (which was missing so far) inSemanticKernel.Functions.UnitTests
.Contribution Checklist