search

Innovateninjas / Paws-frontend

A fast responsive webapp that allows you to report injured stray animals to the nearest NGOs.
https://pawss.vercel.app
GNU General Public License v3.0
64 stars 101 forks source link

Added Chatbot #537

Open sreevidya-16 opened 3 months ago

sreevidya-16 commented 3 months ago

Description

Adding a chatbot to Paws will significantly enhance user engagement and support by providing instant assistance and guidance on reporting injured animals.

The chatbot will facilitate seamless communication between users, NGOs, and animal hospitals, ensuring that reports are efficiently directed to the appropriate parties.

This feature will streamline the process of helping stray injured animals, making the platform more responsive and effective in addressing animal welfare concerns

Related Issue

Resolves #534 Issue

Screenshots / GIFs (if applicable)

[Attach any relevant screenshots or GIFs demonstrating the changes]

Checklist:

Additional Notes

[Add any additional notes or context about the changes made]

@itsekta, could you please approve this pull request

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes introduce a chatbot named "Snapitizer" to the Paws platform, enhancing user engagement through natural language processing capabilities. The chatbot leverages a neural network model for intent recognition and utilizes a structured set of intents for dynamic interactions. Additionally, the implementation includes necessary documentation and utilities for easy customization and training, significantly improving the platform's responsiveness to user inquiries about animal welfare.

Changes

Files Change Summary
AI_CHATBOT/README.md Introduces documentation for the chatbot, outlining its purpose and customization options.
AI_CHATBOT_PAWS/chat.py Implements the chatbot's conversation loop, processing user inputs and responding based on intent recognition with a neural network model.
AI_CHATBOT_PAWS/intents.json Defines conversational intents with tags, patterns, and responses to enhance user interaction focused on animal welfare services.
AI_CHATBOT_PAWS/model.py Introduces the NeuralNet class for the chatbot’s neural network architecture, defining layers and the forward pass for intent classification.
AI_CHATBOT_PAWS/nltk_utils.py Contains utility functions for tokenization, stemming, and creating a bag-of-words representation for natural language processing.
AI_CHATBOT_PAWS/train.py Provides a training pipeline for the chatbot model, including data preparation, model training, and saving the trained model.

Assessment against linked issues

Objective Addressed Explanation
Facilitate seamless communication regarding animal welfare (Issue #534) ✅
Enhance user engagement through instant assistance (Issue #534) ✅
Provide guidance on reporting injured animals (Issue #534) ✅

Poem

Hop, hop, hooray, my friend!
A chatbot's here to lend a hand.
With words and thoughts, it will assist,
In caring for critters, it can't be missed!
So ask away, don't be shy,
For Snapitizer's ready to reply! 🐰✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.