Skip to content

Commit 04391b7

Browse files
committed
Fleshed out readme
1 parent 8eef1a3 commit 04391b7

File tree

1 file changed

+31
-9
lines changed

1 file changed

+31
-9
lines changed

docs/reasoning.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,22 @@ This repository includes an optional feature that uses reasoning models to gener
1919

2020
Set the environment variables for your Azure OpenAI GPT deployments to your reasoning model
2121

22+
For o3-mini:
23+
2224
```shell
2325
azd env set AZURE_OPENAI_CHATGPT_MODEL o3-mini
2426
azd env set AZURE_OPENAI_CHATGPT_DEPLOYMENT o3-mini
27+
azd env set AZURE_OPENAI_CHATGPT_DEPLOYMENT_VERSION 2025-01-31
28+
azd env set AZURE_OPENAI_CHATGPT_DEPLOYMENT_SKU GlobalStandard
29+
```
30+
31+
For o1:
32+
33+
```shell
34+
azd env set AZURE_OPENAI_CHATGPT_MODEL o1
35+
azd env set AZURE_OPENAI_CHATGPT_DEPLOYMENT o1
36+
azd env set AZURE_OPENAI_CHATGPT_DEPLOYMENT_VERSION 2024-12-17
37+
azd env set AZURE_OPENAI_CHATGPT_DEPLOYMENT_SKU GlobalStandard
2538
```
2639

2740
2. **(Optional) Set default reasoning effort**
@@ -34,14 +47,23 @@ This repository includes an optional feature that uses reasoning models to gener
3447
azd env set AZURE_OPENAI_REASONING_EFFORT medium
3548
```
3649

37-
3. **Clean old deployments (optional):**
38-
Run `azd down --purge` for a fresh setup.
50+
3. **Update the infrastructure and application:**
51+
52+
Execute `azd up` to provision the infrastructure changes (only the new model, if you ran `up` previously) and deploy the application code with the updated environment variables.
53+
54+
4. **Try out the feature:**
55+
56+
Open the web app and start a new chat. The reasoning model will be used for all chat completion requests, including the query rewriting step.
57+
58+
5. **Experiment with reasoning effort:**
59+
60+
Select the developer options in the web app and change "Reasoning Effort" to `low`, `medium`, or `high`. This will override the default reasoning effort of "medium".
61+
62+
![Reasoning configuration screenshot](./images/reasoning.png)
63+
64+
6. **Understand token usage:**
3965

40-
4. **Start the application:**
41-
Execute `azd up` to build, provision, deploy, and initiate document preparation.
66+
The reasoning models use additional billed tokens behind the scenes for the thinking process.
67+
To see the token usage, select the lightbulb icon on a chat answer. This will open the "Thought process" tab, which shows the reasoning model's thought process and the token usage for each chat completion.
4268

43-
5. **Try out the feature:**
44-
![Reasoning configuration screenshot](./images/reasoning.png)
45-
![Thought process token usage](./images/token-usage.png)
46-
* Access the developer options in the web app and change "Reasoning Effort".
47-
* Token usage is visible in the thought process tab
69+
![Thought process token usage](./images/token-usage.png)

0 commit comments

Comments
 (0)