Merge pull request #9 from preeesha/fix--devdocs-command

Addition of `/rcc-devdocs` Command and Documentation Ingestion

Author: CulturalProfessor

ai-assistant/src/commands/AskDocsCommand.ts

@@ -8,6 +8,8 @@ import {
     SlashCommandContext,
 } from "@rocket.chat/apps-engine/definition/slashcommands";
 
+import { PromptFactory } from "../core/prompt.factory";
+import { Query } from "../core/query";
 import { Neo4j } from "../core/services/db/neo4j";
 import { MiniLML6 } from "../core/services/embeddings/minilml6";
 import { Llama3_70B } from "../core/services/llm/llama3_70B";
@@ -19,12 +21,48 @@ export class AskDocsCommand implements ISlashCommand {
     public i18nDescription = "";
     public providesPreview = false;
 
+    /**
+     * Processes the user's query and returns the answer.
+     *
+     * @param {IHttp} http - The HTTP object used for making requests.
+     * @param {string} query - The user's query.
+     * @returns {Promise<string | null>} A promise that resolves to the response to be given to the user or `null` if no answer or no reference is found.
+     */
     private async process(http: IHttp, query: string): Promise<string | null> {
         const db = new Neo4j(http);
         const llm = new Llama3_70B(http);
         const embeddingModel = new MiniLML6(http);
 
-        return "UNDER DEVELOPMENT";
+        /**
+         * ---------------------------------------------------------------------------------------------
+         * STEP 1:
+         * Query the database to find the nodes names of which are similar to what user has requested
+         * ---------------------------------------------------------------------------------------------
+         */
+        const results = await Query.getDocsNodesFromQuery(
+            db,
+            embeddingModel,
+            query
+        );
+        if (!results.length) return null;
+
+        /**
+         * ---------------------------------------------------------------------------------------------
+         * STEP 2:
+         * Generate the answer and diagram for the user's query given the nodes data
+         * ---------------------------------------------------------------------------------------------
+         */
+        const uniqueSources = [...new Set<string>(results.map((x) => x.url))];
+        const answer = await llm.ask(
+            PromptFactory.makeAskDocsPrompt(
+                results.map((x) => x.content).join("\n\n"),
+                uniqueSources,
+                query
+            )
+        );
+        if (!answer) return null;
+
+        return answer;
     }
 
     public async executor(

ai-assistant/src/commands/FindSimilar.modal.ts

@@ -11,7 +11,7 @@ import {
 } from "@rocket.chat/apps-engine/definition/uikit";
 import { IUser } from "@rocket.chat/apps-engine/definition/users";
 import { Query } from "../core/query";
-import { DBNode } from "../core/services/db/db";
+import { DBNode } from "../core/services/db/dbNode";
 import { Neo4j } from "../core/services/db/neo4j";
 import { MiniLML6 } from "../core/services/embeddings/minilml6";
 import { getButton, getInputBox } from "../utils/blockBuilders";

ai-assistant/src/commands/ImportanceCommand.ts

@@ -8,8 +8,8 @@ import {
     SlashCommandContext,
 } from "@rocket.chat/apps-engine/definition/slashcommands";
 import { Query } from "../core/query";
-import { DBNode } from "../core/services/db/db";
 import { IDB } from "../core/services/db/db.types";
+import { DBNode } from "../core/services/db/dbNode";
 import { Neo4j } from "../core/services/db/neo4j";
 import { MiniLML6 } from "../core/services/embeddings/minilml6";
 import { handleCommandResponse } from "../utils/handleCommandResponse";

ai-assistant/src/commands/WhyUsedCommand.ts

@@ -46,7 +46,6 @@ export class WhyUsedCommand implements ISlashCommand {
          * ---------------------------------------------------------------------------------------------
          */
         const keywords = await Query.getDBKeywordsFromQuery(llm, query);
-        console.log(keywords);
         if (!keywords.length) return null;
 
         /**

ai-assistant/src/core/prompt.factory.ts

@@ -61,6 +61,42 @@ export namespace PromptFactory {
         return prompt;
     }
 
+    export function makeAskDocsPrompt(
+        content: string,
+        sourceURLs: string[],
+        query: string
+    ): Prompt {
+        const prompt = new Prompt();
+        prompt.pushSystem(`
+            You are an expert in understanding the documentation of Rocket.Chat and answering questions of user when given a proper context.
+
+            Here're the sources of the content:
+            ${sourceURLs.map((url) => `- ${url}`).join("\n")}
+
+            Here're the rules:
+            1. Even if user asks for any kind of diagram or visualization, you must ignore that.
+            2. If the user asks for an explanation of the content, you must provide the answer based on the content.
+            3. You must provide the answer in text GitHub Markdown format only.
+            4. In case of any request for diagrams or visualizations, tell user to use the "/rcc-diagram" command.
+            5. If you are unable to answer the question, you must tell the user that you are unable to answer the question.
+            6. Always and always mentions the sources of the content in the end. You must provide all these URLs.
+        `);
+        prompt.pushUser(`
+            Hey I have been the reading the following documentation content and I am not able to understand it quite well. I'll provide you the content in between the tags <CONTENT_START> and <CONTENT_END> and the query between <QUERY_START> and <QUERY_END>. Can you please help me understand it better?
+
+            <QUERY_START>
+            ${query}
+            <QUERY_END>
+
+            Here's the content:
+            <CONTENT_START>
+            ${content}
+            <CONTENT_END>
+        `);
+
+        return prompt;
+    }
+
     export function makeDiagramPrompt(codebase: string, query: string): Prompt {
         const prompt = new Prompt();
 

ai-assistant/src/core/query.ts

@@ -1,6 +1,7 @@
 import { PromptFactory } from "./prompt.factory";
-import { DBNode } from "./services/db/db";
 import { IDB } from "./services/db/db.types";
+import { DBNode } from "./services/db/dbNode";
+import { DevDocDBNode } from "./services/db/devDocDBNode";
 import { IEmbeddingModel } from "./services/embeddings/embeddings.types";
 import { ILLMModel } from "./services/llm/llm.types";
 
@@ -10,7 +11,7 @@ import { ILLMModel } from "./services/llm/llm.types";
 export namespace Query {
     /**
      * Retrieves database nodes based on a vector query.
-     * 
+     *
      * @param {IDB} db - The database instance.
      * @param {string} indexName - The name of the index to query.
      * @param {number[]} vector - The vector to query with.
@@ -54,7 +55,7 @@ export namespace Query {
 
     /**
      * Retrieves code nodes from the database based on a list of keywords.
-     * 
+     *
      * @param {IDB} db - The database object.
      * @param {IEmbeddingModel} embeddingModel - The embedding model used for generating query vectors.
      * @param {string[]} keywords - The list of keywords to search for.
@@ -82,9 +83,78 @@ export namespace Query {
         return results;
     }
 
+    /**
+     * Retrieves an array of DevDocDBNodes from the specified vector query.
+     *
+     * @param {IDB} db - The IDB instance used for the query.
+     * @param {string} indexName - The name of the index to query.
+     * @param {number[]} vector - The vector used for the query.
+     * @param {number} threshold - The minimum score threshold for the query results.
+     * @returns {Promise<DevDocDBNode[]>} - A promise that resolves to an array of DevDocDBNodes that match the query criteria.
+     */
+    export async function getDevDocDBNodesFromVectorQuery(
+        db: IDB,
+        indexName: string,
+        vector: number[],
+        threshold: number
+    ): Promise<DevDocDBNode[]> {
+        const result = await db.run(
+            `
+				CALL db.index.vector.queryNodes("${indexName}", 2, $vector)
+				YIELD node, score
+                WHERE score >= ${threshold}
+                WITH node, score
+                OPTIONAL MATCH (node)-[r]->(relatedNode)
+                RETURN node, COLLECT(relatedNode) AS relatedNodes, score
+                ORDER BY score DESC
+			`,
+            { vector }
+        );
+        if (!result.length) return [];
+
+        const nodes: DevDocDBNode[] = [];
+        const processRecord = (record: any) => {
+            const data = record as DevDocDBNode;
+            data.contentEmbeddings = [];
+            nodes.push(data);
+        };
+        // node
+        processRecord(result[0]);
+        // relatedNodes
+        for (const record of (result as any)[1]) processRecord(record);
+
+        return nodes;
+    }
+
+    /**
+     * Retrieves an array of DevDocDBNodes from the provided query.
+     *
+     * @param {IDB} db - The IDB instance used for querying the database.
+     * @param {IEmbeddingModel} embeddingModel - The embedding model used for generating query vectors.
+     * @param {string} query - The query string used for searching the database.
+     * @returns {Promise<DevDocDBNode[]>} - A promise that resolves to an array of DevDocDBNodes matching the query.
+     */
+    export async function getDocsNodesFromQuery(
+        db: IDB,
+        embeddingModel: IEmbeddingModel,
+        query: string
+    ): Promise<DevDocDBNode[]> {
+        const queryVector = await embeddingModel.generate(query);
+        if (!queryVector) return [];
+
+        const results: DevDocDBNode[] = await getDevDocDBNodesFromVectorQuery(
+            db,
+            "contentEmbeddings",
+            queryVector,
+            0.7
+        );
+
+        return results;
+    }
+
     /**
      * Retrieves database keywords from a given query using a language model.
-     * 
+     *
      * @param llm - The language model used to generate the keywords.
      * @param query - The query string to extract keywords from.
      * @returns A promise that resolves to an array of database keywords extracted from the query.

ai-assistant/src/core/services/db/db.ts …assistant/src/core/services/db/dbNode.tsai-assistant/src/core/services/db/db.ts renamed to ai-assistant/src/core/services/db/dbNode.ts ai-assistant/src/core/services/db/db.ts renamed to ai-assistant/src/core/services/db/dbNode.ts

@@ -0,0 +1,71 @@
+import { IEmbeddingModel } from "../embeddings/embeddings.types";
+
+export type DevDocDBNodeRelationType = "CONTAINS";
+export type DevDocDBNodeRelation = {
+    target: string;
+    relation: DevDocDBNodeRelationType;
+};
+
+export class DevDocDBNode {
+    id: string;
+    relations: DevDocDBNodeRelation[];
+
+    url: string;
+    element: string;
+
+    content: string;
+    contentEmbeddings: number[];
+
+    constructor(node: {
+        id: string;
+        relations: DevDocDBNodeRelation[];
+
+        url: string;
+        element: string;
+
+        content: string;
+        contentEmbeddings: number[];
+    }) {
+        this.id = node.id;
+        this.relations = node.relations;
+
+        this.url = node.url;
+        this.element = node.element;
+
+        this.content = node.content;
+        this.contentEmbeddings = node.contentEmbeddings;
+    }
+
+    /**
+     * Fills the embeddings for the given embedding model.
+     *
+     * @param {IEmbeddingModel} embeddingModel - The embedding model used to generate embeddings.
+     * @returns {Promise<void>} - A promise that resolves when the embeddings are filled.
+     */
+    async fillEmbeddings(embeddingModel: IEmbeddingModel): Promise<void> {
+        this.contentEmbeddings =
+            (await embeddingModel.generate(this.content)) ?? [];
+    }
+
+    /**
+     * Generates a database insert query for creating a new node with the specified properties.
+     *
+     * @returns The database insert query as a string.
+     */
+    getDBInsertQuery(): string {
+        let query = "";
+        query += `
+            CREATE (n:DevDocDBNode {
+                id: $id,
+
+                url: $url,
+                element: $element,
+
+                content: $content,
+                contentEmbeddings: $contentEmbeddings
+            })
+        `;
+
+        return query;
+    }
+}

ai-assistant/src/core/services/db/devDocDBNode.ts

@@ -77,7 +77,7 @@ export class Neo4j implements IDB {
 
     /**
      * Verifies the connectivity to the Neo4j database.
-     * 
+     *
      * @returns A Promise that resolves to void.
      * @throws An Error if the connection to Neo4j fails.
      */
@@ -92,7 +92,7 @@ export class Neo4j implements IDB {
 
     /**
      * Closes the connection to the Neo4j database.
-     * 
+     *
      * @returns A promise that resolves when the connection is closed.
      */
     async closeDBConnection(): Promise<void> {
@@ -102,10 +102,10 @@ export class Neo4j implements IDB {
 
     /**
      * Begins a new transaction in the Neo4j database.
-     * 
+     *
      * @throws {Error} If a transaction already exists.
      * @throws {Error} If the transaction fails to begin.
-     * 
+     *
      * @returns {Promise<void>} A promise that resolves when the transaction is successfully started.
      */
     async beginTransaction(): Promise<void> {
@@ -124,10 +124,10 @@ export class Neo4j implements IDB {
 
     /**
      * Commits the current transaction.
-     * 
+     *
      * @throws {Error} If there is no transaction to commit.
      * @throws {Error} If the transaction commit fails.
-     * 
+     *
      * @returns {Promise<void>} A promise that resolves when the transaction is successfully committed.
      */
     async commitTransaction(): Promise<void> {
@@ -146,10 +146,10 @@ export class Neo4j implements IDB {
 
     /**
      * Rolls back the current transaction.
-     * 
+     *
      * @throws {Error} If there is no transaction to rollback.
      * @throws {Error} If the transaction rollback fails.
-     * 
+     *
      * @returns {Promise<void>} A promise that resolves when the transaction is successfully rolled back.
      */
     async rollbackTransaction(): Promise<void> {

ai-assistant/src/core/services/db/neo4j.ts

@@ -1,4 +1,4 @@
-import { DBNodeRelationType } from "../core/services/db/db";
+import { DBNodeRelationType } from "../core/services/db/dbNode";
 
 export type EstablishRelationsEndpointRelations = {
     source: string;