Skip to content

Commit b3146d2

Browse files
glahayegitri-ms
andauthored
Add a quip about branches to doc, correct comments in appsettings and… (microsoft#656)
### Motivation and Context Be clear. ### Description - Add a quip about branches to main README - Correct comments in appsettings to reference KernelMemory - Change text when we load website so that it is less odd ### Contribution Checklist - [ ] The code builds clean without any errors or warnings - [ ] The PR follows the [Contribution Guidelines](https://github.com/microsoft/chat-copilot/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/chat-copilot/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄 --------- Co-authored-by: Gina Triolo <[email protected]>
1 parent 0cf4dce commit b3146d2

File tree

3 files changed

+20
-16
lines changed

3 files changed

+20
-16
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,12 @@ By default, Chat Copilot runs locally without authentication, using a guest user
329329
sudo apt install --assume-yes dotnet-sdk-7.0;
330330
```
331331

332+
# A note on branches
333+
334+
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).
335+
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.
336+
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.
337+
332338
# Check out our other repos!
333339

334340
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:

webapi/appsettings.json

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@
243243
},
244244
//
245245
// Configuration for the various services used by kernel memory and semantic kernel.
246-
// Section names correspond to type specified in SemanticMemory section. All supported
246+
// Section names correspond to type specified in KernelMemory section. All supported
247247
// sections are listed below for reference. Only referenced sections are required.
248248
//
249249
"Services": {
@@ -280,7 +280,7 @@
280280
//
281281
"AzureBlobs": {
282282
"Auth": "ConnectionString",
283-
//"ConnectionString": "", // dotnet user-secrets set "SemanticMemory:Services:AzureBlobs:ConnectionString" "MY_AZUREBLOB_CONNECTIONSTRING"
283+
//"ConnectionString": "", // dotnet user-secrets set "KernelMemory:Services:AzureBlobs:ConnectionString" "MY_AZUREBLOB_CONNECTIONSTRING"
284284
//"Account": "",
285285
"Container": "memorypipeline"
286286
//"EndpointSuffix": "core.windows.net"
@@ -294,7 +294,7 @@
294294
//
295295
"AzureQueue": {
296296
"Auth": "ConnectionString"
297-
//"ConnectionString": "", // dotnet user-secrets set "SemanticMemory:Services:AzureQueue:ConnectionString" "MY_AZUREQUEUE_CONNECTIONSTRING"
297+
//"ConnectionString": "", // dotnet user-secrets set "KernelMemory:Services:AzureQueue:ConnectionString" "MY_AZUREQUEUE_CONNECTIONSTRING"
298298
//"Account": "",
299299
//"EndpointSuffix": "core.windows.net"
300300
},
@@ -306,8 +306,8 @@
306306
// - Port is the RabbitMq service port.
307307
//
308308
"RabbitMq": {
309-
//"Username": "user", // dotnet user-secrets set "SemanticMemory:Services:RabbitMq:Username" "MY_RABBITMQ_USER"
310-
//"Password": "", // dotnet user-secrets set "SemanticMemory:Services:RabbitMq:Password" "MY_RABBITMQ_KEY"
309+
//"Username": "user", // dotnet user-secrets set "KernelMemory:Services:RabbitMq:Username" "MY_RABBITMQ_USER"
310+
//"Password": "", // dotnet user-secrets set "KernelMemory:Services:RabbitMq:Password" "MY_RABBITMQ_KEY"
311311
"Host": "127.0.0.1",
312312
"Port": "5672"
313313
},
@@ -319,7 +319,7 @@
319319
//
320320
"AzureCognitiveSearch": {
321321
"Auth": "ApiKey",
322-
//"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureCognitiveSearch:APIKey" "MY_ACS_KEY"
322+
//"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureCognitiveSearch:APIKey" "MY_ACS_KEY"
323323
"Endpoint": ""
324324
},
325325
//
@@ -328,7 +328,7 @@
328328
// - Endpoint is the service endpoint url.
329329
//
330330
"Qdrant": {
331-
//"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:Qdrant:APIKey" "MY_QDRANT_KEY"
331+
//"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:Qdrant:APIKey" "MY_QDRANT_KEY"
332332
"Endpoint": "http://127.0.0.1:6333"
333333
},
334334
//
@@ -342,7 +342,7 @@
342342
//
343343
"AzureOpenAIText": {
344344
"Auth": "ApiKey",
345-
// "APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureOpenAIText:APIKey" "MY_AZUREOPENAI_KEY"
345+
// "APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureOpenAIText:APIKey" "MY_AZUREOPENAI_KEY"
346346
"Endpoint": "",
347347
"Deployment": "gpt-35-turbo",
348348
"APIType": "ChatCompletion",
@@ -357,7 +357,7 @@
357357
//
358358
"AzureOpenAIEmbedding": {
359359
"Auth": "ApiKey",
360-
// "APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureOpenAIEmbedding:APIKey" "MY_AZUREOPENAI_KEY"
360+
// "APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureOpenAIEmbedding:APIKey" "MY_AZUREOPENAI_KEY"
361361
"Endpoint": "",
362362
"Deployment": "text-embedding-ada-002"
363363
},
@@ -372,7 +372,7 @@
372372
"OpenAI": {
373373
"TextModel": "gpt-3.5-turbo",
374374
"EmbeddingModel": "text-embedding-ada-002",
375-
//"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:OpenAI:APIKey" "MY_OPENAI_KEY"
375+
//"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:OpenAI:APIKey" "MY_OPENAI_KEY"
376376
"OrgId": "",
377377
"MaxRetries": 10
378378
},
@@ -384,7 +384,7 @@
384384
//
385385
"AzureFormRecognizer": {
386386
"Auth": "APIKey",
387-
//"APIKey": "", // dotnet user-secrets set "SemanticMemory:Services:AzureFormRecognizer:APIKey" "MY_AZUREFORMRECOGNIZER_KEY"
387+
//"APIKey": "", // dotnet user-secrets set "KernelMemory:Services:AzureFormRecognizer:APIKey" "MY_AZUREFORMRECOGNIZER_KEY"
388388
"Endpoint": ""
389389
},
390390
//

webapp/src/components/views/BackendProbe.tsx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,13 @@ export const BackendProbe: FC<IData> = ({ onBackendFound }) => {
8484
</div>
8585
) : (
8686
<div className={classes.informativeView}>
87-
<Title3>Looking for your backend</Title3>
87+
<Title3>Connecting...</Title3>
8888
<Spinner />
8989
<Body1>
90-
This sample expects to find a Semantic Kernel service from <strong>webapi/</strong> running at{' '}
91-
<strong>{BackendServiceUrl}</strong>
90+
This app expects to find a server running at <strong>{BackendServiceUrl}</strong>
9291
</Body1>
9392
<Body1>
94-
Run your Semantic Kernel service locally using Visual Studio, Visual Studio Code or by typing
95-
the following command:{' '}
93+
To run the server locally, use Visual Studio, Visual Studio Code, or type the following command:{' '}
9694
<code>
9795
<strong>dotnet run</strong>
9896
</code>

0 commit comments

Comments
 (0)