Skip to content

Improve the getting started documentation for Copilot chat #1352

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

Closed
securigy opened this issue Jun 6, 2023 · 5 comments
Closed

Improve the getting started documentation for Copilot chat #1352

securigy opened this issue Jun 6, 2023 · 5 comments
Assignees
Labels
docs and tests Improvements or additions to documentation

Comments

@securigy
Copy link

securigy commented Jun 6, 2023

I cloned the entire Semantic Kernel repository and here I read the following:

`Run func start --csharp from the command line. This will run the service API locally at http://localhost:7071.

Two endpoints will be exposed by the service API:

InvokeFunction: [POST] http://localhost:7071/api/skills/{skillName}/invoke/{functionName}
Ping: [GET] http://localhost:7071/api/ping`

I tried to run the "func start --csharp" on the command line but it cannot find it. It does not say from what folder path I should run it, or do I misunderstand the statement?

Anyway, how to I run this project? (I'm not a web developer)

Also, where do I find clear example of Embeddings + Vector DB usage in C# for a scenario of questioning large number of private documents?

@craigomatic
Copy link
Contributor

Try starting from here: https://github.com/microsoft/semantic-kernel/tree/main/samples/dotnet/kernel-syntax-examples

This sample may help get you moving in the right direction re embeddings: https://github.com/microsoft/semantic-kernel/blob/main/samples/dotnet/kernel-syntax-examples/Example15_MemorySkill.cs

What you are referring to above is how to being running the KernelHttpServer which is an Azure Function that wraps the Kernel so that a web client can make use of it.

@securigy
Copy link
Author

securigy commented Jun 6, 2023

Thank you for the reference. I started from Example38. I use VS2022.
and having Pinecone key and environment. However, it crashes at the following line:
string key1 = await kernel.Memory.SaveInformationAsync(MemoryCollectionName, "british short hair", "cat1", null, additionalMetadata);
with 401 - Access denied.
Did I need to create Pinecode resource or something like that on Azure? Or do I need to run KernelHttpServer locally?
I still cannot figure out how to run the kernel locally on my PC... Can you explain in plain English? Where do I execute the "func start --csharp" from?

@securigy
Copy link
Author

securigy commented Jun 6, 2023

I realized that my problem was with the key: I used Azure OpenAI key instead of OpenAI key. So I replaced original code of instantiating kernel.

IKernel kernel = Kernel.Builder. WithAzureTextCompletionService("text-davinci-003", "https://azuresemantickernel.openai.azure.com/", azureOpenApiKey) .WithAzureTextEmbeddingGenerationService("text-embedding-ada-002", "https://azuresemantickernel.openai.azure.com/",azureOpenApiKey). WithMemoryStorage(memoryStore) .Build();

However, the same line:
string key1 = await kernel.Memory.SaveInformationAsync(MemoryCollectionName, "british short hair", "cat1", null, additionalMetadata);

gives me now the exception:
Microsoft.SemanticKernel.Connectors.Memory.Pinecone.PineconeMemoryException: 'Index creation is not supported within memory store. It should be created manually or using CreateIndexAsync. Ensure index state is Ready.'

So, I am kinda lost...

@matthewbolanos matthewbolanos changed the title Documentation not clear... Improve the getting started documentation for Copilot chat Jun 21, 2023
@matthewbolanos matthewbolanos added docs and tests Improvements or additions to documentation copilot chat labels Jun 21, 2023
@matthewbolanos
Copy link
Member

matthewbolanos commented Jun 21, 2023

I've created an issue here in the docs repo that I'll be working on during the next sprint to improve the getting started documentation for Copilot chat. I'll also try to identify why you're running into the PineconeMemoryException.

MicrosoftDocs/semantic-kernel-docs#22

@matthewbolanos matthewbolanos self-assigned this Jun 21, 2023
@matthewbolanos matthewbolanos moved this to Backlog – Copilot Dev UX in Apps & Services Semantic Kernel Jun 21, 2023
@matthewbolanos matthewbolanos moved this from Backlog – Copilot Dev UX to Ready in Apps & Services Semantic Kernel Jun 21, 2023
@matthewbolanos
Copy link
Member

The docs for Chat Copilot have been updated. Let us know if the instructions are still not clear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs and tests Improvements or additions to documentation
Projects
No open projects
Development

No branches or pull requests

4 participants