Skip to content

Commit 8c98686

Browse files
committed
update docs
1 parent 41a3d2f commit 8c98686

File tree

4 files changed

+49
-0
lines changed

4 files changed

+49
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@ You can find extensive documentation in the [docs](docs/README.md) folder:
256256
- [All features](docs/deploy_features.md)
257257
- [Login and access control](docs/login_and_acl.md)
258258
- [GPT-4 Turbo with Vision](docs/gpt4v.md)
259+
- [Reasoning](docs/reasoning.md)
259260
- [Private endpoints](docs/deploy_private.md)
260261
- [Sharing deployment environments](docs/sharing_environments.md)
261262
- [Local development](docs/localdev.md)

docs/images/reasoning.png

97.3 KB
Loading

docs/images/token-usage.png

75.9 KB
Loading

docs/reasoning.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# RAG chat: Using reasoning models
2+
3+
This repository includes an optional feature that uses reasoning models to generate responses based on retrieved content. These models spend more time processing and understanding the user's request.
4+
5+
## Using the feature
6+
7+
### Supported Models
8+
9+
* o3-mini
10+
* o1
11+
12+
### Prerequisites
13+
14+
* The ability to deploy a reasoning model in the [supported regions](https://learn.microsoft.com/azure/ai-services/openai/concepts/models#standard-deployment-model-availability). If you're not sure, try to create a o3-mini deployment from your Azure OpenAI deployments page.
15+
16+
### Deployment
17+
18+
1. **Enable reasoning:**
19+
20+
Set the environment variables for your Azure OpenAI GPT deployments to your reasoning model
21+
22+
```shell
23+
azd env set AZURE_OPENAI_CHATGPT_MODEL o3-mini
24+
azd env set AZURE_OPENAI_CHATGPT_DEPLOYMENT o3-mini
25+
```
26+
27+
2. **(Optional) Set default reasoning effort**
28+
29+
You can configure how much effort the reasoning model spends on processing and understanding the user's request. Valid options are `low`, `medium`, and `high`. Reasoning effort defaults to `medium` if not set.
30+
31+
Set the environment variable for reasoning effort
32+
33+
```shell
34+
azd env set AZURE_OPENAI_REASONING_EFFORT medium
35+
```
36+
37+
3. **Clean old deployments (optional):**
38+
Run `azd down --purge` for a fresh setup.
39+
40+
4. **Start the application:**
41+
Execute `azd up` to build, provision, deploy, and initiate document preparation.
42+
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
48+

0 commit comments

Comments
 (0)