Kora-API / README.md
ProfessorCEO's picture
Fix PEFT and update README
ad99445
---
license: mit
title: KORA AI
emoji: πŸ‘€
colorTo: blue
short_description: KORA is the intelligent AI assistant for the Kontyra ecosyst
sdk: docker
---
# KORA AI
KORA is the intelligent AI assistant for the Kontyra ecosystem.
This Space hosts the KORA application and related AI services.
## Overview
This repository contains the backend infrastructure for KORA, built with FastAPI, Transformers, and Docker. The API is designed to be compatible with OpenAI-style chat completion endpoints while supporting custom system prompts, knowledge-base integration, and streaming responses.
## Features
* OpenAI-compatible API endpoint
* FastAPI-based architecture
* Streaming responses via Server-Sent Events (SSE)
* Docker-ready deployment
* Environment-based configuration
* Custom KORA system prompt injection
* Knowledge-base context integration
* Scalable backend foundation for future Kontyra products
## Technology Stack
* Python
* FastAPI
* Transformers
* PyTorch
* Docker
* Hugging Face
## API Endpoint
```http
POST /v1/chat/completions
```
### Example Request
```json
{
"model": "KORA",
"stream": true,
"messages": [
{
"role": "user",
"content": "Who created KORA?"
}
]
}
```
## Project Structure
```text
app/
β”œβ”€β”€ routes/
β”œβ”€β”€ services/
β”œβ”€β”€ utils/
β”œβ”€β”€ prompts/
β”œβ”€β”€ knowledge/
β”œβ”€β”€ main.py
β”œβ”€β”€ requirements.txt
└── Dockerfile
```
## Environment Variables
```bash
APP_NAME="KORA AI"
APP_ENV="production"
LOG_LEVEL="INFO"
MODEL_NAME="microsoft/Phi-3-mini-4k-instruct"
DEFAULT_TEMPERATURE=0.7
DEFAULT_TOP_P=0.9
DEFAULT_MAX_TOKENS=512
MAX_INPUT_TOKENS=3072
TRUST_REMOTE_CODE=true
LOW_CPU_MEM_USAGE=true
```
## Deployment
This Space is configured as a Docker Space and automatically starts the KORA API service when deployed.
The application listens on the port provided by Hugging Face:
```bash
uvicorn main:app --host 0.0.0.0 --port ${PORT:-7860}
```
## Vision
KORA serves as the intelligence layer of the Kontyra ecosystem and is being developed to support future products including:
* DevOS
* VUX
* Kontyra Jobs
* Tech Visionaries Network (TVN)
* Kontyra Learn
* Kontyra Projects
## Author
**Heritage Oluwalonimi Oladoye**
Founder of Kontyra
Building technology that creates impact across Nigeria, Africa, and the world.