diff --git a/.vscode/project-words.txt b/.vscode/project-words.txt index 4f610ff..749cadb 100644 --- a/.vscode/project-words.txt +++ b/.vscode/project-words.txt @@ -11,6 +11,7 @@ browser.newtabpage browser.newtabpage.activity-stream.asrouter browser.safebrowsing CHACHA +chatbots cryptomining datareporting datareporting.healthreport diff --git a/CHANGELOG.md b/CHANGELOG.md index d2b6df4..d158b85 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,7 @@ #### Added - `AccessConnector` policy: Configure an Access Connector for proxying web traffic. [#102](https://github.com/mozilla/enterprise-admin-reference/pull/102) +- `AIChatbot` policy: Configure the AI chatbot sidebar. [#106](https://github.com/mozilla/enterprise-admin-reference/pull/106) - `AIControls` policy: Configure AI controls. [#103](https://github.com/mozilla/enterprise-admin-reference/pull/103) - `CrashReportsSubmit` policy: Configure crash report submission settings. [#86](https://github.com/mozilla/enterprise-admin-reference/pull/86) - `Sync` policy: Enable or disable sync and define which data to include. [#70](https://github.com/mozilla/enterprise-admin-reference/pull/70) diff --git a/src/content/docs/reference/policies/AIChatbot.mdx b/src/content/docs/reference/policies/AIChatbot.mdx new file mode 100644 index 0000000..b742f15 --- /dev/null +++ b/src/content/docs/reference/policies/AIChatbot.mdx @@ -0,0 +1,173 @@ +--- +title: "AIChatbot" +description: "Configure the AI chatbot sidebar." +category: "Content settings" +--- + +Configure the AI chatbot sidebar, including which built-in providers are available and the ability to add custom providers. +For more information, see [Access AI chatbots in Firefox](https://support.mozilla.org/en-US/kb/ai-chatbot) on support.mozilla.org. + +> [!NOTE] +> Currently, this is only implemented in Firefox Enterprise. + +**Compatibility:** Firefox Enterprise 149.0.0\ +**CCK2 Equivalent:** N/A\ +**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` + +## Values + +- `Providers`: Configures the available AI chatbot providers. + - `Add`: An array of custom provider objects to add. + Each object accepts the following properties: + - `url` (required): The URL of the AI chatbot provider. + - `name` (required): Display name for the provider. + - `id` (required): Unique identifier for the provider. + - `iconUrl`: URL of the provider's icon. + - `queryParam`: Query parameter name used to pass prompts to the provider. + - `BuiltIn`: An object to enable or disable individual built-in providers. + Set a provider key to `true` to enable it or `false` to disable it. + The following built-in providers are available: + - `Anthropic Claude` + - `ChatGPT` + - `Copilot` + - `Google Gemini` + - `HuggingChat` + - `Le Chat Mistral` + - `localhost` + - `Default`: The `name` of the provider to use as the default. +- `Prompts`: Configures the AI chatbot prompt suggestions. + - `Enabled`: Set to `true` to enable prompt suggestions or `false` to disable them. + - `BuiltIn`: An object to enable or disable individual built-in prompts. + Set a prompt key to `true` to enable it or `false` to disable it. + The following built-in prompts are available: + - `Summarize` + - `Explain` + - `Quiz` + - `Proofread` + +## Windows (GPO) + +``` +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Add\1\url = "https://example.com" +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Add\1\name = "Example AI" +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Add\1\id = "example-ai" +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Add\1\iconUrl = "https://example.com/icon.png" +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Add\1\queryParam = "q" +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\Anthropic Claude = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\ChatGPT = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\Copilot = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\Google Gemini = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\HuggingChat = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\Le Chat Mistral = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\localhost = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Providers\Default = "example-ai" +Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\Enabled = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\BuiltIn\Summarize = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\BuiltIn\Explain = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\BuiltIn\Quiz = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\BuiltIn\Proofread = 0x1 | 0x0 +``` + +## macOS + +```xml + + AIChatbot + + Providers + + Add + + + url + https://example.com + name + Example AI + id + example-ai + iconUrl + https://example.com/icon.png + queryParam + q + + + BuiltIn + + Anthropic Claude + | + ChatGPT + | + Copilot + | + Google Gemini + | + HuggingChat + | + Le Chat Mistral + | + localhost + | + + Default + example-ai + + Prompts + + Enabled + | + BuiltIn + + Summarize + | + Explain + | + Quiz + | + Proofread + | + + + + +``` + +## policies.json + +```json +{ + "policies": { + "AIChatbot": { + "Providers": { + "Add": [ + { + "url": "https://example.com", + "name": "Example AI", + "id": "example-ai", + "iconUrl": "https://example.com/icon.png", + "queryParam": "q" + } + ], + "BuiltIn": { + "Anthropic Claude": true | false, + "ChatGPT": true | false, + "Copilot": true | false, + "Google Gemini": true | false, + "HuggingChat": true | false, + "Le Chat Mistral": true | false, + "localhost": true | false + }, + "Default": "example-ai" + }, + "Prompts": { + "Enabled": true | false, + "BuiltIn": { + "Summarize": true | false, + "Explain": true | false, + "Quiz": true | false, + "Proofread": true | false + } + } + } + } +} +```