Show product images in bit Boilerplate chatbot (#11242)

[ysmoradi]

closes #11242

Summary by CodeRabbit

• New Features
  • Car recommendations in the chatbot now display product images alongside each recommended car.
  • Product images are shown using the exact image URLs provided, formatted for easy viewing.
  • Added support for specifying the API address when starting a chatbot session, improving compatibility in various hosting scenarios.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new requirement for the chatbot to display product images in car recommendations by including the PreviewImageUrl in both the data model and the chatbot's response instructions. This involves updating the system prompt, the product recommendation logic, and the data transfer object to support passing the server API address.

Changes

Cohort / File(s)	Change Summary
System Prompt Update src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Data/Configurations/Chatbot/SystemPromptConfiguration.cs	Added a new instruction step requiring the chatbot to display each recommended car's image using the provided PreviewImageUrl in markdown format.
Product Recommendation Tool Update src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/SignalR/AppHub.Chatbot.cs	Modified the product recommendation tool logic to include a PreviewImageUrl property for each recommended product, populated using the primary medium image URL.
DTO Enhancement src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Dtos/Chatbot/StartChatbotRequest.cs	Added a nullable ServerApiAddress property to the StartChatbotRequest DTO to facilitate correct image URL generation, especially in scenarios involving reverse proxies or Azure SignalR.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Client
    participant AppHub.Chatbot
    participant ProductService

    User->>Client: Requests car recommendations
    Client->>AppHub.Chatbot: Sends StartChatbotRequest (with ServerApiAddress)
    AppHub.Chatbot->>ProductService: Fetch product recommendations
    ProductService-->>AppHub.Chatbot: Returns products with image URLs
    AppHub.Chatbot->>Client: Responds with recommendations (includes PreviewImageUrl)
    Client->>User: Displays car recommendations with images (markdown format)

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Chat bot must show product images (#11242)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

Poem

In codey fields where chatbots play,
A rabbit hops to show the way—
Now cars appear with images bright,
Markdown magic, a lovely sight!
With URLs clear and prompts anew,
The bot brings shiny cars to you.
🐰🚗✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between e5e49ac and d9da158.

📒 Files selected for processing (3)

• src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Data/Configurations/Chatbot/SystemPromptConfiguration.cs (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/SignalR/AppHub.Chatbot.cs (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Dtos/Chatbot/StartChatbotRequest.cs (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
• 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 explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @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.