Fix: Add missing package, which is preventing swagger-ui from loading, and ChatGPT from importing the plugin

thegovind commented 1 year ago

Motivation and Context

This change is required to fix the issue with failure to fetch swagger.json due to a missing assembly Microsoft.CodeAnalysis. This is a blocker for user's onboarding by following Readme, as ChatGPT was unable to load the manifest when trying to fetch swagger.json, as shown below.

This fix will ensure that swagger.json will be fetchable and OpenAI is able to fetch the plugin as expected.

Description

This PR fixes the issue by adding 'Microsoft.CodeAnalysis' package (version 4.7.0-2.final) as a reference in the project file. The 'Microsoft.CodeAnalysis' assembly was missing, causing Swagger UI load to fail. By adding this assembly, the ChatGPT (or, SK's chat-copilot) will now be able to fetch swagger.json.

Contribution Checklist

[x] The code builds clean without any errors or warnings
[x] The PR follows SK Contribution Guidelines (https://github.com/microsoft/semantic-kernel-starters/blob/main/CONTRIBUTING.md)
[x] The code follows the .NET coding conventions (https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions) verified with dotnet format
[x] All unit tests pass, and I have added new tests where possible
[x] I didn't break anyone :smile:

dipteshbosedxc commented 1 year ago

This solution is missing from https://github.com/microsoft/semantic-kernel-starters/blob/main/sk-csharp-chatgpt-plugin/azure-function/sk-chatgpt-azure-function.csproj. Please update the file as it is throwing error without the reference.

hario90 commented 1 year ago

Hi @thegovind! Thanks for the PR - we found a similar issue in the sk-csharp-chatgpt-plugin starter and updated the README for how to run it in this PR. Were you running the chatGPT plugin starter when you ran into this issue or the sk-csharp-azure-functions starter?

I'm not able to reproduce this issue in the Azure Functions starter but note that I'm accessing Swagger UI at http://localhost:7071/api/swagger/ui.

thegovind commented 1 year ago

Hi @thegovind! Thanks for the PR - we found a similar issue in the sk-csharp-chatgpt-plugin starter and updated the README for how to run it in this PR. Were you running the chatGPT plugin starter when you ran into this issue or the sk-csharp-azure-functions starter?

I'm not able to reproduce this issue in the Azure Functions starter but note that I'm accessing Swagger UI at http://localhost:7071/api/swagger/ui.

Getting the issue when I try to pull swagger.json, which is also the case for ChatGPT

hario90 commented 1 year ago

Hi @thegovind, can you still reproduce this issue when you run the chat GPT plugin project using the updated steps here: https://github.com/microsoft/semantic-kernel-starters/blob/main/sk-csharp-chatgpt-plugin/README.md#running-the-starter?

thegovind commented 1 year ago

Hi @thegovind, can you still reproduce this issue when you run the chat GPT plugin project using the updated steps here: main/sk-csharp-chatgpt-plugin/README.md#running-the-starter?

So these two lines did address this issue. However, we still have to update GetAIpluginJson and aiPlugin in appsettings.json to return OpenAPI 3.0 compatible spec:

hario90 commented 1 year ago

Hi @thegovind, can you still reproduce this issue when you run the chat GPT plugin project using the updated steps here: main/sk-csharp-chatgpt-plugin/README.md#running-the-starter?

So these two lines did address this issue. However, we still have to update GetAIpluginJson and aiPlugin in appsettings.json to return OpenAPI 3.0 compatible spec:

Thanks for confirming. I'm going to close this issue since the original issue is fixed.

For the new issue, can you please create a separate issue with repro steps? Feel free to assign to me for now.

microsoft / semantic-kernel-starters