mirror of
https://github.com/wavetermdev/waveterm-docs-old.git
synced 2026-08-05 13:42:53 -07:00
renamed ai parameters, added BYOLLM page in ai features page, changed wording around LLMs, simplified install instructions, and other small changes
This commit is contained in:
Knox Lively
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: 'BYOLLM'
|
||||
description: 'Get up and running with your own LLM'
|
||||
---
|
||||
|
||||
Wave AI supports the integration of any LLM provider that uses the same [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat). This feature allows you to bring your own compatible LLM provider and seamlessly integrate it into your workflow.
|
||||
|
||||
<Tip>
|
||||
To see a full list of supported LLM providers, please visit the [Third-Party LLM Support](/features/waveAI#third-party-llm-support) section in the Wave AI features page.
|
||||
</Tip>
|
||||
|
||||
|
||||
## Configuration
|
||||
After installing and configuring your own LLM provider, you can start using it in Wave by setting two parameters: `aibaseurl` and `aimodel`. These parameters can be set either through the UI or from the command line, but please note that the parameter names are slightly different depending on the method you choose.
|
||||
|
||||
### **Parameters**
|
||||
|
||||
- **AI Base URL:** Set this parameter to the base URL or endpoint that Wave AI should query.
|
||||
- **AI Model**: Specify the model name that you want to use.
|
||||
|
||||
**Note:** If the provided URL (e.g., `http://localhost:8080/v1/chat/completions`) doesn't work, try removing the `/chat/completions` directories from the end of the URL or using just the hostname and port (e.g., `http://localhost:8080`). This often resolves compatibility issues and allows Wave AI to communicate with your LLM provider successfully.
|
||||
|
||||
### Configuring via the UI
|
||||
To configure your own LLM provider from the Wave AI user interface, navigate to the "Settings" menu and set the `AI Base URL` and `AI Model` parameters as described in the previous section.
|
||||
|
||||
### Configuring via the CLI
|
||||
To configure your own LLM provider using the command line, set the `aibaseurl` and `aimodel` parameters using the [/client:set](/reference/slashcommands#client-set) command, as shown in the example below.
|
||||
|
||||
```
|
||||
/client:set aibaseurl=<your-base-url>
|
||||
/client:set aimodel=<your-model-name>
|
||||
```
|
||||
|
||||
## Usage
|
||||
Once you have installed and configured your own LLM provider, you can start using it in Wave. There are two primary ways to interact with your newly configured LLM: [Interactive Mode](/features/waveAI#interactive) and by using the [/chat](/features/waveAI#chat-command) command.
|
||||
|
||||
- **Interactive Mode:** To enter Interactive Mode, click the "Wave AI" button in the command box or use the `ctrl + space` shortcut. This will open an interactive chat session where you can have a continuous conversation with the AI assistant powered by your own LLM provider model.
|
||||
- **/chat:** Alternatively, you can use the [/chat](/features/waveAI#chat-command) command followed by your question to get a quick answer from your own LLM provider model directly in the terminal.
|
||||
|
||||
## Troubleshooting
|
||||
If you encounter issues while using your own LLM provider with Wave AI, consider the following troubleshooting steps:
|
||||
|
||||
- **Connection failures:** If Wave AI fails to connect to your own LLM provider or returns an error message, verify that your own LLM provider is running.
|
||||
- **Timeouts:** If you're unable to complete a query or incur frequent timeouts, try adjusting the [aitimeout](/features/waveAI#customization) parameter to a higher value. This will give your own LLM provider more time to process and respond to your requests, especially if you are running it on a system with limited hardware resources.
|
||||
- **Incorrect base URL or port:** Ensure that the [aibaseurl](/features/waveAI#customization) parameter points to the correct URL and port number where your own LLM provider is running. If you have changed the default port or are running your own LLM provider on a remote server, update the URL accordingly.
|
||||
- **Incorrect model selection:** If you have multiple LLMs installed, make sure to set the [aimodel](/features/waveAI#customization) parameter to the specific model you want to use.
|
||||
- **Unexpected behavior or inconsistent results:** If you encounter unexpected behavior or inconsistent results when using your own LLM provider with Wave AI, try [resetting](#reset-wave-ai) the `aibaseurl` and `aimodel` parameters to their default values and reconfiguring your LLM provider from scratch. This can help rule out any configuration issues that might be causing problems.
|
||||
|
||||
## Reset Wave AI
|
||||
At any time if you find that you wish to return to the default Wave AI experience, you can reset the `aibaseurl` and `aimodel` parameters to their default state by using the following commands.
|
||||
|
||||
```
|
||||
/client:set aibaseurl=
|
||||
/client:set aimodel=
|
||||
```
|
||||
**Note:** This can also be done in the UI just as described in previous steps.
|
||||
@@ -8,18 +8,18 @@ description: 'Get LocalAI up and running in Wave AI'
|
||||
**Note:** At the moment, Wave's integration with LocalAI only supports their LLM features. Image generation, audio processing, speech to text, and other capabilities are not yet available but may be added in future updates.
|
||||
|
||||
<Tip>
|
||||
To see a full list of supported LLMs, please visit the [Third-Party LLM Support](/features/waveAI#third-party-llm-support) section in the Wave AI features page.
|
||||
To see a full list of supported LLM providers, please visit the [Third-Party LLM Support](/features/waveAI#third-party-llm-support) section in the Wave AI features page.
|
||||
</Tip>
|
||||
|
||||
## Installation
|
||||
Please visit LocalAI's [quickstart](https://localai.io/basics/getting_started/) guide for instructions on downloading and installing LocalAI.
|
||||
|
||||
## Configuration
|
||||
After installing and configuring LocalAI, you can start using it in Wave by setting two parameters: `openaibaseurl` and `openaimodel`. These parameters can be set either through the UI or from the command line, but please note that the parameter names are slightly different depending on the method you choose.
|
||||
After installing and configuring LocalAI, you can start using it in Wave by setting two parameters: `aibaseurl` and `aimodel`. These parameters can be set either through the UI or from the command line, but please note that the parameter names are slightly different depending on the method you choose.
|
||||
|
||||
### **Parameters**
|
||||
|
||||
- **Base URL:** Set this parameter to the base URL or endpoint that Wave AI should query. For LocalAI running locally, use http://localhost:8080. Please note that the port number `8080` may be different depending on your specific installation. For remote LocalAI instances, replace `localhost` with the appropriate hostname or IP address of the server where LocalAI is running. If the port number is different from the default `8080`, update it accordingly in the URL.
|
||||
- **AI Base URL:** Set this parameter to the base URL or endpoint that Wave AI should query. For LocalAI running locally, use http://localhost:8080. Please note that the port number `8080` may be different depending on your specific installation. For remote LocalAI instances, replace `localhost` with the appropriate hostname or IP address of the server where LocalAI is running. If the port number is different from the default `8080`, update it accordingly in the URL.
|
||||
- **AI Model**: Specify the LocalAI model you want to use. To discover available models, you can query the LocalAI endpoint, `/v1/models`.
|
||||
|
||||
Example: http://localhost:8080/v1/models.
|
||||
@@ -28,11 +28,11 @@ After installing and configuring LocalAI, you can start using it in Wave by sett
|
||||
To configure LocalAI from the Wave AI user interface, navigate to the "Settings" menu and set the `AI Base URL` and `AI Model` parameters as described in the previous section.
|
||||
|
||||
### Configuring via the CLI
|
||||
To configure LocalAI using the command line, set the `openaibaseurl` and `openaimodel` parameters using the [/client:set](/reference/slashcommands#client-set) command, as shown in the example below. Replace the values with the appropriate `Base URL` and `AI Model` for your LocalAI installation.
|
||||
To configure LocalAI using the command line, set the `aibaseurl` and `aimodel` parameters using the [/client:set](/reference/slashcommands#client-set) command, as shown in the example below.
|
||||
|
||||
```
|
||||
/client:set openaibaseurl=<your-LocalAI-base-url>
|
||||
/client:set openaimodel=<your-LocalAI-model-name>
|
||||
/client:set aibaseurl=<your-LocalAI-base-url>
|
||||
/client:set aimodel=<your-LocalAI-model-name>
|
||||
```
|
||||
|
||||
## Usage
|
||||
@@ -45,20 +45,20 @@ Once you have installed and configured LocalAI, you can start using it in Wave.
|
||||
If you encounter issues while using LocalAI with Wave AI, consider the following troubleshooting steps:
|
||||
|
||||
- **Connection failures:** If Wave AI fails to connect to LocalAI or returns an error message, [verify that LocalAI is running](https://localai.io/basics/getting_started/#text-generation) and accessible from the system where Wave is installed. Check the LocalAI logs for any error messages or indications of why the connection might be failing.
|
||||
- **Timeouts:** If you're unable to complete a query or incur frequent timeouts, try adjusting the [openaitimeout](/features/waveAI#customization) parameter to a higher value. This will give LocalAI more time to process and respond to your requests, especially if you are running it on a system with limited hardware resources.
|
||||
- **Incorrect base URL or port:** Ensure that the [openaibaseurl](/features/waveAI#customization) parameter points to the correct URL and port number where LocalAI is running. If you have changed the default port or are running LocalAI on a remote server, update the URL accordingly.
|
||||
- **Incorrect model selection:** If you have multiple LocalAI models installed, make sure to set the [openaimodel](/features/waveAI#customization) parameter to the specific model you want to use. You can list available models using the LocalAI list command in your terminal.
|
||||
- **Unexpected behavior or inconsistent results:** If you encounter unexpected behavior or inconsistent results when using LocalAI with Wave AI, try [resetting](#reset-wave-ai) the openaibaseurl and openaimodel parameters to their default values and reconfiguring LocalAI from scratch. This can help rule out any configuration issues that might be causing problems.
|
||||
- **Timeouts:** If you're unable to complete a query or incur frequent timeouts, try adjusting the [aitimeout](/features/waveAI#customization) parameter to a higher value. This will give LocalAI more time to process and respond to your requests, especially if you are running it on a system with limited hardware resources.
|
||||
- **Incorrect base URL or port:** Ensure that the [aibaseurl](/features/waveAI#customization) parameter points to the correct URL and port number where LocalAI is running. If you have changed the default port or are running LocalAI on a remote server, update the URL accordingly.
|
||||
- **Incorrect model selection:** If you have multiple LocalAI models installed, make sure to set the [aimodel](/features/waveAI#customization) parameter to the specific model you want to use.
|
||||
- **Unexpected behavior or inconsistent results:** If you encounter unexpected behavior or inconsistent results when using LocalAI with Wave AI, try [resetting](#reset-wave-ai) the aibaseurl and aimodel parameters to their default values and reconfiguring LocalAI from scratch. This can help rule out any configuration issues that might be causing problems.
|
||||
|
||||
If you continue to face issues after trying these troubleshooting steps, please see the [Additional Resources](#additional-resources) section below for further assistance.
|
||||
|
||||
|
||||
## Reset Wave AI
|
||||
At any time if you find that you wish to return to the default Wave AI experience, you can reset the `openaibaseurl` and `openaimodel` parameters to their default state by using the following commands.
|
||||
At any time if you find that you wish to return to the default Wave AI experience, you can reset the `aibaseurl` and `aimodel` parameters to their default state by using the following commands.
|
||||
|
||||
```
|
||||
/client:set openaibaseurl=
|
||||
/client:set openaimodel=
|
||||
/client:set aibaseurl=
|
||||
/client:set aimodel=
|
||||
```
|
||||
**Note:** This can also be done in the UI just as described in previous steps.
|
||||
|
||||
|
||||
@@ -6,29 +6,29 @@ description: 'Get Ollama up and running in Wave AI'
|
||||
[Ollama](https://ollama.com/) is an open-source language model that offers a powerful and flexible alternative to proprietary LLMs, allowing you to run the model locally or on your own server infrastructure. Ollama provides high-quality language generation and understanding capabilities while giving you full control over your data and privacy.
|
||||
|
||||
<Tip>
|
||||
To see a full list of supported LLMs, please visit the [Third-Party LLM Support](/features/waveAI#third-party-llm-support) section in the Wave AI features page.
|
||||
To see a full list of supported LLM providers, please visit the [Third-Party LLM Support](/features/waveAI#third-party-llm-support) section in the Wave AI features page.
|
||||
</Tip>
|
||||
|
||||
## Installation
|
||||
Please visit Ollama's [GitHub](https://github.com/ollama/ollama?tab=readme-ov-file) page for instructions on downloading and installing Ollama, as well as a quickstart guide and a full list of supported models.
|
||||
|
||||
## Configuration
|
||||
After installing and configuring Ollama, you can start using it in Wave by setting two parameters: `openaibaseurl` and `openaimodel`. These parameters can be set either through the UI or from the command line, but please note that the parameter names are slightly different depending on the method you choose.
|
||||
After installing and configuring Ollama, you can start using it in Wave by setting two parameters: `aibaseurl` and `aimodel`. These parameters can be set either through the UI or from the command line, but please note that the parameter names are slightly different depending on the method you choose.
|
||||
|
||||
### **Parameters**
|
||||
|
||||
- **Base URL:** Set this parameter to the base URL or endpoint that Wave AI should query. For Ollama running locally, use http://localhost:11434/v1. Please note that the port number `11434` may be different depending on your specific installation. For remote Ollama instances, replace `localhost` with the appropriate hostname or IP address of the server where Ollama is running. If the port number is different from the default `11434`, update it accordingly in the URL.
|
||||
- **AI Base URL:** Set this parameter to the base URL or endpoint that Wave AI should query. For Ollama running locally, use http://localhost:11434/v1. Please note that the port number `11434` may be different depending on your specific installation. For remote Ollama instances, replace `localhost` with the appropriate hostname or IP address of the server where Ollama is running. If the port number is different from the default `11434`, update it accordingly in the URL.
|
||||
- **AI Model**: Specify the Ollama model you want to use. This can be any "pulled" model in Ollama and doesn't need to be actively running. To discover available models, use the `ollama list` command in your terminal.
|
||||
|
||||
### Configuring via the UI
|
||||
To configure Ollama from the Wave AI user interface, navigate to the "Settings" menu and set the `AI Base URL` and `AI Model` parameters as described in the previous section.
|
||||
|
||||
### Configuring via the CLI
|
||||
To configure Ollama using the command line, set the `openaibaseurl` and `openaimodel` parameters using the [/client:set](/reference/slashcommands#client-set) command, as shown in the example below. Replace the values with the appropriate `Base URL` and `AI Model` for your Ollama installation.
|
||||
To configure Ollama using the command line, set the `aibaseurl` and `aimodel` parameters using the [/client:set](/reference/slashcommands#client-set) command, as shown in the example below.
|
||||
|
||||
```
|
||||
/client:set openaibaseurl=<your-ollama-base-url>
|
||||
/client:set openaimodel=<your-ollama-model-name>
|
||||
/client:set aibaseurl=<your-ollama-base-url>
|
||||
/client:set aimodel=<your-ollama-model-name>
|
||||
```
|
||||
|
||||
## Usage
|
||||
@@ -41,19 +41,19 @@ Once you have installed and configured Ollama, you can start using it in Wave. T
|
||||
If you encounter issues while using Ollama with Wave AI, consider the following troubleshooting steps:
|
||||
|
||||
- **Connection failures:** If Wave AI fails to connect to Ollama or returns an error message, [verify that Ollama is running](https://github.com/ollama/ollama?tab=readme-ov-file#rest-api) and accessible from the system where Wave is installed. Check the Ollama logs for any error messages or indications of why the connection might be failing.
|
||||
- **Timeouts:** If you're unable to complete a query or incur frequent timeouts, try adjusting the [openaitimeout](/features/waveAI#customization) parameter to a higher value. This will give Ollama more time to process and respond to your requests, especially if you are running it on a system with limited hardware resources.
|
||||
- **Incorrect base URL or port:** Ensure that the [openaibaseurl](/features/waveAI#customization) parameter points to the correct URL and port number where Ollama is running. If you have changed the default port or are running Ollama on a remote server, update the URL accordingly.
|
||||
- **Incorrect model selection:** If you have multiple Ollama models installed, make sure to set the [openaimodel](/features/waveAI#customization) parameter to the specific model you want to use. You can list available models using the ollama list command in your terminal.
|
||||
- **Unexpected behavior or inconsistent results:** If you encounter unexpected behavior or inconsistent results when using Ollama with Wave AI, try [resetting](#reset-wave-ai) the openaibaseurl and openaimodel parameters to their default values and reconfiguring Ollama from scratch. This can help rule out any configuration issues that might be causing problems.
|
||||
- **Timeouts:** If you're unable to complete a query or incur frequent timeouts, try adjusting the [aitimeout](/features/waveAI#customization) parameter to a higher value. This will give Ollama more time to process and respond to your requests, especially if you are running it on a system with limited hardware resources.
|
||||
- **Incorrect base URL or port:** Ensure that the [aibaseurl](/features/waveAI#customization) parameter points to the correct URL and port number where Ollama is running. If you have changed the default port or are running Ollama on a remote server, update the URL accordingly.
|
||||
- **Incorrect model selection:** If you have multiple Ollama models installed, make sure to set the [aimodel](/features/waveAI#customization) parameter to the specific model you want to use. You can list available models using the ollama list command in your terminal.
|
||||
- **Unexpected behavior or inconsistent results:** If you encounter unexpected behavior or inconsistent results when using Ollama with Wave AI, try [resetting](#reset-wave-ai) the aibaseurl and aimodel parameters to their default values and reconfiguring Ollama from scratch. This can help rule out any configuration issues that might be causing problems.
|
||||
|
||||
If you continue to face issues after trying these troubleshooting steps, please see the [Additional Resources](#additional-resources) section below for further assistance.
|
||||
|
||||
## Reset Wave AI
|
||||
At any time if you find that you wish to return to the default Wave AI experience, you can reset the `openaibaseurl` and `openaimodel` parameters to their default state by using the following commands.
|
||||
At any time if you find that you wish to return to the default Wave AI experience, you can reset the `aibaseurl` and `aimodel` parameters to their default state by using the following commands.
|
||||
|
||||
```
|
||||
/client:set openaibaseurl=
|
||||
/client:set openaimodel=
|
||||
/client:set aibaseurl=
|
||||
/client:set aimodel=
|
||||
```
|
||||
**Note:** This can also be done in the UI just as described in previous steps.
|
||||
|
||||
|
||||
+14
-13
@@ -6,7 +6,7 @@ icon: 'robot'
|
||||
|
||||
Wave AI is our native ChatGPT integration that allows you to ask questions and receive answers directly from your terminal. This feature streamlines your workflow by providing AI assistance without the need to switch between multiple tools or applications.
|
||||
|
||||
Wave AI also supports the use of third party LLM's, allowing you to tailor your AI experience to your specific needs and concerns, whether they're related to privacy, ethics, or accessing the latest technologies. See the [Third-Party LLM Support](#third-party-llm-support) section for a full list of supported LLMs.
|
||||
Wave AI also supports the use of third party LLM providers, allowing you to tailor your AI experience to your specific needs and concerns, whether they're related to privacy, ethics, or accessing the latest technologies. See the [Third-Party LLM Support](#third-party-llm-support) section for a full list of supported LLM providers.
|
||||
|
||||
## Using Wave AI
|
||||
There are currently two ways to use Wave AI: *interactively*, and via the [/chat](/reference/slashcommands#chat) command.
|
||||
@@ -21,7 +21,7 @@ In the interactive mode, you can ask follow-up questions, provide additional con
|
||||
|
||||
### Chat command
|
||||
Alternatively, you can use the [/chat](/reference/slashcommands#chat) command followed by your question to get a quick answer from the terminal.
|
||||
```
|
||||
```x
|
||||
Usage:
|
||||
/chat How do I resolve a merge conflict?
|
||||
```
|
||||
@@ -34,29 +34,30 @@ This method is ideal for one-off queries or when you need a straightforward answ
|
||||
|
||||
Wave AI comes with default settings that work out of the box. By default, Wave will proxy your requests through our cloud servers to OpenAI. However, you can customize your experience by modifying the following settings in the UI or by using the [/client:set](/reference/slashcommands#client-set) command:
|
||||
|
||||
- `openaiapitoken:` Set your own OpenAI API key if you prefer not to use Wave's default configuration. Note that your API token will never be sent to Wave's cloud servers. When you provide your own API key, all future requests will be sent directly to OpenAI or any other endpoint you specify using `openaibaseurl`.
|
||||
- `openaibaseurl:` If you want to use other 3rd party APIs compatible with the OpenAI API, you can change the base URL. You will also want to set your `openaiapitoken` in conjunction with the base url to use a different service.
|
||||
- `openaimaxchoices:` This option determines the number of different response variations the AI model will generate for each query. Increasing this value will provide more diverse responses, while decreasing it will make the model's output more focused and consistent.
|
||||
- `openaimaxtokens:` This setting allows you to control the maximum number of tokens (words or word pieces) that the AI model will generate in a single response.
|
||||
- `openaimodel:` Wave AI uses the ChatGPT *gpt-3.5-turbo* model by default, but you can choose a different model that suits your needs. You will need to also set `openaiapitoken` if you choose to use another ChatGPT model. Also, when configuring other third-party services you will want to change this setting to the appropriate model.
|
||||
- `openaitimeout:` Specify the maximum time (in milliseconds) to wait for a response from the AI service before timing out. The default value is 10000 (10 seconds). This setting is particularly useful when configuring and troubleshooting local LLMs, as response times can vary significantly depending on the hardware constraints of the system running the model.
|
||||
- `aiapitoken:` Set your own OpenAI API key if you prefer not to use Wave's default configuration. Note that your API token will never be sent to Wave's cloud servers. When you provide your own API key, all future requests will be sent directly to OpenAI or any other endpoint you specify using `aibaseurl`.
|
||||
- `aibaseurl:` If you want to use other 3rd party APIs compatible with the OpenAI API, you can change the base URL. You will also want to set your `aiapitoken` in conjunction with the base url to use a different service.
|
||||
- `aimaxchoices:` This option determines the number of different response variations the AI model will generate for each query. Increasing this value will provide more diverse responses, while decreasing it will make the model's output more focused and consistent.
|
||||
- `aimaxtokens:` This setting allows you to control the maximum number of tokens (words or word pieces) that the AI model will generate in a single response.
|
||||
- `aimodel:` Wave AI uses the ChatGPT *gpt-3.5-turbo* model by default, but you can choose a different model that suits your needs. You will need to also set `aiapitoken` if you choose to use another ChatGPT model. Also, when configuring other third-party services you will want to change this setting to the appropriate model.
|
||||
- `aitimeout:` Specify the maximum time (in milliseconds) to wait for a response from the AI service before timing out. The default value is 10000 (10 seconds). This setting is particularly useful when configuring and troubleshooting LLM providers, as response times can vary significantly depending on the hardware constraints of the system running the model.
|
||||
|
||||
**Note:** In order to prevent abuse, [telemetry](/reference/telemetry) must be enabled to use the cloud servers. There is currently a rate limit of 200 requests per day.
|
||||
|
||||
## Third-Party LLM Support
|
||||
Wave AI supports various third-party Large Language Models (LLMs), allowing you to choose the model that best suits your needs and preferences. This section provides a comprehensive list of the third-party LLMs compatible with Wave AI, enabling you to make an informed decision based on your specific needs and concerns.
|
||||
Wave AI supports various third-party Large Language Model providers, allowing you to choose the model that best suits your needs and preferences. This section provides a comprehensive list of the third-party LLM providers that are compatible with Wave AI, enabling you to make an informed decision based on your specific needs and concerns.
|
||||
|
||||
To get started with a specific integration, simply click on the integration to access the setup instructions and configuration details for that particular LLM.
|
||||
To get started with a specific integration, simply click on the integration to access the setup instructions and configuration details for that particular LLM provider.
|
||||
|
||||
### Supported LLM's:
|
||||
### Supported LLM Providers:
|
||||
* [Ollama](/features/supportedLLMs/ollama)
|
||||
* [LocalAI](/features/supportedLLMs/localai)
|
||||
* [BYOLLM (Bring Your Own LLM)](/features/supportedLLMs/BYOLLM)
|
||||
|
||||
**Note:** Currently, Wave's third-party LLM integration supports language models that are compatible with OpenAI's [Chat Completions API](https://platform.openai.com/docs/api-reference/chat). We are actively working on expanding our integrations to support a wider range of LLMs and API formats in the near future.
|
||||
**Note:** Currently, Wave's third-party LLM integration supports language models that are compatible with [OpenAI's Chat Completions API](https://platform.openai.com/docs/api-reference/chat). We are actively working on expanding our integrations to support a wider range of LLM providers and API formats in the near future.
|
||||
|
||||
## Disabling Wave AI
|
||||
|
||||
Wave AI functionality can be disabled by simply turning telemetry off. This can be done in the UI under "Settings", or by issuing the [/telemetry:off](/reference/slashcommands#telemetry-off) command.
|
||||
|
||||
## Future Plans
|
||||
We're excited about the future of Wave AI and have plans to expand its capabilities. In the near future, we'll be expanding our BYOLLM (Bring Your Own Large Language Model) offerings to include more integrations around popular cloud-based models like Anthropic's Claude, Google's Gemini, and more.
|
||||
We're excited about the future of Wave AI and have plans to expand its capabilities. In the near future, we'll be expanding our third-party offerings to include more integrations around popular cloud-based models like Anthropic's Claude, Google's Gemini, and more.
|
||||
@@ -143,7 +143,7 @@ The `{KeyZ}` keycode will ensure that The *Z* key is used for this keybinding, r
|
||||
<Accordion title="Example">
|
||||
To reassign the `Cmd+b` keybinding to your custom command, you would need to:
|
||||
|
||||
1. Add the default "Open Bookmarks View" command in the `keybindings.json` file and asign it a different keybinding, such as `Cmd+Shift+b`:
|
||||
1. Add the default "Open Bookmarks View" command in the `keybindings.json` file and assign it a different keybinding, such as `Cmd+Shift+b`:
|
||||
```json
|
||||
{
|
||||
"command": "app:openBookmarksView",
|
||||
|
||||
+12
-12
@@ -72,20 +72,20 @@ This command is used to update client settings.
|
||||
|
||||
```
|
||||
Usage:
|
||||
/client:set [openaiapitoken=token] [openaibaseurl=url] [openaimaxchoices=choices] [openaimaxtokens=tokens] [openaimodel=modelname] [termfontfamily=fontfamily] [termfontsize=fontsize]
|
||||
/client:set [aiapitoken=token] [aibaseurl=url] [aimaxchoices=choices] [aimaxtokens=tokens] [aimodel=modelname] [termfontfamily=fontfamily] [termfontsize=fontsize]
|
||||
```
|
||||
**Options:**
|
||||
|
||||
- `openaiapitoken` - Set your OpenAI API token to use the OpenAI API directly instead of the Wave cloud servers.
|
||||
- `openaibaseurl` - Set the base URL for the OpenAI API if you want to use a different endpoint or a third-party API compatible with the OpenAI API.
|
||||
- `openaimaxchoices` - Specify the maximum number of choices to generate when using the OpenAI API. Note that this option only applies when using your own API token. If you're using Wave's proxy, this value is predetermined.
|
||||
- `openaimaxtokens` - Set the maximum number of tokens to use when generating a response from the OpenAI API. Note that this option is only effective when using your own API token. If you're using Wave's proxy, the maxtokens value is preconfigured.
|
||||
- `openaimodel` - Choose the OpenAI language model to use for generating responses. Default is *gpt-3.5-turbo*.
|
||||
- `aiapitoken` - Set your OpenAI API token to use the OpenAI API directly instead of the Wave cloud servers.
|
||||
- `aibaseurl` - Set the base URL for the OpenAI API if you want to use a different endpoint or a third-party API compatible with the OpenAI API.
|
||||
- `aimaxchoices` - Specify the maximum number of choices to generate when using the OpenAI API. Note that this option only applies when using your own API token. If you're using Wave's proxy, this value is predetermined.
|
||||
- `aimaxtokens` - Set the maximum number of tokens to use when generating a response from the OpenAI API. Note that this option is only effective when using your own API token. If you're using Wave's proxy, the maxtokens value is preconfigured.
|
||||
- `aimodel` - Choose the OpenAI language model to use for generating responses. Default is *gpt-3.5-turbo*.
|
||||
- `termfontfamily` - Update the font family used in the terminal. Wave supports *JetBrains Mono*, *Hack*, and *Fira Code* out of the box. You can also use any fixed-width font installed on your local machine by specifying its exact name. Be cautious when setting a custom font, as mistyping the font name or using a non-fixed-width font may result in visual inconsistencies.
|
||||
- `termfontsize` - Update the font size used in the terminal. You can set the font size from 8 to 15 pixels (px).
|
||||
|
||||
|
||||
**Note:** The `openaimaxtokens` and `openaimaxchoices` options are only applicable when using your own OpenAI API token. If you're using Wave's built-in proxy for API requests, these values are predetermined to ensure optimal performance and compatibility.
|
||||
**Note:** The `aimaxtokens` and `aimaxchoices` options are only applicable when using your own OpenAI API token. If you're using Wave's built-in proxy for API requests, these values are predetermined to ensure optimal performance and compatibility.
|
||||
|
||||
### /client:show
|
||||
|
||||
@@ -97,11 +97,11 @@ This command displays various client settings and version information.
|
||||
- `client-version` - The version number of your Wave client.
|
||||
- `clientid` - The identifier for your specific Wave client instance.
|
||||
- `db-version` - The version of the client's database.
|
||||
- `openaiapitoken` - Your OpenAI API token.
|
||||
- `openaibaseurl` - The URL used for sending OpenAI queries.
|
||||
- `openaimaxchoices` - The maximum number of choices returned when querying OpenAI.
|
||||
- `openaimaxtokens` - The maximum number of tokens currently set for OpenAI queries.
|
||||
- `openaimodel` - OpenAI model name.
|
||||
- `aiapitoken` - Your OpenAI API token.
|
||||
- `aibaseurl` - The URL used for sending OpenAI queries.
|
||||
- `aimaxchoices` - The maximum number of choices returned when querying OpenAI.
|
||||
- `aimaxtokens` - The maximum number of tokens currently set for OpenAI queries.
|
||||
- `aimodel` - OpenAI model name.
|
||||
- `releasecheck` - Shows if automatic release checks are active (on/off).
|
||||
- `server-version` - The version of the Wave server you're connected to.
|
||||
- `telemetry` - Indicates whether telemetry is enabled (on/off).
|
||||
|
||||
Reference in New Issue
Block a user