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

Add a quip about branches to doc, correct comments in appsettings and… #656

Merged
merged 5 commits into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,12 @@ By default, Chat Copilot runs locally without authentication, using a guest user
sudo apt install --assume-yes dotnet-sdk-7.0;
```

# A note on branches

Every release is associated with a release branch. For instance release [v0.9](https://github.com/microsoft/chat-copilot/releases/tag/v0.9) is on a branch called [0.9](https://github.com/microsoft/chat-copilot/tree/0.9).
glahaye marked this conversation as resolved.
Show resolved Hide resolved
Once a release is out, its branch will no longer be updated. The exception to this is the latest release branch, which will only receive bug fixes.
This is to provide some stability to those for whom breaking changes and being on the bleeding edge (with the bugs it can entail) is not a desirable option.

# Check out our other repos!

If you would like to learn more about Semantic Kernel and AI, you may also be interested in other repos the Semantic Kernel team supports:
Expand Down
22 changes: 11 additions & 11 deletions webapi/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@
},
//
// Configuration for the various services used by kernel memory and semantic kernel.
// Section names correspond to type specified in SemanticMemory section. All supported
// Section names correspond to type specified in KernelMemory section. All supported
// sections are listed below for reference. Only referenced sections are required.
//
"Services": {
Expand Down Expand Up @@ -280,7 +280,7 @@
//
"AzureBlobs": {
"Auth": "ConnectionString",
//"ConnectionString": "", // dotnet user-secrets set "SemanticMemory:Services:AzureBlobs:ConnectionString" "MY_AZUREBLOB_CONNECTIONSTRING"
//"ConnectionString": "", // dotnet user-secrets set "KernelMemory:Services:AzureBlobs:ConnectionString" "MY_AZUREBLOB_CONNECTIONSTRING"
//"Account": "",
"Container": "memorypipeline"
//"EndpointSuffix": "core.windows.net"
Expand All @@ -294,7 +294,7 @@
//
"AzureQueue": {
"Auth": "ConnectionString"
//"ConnectionString": "", // dotnet user-secrets set "SemanticMemory:Services:AzureQueue:ConnectionString" "MY_AZUREQUEUE_CONNECTIONSTRING"
//"ConnectionString": "", // dotnet user-secrets set "KernelMemory:Services:AzureQueue:ConnectionString" "MY_AZUREQUEUE_CONNECTIONSTRING"
//"Account": "",
//"EndpointSuffix": "core.windows.net"
},
Expand All @@ -306,8 +306,8 @@
// - Port is the RabbitMq service port.
//
"RabbitMq": {
//"Username": "user", // dotnet user-secrets set "SemanticMemory:Services:RabbitMq:Username" "MY_RABBITMQ_USER"
//"Password": "", // dotnet user-secrets set "SemanticMemory:Services:RabbitMq:Password" "MY_RABBITMQ_KEY"
//"Username": "user", // dotnet user-secrets set "KernelMemory:Services:RabbitMq:Username" "MY_RABBITMQ_USER"
//"Password": "", // dotnet user-secrets set "KernelMemory:Services:RabbitMq:Password" "MY_RABBITMQ_KEY"
"Host": "127.0.0.1",
"Port": "5672"
},
Expand All @@ -319,7 +319,7 @@
//
"AzureCognitiveSearch": {
"Auth": "ApiKey",
//"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureCognitiveSearch:APIKey" "MY_ACS_KEY"
//"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureCognitiveSearch:APIKey" "MY_ACS_KEY"
"Endpoint": ""
},
//
Expand All @@ -328,7 +328,7 @@
// - Endpoint is the service endpoint url.
//
"Qdrant": {
//"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:Qdrant:APIKey" "MY_QDRANT_KEY"
//"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:Qdrant:APIKey" "MY_QDRANT_KEY"
"Endpoint": "http://127.0.0.1:6333"
},
//
Expand All @@ -342,7 +342,7 @@
//
"AzureOpenAIText": {
"Auth": "ApiKey",
// "APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureOpenAIText:APIKey" "MY_AZUREOPENAI_KEY"
// "APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureOpenAIText:APIKey" "MY_AZUREOPENAI_KEY"
"Endpoint": "",
"Deployment": "gpt-35-turbo",
"APIType": "ChatCompletion",
Expand All @@ -357,7 +357,7 @@
//
"AzureOpenAIEmbedding": {
"Auth": "ApiKey",
// "APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureOpenAIEmbedding:APIKey" "MY_AZUREOPENAI_KEY"
// "APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureOpenAIEmbedding:APIKey" "MY_AZUREOPENAI_KEY"
"Endpoint": "",
"Deployment": "text-embedding-ada-002"
},
Expand All @@ -372,7 +372,7 @@
"OpenAI": {
"TextModel": "gpt-3.5-turbo",
"EmbeddingModel": "text-embedding-ada-002",
//"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:OpenAI:APIKey" "MY_OPENAI_KEY"
//"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:OpenAI:APIKey" "MY_OPENAI_KEY"
"OrgId": "",
"MaxRetries": 10
},
Expand All @@ -384,7 +384,7 @@
//
"AzureFormRecognizer": {
"Auth": "APIKey",
//"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureFormRecognizer:APIKey" "MY_AZUREFORMRECOGNIZER_KEY"
//"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureFormRecognizer:APIKey" "MY_AZUREFORMRECOGNIZER_KEY"
"Endpoint": ""
},
//
Expand Down
9 changes: 4 additions & 5 deletions webapp/src/components/views/BackendProbe.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,14 @@ export const BackendProbe: FC<IData> = ({ onBackendFound }) => {
</div>
) : (
<div className={classes.informativeView}>
<Title3>Looking for your backend</Title3>
<Title3>Connecting...</Title3>
glahaye marked this conversation as resolved.
Show resolved Hide resolved
<Spinner />
<Body1>
This sample expects to find a Semantic Kernel service from <strong>webapi/</strong> running at{' '}
<strong>{BackendServiceUrl}</strong>
This app expects to find a server running at <strong>{BackendServiceUrl}</strong>
</Body1>
<Body1>
Run your Semantic Kernel service locally using Visual Studio, Visual Studio Code or by typing
the following command:{' '}
To run the server locally, use Visual Studio, Visual Studio Code or by type the following
glahaye marked this conversation as resolved.
Show resolved Hide resolved
command:{' '}
<code>
<strong>dotnet run</strong>
</code>
Expand Down
Loading