Semantic Kernel plugin with API manifest file

[ktjosh]

Hello, I am trying to create a plugin using Api manifest file, and I am having difficulty finding good documentation about it.
one particulate question is regarding the schema of Api manifest file.

I see the application description URL is place where a yaml file is provided with Api description and all the other details, however, If I do not have such yaml file uploaded on a server, then can I create plugin using Api manifest ?

Further question is, does it mean the plugins uploaded on open ai have the capabilities to be used in Api manifest, or i can use my personal open to public services as a plugin in the semantic kernel.

Thank you.

[moonbox3]

Hello @ktjosh are you using SK Python or C#? Python supports the v3+ OpenApi spec and I believe that C# supports 2.0+ and 3.0+. When creating a plugin from an OpenApi spec, you will need to provide it the spec as either yaml or json so that we can parse it and create the required kernel functions / plugin.

Further question is, does it mean the plugins uploaded on open ai have the capabilities to be used in Api manifest, or i can use my personal open to public services as a plugin in the semantic kernel.

Are you referring to an OpenAI plugin? Those plugins were deprecated by OpenAI are no longer supported in SK.

By your question is sounds like you're using SK C#, but please correct me if I am wrong. Have you seen this OpenApi plugin sample?

https://github.com/microsoft/semantic-kernel/blob/main/dotnet/samples/GettingStarted/Step9_OpenAPI_Plugins.cs

[ktjosh]

Hello @moonbox3 Thanks for your reply, all the examples that i see contains, a json file considered as a api manifest, while the json file has a apidescriptionurl: which points to an open api yaml file, example: https://devblogs.microsoft.com/semantic-kernel/introducing-api-manifest-plugins-for-semantic-kernel-2/

Hence the confusion arise whether, why is there information regarding the plugin api stored in 2 levels, can i keep it in the json file that is provided and second question would be, do i need to have the yaml on my local or should be online on a server?

[moonbox3]

Let me add @SergeyMenshykh, since this question is specifically about SK .Net (as well as the blog post).

[ktjosh]

Hello @moonbox3 I am little new to the API Manifest idea in general, so may be the first question might be too basic, but I am still unsure about the second question, if i can have the api description url in my local, vs it needs to be accessed by in the form server url.
e.g. in this blog https://devblogs.microsoft.com/semantic-kernel/generating-api-manifests-for-semantic-kernel/, the api description url is https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.yaml vs can it be on local machine, or the server file, like. C://User/UserName/somefolder/api.github.com.yaml

[SergeyMenshykh]

Hello @ktjosh, as far as I understand, this line of code decides whether to load the OpenAPI document/API description from any host server or a directory on the hard drive. Adding API Manifest SME: @baywet

[baywet]

Correct, the OAS description does not need to be stored locally (but it can), in any case, it needs to be resolvable from the API manifest itself.
Let us know if you have any additional comments or questions.