Skip to content

Commit a6c4e60

Browse files
committed
update readme
1 parent 9b2f376 commit a6c4e60

File tree

2 files changed

+5
-12
lines changed

2 files changed

+5
-12
lines changed
Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Agent Query Engine - Agent Guidelines
1+
# Document Query Engine - Agent Guidelines
22

33
## Project Overview
44

@@ -23,7 +23,7 @@ FastAPI backend service that exposes a LlamaIndex Knowledge Graph query engine o
2323
```
2424
app/
2525
├── api/v1/ # API route handlers
26-
├── connectors/ # Document source connectors (filesystem, GCS)
26+
├── connectors/ # Document source connectors (GCS)
2727
├── core/ # Config (Pydantic Settings), logging, errors, middleware
2828
├── models/ # Pydantic request/response schemas (CamelModel base)
2929
├── services/ # Business logic (KnowledgeGraphService, IngestionPipeline)
@@ -33,6 +33,8 @@ tests/ # Pytest test suite
3333

3434
## Commands
3535

36+
All commands run from `services/query-engine/`.
37+
3638
```bash
3739
# Install dependencies
3840
poetry install
@@ -74,12 +76,3 @@ poetry run celery -A app.worker.celery_app:celery_app worker --loglevel=info
7476
- Use `pytest-asyncio` with mode `auto`
7577
- Use `httpx.AsyncClient` with `ASGITransport` for endpoint tests
7678
- Fixtures defined in `tests/conftest.py`
77-
78-
## Docker
79-
80-
```bash
81-
docker build -t agent-query-engine .
82-
docker run -p 8000:8000 agent-query-engine
83-
```
84-
85-
Multi-stage Dockerfile: base → builder (Poetry install) → runtime (minimal image).

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![API Build](https://github.com/Yukigeshiki/document-query-engine-python/actions/workflows/api-build.yml/badge.svg)](https://github.com/Yukigeshiki/document-query-engine-python/actions/workflows/api-build.yml)
55
[![UI Build](https://github.com/Yukigeshiki/document-query-engine-python/actions/workflows/ui-build.yml/badge.svg)](https://github.com/Yukigeshiki/document-query-engine-python/actions/workflows/ui-build.yml)
66

7-
A document ingestion and query engine built with Python/FastAPI, LlamaIndex, Neo4j, and pgvector. Upload documents (PDF, DOCX, TXT), extract knowledge graph triplets and vector embeddings, then query across both using natural language. LlamaIndex orchestrates the full pipeline - chunking documents, extracting entity-relationship triplets via OpenAI into Neo4j, embedding chunks into pgvector, and synthesizing answers from dual retrieval (graph traversal + vector similarity). Documents are stored in GCS and processed asynchronously via Celery. The UI provides testing for document upload with interactive graph visualization, a query interface with retrieval mode selection, and document deletion.
7+
A hybrid RAG (retrieval-augmented generation) system built with Python/FastAPI, LlamaIndex, Neo4j, and pgvector. Upload documents (PDF, DOCX, TXT), extract knowledge graph triplets and vector embeddings, then query across both using natural language. LlamaIndex orchestrates the full pipeline - chunking documents, extracting entity-relationship triplets via OpenAI into Neo4j, embedding chunks into pgvector, and synthesizing answers from dual retrieval (graph traversal + vector similarity). Documents are stored in GCS and processed asynchronously via Celery. The UI provides testing for document upload with interactive graph visualization, a query interface with retrieval mode selection, and document deletion.
88

99
## How It Works
1010

0 commit comments

Comments
 (0)