Skip to content

Commit 5676738

Browse files
authored
Update deployment instructions for AI models (#749)
Improvements to https://ssweagleeye.com/docs/deploy-ai-model As per
1 parent 03415f0 commit 5676738

1 file changed

Lines changed: 32 additions & 28 deletions

File tree

content/docs/EagleEye/deploy-ai-model.mdx

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you plan to use **Non-AI Tags** only, you can skip this guide.
2323

2424
At the moment, EagleEye supports **chat models only**, so make sure you choose a compatible chat model.
2525

26-
**EagleEye supported models include:**
26+
**EagleEye supported models include:**
2727

2828
* `gpt-4.1-mini (recommended)`
2929
* `gpt-4o-mini`
@@ -32,36 +32,39 @@ At the moment, EagleEye supports **chat models only**, so make sure you choose a
3232
* `gpt-4.1`, `gpt-4o`
3333
* `gpt-3.5-turbo`
3434

35-
**Do not use:**
35+
⚠️ **Do not use:**
3636

3737
* Reasoning models such as `gpt-5`, `gpt-5-mini`, `gpt-5-nano`, `gpt-5-pro`, `gpt-5-codex`, `gpt-5.4-mini`, `o1`, `o1-mini`, `o3-mini`, `o4-mini`
3838
* Non-OpenAI Foundry catalog models such as Llama, Mistral, Grok, DeepSeek, Cohere, Kimi, `gpt-oss-*`, and Phi
3939
* Non-chat models such as embeddings, image models, audio models, speech models, and legacy completion models
4040

4141
## Step 1 - Deploy an AI chat model in Azure AI Foundry
4242

43-
You have two options. Pick the one that best fits your workflow.
43+
You have 2 options. Pick the one that best fits your workflow.
4444

4545
### Option A - Deploy via Azure AI Foundry portal
4646

47-
1. Go to your EagleEye resource group used during Step 3 installation (e.g., `Northwind.EagleEye.RG`).
48-
2. Find your `openai-shared-xxx` resource and open it.
47+
1. Go to your EagleEye resource group used during Step 3 installation (e.g., `Northwind.EagleEye.RG`)
48+
2. Find your `openai-shared-xxx` resource and open it
4949
![](/EagleEye/Guides/OpenAI-Shared.png)
50-
3. Click **Go to Azure AI Foundry portal**.
50+
3. Click **Go to Azure AI Foundry portal**
5151
![](/EagleEye/Guides/Foundry-Portal-Link.png)
52-
4. In Foundry portal, click **Model catalog**.
52+
4. In Foundry portal, click **Model catalog**
5353
![](/EagleEye/Guides/Model-Catalog.png)
5454
5. Pick a compatible chat model > Use this model
5555
![](/EagleEye/Guides/GPT-4.1-Mini.png)
5656
6. On the deployment screen, set:
5757
* **Deployment name** to exactly `eagleeye`
58-
* **Deployment type** to `Global Standard` if available. If not, choose another compatible deployment type with available quota.
58+
* **Deployment type** to `Global Standard` if available. If not, choose another compatible deployment type with available quota
5959
* **Tokens per Minute Rate Limit** to at least `100`
6060
![](/EagleEye/Guides/Model-Config.png)
61-
7. Click **Deploy** and wait for the deployment to become active.
61+
7. Click **Deploy** and wait for the deployment to become active
6262

63-
> **Important:**
64-
> The deployment name must be exactly `eagleeye`. If you use a different name, EagleEye will fail to find the model at runtime.
63+
<OutlineBox
64+
content={<>
65+
❗️ **Important:** The deployment name must be exactly `eagleeye`. If you use a different name, EagleEye will fail to find the model at runtime.
66+
</>}
67+
/>
6568

6669
### Option B - Deploy via AI agent
6770

@@ -76,14 +79,17 @@ Create the deployment with the name exactly `eagleeye`.
7679

7780
The agent should:
7881

79-
1. Ask for the resource group you used during Step 3 installation (e.g., `Northwind.EagleEye.RG`).
80-
2. Find the `openai-shared-xxx` Azure OpenAI resource in that resource group.
81-
3. Show which compatible non-reasoning chat models have available quota.
82-
4. Ask which model and capacity you want to deploy.
83-
5. Create the deployment with the exact name `eagleeye`.
82+
1. Ask for the resource group you used during Step 3 installation (e.g., `Northwind.EagleEye.RG`)
83+
2. Find the `openai-shared-xxx` Azure OpenAI resource in that resource group
84+
3. Show which compatible non-reasoning chat models have available quota
85+
4. Ask which model and capacity you want to deploy
86+
5. Create the deployment with the exact name `eagleeye`
8487

85-
> **Tip:**
86-
> Review the commands your agent proposes before approving them. AI agents can still make mistakes.
88+
<OutlineBox
89+
content={<>
90+
💡 **Tip:** Review the commands your agent proposes before approving them. AI agents can still make mistakes.
91+
</>}
92+
/>
8793

8894
## Step 2 - Verify AI email analysis works
8995

@@ -99,19 +105,15 @@ Use EagleEye's built-in test flow to verify the model deployment without sending
99105

100106
4\. In the **AI decision prompt** field, enter a simple test prompt such as:
101107

102-
```text
103-
Check if the email has been checked by someone by looking for keywords like "Checked by xx", "Checked by xx & xx", or similar variations.
104-
```
108+
> Check if the email has been checked by someone by looking for keywords like "Checked by xx", "Checked by xx & xx", or similar variations.
105109
106110
5\. Paste sample email content such as:
107111

108-
```plain
109-
(Checked by Adam)
110-
111-
Hi team, I just checked the invoice from Acme Corp and everything looks good.
112-
Regards,
113-
Hark
114-
```
112+
> (Checked by Adam)
113+
>
114+
> Hi team, I just checked the invoice from Acme Corp and everything looks good.
115+
> Regards,
116+
> Hark
115117
116118
6\. Click **Test**.
117119

@@ -127,6 +129,8 @@ Hark
127129
</>}
128130
/>
129131

132+
---
133+
130134
## References
131135

132136
* [Step 3 - Install from Azure Marketplace](./step-3-install-from-marketplace)

0 commit comments

Comments
 (0)