CoolFace
Apppublic

wnxddev/humanoid-robotics-api

sourceHugging Facemitupdated 9mo agoView on Hugging Face
0likes
App README

Humanoid Robotics RAG Chatbot API

A FastAPI backend for the Humanoid Robotics RAG Chatbot, deployed on Hugging Face Spaces.

Features

  • —🤖 OpenAI Agents: GPT-4o powered conversational AI
  • —📚 RAG System: Retrieval-augmented generation using Qdrant vector database
  • —🔍 Semantic Search: Cohere embeddings for accurate content retrieval
  • —👤 User Authentication: Secure JWT-based authentication
  • —🎯 Personalization: Content adapted to user's background
  • —🌐 Translation: English to Urdu translation support
  • —📝 Summarization: Text summarization capabilities
  • —💾 Session Management: Persistent chat history

API Endpoints

Health Check

bash
GET /health

Authentication

  • —POST /api/v1/auth/signup - User registration
  • —POST /api/v1/auth/signin - User login
  • —GET /api/v1/auth/profile - Get user profile

Chat & RAG

  • —POST /agent/chat - Main chat endpoint with RAG
  • —GET /api/v1/history - Get chat history

Content Services

  • —POST /api/v1/summarize - Summarize text
  • —POST /api/v1/content/translate/{chapter_id} - Translate to Urdu
  • —POST /api/v1/content/personalize/{chapter_id} - Personalize content

Interests (Personalization)

  • —POST /api/v1/interests - Update user interests
  • —GET /api/v1/interests - Get user interests
  • —POST /api/v1/interests/filter-chapters - Filter chapters by interests

Architecture

FastAPI Backend
├── OpenAI Agent (GPT-4o)
├── Qdrant Vector DB (Embeddings)
├── Cohere (Text Embeddings)
└── Neon PostgreSQL (User Data)

Environment Variables

This Space requires the following secrets to be configured:

  • —OPENAI_API_KEY - OpenAI API key for GPT-4o
  • —COHERE_KEY - Cohere API key for embeddings
  • —QDRANT_URL - Qdrant Cloud instance URL
  • —QDRANT_KEY - Qdrant API key
  • —NEON_URL - Neon PostgreSQL connection string
  • —BETTERAUTH_SECRET - Secret for JWT token generation
  • —CORS_ORIGINS - Allowed CORS origins (comma-separated)
  • —QDRANT_COLLECTION_NAME - Qdrant collection name

Tech Stack

  • —Framework: FastAPI
  • —AI/ML: OpenAI Agents, Cohere
  • —Vector DB: Qdrant Cloud
  • —Database: Neon PostgreSQL
  • —Deployment: Docker on Hugging Face Spaces

API Documentation

Once deployed, visit /docs for interactive API documentation (Swagger UI).

Testing the API

bash
# Health check
curl https://wnxddev-humanoid-robotics-api.hf.space/health

# Chat endpoint (requires authentication)
curl -X POST https://wnxddev-humanoid-robotics-api.hf.space/agent/chat \
  -H "Content-Type: application/json" \
  -d '{
    "message": "What is inverse kinematics?",
    "session_id": "test-session",
    "mode": "full-book"
  }'

Frontend Integration

This API is designed to work with the Humanoid Robotics Docusaurus frontend:

  • —Frontend: https://website-wania-akrams-projects.vercel.app
  • —GitHub: https://github.com/waniaa00/Physical-AI-And-Humanoid-Robotics-Textbook

License

MIT License

Support

For issues and questions, please visit the GitHub repository or contact the maintainer.