[Deployment] Setup fly.io deployment method and update docs (#1028)

Co-authored-by: sidmohanty11 <sidmohanty11@gmail.com>

embedchain/deployment/fly.io/.dockerignore

@@ -0,0 +1 @@
+db/

embedchain/deployment/fly.io/.env.example

@@ -0,0 +1 @@
+OPENAI_API_KEY=sk-xxx

embedchain/deployment/fly.io/Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.11-slim
+
+WORKDIR /app
+
+COPY requirements.txt /app/
+
+RUN pip install -r requirements.txt
+
+COPY . /app
+
+EXPOSE 8080
+
+CMD ["uvicorn", "app:app", "--host", "0.0.0.0", "--port", "8080"]

embedchain/deployment/fly.io/app.py

@@ -0,0 +1,53 @@
+from fastapi import FastAPI, responses
+from pydantic import BaseModel
+
+from embedchain import Pipeline
+
+app = FastAPI(title="Embedchain FastAPI App")
+embedchain_app = Pipeline()
+
+
+class SourceModel(BaseModel):
+    source: str
+
+
+class QuestionModel(BaseModel):
+    question: str
+
+
+@app.post("/add")
+async def add_source(source_model: SourceModel):
+    """
+    Adds a new source to the EmbedChain app.
+    Expects a JSON with a "source" key.
+    """
+    source = source_model.source
+    embedchain_app.add(source)
+    return {"message": f"Source '{source}' added successfully."}
+
+
+@app.post("/query")
+async def handle_query(question_model: QuestionModel):
+    """
+    Handles a query to the EmbedChain app.
+    Expects a JSON with a "question" key.
+    """
+    question = question_model.question
+    answer = embedchain_app.query(question)
+    return {"answer": answer}
+
+
+@app.post("/chat")
+async def handle_chat(question_model: QuestionModel):
+    """
+    Handles a chat request to the EmbedChain app.
+    Expects a JSON with a "question" key.
+    """
+    question = question_model.question
+    response = embedchain_app.chat(question)
+    return {"response": response}
+
+
+@app.get("/")
+async def root():
+    return responses.RedirectResponse(url="/docs")

embedchain/deployment/fly.io/requirements.txt

@@ -0,0 +1,4 @@
+fastapi==0.104.0
+uvicorn==0.23.2
+embedchain==0.1.34
+beautifulsoup4

embedchain/deployment/modal.com/.env.example

@@ -0,0 +1 @@
+OPENAI_API_KEY=

embedchain/deployment/modal.com/.gitignore

@@ -0,0 +1 @@
+.env

embedchain/deployment/modal.com/app.py

@@ -0,0 +1,75 @@
+from dotenv import load_dotenv
+from fastapi import Body, FastAPI, responses
+from modal import Image, Secret, Stub, asgi_app
+
+from embedchain import Pipeline
+
+load_dotenv(".env")
+
+image = Image.debian_slim().pip_install(
+    "embedchain",
+    "embedchain[dataloaders]",
+)
+
+stub = Stub(
+    name="embedchain-app",
+    image=image,
+    secrets=[Secret.from_dotenv(".env")],
+)
+
+web_app = FastAPI()
+embedchain_app = Pipeline(name="embedchain-modal-app")
+
+
+@web_app.post("/add")
+async def add(
+    source: str = Body(..., description="Source to be added"),
+    data_type: str | None = Body(None, description="Type of the data source"),
+):
+    """
+    Adds a new source to the EmbedChain app.
+    Expects a JSON with a "source" and "data_type" key.
+    "data_type" is optional.
+    """
+    if source and data_type:
+        embedchain_app.add(source, data_type)
+    elif source:
+        embedchain_app.add(source)
+    else:
+        return {"message": "No source provided."}
+    return {"message": f"Source '{source}' added successfully."}
+
+
+@web_app.post("/query")
+async def query(question: str = Body(..., description="Question to be answered")):
+    """
+    Handles a query to the EmbedChain app.
+    Expects a JSON with a "question" key.
+    """
+    if not question:
+        return {"message": "No question provided."}
+    answer = embedchain_app.query(question)
+    return {"answer": answer}
+
+
+@web_app.get("/chat")
+async def chat(question: str = Body(..., description="Question to be answered")):
+    """
+    Handles a chat request to the EmbedChain app.
+    Expects a JSON with a "question" key.
+    """
+    if not question:
+        return {"message": "No question provided."}
+    response = embedchain_app.chat(question)
+    return {"response": response}
+
+
+@web_app.get("/")
+async def root():
+    return responses.RedirectResponse(url="/docs")
+
+
+@stub.function(image=image)
+@asgi_app()
+def fastapi_app():
+    return web_app

embedchain/deployment/modal.com/requirements.txt

@@ -0,0 +1,4 @@
+modal==0.56.4329
+fastapi==0.104.0
+uvicorn==0.23.2
+embedchain==0.1.34

embedchain/deployment/render.com/app.py

@@ -0,0 +1,58 @@
+import logging
+import os
+
+from flask import Flask, jsonify, request
+
+from embedchain import Pipeline as App
+
+app = Flask(__name__)
+
+os.environ["OPENAI_API_KEY"] = "sk-xxx"
+
+
+@app.route("/add", methods=["POST"])
+def add():
+    data = request.get_json()
+    data_type = data.get("data_type")
+    url_or_text = data.get("url_or_text")
+    if data_type and url_or_text:
+        try:
+            App().add(url_or_text, data_type=data_type)
+            return jsonify({"data": f"Added {data_type}: {url_or_text}"}), 200
+        except Exception:
+            logging.exception(f"Failed to add {data_type=}: {url_or_text=}")
+            return jsonify({"error": f"Failed to add {data_type}: {url_or_text}"}), 500
+    return jsonify({"error": "Invalid request. Please provide 'data_type' and 'url_or_text' in JSON format."}), 400
+
+
+@app.route("/query", methods=["POST"])
+def query():
+    data = request.get_json()
+    question = data.get("question")
+    if question:
+        try:
+            response = App().query(question)
+            return jsonify({"data": response}), 200
+        except Exception:
+            logging.exception(f"Failed to query {question=}")
+            return jsonify({"error": "An error occurred. Please try again!"}), 500
+    return jsonify({"error": "Invalid request. Please provide 'question' in JSON format."}), 400
+
+
+@app.route("/chat", methods=["POST"])
+def chat():
+    data = request.get_json()
+    question = data.get("question")
+    if question:
+        try:
+            response = App().chat(question)
+            return jsonify({"data": response}), 200
+        except Exception:
+            logging.exception(f"Failed to chat {question=}")
+            return jsonify({"error": "An error occurred. Please try again!"}), 500
+    return jsonify({"error": "Invalid request. Please provide 'question' in JSON format."}), 400
+
+
+@app.route("/api/python")
+def hello_world():
+    return "<p>Hello, World!</p>"

embedchain/deployment/render.com/requirements.txt

@@ -0,0 +1,5 @@
+numpy==1.24.3
+Flask==2.2.2
+Werkzeug==2.2.2
+gunicorn
+embedchain