From eb95526dcd429f2ac59e272949d07b3660cf502b Mon Sep 17 00:00:00 2001 From: Sanjay Nadhavajhala Date: Mon, 12 Feb 2024 01:26:40 -0800 Subject: [PATCH] delete READMEs --- services/backend/text_embedding_api/README.md | 24 ------------------- services/backend/vector_db_api/README.md | 11 --------- 2 files changed, 35 deletions(-) delete mode 100644 services/backend/text_embedding_api/README.md delete mode 100644 services/backend/vector_db_api/README.md diff --git a/services/backend/text_embedding_api/README.md b/services/backend/text_embedding_api/README.md deleted file mode 100644 index fcc6c19..0000000 --- a/services/backend/text_embedding_api/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# Text Embedding API - -This project provides a FastAPI server for generating text embeddings using a pre-trained model. - -## Getting Started - -To build and run the Docker container: - -```bash -docker build -t text-embedding-api . -docker run -p 8020:8020 text-embedding-api -``` - -The API server will be available at `http://localhost:8020`. - -## Endpoints - -- `GET /ping`: Health check endpoint. -- `POST /embed_multiple`: Accepts a list of texts and returns their embeddings. - -## Environment Variables - -- `MODEL_NAME`: Set the environment variable to change the Sentence Transformer model - - default is [`sentence-transformers/all-MiniLM-L6-v2`](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) \ No newline at end of file diff --git a/services/backend/vector_db_api/README.md b/services/backend/vector_db_api/README.md deleted file mode 100644 index f50676a..0000000 --- a/services/backend/vector_db_api/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Vector Search Service - -This service provides a FastAPI application that interfaces with a vector database for text embedding and similarity search operations. It is designed to be flexible and allows for the potential integration of various vector databases in the future. - -The service provides the following endpoints: - -- `POST /add_texts`: Add texts to a specified Milvus collection -- `DELETE /delete_docs`: Delete documents from a specified Milvus collection based on an expression -- `POST /similarity_match`: Perform a similarity search and return the top-k similar documents -- `GET /ping`: Health check endpoint -