digiteinfotech / kairon

Conversational AI Platform to build effective Proactive Digital Assistants using Visual LLM Chaining
https://kairon.nimblework.com/bots
Apache License 2.0
248 stars 78 forks source link

Collection Data #1402

Closed maheshsattala closed 3 months ago

maheshsattala commented 3 months ago

Added CRUD operations for the CollectionData and added unit and integration tests for the same.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent updates enhance the API with robust management capabilities for collection data. New endpoints allow users to save, update, delete, and list collections, complemented by a validation model that ensures data integrity. Enhanced methods in the processor support data encryption and decryption, while comprehensive testing validates these new features. This significantly improves the application's functionality and user experience.

Changes

File(s) Change Summary
kairon/api/app/routers/bot/data.py Added endpoints for saving, updating, deleting, and listing collection data, utilizing a new data model.
kairon/api/models.py Introduced CollectionDataRequest class with validation logic for incoming requests.
kairon/shared/cognition/data_objects.py Created CollectionData class with fields and validation for collection attributes.
kairon/shared/cognition/processor.py Enhanced CognitionDataProcessor with methods for managing collection data operations, including encryption.
tests/integration_test/services_test.py Added integration tests for new API endpoints, covering various scenarios for collection data management.
tests/unit_test/data_processor/data_processor_test.py Developed unit tests for the CognitionDataProcessor class, validating core functionalities for collections.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant Processor
    participant Model

    User->>API: Save Collection Data
    API->>Processor: Validate and Process Data
    Processor->>Model: Save Data
    Model-->>Processor: Return ID
    Processor-->>API: Success Message with ID
    API-->>User: Success Response
sequenceDiagram
    participant User
    participant API
    participant Processor
    participant Model

    User->>API: Update Collection Data
    API->>Processor: Validate and Update Data
    Processor->>Model: Update Data
    Model-->>Processor: Confirm Update
    Processor-->>API: Success Message
    API-->>User: Success Response

🐰 Hop along, the changes are here,
With collections to save, update, and cheer!
Data flows smoothly, no worries or fuss,
In the world of code, it's a magical plus!
So let’s leap and rejoice, with all of our might,
For a brighter tomorrow, all bundled up tight! ✨


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.