Okos - AI Telegram Assistant

Okos is a Telegram AI Assistant built with TypeScript, LangGraph, and multiple AI model providers. It maintains conversation context and provides summaries of interactions.

Features

• Multiple AI model support (OpenAI, Google Gemini, Groq, Ollama)
• Conversation context management
• Automatic conversation summarization
• Multiple Images input support
• Internet searching
• Redis for state persistence
• Docker support for both local and cloud deployments

Prerequisites

• Node.js 20+ (for development only)
• Docker and Docker Compose (for containerized deployment)
• Telegram Bot Token from BotFather
• API keys for chosen AI providers
• Redis server
• Ollama with Llama model installed (for Ollama model provider)

Prebuilt Docker Image

ghcr.io/johnnybui/okos

Platforms: amd64 and arm64

Setup

1. Clone the repository
2. Install dependencies:

yarn install

3. Copy the example environment file:

# For local development
cp .env.example .env

# For Docker deployment
cp .env.docker.example .env.docker

4. Configure environment variables in .env or .env.docker:

• TELEGRAM_BOT_TOKEN: Your Telegram bot token
• MODEL_PROVIDER: Choose from 'ollama', 'google', 'groq', or 'openai'
• Provider-specific API keys and model names
• Redis URL
• (Optional) LangSmith credentials for monitoring

Running Locally

Development mode with hot reload:

yarn dev

Production mode:

yarn build
yarn start

Docker Deployment

You can deploy using one of two options:

1. Local Deployment with Ollama

For local LLM inference:

1. Build Containers (optional):
   Use the command below to build the containers. Alternatively, to use a prebuilt image, edit the docker-compose file, replacing the build: . line with:

   image: ghcr.io/johnnybui/okos

   Run build:

   yarn build:ollama

2. Start Services:

   yarn up:ollama

2. Cloud Deployment

For cloud-based AI providers (OpenAI, Google, Groq):

1. Build Containers (optional):
   Similar to local deployment, replace build: . in the docker-compose file with the prebuilt image if desired:

   image: ghcr.io/johnnybui/okos

   Run build:

   yarn build:cloud

2. Start Services:

   yarn up:cloud

Environment Variables

Required

• TELEGRAM_BOT_TOKEN: Telegram Bot token
• MODEL_PROVIDER: AI model provider ('ollama', 'google', 'groq', or 'openai')
• SEARCH_PROVIDER: Search provider ('tavily' or 'brave')
• TAVILY_API_KEY: Tavily API key for internet searching
• BRAVE_SEARCH_API_KEY: Brave Search API key for internet searching
• REDIS_URL: Redis connection URL

Provider-Specific

• OpenAI:
  • OPENAI_API_KEY
  • OPENAI_MODEL_NAME (default: gpt-4o-mini)
• Google:
  • GOOGLE_API_KEY
  • GOOGLE_MODEL_NAME (default: gemini-1.5-flash)
• Groq:
  • GROQ_API_KEY
  • GROQ_MODEL_NAME (default: llama-3.3-70b-versatile)
• Ollama:
  • OLLAMA_API_URL
  • OLLAMA_MODEL_NAME (default: llama3.2)

Optional

• LANGCHAIN_TRACING_V2: Enable LangSmith tracing
• LANGCHAIN_ENDPOINT: LangSmith endpoint
• LANGCHAIN_API_KEY: LangSmith API key
• LANGCHAIN_PROJECT: LangSmith project name

License

MIT