ApeRAG

ApeRAG, Graph RAG, vektör arama ve tam metin aramasını gelişmiş AI ajanlarıyla birleştiren üretim hazır bir RAG (Retrieval-Augmented Generation) platformudur. Hibrit retrieval, çok modlu belge işleme, akıllı ajanlar ve kurumsal sınıf yönetim özellikleriyle gelişmiş AI uygulamaları oluşturun.

ApeRAG, kendi Bilgi Grafiğinizi oluşturmak, Context Engineering yapmak ve bilgi tabanınız üzerinde bağımsız olarak arama yapabilen ve akıl yürütebilen akıllı AI ajanlarını dağıtmak için en iyi seçimdir.

阅读中文文档

• Hızlı Başlangıç
• Temel Özellikler
• Kubernetes Dağıtımı (Üretim için Önerilir)
• Geliştirme
• Docker İmajı Oluşturma
• Teşekkürler
• Lisans

Hızlı Başlangıç

ApeRAG'ı yüklemeden önce, makinenizin aşağıdaki minimum sistem gereksinimlerini karşıladığından emin olun:

• CPU >= 2 Çekirdek
• RAM >= 4 GiB
• Docker & Docker Compose

ApeRAG'ı başlatmanın en kolay yolu Docker Compose aracılığıyladır. Aşağıdaki komutları çalıştırmadan önce, makinenizde Docker ve Docker Compose kurulu olduğundan emin olun:

git clone https://github.com/apecloud/ApeRAG.git
cd ApeRAG
cp envs/env.template .env
docker-compose up -d --pull always

Çalıştıktan sonra, ApeRAG'a tarayıcınızda erişebilirsiniz:

• Web Arayüzü: http://localhost:3000/web/
• API Belgeleri: http://localhost:8000/docs

MCP (Model Context Protocol) Desteği

ApeRAG, MCP (Model Context Protocol) entegrasyonunu destekler ve AI asistanlarının bilgi tabanınızla doğrudan etkileşim kurmasını sağlar. Hizmetleri başlattıktan sonra, MCP istemcinizi aşağıdakiyle yapılandırın:

{
  "mcpServers": {
    "aperag-mcp": {
      "url": "http://localhost:8000/mcp/",
      "headers": {
        "Authorization": "Bearer your-api-key-here"
      }
    }
  }
}

Kimlik Doğrulama (öncelik sırasına göre):

1. HTTP Yetkilendirme Başlığı (Önerilir): Authorization: Bearer your-api-key
2. Ortam Değişkeni (Yedek): APERAG_API_KEY=your-api-key

Önemli: Lokal değilse dağıtılan API kaynağını kullanın (örn. https://your-host/mcp/). your-api-key-here yerine ApeRAG ayarlarınızdan geçerli bir API anahtarını yazın.

MCP sunucusu şunları sağlar:

• Koleksiyon tarama: Bilgi koleksiyonlarınızı listeleyin ve keşfedin
• Hibrit arama: Vektör, tam metin ve grafik yöntemlerini kullanarak arama yapın
• Akıllı sorgulama: Belgeleriniz hakkında doğal dil soruları sorun

Geliştirilmiş Belge Ayrıştırma

Geliştirilmiş belge ayrıştırma yetenekleri için, ApeRAG karmaşık belgeler, tablolar ve formüller için üstün ayrıştırma sağlayan MinerU tarafından desteklenen bir gelişmiş belge ayrıştırma hizmeti destekler.

# Gelişmiş belge ayrıştırma hizmetini etkinleştir
DOCRAY_HOST=http://aperag-docray:8639 docker compose --profile docray up -d

# GPU hızlandırmasıyla gelişmiş ayrıştırmayı etkinleştir 
DOCRAY_HOST=http://aperag-docray-gpu:8639 docker compose --profile docray-gpu up -d

# Gelişmiş belge ayrıştırma hizmetini etkinleştir
make compose-up WITH_DOCRAY=1

# GPU hızlandırmasıyla gelişmiş ayrıştırmayı etkinleştir (önerilir)
make compose-up WITH_DOCRAY=1 WITH_GPU=1

Geliştirme & Katkı

Kaynak kodu geliştirmesi, gelişmiş konfigürasyonlar veya ApeRAG'a katkı vermekle ilgilenen geliştiriciler için, lütfen ayrıntılı kurulum talimatları için Geliştirme Rehberimize bakınız.

Temel Özellikler

1. Gelişmiş İndeks Türleri: Optimal retrieval için beş kapsamlı indeks türü: Vektör, Tam metin, Grafik, Özet ve Vision - çok boyutlu belge anlayışı ve arama yetenekleri sağlar.

2. Akıllı AI Ajanları: MCP (Model Context Protocol) tool desteğine sahip yerleşik AI ajanları, ilgili koleksiyonları otomatik olarak tanımlayabilir, içeriği akıllıca arayabilir ve kapsamlı soru cevaplama için web arama yetenekleri sağlar.

3. Geliştirilmiş Graph RAG ve Varlık Normalleştirmesi: Daha temiz bilgi grafikleri ve iyileştirilmiş ilişkisel anlayış için gelişmiş varlık normalleştirmesi (varlık birleştirme) ile derin şekilde değiştirilmiş LightRAG uygulaması.

4. Çok Modlu İşleme & Vision Desteği: Görüntüler, grafikler ve görsel içerik analizi için vision yetenekleri de dahil olmak üzere eksiksiz çok modlu belge işleme ve geleneksel metin işleme.

5. Hibrit Retrieval Motoru: Graph RAG, vektör arama, tam metin arama, özet tabanlı retrieval ve vision tabanlı aramayı birleştiren kapsamlı belge anlayışı için karmaşık retrieval sistemi.

6. MinerU Entegrasyonu: MinerU teknolojisi tarafından desteklenen gelişmiş belge ayrıştırma hizmeti, karmaşık belgeler, tablolar, formüller ve bilimsel içerik için isteğe bağlı GPU hızlandırması ile üstün ayrıştırma sağlar.

7. Üretim Sınıfı Dağıtım: Üretim sınıfı veritabanlarının (PostgreSQL, Redis, Qdrant, Elasticsearch, Neo4j) basitleştirilmiş dağıtımı için tam Kubernetes desteği, Helm grafikleri ve KubeBlocks entegrasyonu.

8. Kurumsal Yönetim: Yerleşik denetim günlüğü, LLM model yönetimi, grafik görselleştirmesi, kapsamlı belge yönetimi arayüzü ve ajanlar iş akışı yönetimi.

9. MCP Entegrasyonu: Model Context Protocol (MCP) için tam destek, AI asistanları ve araçlarla sorunsuz entegrasyon, doğrudan bilgi tabanı erişimi ve akıllı sorgulama sağlar.

10. Geliştirici Dostu: FastAPI backend, React frontend, Celery ile async görev işleme, kapsamlı testler, kapsamlı geliştirme kılavuzları ve kolay katkı ve özelleştirme için ajanlar geliştirme framework'ü.

Kubernetes Dağıtımı (Üretim için Önerilir)

Yüksek kullanılabilirlik ve ölçeklenebilirlik ile kurumsal sınıf dağıtım

Sağlanan Helm grafiğini kullanarak ApeRAG'ı Kubernetes'e dağıtın. Bu yaklaşım yüksek kullanılabilirlik, ölçeklenebilirlik ve üretim sınıfı yönetim yetenekleri sunar.

Ön Koşullar

• Kubernetes kümesi (v1.20+)
• Kümenize yapılandırılmış ve bağlı kubectl
• Helm v3+ yüklenmiş

Depoyu Klonlayın

İlk olarak, dağıtım dosyalarını almak için ApeRAG deposunu klonlayın:

git clone https://github.com/apecloud/ApeRAG.git
cd ApeRAG

Adım 1: Veritabanı Hizmetlerini Dağıtın

ApeRAG, PostgreSQL, Redis, Qdrant ve Elasticsearch gerektirir. İki seçeneğiniz vardır:

Seçenek A: Mevcut veritabanlarını kullanın - Kümenizde zaten bu veritabanlar çalışıyorsa, deploy/aperag/values.yaml dosyasını düzenleyerek veritabanı bağlantı ayrıntılarını yapılandırın, ardından Adım 2'ye geçin.

Seçenek B: KubeBlocks ile veritabanlarını dağıtın - Otomatik veritabanı dağıtımını kullanın (veritabanı bağlantıları önceden yapılandırılmış):

# Veritabanı dağıtım betiklerine gidin
cd deploy/databases/

# (İsteğe bağlı) Konfigürasyonu gözden geçirin - varsayılanlar çoğu durum için çalışır
# edit 00-config.sh

# KubeBlocks'ı yükleyin ve veritabanlarını dağıtın
bash ./01-prepare.sh          # KubeBlocks'ı yükler
bash ./02-install-database.sh # PostgreSQL, Redis, Qdrant, Elasticsearch'ü dağıtır

# Veritabanı dağıtımını izleyin
kubectl get pods -n default

# Adım 2 için proje köküne dönün
cd ../../

Devam etmeden önce tüm veritabanı pod'larının Running durumunda olmasını bekleyin.

Adım 2: ApeRAG Uygulamasını Dağıtın

# Adım 1'de KubeBlocks ile veritabanlarını dağıttıysanız, veritabanı bağlantıları önceden yapılandırılmıştır
# Mevcut veritabanları kullanıyorsanız, deploy/aperag/values.yaml dosyasını bağlantı ayrıntılarıyla düzenleyin

# ApeRAG'ı dağıtın
helm install aperag ./deploy/aperag --namespace default --create-namespace

# ApeRAG dağıtımını izleyin
kubectl get pods -n default -l app.kubernetes.io/instance=aperag

Konfigürasyon Seçenekleri

Kaynak Gereksinimleri: Varsayılan olarak, doc-ray hizmeti (4+ CPU çekirdeği, 8GB+ RAM gerekir) içerir. Devre dışı bırakmak için: values.yaml'de docray.enabled: false olarak ayarlayın.

Gelişmiş Ayarlar: İmajlar, kaynaklar ve Ingress ayarları dahil olmak üzere ek konfigürasyon seçenekleri için values.yaml dosyasını gözden geçirin.

Dağıtımınıza Erişin

Dağıtıldıktan sonra, port forwarding kullanarak ApeRAG'a erişin:

# Hızlı erişim için portları ilet
kubectl port-forward svc/aperag-frontend 3000:3000 -n default
kubectl port-forward svc/aperag-api 8000:8000 -n default

# Tarayıcıda erişin
# Web Arayüzü: http://localhost:3000
# API Belgeleri: http://localhost:8000/docs

Üretim ortamları için, dış erişim için values.yaml'de Ingress yapılandırın.

Sorun Giderme

Veritabanı Sorunları: KubeBlocks yönetimi, kimlik bilgileri ve kaldırma yordamları için deploy/databases/README.md dosyasına bakınız.

Pod Durumu: Dağıtım sorunları için pod günlüklerini kontrol edin:

kubectl logs -f deployment/aperag-api -n default
kubectl logs -f deployment/aperag-frontend -n default

Teşekkürler

ApeRAG, birkaç mükemmel açık kaynak projesini entegre eder ve bunları temel alır:

LightRAG

ApeRAG'daki grafik tabanlı bilgi retrieval yetenekleri, LightRAG'ın derin şekilde değiştirilmiş bir sürümü tarafından desteklenir:

• Makale: "LightRAG: Simple and Fast Retrieval-Augmented Generation" (arXiv:2410.05779)
• Yazarlar: Zirui Guo, Lianghao Xia, Yanhua Yu, Tu Ao, Chao Huang
• Lisans: MIT Lisansı

LightRAG'ı üretim sınıfı eşzamanlı işleme, dağıtılmış görev kuyrukları (Celery/Prefect) ve durumsuz işlemleri desteklemek için kapsamlı şekilde değiştirdik. Ayrıntılar için LightRAG değişiklikleri değişim günlüğümüze bakınız.

Topluluk

• Discord
• Feishu

Star Geçmişi

Lisans

ApeRAG, Apache Lisansı 2.0 kapsamında lisanslanmıştır. Ayrıntılar için LICENSE dosyasına bakınız.