Skip to content

Commit 2818282

Browse files
bsmthbsmth
authored
feat(docs): Add AIChatbot policy (#106)
* feat(docs): Add AIChatbot policy * Apply suggestion from @bsmth * feat(docs): Changes following reviewer feedback * Apply suggestion from @bsmth
1 parent 16f88e1 commit 2818282

3 files changed

Lines changed: 175 additions & 0 deletions

File tree

‎.vscode/project-words.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ browser.newtabpage
1111
browser.newtabpage.activity-stream.asrouter
1212
browser.safebrowsing
1313
CHACHA
14+
chatbots
1415
cryptomining
1516
datareporting
1617
datareporting.healthreport

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
#### Added
2222

2323
- `AccessConnector` policy: Configure an Access Connector for proxying web traffic. [#102](https://github.com/mozilla/enterprise-admin-reference/pull/102)
24+
- `AIChatbot` policy: Configure the AI chatbot sidebar. [#106](https://github.com/mozilla/enterprise-admin-reference/pull/106)
2425
- `AIControls` policy: Configure AI controls. [#103](https://github.com/mozilla/enterprise-admin-reference/pull/103)
2526
- `CrashReportsSubmit` policy: Configure crash report submission settings. [#86](https://github.com/mozilla/enterprise-admin-reference/pull/86)
2627
- `Sync` policy: Enable or disable sync and define which data to include. [#70](https://github.com/mozilla/enterprise-admin-reference/pull/70)

‎src/content/docs/reference/policies/AIChatbot.mdx‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
---
2+
title: "AIChatbot"
3+
description: "Configure the AI chatbot sidebar."
4+
category: "Content settings"
5+
---
6+
7+
Configure the AI chatbot sidebar, including which built-in providers are available and the ability to add custom providers.
8+
For more information, see [Access AI chatbots in Firefox](https://support.mozilla.org/en-US/kb/ai-chatbot) on support.mozilla.org.
9+
10+
> [!NOTE]
11+
> Currently, this is only implemented in Firefox Enterprise.
12+
13+
**Compatibility:** Firefox Enterprise 149.0.0\
14+
**CCK2 Equivalent:** N/A\
15+
**Preferences Affected:** `browser.ml.chat.enabled`, `browser.ml.chat.provider`, `browser.ml.chat.providers`, `browser.ml.chat.shortcuts`, `browser.ml.chat.prompts.0`, `browser.ml.chat.prompts.1`, `browser.ml.chat.prompts.2`, `browser.ml.chat.prompts.3`
16+
17+
## Values
18+
19+
- `Providers`: Configures the available AI chatbot providers.
20+
- `Add`: An array of custom provider objects to add.
21+
Each object accepts the following properties:
22+
- `url` (required): The URL of the AI chatbot provider.
23+
- `name` (required): Display name for the provider.
24+
- `id` (required): Unique identifier for the provider.
25+
- `iconUrl`: URL of the provider's icon.
26+
- `queryParam`: Query parameter name used to pass prompts to the provider.
27+
- `BuiltIn`: An object to enable or disable individual built-in providers.
28+
Set a provider key to `true` to enable it or `false` to disable it.
29+
The following built-in providers are available:
30+
- `Anthropic Claude`
31+
- `ChatGPT`
32+
- `Copilot`
33+
- `Google Gemini`
34+
- `HuggingChat`
35+
- `Le Chat Mistral`
36+
- `localhost`
37+
- `Default`: The `name` of the provider to use as the default.
38+
- `Prompts`: Configures the AI chatbot prompt suggestions.
39+
- `Enabled`: Set to `true` to enable prompt suggestions or `false` to disable them.
40+
- `BuiltIn`: An object to enable or disable individual built-in prompts.
41+
Set a prompt key to `true` to enable it or `false` to disable it.
42+
The following built-in prompts are available:
43+
- `Summarize`
44+
- `Explain`
45+
- `Quiz`
46+
- `Proofread`
47+
48+
## Windows (GPO)
49+
50+
```
51+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Add\1\url = "https://example.com"
52+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Add\1\name = "Example AI"
53+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Add\1\id = "example-ai"
54+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Add\1\iconUrl = "https://example.com/icon.png"
55+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Add\1\queryParam = "q"
56+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\Anthropic Claude = 0x1 | 0x0
57+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\ChatGPT = 0x1 | 0x0
58+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\Copilot = 0x1 | 0x0
59+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\Google Gemini = 0x1 | 0x0
60+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\HuggingChat = 0x1 | 0x0
61+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\Le Chat Mistral = 0x1 | 0x0
62+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\localhost = 0x1 | 0x0
63+
Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Default = "example-ai"
64+
Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\Enabled = 0x1 | 0x0
65+
Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\BuiltIn\Summarize = 0x1 | 0x0
66+
Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\BuiltIn\Explain = 0x1 | 0x0
67+
Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\BuiltIn\Quiz = 0x1 | 0x0
68+
Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\BuiltIn\Proofread = 0x1 | 0x0
69+
```
70+
71+
## macOS
72+
73+
```xml
74+
<dict>
75+
<key>AIChatbot</key>
76+
<dict>
77+
<key>Providers</key>
78+
<dict>
79+
<key>Add</key>
80+
<array>
81+
<dict>
82+
<key>url</key>
83+
<string>https://example.com</string>
84+
<key>name</key>
85+
<string>Example AI</string>
86+
<key>id</key>
87+
<string>example-ai</string>
88+
<key>iconUrl</key>
89+
<string>https://example.com/icon.png</string>
90+
<key>queryParam</key>
91+
<string>q</string>
92+
</dict>
93+
</array>
94+
<key>BuiltIn</key>
95+
<dict>
96+
<key>Anthropic Claude</key>
97+
<true/> | <false/>
98+
<key>ChatGPT</key>
99+
<true/> | <false/>
100+
<key>Copilot</key>
101+
<true/> | <false/>
102+
<key>Google Gemini</key>
103+
<true/> | <false/>
104+
<key>HuggingChat</key>
105+
<true/> | <false/>
106+
<key>Le Chat Mistral</key>
107+
<true/> | <false/>
108+
<key>localhost</key>
109+
<true/> | <false/>
110+
</dict>
111+
<key>Default</key>
112+
<string>example-ai</string>
113+
</dict>
114+
<key>Prompts</key>
115+
<dict>
116+
<key>Enabled</key>
117+
<true/> | <false/>
118+
<key>BuiltIn</key>
119+
<dict>
120+
<key>Summarize</key>
121+
<true/> | <false/>
122+
<key>Explain</key>
123+
<true/> | <false/>
124+
<key>Quiz</key>
125+
<true/> | <false/>
126+
<key>Proofread</key>
127+
<true/> | <false/>
128+
</dict>
129+
</dict>
130+
</dict>
131+
</dict>
132+
```
133+
134+
## policies.json
135+
136+
```json
137+
{
138+
"policies": {
139+
"AIChatbot": {
140+
"Providers": {
141+
"Add": [
142+
{
143+
"url": "https://example.com",
144+
"name": "Example AI",
145+
"id": "example-ai",
146+
"iconUrl": "https://example.com/icon.png",
147+
"queryParam": "q"
148+
}
149+
],
150+
"BuiltIn": {
151+
"Anthropic Claude": true | false,
152+
"ChatGPT": true | false,
153+
"Copilot": true | false,
154+
"Google Gemini": true | false,
155+
"HuggingChat": true | false,
156+
"Le Chat Mistral": true | false,
157+
"localhost": true | false
158+
},
159+
"Default": "example-ai"
160+
},
161+
"Prompts": {
162+
"Enabled": true | false,
163+
"BuiltIn": {
164+
"Summarize": true | false,
165+
"Explain": true | false,
166+
"Quiz": true | false,
167+
"Proofread": true | false
168+
}
169+
}
170+
}
171+
}
172+
}
173+
```

0 commit comments

Comments
 (0)