Skip to content

Commit 96259d3

Browse files
jongiojongio
authored
Readme tweaks (#759)
### Motivation and Context UX ### Description Small readme updates to help clarify a few things I questioned when running this. ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [x ] The code builds clean without any errors or warnings - [ x] 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 - [x ] All unit tests pass, and I have added new tests where possible - [x ] I didn't break anyone 😄
1 parent f9ea331 commit 96259d3

File tree

1 file changed

+31
-12
lines changed

1 file changed

+31
-12
lines changed

‎README.md

+31-12
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ You will need the following items to run the sample:
2525
- [.NET 7.0 SDK](https://dotnet.microsoft.com/download/dotnet/7.0) _(via Setup install.\* script)_
2626
- [Node.js](https://nodejs.org/en/download) _(via Setup install.\* script)_
2727
- [Yarn](https://classic.yarnpkg.com/docs/install) _(via Setup install.\* script)_
28-
- AI Service
28+
- [Git](https://www.git-scm.com/downloads)
29+
- AI Service (one of the following is required)
2930

3031
| AI Service | Requirement |
3132
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -38,7 +39,13 @@ You will need the following items to run the sample:
3839

3940
1. Open PowerShell as an administrator.
4041
> NOTE: Ensure that you have [PowerShell Core 6+](https://github.com/PowerShell/PowerShell) installed. This is different from the default PowerShell installed on Windows.
41-
2. Setup your environment.
42+
1. Clone this repository
43+
```powershell
44+
git clone https://github.com/microsoft/chat-copilot
45+
```
46+
1. Setup your environment.
47+
48+
The following is a script to help you install the dependencies required. Feel free to install `dotnet`, `nodejs`, and `yarn` with your method of choice or use this script.
4249

4350
```powershell
4451
cd <path to chat-copilot>\scripts\
@@ -49,23 +56,27 @@ You will need the following items to run the sample:
4956
5057
> NOTE: If you receive an error that the script is not digitally signed or cannot execute on the system, you may need to [change the execution policy](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.3#change-the-execution-policy) (see list of [policies](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.3#powershell-execution-policies) and [scopes](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.3#execution-policy-scope)) or [unblock the script](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-executionpolicy?view=powershell-7.3#example-4-unblock-a-script-to-run-it-without-changing-the-execution-policy).
5158
52-
3. Configure Chat Copilot.
59+
1. Configure Chat Copilot.
5360

5461
```powershell
5562
.\Configure.ps1 -AIService {AI_SERVICE} -APIKey {API_KEY} -Endpoint {AZURE_OPENAI_ENDPOINT}
5663
```
5764

5865
- `AI_SERVICE`: `AzureOpenAI` or `OpenAI`.
5966
- `API_KEY`: The `API key` for Azure OpenAI or for OpenAI.
60-
- `AZURE_OPENAI_ENDPOINT`: The Azure OpenAI resource `Endpoint` address. Omit `-Endpoint` if using OpenAI.
67+
- `AZURE_OPENAI_ENDPOINT`: The Azure OpenAI resource `Endpoint` address. This is only required when using Azure OpenAI, omit `-Endpoint` if using OpenAI.
6168

62-
- > **IMPORTANT:** For `AzureOpenAI`, if you deployed models `gpt-35-turbo` and `text-embedding-ada-002` with custom names (instead of each own's given name), also use the parameters:
69+
- > **IMPORTANT:** For `AzureOpenAI`, if you deployed models `gpt-35-turbo` and `text-embedding-ada-002` with custom names (instead of the default names), also use the parameters:
6370
6471
```powershell
6572
-CompletionModel {DEPLOYMENT_NAME} -EmbeddingModel {DEPLOYMENT_NAME} -PlannerModel {DEPLOYMENT_NAME}
6673
```
6774
68-
4. Run Chat Copilot locally. This step starts both the backend API and frontend application.
75+
> -PlannerModel name will be the same as -CompletionModel
76+
77+
Open the `.\Configure.ps1` script to see all of the available parameters.
78+
79+
1. Run Chat Copilot locally. This step starts both the backend API and frontend application.
6980
7081
```powershell
7182
.\Start.ps1
@@ -83,8 +94,14 @@ You will need the following items to run the sample:
8394
8495
## Linux/macOS
8596
86-
1. Open Bash as an administrator.
87-
2. Configure environment.
97+
1. Open Bash as an Administrator.
98+
1. Clone this repository
99+
```bash
100+
git clone https://github.com/microsoft/chat-copilot
101+
```
102+
1. Configure environment.
103+
104+
The following is a script to help you install the dependencies required. Feel free to install `dotnet`, `nodejs`, and `yarn` with your method of choice or use this script.
88105

89106
```bash
90107
cd <path to chat-copilot>/scripts/
@@ -106,7 +123,7 @@ You will need the following items to run the sample:
106123

107124
> NOTE: This script uses `homebrew` to install `dotnet-sdk`, `nodejs`, and `yarn`.
108125
109-
3. Configure Chat Copilot.
126+
1. Configure Chat Copilot.
110127

111128
1. For OpenAI
112129

@@ -128,7 +145,7 @@ You will need the following items to run the sample:
128145
- `API_KEY`: The `API key` for Azure OpenAI.
129146

130147
**IMPORTANT:** If you deployed models `gpt-35-turbo` and `text-embedding-ada-002`
131-
with custom names (instead of each own's given name), you need to specify
148+
with custom names (instead of the default names), you need to specify
132149
the deployment names with three additional parameters:
133150

134151
```bash
@@ -140,7 +157,9 @@ You will need the following items to run the sample:
140157
--embeddingmodel {DEPLOYMENT_NAME}
141158
```
142159

143-
4. Run Chat Copilot locally. This step starts both the backend API and frontend application.
160+
`--plannermodel` will be the same name as `--completionmodel`
161+
162+
1. Run Chat Copilot locally. This step starts both the backend API and frontend application.
144163

145164
```bash
146165
./start.sh
@@ -248,7 +267,7 @@ By default, Chat Copilot runs locally without authentication, using a guest user
248267
249268
- `AI_SERVICE`: `AzureOpenAI` or `OpenAI`.
250269
- `API_KEY`: The `API key` for Azure OpenAI or for OpenAI.
251-
- `AZURE_OPENAI_ENDPOINT`: The Azure OpenAI resource `Endpoint` address. Omit `-Endpoint` if using OpenAI.
270+
- `AZURE_OPENAI_ENDPOINT`: The Azure OpenAI resource `Endpoint` address. This is only required when using Azure OpenAI, omit `-Endpoint` if using OpenAI.
252271
- `FRONTEND_APPLICATION_ID`: The `Application (client) ID` associated with the application registration for the frontend.
253272
- `BACKEND_APPLICATION_ID`: The `Application (client) ID` associated with the application registration for the backend.
254273
- `TENANT_ID` : Your Azure AD tenant ID

0 commit comments

Comments
 (0)