Added JSDoc documentation for RC app endpoints

Author: preeesha

ai-assistant/src/endpoints/establishRelations.ts

@@ -19,6 +19,15 @@ import {
 } from "./establishRelations.types";
 
 namespace Helpers {
+    /**
+     * Establishes a relation between two nodes in the database.
+     * 
+     * @param {IDB} db - The database instance.
+     * @param {string} sourceID - The ID of the source node.
+     * @param {string} targetID - The ID of the target node.
+     * @param {string} relation - The type of relation to establish between the nodes.
+     * @returns {Promise<void>} - A promise that resolves when the relation is successfully established.
+     */
     async function establishRelation(
         db: IDB,
         sourceID: string,
@@ -37,6 +46,13 @@ namespace Helpers {
         }
     }
 
+    /**
+     * Establishes relations between entities in the database.
+     * 
+     * @param {IDB} db - The database instance.
+     * @param {EstablishRelationsEndpointRelations[]} relations - An array of objects representing the relations to be established.
+     * @returns {Promise<void>} - A promise that resolves when all relations have been established.
+     */
     export async function establishRelations(
         db: IDB,
         relations: EstablishRelationsEndpointRelations[]
@@ -58,6 +74,12 @@ namespace Helpers {
 export class EstablishRelationsEndpoint extends ApiEndpoint {
     public path = "establishRelations";
 
+    /**
+     * Generates the request and response bodies for the EstablishRelationsEndpoint.
+     *
+     * @param content - The content to be used for generating the request and response bodies.
+     * @returns An array containing the generated request body and response body.
+     */
     makeBodies(
         content: any
     ): [
@@ -72,6 +94,14 @@ export class EstablishRelationsEndpoint extends ApiEndpoint {
         return [requestBody, responseBody];
     }
 
+    /**
+     * Commits the progress of the database transaction.
+     * 
+     * @param {IDB} db - The database instance.
+     * @returns {Promise<number>} - A promise that resolves to the status code indicating the success or failure of the commit operation.
+     *                            - Returns 200 if the commit is successful.
+     *                            - Returns 500 if an error occurs during the commit or rollback operation.
+     */
     async commitProgress(
         db: IDB
     ): Promise<EstablishRelationsEndpointResponseBody["status"]> {

ai-assistant/src/endpoints/ingest.ts

@@ -20,11 +20,25 @@ import {
 } from "./ingest.types";
 
 namespace Helpers {
+    /**
+     * Inserts a node into the database.
+     * 
+     * @param {IDB} db - The database instance.
+     * @param {DBNode} node - The node to be inserted.
+     * @returns {Promise<void>} - A promise that resolves when the node is successfully inserted.
+     */
     async function insertNode(db: IDB, node: DBNode) {
         const query = new DBNode(node).getDBInsertQuery();
         await db.run(query, node);
     }
 
+    /**
+     * Inserts an array of nodes into the database.
+     * 
+     * @param {IDB} db - The database object.
+     * @param {DBNode[]} nodes - The array of nodes to be inserted.
+     * @returns {Promise<void>} - A promise that resolves when all nodes have been inserted.
+     */
     export async function insertNodes(db: IDB, nodes: DBNode[]) {
         await Promise.all(nodes.map((node) => insertNode(db, node)));
     }
@@ -33,6 +47,12 @@ namespace Helpers {
 export class IngestEndpoint extends ApiEndpoint {
     public path = "ingest";
 
+    /**
+     * Generates the request and response bodies for the IngestEndpoint.
+     * 
+     * @param content - The content to be used for generating the request body.
+     * @returns An array containing the generated request body and response body.
+     */
     makeBodies(
         content: any
     ): [IngestEndpointRequestBody, IngestEndpointResponseBody] {

ai-assistant/src/endpoints/llm.ts

@@ -16,11 +16,23 @@ import { Neo4j } from "../core/services/db/neo4j";
 export class PurgeDBEndpoint extends ApiEndpoint {
     public path = "purgeDB";
 
+    /**
+     * Empties the specified database by deleting all nodes and relationships.
+     *
+     * @param {IDB} db - The database to be emptied.
+     * @returns {Promise<void>} - A promise that resolves when the database has been emptied.
+     */
     async emptyDB(db: IDB) {
         const query = `MATCH (n) DETACH DELETE n`;
         await db.run(query);
     }
 
+    /**
+     * Sets up the indices for name embeddings and code embeddings in the specified database.
+     *
+     * @param {IDB} db - The database object.
+     * @returns {Promise<void>} - A promise that resolves when the indices are set up.
+     */
     async setupIndices(db: IDB) {
         const query = [
             // Create indices for name embeddings