Quick Reference
Base Configuration
Most Common Operations
Complete Working Workflow
Available RAG Models
Use with OpenAI-compatible endpoint:Model | Purpose | Example |
---|---|---|
vedaya-naive | Basic keyword search | model="vedaya-naive" |
vedaya-local | Entity-focused | model="vedaya-local" |
vedaya-global | Relationships | model="vedaya-global" |
vedaya-hybrid | Combined (default) | model="vedaya-hybrid" |
Quick Functions
Query with Fallback
Endpoint Reference
Document Management
POST /documents/texts
- Upload text documents (recommended)POST /documents/upload
- Upload files to input directoryPOST /documents/file
- Direct file processingPOST /documents/file_batch
- Batch file uploadGET /documents
- List all documentsDELETE /documents
- Clear all documentsGET /documents/pipeline_status
- Check processing statusPOST /documents/scan
- Scan input directoryPOST /documents/clear_cache
- Clear cache
Query/RAG
POST /v1/chat/completions
- OpenAI-compatible chat (primary)POST /query
- Native query endpoint (alternative)POST /query/stream
- Streaming (Note: returns 404 currently)
Knowledge Graph
GET /graph/label/list
- List entitiesGET /graphs
- Get subgraphGET /graph/entity/exists
- Check if entity existsPOST /graph/entity/edit
- Update entityPOST /graph/relation/edit
- Update relation
Compatibility
POST /v1/chat/completions
- OpenAI chat completionsPOST /v1/embeddings
- Generate embeddingsGET /v1/models
- List available models
System
GET /health
- Health checkPOST /login
- Authentication (optional - API works without it)
Important Notes
✅ What Works- Authentication optional (dummy keys work)
- Text upload via
/documents/texts
- OpenAI SDK with
base_url="/v1"
- Special
vedaya-*
models for RAG - Fast processing (seconds not minutes)
- Multi-turn conversations
- Streaming responses (returns 404)
- OAuth2 flow (use dummy keys instead)
/openai/v1
endpoint (use/v1
)