Skip to content

Tutorials

Frank Zhang edited this page Aug 23, 2024 · 9 revisions

Quick start

Welcome to Kaas, this guide will walk you through the installation process and show you how to start chatting with a remote LLM in no time.

Installation

  1. Download the latest release for your operating system from the Releases page. Kaas currently supports Windows(64-bit), macOS and Linux.
  2. Install the application:
    • Windows: Run the Microsoft Installer (.msi file) or NSIS Installer (-setup.exe file)
    • macOS: Run the .dmginstaller
    • Linux: Use the appropriate package manager for your distribution (e.g., .deb for Debian/Ubuntu, .rpm for Fedora)
  3. Launch Kaas from your applications menu or desktop shortcut.

Create a Model

  1. Hover over the side navigation bar on the left and click Models. This will bring you to the Models page.

  2. Click Create new model button, it will open a dialog that asks you to pick a provider you want to create model with

  3. Each provider requires a difference set of fields to be filled, so that you can successfully access its APIs. For example, to use OpenAI, you need to fill it your API Key (kept in a database on your device) and name of the model you want to use. For OpenAI and Ollama, you can load available models by clicking the **Load from API" button, or you can choose to fill in the model name manually.
    Note: if you have enabled Proxy on the Settings page, the request to load models will go through proxy too.

  4. Once you filled all the required fields, click Save.

  5. You should now see the model you just created under the Your Models section.

  6. You can create multiple models from the same provider and use the in different conversations.

Start a Conversation

  1. Make sure you have created at least one model

  2. Hover over the side navigation bar on the left and click Conversations. This will bring you to the Conversations page.

  3. Click "Start new conversation" button

  4. It will ask you to pick a model for the new conversation, pick one and click Use this model

  5. A conversation with default title "New conversation" is created, you can now type your question in the input box, upload an image (if the model supports vision) or use a prompt template for more complex prompt (how to define a prompt template).

Guides

Clone this wiki locally