Remove config.json-related information #503
Conversation
Indeed people using it locally should not need to touch configuration files 👍 However, people operating or administrating installations, and people using docker images (a large number of JupyterLab users start a clean image every day for example due to security concerns) may want to pre-specify the key. My understanding is that such users should use environment variables, is it right? Would it be worth replacing this section with a guide for setting environment variables? From a quick glance it seems that elsewhere the documentation mentions ( An alternative would be having a configurable traitlet but this is a separate discussion. |
The Chat UI that this config refers to currently doesn't support the API keys as environment variables. I agree that we should unify the behavior for API keys input if present in env variables, but that's a separate effort. Even for admins, I believe we should have a clear way to have them configure things rather than handling the config directly, for example we enable allowlists, blocklists etc. which are configured as traitlets and clearly something we expect as inputs. Similarly, PR #421 for default providers will provide admins a way to configure a language and embedding provider of their choice so that users don't have to configure them on their own; this should benefit people using docker images as well. |
|
Thank you for looking into this, @krassowski and @3coins. I definitely agree that we need a non-UI way to specify API keys and other essential config fields for chat (and I thought that editing config directly would be a viable way to do it when creating #494). Created issue to track this: |
* Update Users section of the docs (#494) * Update example of setting model provider and API key * resize screenshots * update chat settings screenshots * Promote “Custom model providers” and “Customizing prompt templates” to subsections, move them to the bottom of the users doc page * Update docs/source/users/index.md Co-authored-by: Michał Krassowski <[email protected]> * Update docs/source/users/index.md Co-authored-by: Michał Krassowski <[email protected]> * change double-backtick to single-backticks as they serve the same function * move Prompt templates sections to Developers page * Update snapshots to use the same zoom level * Update docs/source/developers/index.md Co-authored-by: Jason Weill <[email protected]> * move "Custom model providers" section to Dev page * Update lang model choice screen to show OpenAI models mentioned in text around the screenshot --------- Co-authored-by: Michał Krassowski <[email protected]> Co-authored-by: Jason Weill <[email protected]> * remove config.json-related information (#503) * Base chat handler refactor for custom slash commands (#398) * Adds attributes, starts adding to subclasses * Consistent syntax * Help for all handlers * Fix slash ID error * Iterate through entry points * Fix typo in call to select() * Moves config to magics, modifies extensions to attempt to load classes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Moves config to proper location, improves error logging * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * WIP: Updates per feedback, adds custom handler * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Removes redundant code, style fixes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Removes unnecessary custom message * Instantiates class * Validates slash ID * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Consistent arguments to chat handlers * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Refactors to avoid intentionally unused params * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Updates docs, removes custom handler from source and config * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Renames process_message to match base class * Adds needed parameter that had been deleted * Joins lines in contributor doc * Removes natural language routing type, which is not yet used * Update docs/source/developers/index.md Co-authored-by: Piyush Jain <[email protected]> * Update docs/source/developers/index.md Co-authored-by: Piyush Jain <[email protected]> * Update docs/source/developers/index.md Co-authored-by: Piyush Jain <[email protected]> * Revises per @3coins, avoids Latinism * Removes Configurable, since we do not yet have configurable traits * Uses Literal for validation * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Piyush Jain <[email protected]> --------- Co-authored-by: Andrii Ieroshenko <[email protected]> Co-authored-by: Michał Krassowski <[email protected]> Co-authored-by: Jason Weill <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Piyush Jain <[email protected]>
Remove
config.json-relared instructions added in PR #494 from Users readthedocs page. As discussed with @3coins,config.jsonshould not be edited directly by people using Jupyter AI.