Update AI_INTEGRATION_README.md

Author: seemantTUI

AI_INTEGRATION_README.md

@@ -4,7 +4,7 @@ This project integrates ChatGPT into CodeOcean to provide automated feedback for
 
 ## Prerequisites
 
-- **ChatGPT API Key:** Stored securely via Rails credentials
+- **API Key:** Stored securely via Rails credentials
 - **Internal User:** Requires an internal user (`[email protected]`) to create comments
 - **Gem Required:** `gem 'ruby-openai'`
 
@@ -20,9 +20,9 @@ This project integrates ChatGPT into CodeOcean to provide automated feedback for
 
 Encapsulates API communication with ChatGPT.
 
-- **Implementation:** `app/services/chat_gpt_service/chat_gpt_request.rb`
-- **Prompt files:** `app/services/chat_gpt_service/chat_gpt_prompts/` (EN and DE versions)
-- **Structured Output Schema:** `app/services/chat_gpt_service/chat_gpt_prompts/response_format.json`
+- **Implementation:** [`app/services/chat_gpt_service/chat_gpt_request.rb`](app/services/chat_gpt_service/chat_gpt_request.rb)
+- **Prompt files:** [`app/services/chat_gpt_service/chat_gpt_prompts/`](app/services/chat_gpt_service/chat_gpt_prompts/) (EN and DE versions)
+- **Structured Output Schema:** [`app/services/chat_gpt_service/chat_gpt_prompts/response_format.json`](app/services/chat_gpt_service/chat_gpt_prompts/response_format.json)
 
 **Key Method:**
 - `execute(prompt, structured_output)`: Sends prompt and receives response
@@ -31,14 +31,15 @@ Encapsulates API communication with ChatGPT.
 
 Responsible for formatting prompts and parsing responses.
 
+- [`app/helpers/chat_gpt_helper.rb`](app/helpers/chat_gpt_helper.rb)
 - `format_prompt`: Loads locale-specific templates and replaces placeholders in the prompt from application
 - `format_response`: Parses structured JSON response from chatGPT to create general commenta(line 0) and line comments for RFC.
 
 ###  Automatic Comment Job (RFC)
 
 Handles background comment generation when students submit a Request for Comments.
 
-- **Job class:** `GenerateAutomaticCommentsJob`
+- **Job class:** [`GenerateAutomaticCommentsJob`](app/jobs/generate_automatic_comments_job.rb)
 - **Service:** Uses `ChatGptRequest` to communicate with the API
 - **Process:**
   1. Prompts are built from student code and context
@@ -51,26 +52,25 @@ Handles background comment generation when students submit a Request for Comment
 Allows students to request feedback per test result after scoring.
 
 - **Output modification:**  
-  `app/models/submission.rb`  
+  [`app/models/submission.rb`](app/models/submission.rb)  
   Adds `testrun_id` to each test result:
   ```ruby
   output.merge!(filename:, message: feedback_message(file, output), weight: file.weight, hidden_feedback: file.hidden_feedback, testrun_id: testrun.id)
   ```
 
 - **Frontend integration:**  
-  `app/assets/javascripts/editor/editor.js.erb`  
-  Adds data attribute to each test result card:
+  [`app/assets/javascripts/editor/editor.js.erb`](app/assets/javascripts/editor/editor.js.erb)  
   ```js
   card.attr('data-testrun-id', result.testrun_id); // Add testrun_id to the card
   ```
 
 - **Triggering feedback request:**  
-  `app/assets/javascripts/editor.js`  
+  [`app/assets/javascripts/editor.js`](app/assets/javascripts/editor.js)  
   Handles button click, calls backend route, and updates the UI with the ChatGPT feedback.
 
 - **Route and logic:**  
-  - `app/controllers/submissions_controller.rb`: Handles `/testrun_ai_feedback_message` route  
-  - `app/models/testrun.rb`: Contains `generate_ai_feedback` method that builds prompt and fetches response
+  - [`app/controllers/submissions_controller.rb`](app/controllers/submissions_controller.rb): Handles `/testrun_ai_feedback_message` route  
+  - [`app/models/testrun.rb`](app/models/testrun.rb): Contains `generate_ai_feedback` method that builds prompt and fetches response
 
 ###  Exercise-Level Controls
 
@@ -79,5 +79,4 @@ Instructors can toggle AI features per exercise using boolean flags:
 - `allow_ai_comment_for_rfc`: Enables RFC-based AI feedback
 - `allow_ai_feedback_on_score`: Enables test-based feedback
 
-
 ---