dimagi / open-chat-studio

A web based platform for building Chatbots backed by Large Language Models
BSD 3-Clause "New" or "Revised" License
16 stars 7 forks source link

Version tag updates #876

Closed SmittieC closed 1 week ago

SmittieC commented 1 week ago

Description

Options:

User Impact

Demo

Session table shows versions that the session spans

image

We indicate that the chat happened on an unreleased version

image

Docs

N/A

SmittieC commented 1 week ago

cc @bderenzi

SmittieC commented 1 week ago

@coderabbitai do a full review

coderabbitai[bot] commented 1 week ago

@SmittieC: I will perform a full review of the pull request.

:white_check_mark: Actions performed Full review triggered.
coderabbitai[bot] commented 1 week ago
πŸ“ Walkthrough
πŸ“ Walkthrough
πŸ“ Walkthrough
πŸ“ Walkthrough
πŸ“ Walkthrough
πŸ“ Walkthrough ## Walkthrough This pull request introduces several modifications across multiple files, primarily focusing on enhancements related to tagging and versioning within the application. A new category, `VERSION_DEPLOYED_STATUS`, is added to the `category` field of the `tag` model in the `annotations` app, allowing for improved categorization of tags. The `experiment_version_for_display` method in the `ExperimentSession` class is updated to return distinct version tags associated with chat messages, enhancing how experiment versions are represented. Additionally, the `ExperimentSessionsTable` class has its `version` column renamed to `versions` for clarity. In the `Pipeline` class, methods related to message handling and versioning are modified to incorporate tagging functionality. Changes in the `ChatExperimentState` and `ExperimentAssistantState` classes include updates to the `save_message_to_history` method to add system tags based on the message type. Overall, these changes enhance the functionality related to tagging and version management without altering existing logic or control flows. ## Possibly related PRs - **#698**: This PR enhances functionality related to experiment version management, which is directly connected to the changes in the main PR that involve modifying the `category` field of the `tag` model, as both involve managing and categorizing versions within the experiments. - **#715**: This PR introduces updates to versioning capabilities, including methods for managing versions in the `Experiment` class, which relates to the main PR's focus on categorizing tags and managing versions. - **#833**: This PR focuses on versioning assistants linked to experiments, which aligns with the main PR's changes to the `tag` model's categorization, as both involve managing different versions and their associated metadata. ## Suggested reviewers - snopoke

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 , 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` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) 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.
codecov-commenter commented 1 week ago

Codecov Report

Attention: Patch coverage is 96.96970% with 1 line in your changes missing coverage. Please review.

:white_check_mark: All tests successful. No failed tests found.

Files with missing lines Patch % Lines
apps/experiments/models.py 80.00% 1 Missing :warning:
Additional details and impacted files

:loudspeaker: Thoughts on this report? Let us know!


🚨 Try these New Features:

snopoke commented 1 week ago
  • One "issue" with this is that if we create a new version, then chatting to a working version will still tag responses with the "unreleased" tag even though there are no changes between the current working version and the latest version.

I don't think this is worth trying to work around.

SmittieC commented 1 week ago

Generally seems OK though I wonder about using a separate tag for the 'unreleased' vs changing the name of the version tag e.g. v3 unreleased.

I like this suggestion. I'm going with it