Assistant: update provider-related settings docs to match new settings ids#280
Assistant: update provider-related settings docs to match new settings ids#280sharon-wang merged 6 commits intomainfrom
Conversation
✅ Deploy Preview for positron-posit-co ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
sharon-wang
left a comment
sharon-wang
left a comment
There was a problem hiding this comment.
For the release notes, we should note these changes are occurring, but that there is also a migration that runs automatically to update your existing enabledProviders setting to these provider-specific settings
assistant-chat.qmd
Outdated
| - [`positron.assistant.models.preference.global`](positron://settings/positron.assistant.models.preference.global): Set a preferred model to be pre-selected across all providers. Matching is case-insensitive and supports partial matches. | ||
|
|
||
| - [`positron.assistant.models.preference.byProvider`](positron://settings/positron.assistant.models.preference.byProvider): Set default models for specific providers. Provider-specific preferences take precedence over the global preference. | ||
| - `positron.assistant.models.preference.<provider>`: Set a default model for a specific provider. Provider-specific preferences take precedence over the global preference. |
There was a problem hiding this comment.
Looking for thoughts on this!
Unfortunately a settings link doesn't work here (and for the other setting below) as the exact setting ID must be used -- a partial match like positron.assistant.models.preference doesn't work
We could:
- leave this as-is and have users search for the setting themselves (though they need to make sure they omit the
<provider>part) - make a change to Positron to allow for partial matches in the settings uri
- be explicit about searching for
positron.assistant.models.preferencein the Settings UI - we could instead include this setting in the getting started page and directly link out to the specific preference and overrides settings for each provider
There was a problem hiding this comment.
What if we showed a "real" example as well, to help folks understand? Something like:
- `positron.assistant.models.preference.<provider>` such as `positron.assistant.models.preference.amazonBedrock`: Set a default model...
I don't love the idea of putting this on "Getting Started". In the long run, supporting partial matches would be nice but we can do something lower lift for now.
juliasilge
left a comment
juliasilge
left a comment
There was a problem hiding this comment.
Thank you so much! 🚀
I'd probably advocate for us showing an example provider-specific setting or two, to help folks figure out what's what.
assistant-chat.qmd
Outdated
| - [`positron.assistant.models.preference.global`](positron://settings/positron.assistant.models.preference.global): Set a preferred model to be pre-selected across all providers. Matching is case-insensitive and supports partial matches. | ||
|
|
||
| - [`positron.assistant.models.preference.byProvider`](positron://settings/positron.assistant.models.preference.byProvider): Set default models for specific providers. Provider-specific preferences take precedence over the global preference. | ||
| - `positron.assistant.models.preference.<provider>`: Set a default model for a specific provider. Provider-specific preferences take precedence over the global preference. |
There was a problem hiding this comment.
What if we showed a "real" example as well, to help folks understand? Something like:
- `positron.assistant.models.preference.<provider>` such as `positron.assistant.models.preference.amazonBedrock`: Set a default model...
I don't love the idea of putting this on "Getting Started". In the long run, supporting partial matches would be nice but we can do something lower lift for now.
Co-authored-by: Julia Silge <julia.silge@gmail.com>
2 participants
Previews