khoj/documentation/docs/advanced/litellm.md
Debanjum 01bc6d35dc
Rename Chat Model Options table to Chat Model as short & readable (#1003)
- Previous was incorrectly plural but was defining only a single model
- Rename chat model table field to name
- Update documentation
- Update references functions and variables to match new name
2024-12-12 11:24:16 -08:00

1.7 KiB

LiteLLM

:::info This is only helpful for self-hosted users. If you're using Khoj Cloud, you're limited to our first-party models. :::

:::info Khoj natively supports local LLMs available on HuggingFace in GGUF format. Using an OpenAI API proxy with Khoj maybe useful for ease of setup, trying new models or using commercial LLMs via API. :::

LiteLLM exposes an OpenAI compatible API that proxies requests to other LLM API services. This provides a standardized API to interact with both open-source and commercial LLMs.

Using LiteLLM with Khoj makes it possible to turn any LLM behind an API into your personal AI agent.

Setup

  1. Install LiteLLM
    pip install litellm[proxy]
    
  2. Start LiteLLM and use Mistral tiny via Mistral API
    export MISTRAL_API_KEY=<MISTRAL_API_KEY>
    litellm --model mistral/mistral-tiny --drop_params
    
  3. Create a new API Model API on your Khoj admin panel
    • Name: proxy-name
    • Api Key: any string
    • Api Base Url: URL of your Openai Proxy API
  4. Create a new Chat Model on your Khoj admin panel.
    • Name: llama3.1 (replace with the name of your local model)
    • Model Type: Openai
    • Openai Config: <the proxy config you created in step 3>
    • Max prompt size: 20000 (replace with the max prompt size of your model)
    • Tokenizer: Do not set for OpenAI, Mistral, Llama3 based models
  5. Go to your config and select the model you just created in the chat model dropdown.