-
Notifications
You must be signed in to change notification settings - Fork 6
feat(docs): Add AIChatbot policy #106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a1bad54
feat(docs): Add AIChatbot policy
bsmth 5975a2b
Apply suggestion from @bsmth
bsmth 45c237e
feat(docs): Changes following reviewer feedback
bsmth 0fed7d4
Apply suggestion from @bsmth
bsmth 0d723eb
Merge branch 'main' into 102-AIChatbot
bsmth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| > [!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 `id` of the provider to use as the default. | ||
|
bsmth marked this conversation as resolved.
Outdated
|
||
| - `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 | ||
| <dict> | ||
| <key>AIChatbot</key> | ||
| <dict> | ||
| <key>Providers</key> | ||
| <dict> | ||
| <key>Add</key> | ||
| <array> | ||
| <dict> | ||
| <key>url</key> | ||
| <string>https://example.com</string> | ||
| <key>name</key> | ||
| <string>Example AI</string> | ||
| <key>id</key> | ||
| <string>example-ai</string> | ||
| <key>iconUrl</key> | ||
| <string>https://example.com/icon.png</string> | ||
| <key>queryParam</key> | ||
| <string>q</string> | ||
| </dict> | ||
| </array> | ||
| <key>BuiltIn</key> | ||
| <dict> | ||
| <key>Anthropic Claude</key> | ||
| <true/> | <false/> | ||
| <key>ChatGPT</key> | ||
| <true/> | <false/> | ||
| <key>Copilot</key> | ||
| <true/> | <false/> | ||
| <key>Google Gemini</key> | ||
| <true/> | <false/> | ||
| <key>HuggingChat</key> | ||
| <true/> | <false/> | ||
| <key>Le Chat Mistral</key> | ||
| <true/> | <false/> | ||
| <key>localhost</key> | ||
| <true/> | <false/> | ||
| </dict> | ||
| <key>Default</key> | ||
| <string>example-ai</string> | ||
| </dict> | ||
| <key>Prompts</key> | ||
| <dict> | ||
| <key>Enabled</key> | ||
| <true/> | <false/> | ||
| <key>BuiltIn</key> | ||
| <dict> | ||
| <key>Summarize</key> | ||
| <true/> | <false/> | ||
| <key>Explain</key> | ||
| <true/> | <false/> | ||
| <key>Quiz</key> | ||
| <true/> | <false/> | ||
| <key>Proofread</key> | ||
| <true/> | <false/> | ||
| </dict> | ||
| </dict> | ||
| </dict> | ||
| </dict> | ||
| ``` | ||
|
|
||
| ## 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 | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.