Skip to content

Commit 9cd1186

Browse files
Fix indentation in chat template readme (#6134)
1 parent 6a23beb commit 9cd1186

File tree

1 file changed

+70
-70
lines changed
  • src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData.Web-CSharp

1 file changed

+70
-70
lines changed

src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData.Web-CSharp/README.md

+70-70
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ Configure your token for this project using .NET User Secrets:
2020
1. In Visual Studio, right-click on your project in the Solution Explorer and select "Manage User Secrets".
2121
2. This opens a `secrets.json` file where you can store your API keys without them being tracked in source control. Add the following key and value:
2222

23-
```json
24-
{
25-
"GitHubModels:Token": "YOUR-TOKEN"
26-
}
27-
```
23+
```json
24+
{
25+
"GitHubModels:Token": "YOUR-TOKEN"
26+
}
27+
```
2828
#### ---#else
2929
From the command line, configure your token for this project using .NET User Secrets by running the following commands:
3030

@@ -48,11 +48,11 @@ Configure your API key for this project, using .NET User Secrets:
4848
1. In Visual Studio, right-click on your project in the Solution Explorer and select "Manage User Secrets".
4949
2. This will open a secrets.json file where you can store your API key without them being tracked in source control. Add the following key and value to the file:
5050
51-
```json
52-
{
53-
"OpenAI:Key": "YOUR-API-KEY"
54-
}
55-
```
51+
```json
52+
{
53+
"OpenAI:Key": "YOUR-API-KEY"
54+
}
55+
```
5656
5757
#### ---#else
5858
From the command line, configure your API key for this project using .NET User Secrets by running the following commands:
@@ -100,50 +100,50 @@ This template is configured to use keyless authentication (also known as Managed
100100
101101
### 4. Configure Azure OpenAI Endpoint
102102
Configure your Azure OpenAI endpoint for this project, using .NET User Secrets:
103-
1. In the Azure Portal, navigate to your Azure OpenAI resource.
104-
2. Copy the "Endpoint" URL from the "Keys and Endpoint" section.
103+
1. In the Azure Portal, navigate to your Azure OpenAI resource.
104+
2. Copy the "Endpoint" URL from the "Keys and Endpoint" section.
105105
#### ---#if (hostIdentifier == "vs")
106-
3. In Visual Studio, right-click on your project in the Solution Explorer and select "Manage User Secrets".
107-
4. This will open a `secrets.json` file where you can store your Azure OpenAI endpoint without it being tracked in source control. Add the following key and value to the file:
106+
3. In Visual Studio, right-click on your project in the Solution Explorer and select "Manage User Secrets".
107+
4. This will open a `secrets.json` file where you can store your Azure OpenAI endpoint without it being tracked in source control. Add the following key and value to the file:
108108
109-
```json
110-
{
111-
"AzureOpenAI:Endpoint": "YOUR-AZURE-OPENAI-ENDPOINT"
112-
}
113-
```
109+
```json
110+
{
111+
"AzureOpenAI:Endpoint": "YOUR-AZURE-OPENAI-ENDPOINT"
112+
}
113+
```
114114
#### ---#else
115-
3. From the command line, configure your Azure OpenAI endpoint for this project using .NET User Secrets by running the following commands:
115+
3. From the command line, configure your Azure OpenAI endpoint for this project using .NET User Secrets by running the following commands:
116116
117-
```sh
118-
cd <<your-project-directory>>
119-
dotnet user-secrets set AzureOpenAI:Endpoint YOUR-AZURE-OPENAI-ENDPOINT
120-
```
117+
```sh
118+
cd <<your-project-directory>>
119+
dotnet user-secrets set AzureOpenAI:Endpoint YOUR-AZURE-OPENAI-ENDPOINT
120+
```
121121
#### ---#endif
122122
123123
Make sure to replace `YOUR-AZURE-OPENAI-ENDPOINT` with your actual Azure OpenAI endpoint, formatted like https://YOUR-DEPLOYMENT-NAME.openai.azure.com/ (do not include any path after .openai.azure.com/).
124124
#### ---#else
125125
### 3. Configure API Key and Endpoint
126126
Configure your Azure OpenAI API key and endpoint for this project, using .NET User Secrets:
127-
1. In the Azure Portal, navigate to your Azure OpenAI resource.
128-
2. Copy the "Endpoint" URL and "Key 1" from the "Keys and Endpoint" section.
127+
1. In the Azure Portal, navigate to your Azure OpenAI resource.
128+
2. Copy the "Endpoint" URL and "Key 1" from the "Keys and Endpoint" section.
129129
#### ---#if (hostIdentifier == "vs")
130130
3. In Visual Studio, right-click on your project in the Solution Explorer and select "Manage User Secrets".
131131
4. This will open a secrets.json file where you can store your API key and endpoint without it being tracked in source control. Add the following keys & values to the file:
132132
133-
```json
134-
{
135-
"AzureOpenAI:Key": "YOUR-AZURE-OPENAI-KEY",
136-
"AzureOpenAI:Endpoint": "YOUR-AZURE-OPENAI-ENDPOINT"
137-
}
138-
```
133+
```json
134+
{
135+
"AzureOpenAI:Key": "YOUR-AZURE-OPENAI-KEY",
136+
"AzureOpenAI:Endpoint": "YOUR-AZURE-OPENAI-ENDPOINT"
137+
}
138+
```
139139
#### ---#else
140140
3. From the command line, configure your API key and endpoint for this project using .NET User Secrets by running the following commands:
141141
142-
```sh
143-
cd <<your-project-directory>>
144-
dotnet user-secrets set AzureOpenAI:Key YOUR-AZURE-OPENAI-KEY
145-
dotnet user-secrets set AzureOpenAI:Endpoint YOUR-AZURE-OPENAI-ENDPOINT
146-
```
142+
```sh
143+
cd <<your-project-directory>>
144+
dotnet user-secrets set AzureOpenAI:Key YOUR-AZURE-OPENAI-KEY
145+
dotnet user-secrets set AzureOpenAI:Endpoint YOUR-AZURE-OPENAI-ENDPOINT
146+
```
147147
#### ---#endif
148148
149149
Make sure to replace `YOUR-AZURE-OPENAI-KEY` and `YOUR-AZURE-OPENAI-ENDPOINT` with your actual Azure OpenAI key and endpoint. Make sure your endpoint URL is formatted like https://YOUR-DEPLOYMENT-NAME.openai.azure.com/ (do not include any path after .openai.azure.com/).
@@ -166,51 +166,51 @@ This template is configured to use keyless authentication (also known as Managed
166166
167167
### 3. Set the Azure AI Search Endpoint for this app
168168
Configure your Azure AI Search endpoint for this project, using .NET User Secrets:
169-
1. In the Azure Portal, navigate to your Azure AI Search resource.
170-
2. Copy the "URL" from the "Overview" section.
169+
1. In the Azure Portal, navigate to your Azure AI Search resource.
170+
2. Copy the "URL" from the "Overview" section.
171171
#### ---#if (hostIdentifier == "vs")
172-
3. In Visual Studio, right-click on your project in the Solution Explorer and select "Manage User Secrets".
173-
4. This will open a `secrets.json` file where you can store your Azure AI Search endpoint securely. Add the following key & value to the file:
172+
3. In Visual Studio, right-click on your project in the Solution Explorer and select "Manage User Secrets".
173+
4. This will open a `secrets.json` file where you can store your Azure AI Search endpoint securely. Add the following key & value to the file:
174174
175-
```json
176-
{
177-
"AzureAISearch:Endpoint": "YOUR-AZURE-AI-SEARCH-ENDPOINT"
178-
}
179-
```
175+
```json
176+
{
177+
"AzureAISearch:Endpoint": "YOUR-AZURE-AI-SEARCH-ENDPOINT"
178+
}
179+
```
180180
#### ---#else
181-
3. From the command line, configure your Azure AI Search endpoint for this project using .NET User Secrets by running the following commands:
181+
3. From the command line, configure your Azure AI Search endpoint for this project using .NET User Secrets by running the following commands:
182182
183-
```sh
184-
cd <<your-project-directory>>
185-
dotnet user-secrets set AzureAISearch:Endpoint YOUR-AZURE-AI-SEARCH-ENDPOINT
186-
```
183+
```sh
184+
cd <<your-project-directory>>
185+
dotnet user-secrets set AzureAISearch:Endpoint YOUR-AZURE-AI-SEARCH-ENDPOINT
186+
```
187187
#### ---#endif
188188
189189
Make sure to replace `YOUR-AZURE-AI-SEARCH-ENDPOINT` with your actual Azure AI Search endpoint.
190190
191191
#### ---#else
192192
### 3. Configure API Key and Endpoint
193193
Configure your Azure AI Search API key and endpoint for this project, using .NET User Secrets:
194-
1. In the Azure Portal, navigate to your Azure AI Search resource.
195-
2. Copy the "Endpoint" URL and "Primary admin key" from the "Keys" section.
194+
1. In the Azure Portal, navigate to your Azure AI Search resource.
195+
2. Copy the "Endpoint" URL and "Primary admin key" from the "Keys" section.
196196
#### ---#if (hostIdentifier == "vs")
197197
3. In Visual Studio, right-click on your project in the Solution Explorer and select "Manage User Secrets".
198198
4. This will open a `secrets.json` file where you can store your API key and endpoint without them being tracked in source control. Add the following keys and values to the file:
199199
200-
```json
201-
{
202-
"AzureAISearch:Key": "YOUR-AZURE-AI-SEARCH-KEY",
203-
"AzureAISearch:Endpoint": "YOUR-AZURE-AI-SEARCH-ENDPOINT"
204-
}
205-
```
200+
```json
201+
{
202+
"AzureAISearch:Key": "YOUR-AZURE-AI-SEARCH-KEY",
203+
"AzureAISearch:Endpoint": "YOUR-AZURE-AI-SEARCH-ENDPOINT"
204+
}
205+
```
206206
#### ---#else
207207
3. From the command line, configure your API key and endpoint for this project using .NET User Secrets by running the following commands:
208208
209-
```sh
210-
cd <<your-project-directory>>
211-
dotnet user-secrets set AzureAISearch:Key YOUR-AZURE-AI-SEARCH-KEY
212-
dotnet user-secrets set AzureAISearch:Endpoint YOUR-AZURE-AI-SEARCH-ENDPOINT
213-
```
209+
```sh
210+
cd <<your-project-directory>>
211+
dotnet user-secrets set AzureAISearch:Key YOUR-AZURE-AI-SEARCH-KEY
212+
dotnet user-secrets set AzureAISearch:Endpoint YOUR-AZURE-AI-SEARCH-ENDPOINT
213+
```
214214
#### ---#endif
215215
Make sure to replace `YOUR-AZURE-AI-SEARCH-KEY` and `YOUR-AZURE-AI-SEARCH-ENDPOINT` with your actual Azure AI Search key and endpoint.
216216
@@ -220,15 +220,15 @@ Make sure to replace `YOUR-AZURE-AI-SEARCH-KEY` and `YOUR-AZURE-AI-SEARCH-ENDPOI
220220
221221
## Using Visual Studio
222222
223-
1. Open the `.csproj` file in Visual Studio.
224-
2. Press `Ctrl+F5` or click the "Start" button in the toolbar to run the project.
223+
1. Open the `.csproj` file in Visual Studio.
224+
2. Press `Ctrl+F5` or click the "Start" button in the toolbar to run the project.
225225
226226
## Using Visual Studio Code
227227
228-
1. Open the project folder in Visual Studio Code.
229-
2. Install the [C# Dev Kit extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) for Visual Studio Code.
230-
3. Once installed, Open the `Program.cs` file.
231-
4. Run the project by clicking the "Run" button in the Debug view.
228+
1. Open the project folder in Visual Studio Code.
229+
2. Install the [C# Dev Kit extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) for Visual Studio Code.
230+
3. Once installed, Open the `Program.cs` file.
231+
4. Run the project by clicking the "Run" button in the Debug view.
232232
233233
# Learn More
234234
To learn more about development with .NET and AI, check out the following links:

0 commit comments

Comments
 (0)