CareEvolution / MyDataHelpsUI

MyDataHelps UI React Component Library
MIT License
1 stars 2 forks source link

AIAssistant Suggestions #341

Closed vladtar closed 1 month ago

vladtar commented 1 month ago

Added prompts suggesting to a user potential use cases they might be interested in.

Security

REMINDER: All file contents are public.

Describe briefly what security risks you considered, why they don't apply, or how they've been mitigated.

Checklist

Testing

Documentation

Consider "Squash and merge" as needed to keep the commit history reasonable on main.

Reviewers

Assign to the appropriate reviewer(s). Minimally, a second set of eyes is needed ensure no non-public information is published. Consider also including:

image

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduced in this pull request enhance the functionality and configurability of the AIAssistant and Chat components. A new property showSuggestions is added to control the display of suggestions, alongside modifications to the tools array. The Chat component is updated to handle suggestions through new props and conditional rendering. Additionally, CSS updates improve the visual presentation of chat suggestions. Overall, these changes facilitate user interaction by providing suggestions and enhancing the components' usability.

Changes

File Change Summary
src/components/container/AIAssistant/AIAssistant.stories.tsx Added showSuggestions property in argTypes (default: true); updated tools array with new options; updated Default and Debug exports to include showSuggestions; added new NoSuggestions export (showSuggestions: false).
src/components/container/AIAssistant/AIAssistant.tsx Added optional showSuggestions property to AIAssistantProps; introduced suggestions state; updated useEffect to manage suggestions; modified addUserMessage function and rendering logic for Chat component.
src/components/presentational/Chat/Chat.css Added new styles for chat suggestions with classes .mdhui-chat-suggestions and .mdhui-chat-suggestion.
src/components/presentational/Chat/Chat.tsx Updated ChatProps interface to include suggestions (string array) and onSuggestionSelected (function); added conditional rendering for suggestions in the component.
src/helpers/AIAssistant/AIAssistant.ts Added a line to promptTemplate to enhance multilingual capabilities, allowing responses in the same language as the user's question.
src/helpers/strings-de.ts Added multiple new string entries for health-related suggestions in German.
src/helpers/strings-en.ts Added multiple new string entries for health-related suggestions in English.
src/helpers/strings-es.ts Added multiple new string entries for health-related suggestions in Spanish.
src/helpers/strings-fr.ts Added multiple new string entries for health-related suggestions in French.
src/helpers/strings-it.ts Added multiple new string entries for health-related suggestions in Italian.
src/helpers/strings-nl.ts Added multiple new string entries for health-related suggestions in Dutch.
src/helpers/strings-pl.ts Added multiple new string entries for health-related suggestions in Polish.
src/helpers/strings-pt.ts Added multiple new string entries for health-related suggestions in Portuguese.
src/components/presentational/Chat/Chat.stories.tsx Added suggestions property in argTypes; created new story Suggestions to demonstrate suggestion handling with an alert on selection.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AIAssistant
    participant Chat

    User->>AIAssistant: Send message
    AIAssistant->>Chat: Add user message
    Chat->>Chat: Clear suggestions
    AIAssistant->>AIAssistant: Check showSuggestions
    AIAssistant->>AIAssistant: Populate suggestions
    AIAssistant->>Chat: Pass suggestions
    User->>Chat: Click on suggestion
    Chat->>AIAssistant: Trigger addUserMessage with suggestion

đŸª§ Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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` or `@coderabbitai title` 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.