Added JSDoc documentation for LLM services

Author: preeesha

ai-assistant/src/core/services/llm/llama3_70B.ts

@@ -36,6 +36,12 @@ export class Llama3_70B implements ILLMModel {
         return message;
     }
 
+    /**
+     * Asynchronously asks a prompt and returns the response.
+     *
+     * @param {Prompt} prompt - The prompt to ask.
+     * @returns {Promise<string | null>} A promise that resolves with the response string or null if no response is available.
+     */
     async ask(prompt: Prompt): Promise<string | null> {
         // return await this.fromHuggingFace(prompt);
 

ai-assistant/src/core/services/llm/llm.types.ts

@@ -1,5 +1,11 @@
 import { Prompt } from "../../prompt";
 
 export interface ILLMModel {
+    /**
+     * Asynchronously asks a prompt and returns the response.
+     *
+     * @param {Prompt} prompt - The prompt to ask.
+     * @returns {Promise<string | null>} A promise that resolves with the response string or null if no response is available.
+     */
     ask(prompt: Prompt): Promise<string | null>;
 }

ai-assistant/src/core/services/llm/mistral_7b.ts

@@ -12,6 +12,11 @@ export class Mistral_7B implements ILLMModel {
         this.http = http;
     }
 
+    /**
+     * Asynchronously sends a prompt to the server and retrieves a response.
+     * @param {Prompt} prompt - The prompt object containing the messages to send.
+     * @returns {Promise<string | null>} A promise that resolves to the response message or null if no response is received.
+     */
     async ask(prompt: Prompt): Promise<string | null> {
         const url = `${this.baseURL}/chat/completions`;
         const res = await this.http.post(url, {