Exercise Chat: Add citation pipeline for FAQs

[cremertim]

I missed adding the citation of faqs in the exercise chat, this PR makes sure the Faqs are also cited properly

Summary by CodeRabbit

• New Features
  • Enhanced the response generation process to incorporate relevant FAQ information when available, ensuring that responses are more informative and contextual for users.

[coderabbitai]

Walkthrough

The changes enhance the response generation process in the chat agent pipeline. After refining the response using guide_response, the __call__ method now checks if retrieved FAQs exist. If they do, it calls the citation pipeline to augment the response with FAQ data using an imported InformationType.FAQS and logs the augmentation process. This modification integrates FAQ enrichment seamlessly into the existing flow.

Changes

File	Change Summary
app/pipeline/chat/exercise_chat_agent_pipeline.py	Added import for InformationType from citation_pipeline; modified __call__ to conditionally invoke citation pipeline for FAQ augmentation and added logging for the augmentation process.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client
    participant Pipeline as ExerciseChatAgentPipeline
    participant Citation as citation_pipeline

    Client->>Pipeline: Request exercise chat response
    Pipeline->>Pipeline: Generate response using guide_response
    alt Retrieved FAQs exist
        Pipeline->>Citation: Invoke augmentation with FAQ data (InformationType.FAQS, FAQs, response, base URL)
        Citation-->>Pipeline: Return augmented response
        Pipeline->>Pipeline: Log FAQ augmentation process
    end
    Pipeline-->>Client: Return final response

Loading

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

app/pipeline/chat/exercise_chat_agent_pipeline.py (1)

588-596: Add error handling and logging for the FAQ citation process.

While the code is functionally correct, consider these improvements for better reliability and observability:

1. Add specific error handling for the citation pipeline call
2. Add logging for the FAQ augmentation process
3. Validate the citation pipeline output

Apply this diff to implement the suggestions:

                 if self.retrieved_faqs:
                     self.callback.in_progress("Augmenting response ...")
+                    logger.info("Augmenting response with FAQ citations...")
+                    try:
                         out = self.citation_pipeline(
                             self.retrieved_faqs,
                             out,
                             InformationType.FAQS,
                             base_url=dto.settings.artemis_base_url,
                         )
+                        if not out:
+                            logger.warning("Citation pipeline returned empty output")
+                        else:
+                            logger.info("Successfully augmented response with FAQ citations")
+                    except Exception as e:
+                        logger.error("Failed to augment response with FAQ citations", exc_info=e)
+                        # Continue with the original response if citation fails
+                        self.callback.in_progress("Continuing with original response...")

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eb7faf8 and 6516821.

📒 Files selected for processing (1)

• app/pipeline/chat/exercise_chat_agent_pipeline.py (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Build and Push Docker Image

🔇 Additional comments (1)

app/pipeline/chat/exercise_chat_agent_pipeline.py (1)

29-29: LGTM!

The import statement is correctly placed and both imported entities are used in the code.