Skip to main content

Communication: helvia-rag-pipelines

1-hop view of how this service communicates with its siblings. For the full system view, see service-communication.md.

Calls Out To

ServiceProtocolPurposeKey calls / queues
MilvusTCP (pymilvus SDK)Primary vector DBCollection CRUD, vector insert/search
QdrantHTTP/gRPC (qdrant-client SDK)Secondary vector DBCollection CRUD, vector insert/search
OpenAIHTTP (openai SDK)Embeddings, chat completionsEmbeddings API, Chat Completions API
Azure OpenAIHTTP (custom client)Embeddings, chat completionsCustom HTTP calls
Google GeminiHTTP (google-generativeai SDK)Embeddings, chat completionsSDK method calls
Google Cloud TranslateHTTP (SDK)TranslationTranslation API
Azure TranslatorHTTPTranslationTranslator API
Helvia SemCacheHTTP (custom client)Semantic caching (optional)Custom HTTP calls
MySQLTCP (SQLAlchemy)Corpus, pipeline config, NLP providersORM queries
RedisTCPOptional embedding cacheKey-value cache

Called By

ServiceProtocolHow
hbf-nlpHTTP POST/pipelines/{id}:process, :search, /corpus (PUT), :train
hbf-botHTTP POST/pipelines/{id}:search

Contracts

Inbound

  • POST /pipelines/{id}:process -- process query through RAG pipeline
  • POST /pipelines/{id}:search -- semantic search against indexed corpus
  • PUT /pipelines/{id}/corpus -- full corpus update
  • POST /pipelines/{id}:train -- trigger training (embedding + indexing)
  • POST /pipelines/{id}:index -- trigger indexing only
  • CRUD on /pipelines -- pipeline configuration management
  • /admin/* -- administrative endpoints

Outbound

  • Vector DBs: Milvus or Qdrant depending on VECTOR_DB config. Insert, search, delete operations.
  • LLM providers: OpenAI, Azure OpenAI, or Google Gemini per pipeline configuration for embeddings and completions.
  • Translation: Google Cloud Translate or Azure Translator per configuration.
  • SemCache: Optional semantic caching layer for repeated queries.

Environment Variables

VariableTarget
VECTOR_DBVector DB selection (milvus or qdrant)
MILVUS_*Milvus connection
QDRANT_*Qdrant connection
MYSQL_URLMySQL
OPENAI_API_KEYOpenAI
AZURE_OPENAI_*Azure OpenAI
GOOGLE_APPLICATION_CREDENTIALSGoogle Cloud (Gemini, Translate)

Flows Involving This Service