From ce76a6cd43cca97487984c87e221e5fc2bd00962 Mon Sep 17 00:00:00 2001 From: Brian Smith Date: Mon, 9 Nov 2026 18:44:18 +0000 Subject: [PATCH 1/2] feat: add exampoles for AIChatbot policy --- .../docs/reference/policies/AIChatbot.mdx | 98 +++++++++++++++++-- 1 file changed, 88 insertions(+), 10 deletions(-) diff --git a/src/content/docs/reference/policies/AIChatbot.mdx b/src/content/docs/reference/policies/AIChatbot.mdx index bda070d..a11523b 100644 --- a/src/content/docs/reference/policies/AIChatbot.mdx +++ b/src/content/docs/reference/policies/AIChatbot.mdx @@ -17,21 +17,24 @@ For more information, see [Access AI chatbots in Firefox](https://support.mozill - `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. + Firefox sends prompts to custom providers in the `q` query parameter, so set `queryParam` if your bot or provider expects something different. + - `BuiltIn`: An object to remove specific built-in providers. + Set a provider key to `false` to remove it. + To add a provider that isn't already listed, use the `Add` key. The following built-in providers are available: - `Anthropic Claude` - `ChatGPT` - `Copilot` - `Google Gemini` - `HuggingChat` - - `Le Chat Mistral` + - `Mistral Vibe` - `localhost` - - `Default`: The `name` of the provider to use as the default. + - `Le Chat Mistral` (_Deprecated_. Use `Mistral Vibe` instead.) + - `Default`: The `name` of the provider to use as the default, for example `Anthropic Claude` or the `name` of a provider in `Add`. - `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. + - `BuiltIn`: An object to remove individual built-in prompts. + Set a prompt key to `false` to remove it. The following built-in prompts are available: - `Summarize` - `Explain` @@ -42,6 +45,81 @@ For more information, see [Access AI chatbots in Firefox](https://support.mozill +### Setting your organization's chat provider as the default + +This example adds a company-approved chatbot next to the built-in providers and selects it for users who haven't already picked one. +`Default` must match the provider's `name`, not its `id`: + +```json +{ + "policies": { + "AIChatbot": { + "Providers": { + "Add": [ + { + "url": "https://ai.example.com", + "name": "Example AI", + "id": "example-ai", + "iconUrl": "https://ai.example.com/icon.png" + } + ], + "Default": "Example AI" + } + } + } +} +``` + +### Using on-device models + +If you deploy a local model server to your devices, add it as a custom provider so prompts and page content stay on the device. +Setting `localhost` to `true` in `BuiltIn` doesn't show the built-in localhost provider, so use `Add` with the address your server listens on. +Ensure the server is installed and running on the configured port as it's possible that another program can listen there for user prompts. +This example also removes the built-in cloud providers so users can't choose one instead: + +```json +{ + "policies": { + "AIChatbot": { + "Providers": { + "Add": [ + { + "url": "http://localhost:8080", + "name": "Local model", + "id": "local-model" + } + ], + "BuiltIn": { + "Anthropic Claude": false, + "ChatGPT": false, + "Google Gemini": false, + "HuggingChat": false, + "Mistral Vibe": false + }, + "Default": "Local model" + } + } + } +} +``` + +### Turning off prompt suggestions + +This example removes the built-in prompts, such as Summarize and Explain, and the prompt shortcut that appears when users select text on a page. +Users can still type their own prompts in the chatbot in the sidebar: + +```json +{ + "policies": { + "AIChatbot": { + "Prompts": { + "Enabled": false + } + } + } +} +``` + ## Windows (GPO) ``` @@ -55,9 +133,9 @@ Software\Policies\Mozilla\Firefox\AIChatbot\Providers\BuiltIn\ChatGPT = 0x1 | 0x 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\Mistral Vibe = 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\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 @@ -100,13 +178,13 @@ Software\Policies\Mozilla\Firefox\AIChatbot\Prompts\BuiltIn\Proofread = 0x1 | 0x | HuggingChat | - Le Chat Mistral + Mistral Vibe | localhost | Default - example-ai + Example AI Prompts From d568ed223b077d0faf5743f43d2d5f1bcea37df1 Mon Sep 17 00:00:00 2001 From: Brian Smith Date: Mon, 9 Nov 2026 18:55:04 +0000 Subject: [PATCH 2/2] feat: add exampoles for AIChatbot policy --- src/content/docs/reference/policies/AIChatbot.mdx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/content/docs/reference/policies/AIChatbot.mdx b/src/content/docs/reference/policies/AIChatbot.mdx index a11523b..dff874b 100644 --- a/src/content/docs/reference/policies/AIChatbot.mdx +++ b/src/content/docs/reference/policies/AIChatbot.mdx @@ -72,9 +72,12 @@ This example adds a company-approved chatbot next to the built-in providers and ### Using on-device models -If you deploy a local model server to your devices, add it as a custom provider so prompts and page content stay on the device. +If you run a chatbot on each device, add it as a custom provider so prompts and page content don't leave the device. +Firefox opens the provider's `url` as a web page in the sidebar and passes prompts in the `q` query parameter, so the server must provide a chat web interface, not just an inference API. +It must also process requests itself rather than forwarding them to an external service. Setting `localhost` to `true` in `BuiltIn` doesn't show the built-in localhost provider, so use `Add` with the address your server listens on. -Ensure the server is installed and running on the configured port as it's possible that another program can listen there for user prompts. +Make sure the server is installed and running on every device that receives this policy. +Another application listening on that port could receive users' prompts. This example also removes the built-in cloud providers so users can't choose one instead: ```json @@ -92,6 +95,7 @@ This example also removes the built-in cloud providers so users can't choose one "BuiltIn": { "Anthropic Claude": false, "ChatGPT": false, + "Copilot": false, "Google Gemini": false, "HuggingChat": false, "Mistral Vibe": false