Backend Proxy For Suggested Question

.gitignore

@@ -35,3 +35,7 @@ temp_test_run_data.json
 
 # backend
 faiss_db
+
+# frontend
+node_modules
+.next

.pre-commit-config.yaml

@@ -10,7 +10,3 @@ repos:
     -   id: check-executables-have-shebangs
     -   id: check-shebang-scripts-are-executable
     -   id: detect-private-key
-    -   id: check-added-large-files
-        args:
-        - --maxkb=120
-        - --enforce-all

backend/requirements.txt

@@ -20,3 +20,4 @@ pypdf==5.6.0
 unstructured==0.15.1
 nltk==3.9.1
 huggingface_hub[cli]==0.24.6
+openai==1.93.0

backend/src/api/main.py

@@ -1,7 +1,23 @@
 from fastapi import FastAPI
-from .routers import graphs, healthcheck
+from .routers import graphs, healthcheck, helpers, ui
+from fastapi.middleware.cors import CORSMiddleware
 
 app = FastAPI()
 
+# Add CORS middleware
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=[
+        "http://localhost:3000",
+        "http://127.0.0.1:3000",
+        "http://localhost:8001",  # mock endpoint
+        "http://127.0.0.1:8001",
+    ],
+    allow_credentials=True,
+    allow_methods=["GET", "POST", "PUT", "DELETE", "OPTIONS"],
+    allow_headers=["*"],
+)
 app.include_router(healthcheck.router)
 app.include_router(graphs.router)
+app.include_router(helpers.router)
+app.include_router(ui.router)

backend/src/api/models/response_model.py

@@ -13,6 +13,15 @@ class ContextSource(BaseModel):
     context: str = ""
 
 
+class SuggestedQuestions(BaseModel):
+    suggested_questions: list[str]
+
+
+class SuggestedQuestionInput(BaseModel):
+    latest_question: str
+    assistant_answer: str
+
+
 class ChatResponse(BaseModel):
     response: str
     context_sources: list[ContextSource] = []

backend/src/api/routers/graphs.py

@@ -52,6 +52,10 @@
     embeddings_model_name = str(os.getenv("HF_EMBEDDINGS"))
 elif embeddings_type == "GOOGLE_GENAI" or embeddings_type == "GOOGLE_VERTEXAI":
     embeddings_model_name = str(os.getenv("GOOGLE_EMBEDDINGS"))
+else:
+    raise ValueError(
+        "EMBEDDINGS_TYPE environment variable must be set to 'HF', 'GOOGLE_GENAI', or 'GOOGLE_VERTEXAI'."
+    )
 
 embeddings_config = {"type": embeddings_type, "name": embeddings_model_name}
 

backend/src/api/routers/helpers.py

@@ -0,0 +1,52 @@
+import os
+from fastapi import APIRouter, HTTPException
+from dotenv import load_dotenv
+from ..models.response_model import SuggestedQuestionInput, SuggestedQuestions
+from ...prompts.prompt_templates import suggested_questions_prompt_template
+from openai import OpenAI
+
+load_dotenv()
+
+GOOGLE_API_KEY = os.getenv("GOOGLE_API_KEY")
+if not GOOGLE_API_KEY:
+    raise RuntimeError("GOOGLE_API_KEY is not set")
+
+model = "gemini-2.0-flash"
+client = OpenAI(
+    base_url="https://generativelanguage.googleapis.com/v1beta/openai/",
+    api_key=GOOGLE_API_KEY,
+)
+
+router = APIRouter(prefix="/helpers", tags=["helpers"])
+
+
+# Main Router
+@router.post("/suggestedQuestions")
+async def get_suggested_questions(
+    suggested_question_input: SuggestedQuestionInput,
+) -> SuggestedQuestions:
+    full_prompt = suggested_questions_prompt_template.format(
+        latest_question=suggested_question_input.latest_question,
+        assistant_answer=suggested_question_input.assistant_answer,
+    )
+
+    try:
+        response = client.beta.chat.completions.parse(
+            model=model,
+            messages=[
+                {"role": "system", "content": "You are a helpful assistant."},
+                {"role": "user", "content": full_prompt},
+            ],
+            response_format=SuggestedQuestions,
+        )
+        response_data = response.choices[0].message.parsed
+        if not response_data or not SuggestedQuestions.model_validate(response_data):
+            raise ValueError(
+                f"Invalid response format from the model, got {response_data}"
+            )
+        return SuggestedQuestions.model_validate(response_data)
+
+    except Exception as e:
+        raise HTTPException(
+            status_code=500, detail="Failed to get suggested questions: " + str(e)
+        )

backend/src/api/routers/ui.py

@@ -0,0 +1,36 @@
+from fastapi import APIRouter, Request, Response
+import httpx
+import os
+
+router = APIRouter(prefix="/ui", tags=["ui"])
+
+BACKEND_ENDPOINT = os.getenv("BACKEND_ENDPOINT", "http://localhost:8000")
+client = httpx.AsyncClient(base_url=BACKEND_ENDPOINT)
+
+
+@router.post("/chat")
+async def proxy_chat(request: Request) -> Response:
+    data = await request.json()
+    # TODO: set this route dynamically
+    resp = await client.post("/graphs/agent-retriever", json=data)
+    return Response(
+        content=resp.content,
+        status_code=resp.status_code,
+        media_type=resp.headers.get("content-type"),
+    )
+
+
+@router.post("/suggestedQuestions")
+async def suggested_questions(request: Request) -> Response:
+    data = await request.json()
+    # Transform camelCase to snake_case for the backend
+    transformed_data = {
+        "latest_question": data.get("latestQuestion", ""),
+        "assistant_answer": data.get("assistantAnswer", ""),
+    }
+    resp = await client.post("/helpers/suggestedQuestions", json=transformed_data)
+    return Response(
+        content=resp.content,
+        status_code=resp.status_code,
+        media_type=resp.headers.get("content-type"),
+    )

backend/src/prompts/prompt_templates.py

@@ -1,22 +1,22 @@
 summarise_prompt_template = """
-You are an expert programmer and problem-solver, tasked with answering any question about the OpenROAD (OR) project \
+You are an expert programmer and problem-solver, tasked with answering any question about the OpenROAD (OR) project
 and the OpenROAD-Flow-Scripts (ORFS).
 
-Generate a comprehensive and informative answer for the given question based solely on the provided context.\
-Use an unbiased and journalistic tone. \
-You may use bullet points to explain the answer in a step-by-step, detailed manner.\
+Generate a comprehensive and informative answer for the given question based solely on the provided context.
+Use an unbiased and journalistic tone.
+You may use bullet points to explain the answer in a step-by-step, detailed manner.
 You may provide code snippets and terminal commands as part of the answer.
 
-The user does not have access to the context.\
-You must not ask the user to refer to the context in any part of your answer.\
+The user does not have access to the context.
+You must not ask the user to refer to the context in any part of your answer.
 You must not ask the user to refer to a link that is not a part of your answer.
 
-If there is nothing in the context relevant to the question, simply say "Sorry its not avaiable in my knowledge base." \
-Do not try to make up an answer.\
+If there is nothing in the context relevant to the question, simply say "Sorry its not avaiable in my knowledge base."
+Do not try to make up an answer.
 Anything between the following `context`  html blocks is retrieved from a knowledge bank, not part of the conversation with the user.
 
-For casual greetings respond politely with a simple, relevant answer.\
-Introduce yourself when asked.\
+For casual greetings respond politely with a simple, relevant answer.
+Introduce yourself when asked.
 
 ------------------------------------------------------------------------------------
 Use the following context:
@@ -33,15 +33,16 @@
 """
 
 gh_discussion_prompt_template = """
-The following is a GitHub Discussions conversation between two programmers discussing the OpenROAD (OR) project\
-and the OpenROAD-Flow-Scripts (ORFS).\
+The following is a GitHub Discussions conversation between two programmers discussing the OpenROAD (OR) project
+and the OpenROAD-Flow-Scripts (ORFS).
 
 You may infer information from the conversation to answer the question.
 
 """
 
-tool_rephrase_prompt_template = """You are an assistant tasked with answering any question about the OpenROAD (OR) project \
-and the OpenROAD-Flow-Scripts (ORFS). You have access to the following set of tools.\
+tool_rephrase_prompt_template = """
+You are an assistant tasked with answering any question about the OpenROAD (OR) project
+and the OpenROAD-Flow-Scripts (ORFS). You have access to the following set of tools.
 
 Here are the names and descriptions for each tool:
 
@@ -53,29 +54,76 @@
 This is the user's follow-up question:
 {question}
 
-Given the chat history, rephrase the follow-up question to be a standalone question.\
-The rephrased question should include only relevant information inferred from the chat history.\
-If the question is already standalone, return the same question.\
-Return your response as a json blob with 'rephrased_question'.\
+Given the chat history, rephrase the follow-up question to be a standalone question.
+The rephrased question should include only relevant information inferred from the chat history.
+If the question is already standalone, return the same question.
+Return your response as a json blob with 'rephrased_question'.
 
-Choose the most appropriate tools from the list of tools to answer the rephrased question.\
-Use the tool descriptions to pick the appropriate tools.\
-Return your response as a JSON blob with 'tool_names'.\
+Choose the most appropriate tools from the list of tools to answer the rephrased question.
+Use the tool descriptions to pick the appropriate tools.
+Return your response as a JSON blob with 'tool_names'.
 
 """
 
 rephrase_prompt_template = """
-
-This is the chat history between you and the user:\
+This is the chat history between you and the user:
 {chat_history}
 
-This is the user's follow-up question:\
+This is the user's follow-up question:
 {question}
 
-Given the chat history, rephrase the follow-up question to be a standalone question.\
-The rephrased question should include only relevant information inferred from the chat history.\
-If the question is already standalone, return the same question.\
-Choose the most appropriate tools from the list of tools to answer the rephrased question.\
-Return your response as a json blob with 'rephrased_question'.\
+Given the chat history, rephrase the follow-up question to be a standalone question.
+The rephrased question should include only relevant information inferred from the chat history.
+If the question is already standalone, return the same question.
+Choose the most appropriate tools from the list of tools to answer the rephrased question.
+Return your response as a json blob with 'rephrased_question'.
+
+"""
+
+suggested_questions_prompt_template = """
+If the assistant answer has sufficient knowledge, use it to predict the next 3 suggested questions.
+Otherwise, strictly restrict to these topics. Make sure it is in the form of a question.
+  Getting Started with OpenROAD
+  Building OpenROAD
+  Getting Started with the OpenROAD Flow - OpenROAD-flow-scripts
+  Tutorials
+  Git Quickstart
+  Man pages
+  OpenROAD User Guide
+  Database
+  GUI
+  Partition Management
+  Restructure
+  Floorplan Initialization
+  Pin Placement
+  Chip-level Connections
+  Macro Placement
+  Hierarchical Macro Placement
+  Tapcell Insertion
+  PDN Generation
+  Global Placement
+  Gate Resizing
+  Detailed Placement
+  Clock Tree Synthesis
+  Global Routing
+  Antenna Checker
+  Detailed Routing
+  Metal Fill
+  Parasitics Extraction
+  Messages Glossary
+  Getting Involved
+  Developer's Guide
+  Coding Practices
+  Logger
+  CI
+  README Format
+  Tcl Format
+  Man pages Test Framework
+  Code of Conduct
+  FAQs
+
+User Question: {latest_question}
+
+Assistant Answer: {assistant_answer}
 
 """