Documented everything leftover

Author: preeesha

ai-assistant/src/constants.ts

@@ -1 +1,2 @@
+// Rocket Chat's Marketplace App ID
 export const APP_ID = "ai-assistant";

ai-assistant/src/core/prompt.ts

@@ -11,6 +11,12 @@ export class Prompt {
         this._messages = messages;
     }
 
+    /**
+     * Parses the content of a prompt by removing leading and trailing whitespace from each line.
+     *
+     * @param content - The content of the prompt to be parsed.
+     * @returns The parsed content with leading and trailing whitespace removed from each line.
+     */
     private parsePromptContent(content: string): string {
         return content
             .split("\n")
@@ -19,20 +25,38 @@ export class Prompt {
             .trim();
     }
 
+    /**
+     * Pushes a system message to the message list.
+     *
+     * @param {string} content - The content of the system message.
+     * @returns {void}
+     */
     pushSystem(content: string) {
         this._messages.push({
             role: "system",
             content: this.parsePromptContent(content),
         });
     }
 
+    /**
+     * Adds a message from the assistant to the message list.
+     *
+     * @param {string} content - The content of the message.
+     * @returns {void}
+     */
     pushAssistant(content: string) {
         this._messages.push({
             role: "assistant",
             content: this.parsePromptContent(content),
         });
     }
 
+    /**
+     * Adds a user message to the message list.
+     *
+     * @param {string} content - The content of the user message.
+     * @returns {void}
+     */
     pushUser(content: string) {
         this._messages.push({
             role: "user",

ai-assistant/src/core/query.ts

@@ -4,7 +4,19 @@ import { IDB } from "./services/db/db.types";
 import { IEmbeddingModel } from "./services/embeddings/embeddings.types";
 import { ILLMModel } from "./services/llm/llm.types";
 
+/**
+ * The Query namespace provides functions for querying a database and retrieving nodes based on various criteria.
+ */
 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.
+     * @param {number} threshold - The minimum score threshold for the query results.
+     * @returns {Promise<DBNode[]>} - A promise that resolves to an array of DBNode objects.
+     */
     export async function getDBNodesFromVectorQuery(
         db: IDB,
         indexName: string,
@@ -40,6 +52,14 @@ export namespace Query {
         return nodes;
     }
 
+    /**
+     * 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.
+     * @returns {Promise<DBNode[]>} - A promise that resolves to an array of DBNode objects matching the keywords.
+     */
     export async function getCodeNodesFromKeywords(
         db: IDB,
         embeddingModel: IEmbeddingModel,
@@ -62,6 +82,13 @@ export namespace Query {
         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.
+     */
     export async function getDBKeywordsFromQuery(
         llm: ILLMModel,
         query: string