Skip to content
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.

Sign up for GitHub

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

Improve preference description #14376

Merged
merged 1 commit into from
Oct 30, 2024
Merged

Improve preference description #14376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/ai-llamafile/src/browser/llamafile-preferences.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@ export const aiLlamafilePreferencesSchema: PreferenceSchema = {
properties: {
[PREFERENCE_LLAMAFILE]: {
title: AI_LLAMAFILE_PREFERENCES_TITLE,
markdownDescription: '❗ This setting allows you to add llamafiles.\
markdownDescription: 'This setting allows you to configure and manage LlamaFile models in Theia IDE.\
\n\
You need to provide a user friendly `name`, the file `uri` to the llamafile and the `port` to use.\
Each entry requires a user-friendly `name`, the file `uri` pointing to your LlamaFile, and the `port` on which it will run.\
\n\
In order to start your llamafile you have to call the "Start Llamafile" command where you can then select the llamafile to start.\
To start a LlamaFile, use the "Start LlamaFile" command, which enables you to select the desired model.\
\n\
If you modify an entry, e.g. change the port and the server was already running, then it will be stopped and you have to manually start it again.',
If you edit an entry (e.g., change the port), any running instance will stop, and you will need to manually start it again.\
\n\
[Learn more about configuring and managing LlamaFiles in the Theia IDE documentation](https://theia-ide.org/docs/user_ai/#llamafile-models).',
type: 'array',
default: [],
items: {
Expand Down
4 changes: 3 additions & 1 deletion packages/ai-openai/src/browser/openai-preferences.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ export const OpenAiPreferencesSchema: PreferenceSchema = {
\n\
- specify a unique `id` to identify the custom model in the UI. If none is given `model` will be used as `id`.\
\n\
- provide an `apiKey` to access the API served at the given url. Use `true` to indicate the use of the global OpenAI API key.',
- provide an `apiKey` to access the API served at the given url. Use `true` to indicate the use of the global OpenAI API key.\
\n\
Refer to [our documentation](https://theia-ide.org/docs/user_ai/#openai-compatible-models-eg-via-vllm) for more information.',
default: [],
items: {
type: 'object',
Expand Down
Loading