Experiment Versioning: Assistants

stephherbers commented 2 weeks ago

Description

Allow versioning of assistants

User Impact

Now experiments with assistants can be versioned where a copy of the assistant if made if attached to that experiment

Demo

not part of this PR

Docs

Docs updates are coming be ready

stephherbers commented 2 weeks ago

@coderabbitai please review

coderabbitai[bot] commented 2 weeks ago

@stephherbers: I will review the changes.

:white_check_mark: Actions performed

Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot] commented 2 weeks ago

📝 Walkthrough

## Walkthrough This pull request introduces significant changes to the `OpenAIAssistant` model and its associated functionalities within a Django application. It adds three new fields: `is_archived`, a BooleanField for marking assistants as archived; `version_number`, a PositiveIntegerField for tracking the version of the assistant; and `working_version`, a ForeignKey referencing the same model to establish a relationship with another version. The `OpenAiAssistant` class now inherits from `VersionsMixin`, enhancing its version management capabilities. A new method, `create_new_version`, is introduced to facilitate the creation of new versions within a database transaction. Additionally, the `OpenAiAssistantTable` class receives a `render_actions` method that conditionally displays action buttons based on the assistant's state. The views related to `OpenAiAssistant` are updated to filter out archived assistants and modify deletion behavior, shifting it towards archiving instead. Finally, changes in the `Experiment` model ensure that assistant versions are maintained alongside experiment versions, with corresponding updates to the testing suite to reflect these integrations. ## Possibly related PRs - **#774**: This PR introduces synchronization features for the `OpenAiAssistant`, which relates to the new `working_version` field added in the main PR, as both involve managing versions of the assistant and ensuring consistency with external systems. ## Suggested reviewers - SmittieC - 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://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.

codecov-commenter commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 86.74699% with 11 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
apps/assistants/views.py	0.00%	6 Missing :warning:
apps/assistants/sync.py	50.00%	2 Missing :warning:
apps/assistants/models.py	96.96%	1 Missing :warning:
apps/assistants/tables.py	66.66%	1 Missing :warning:
apps/chat/agent/tools.py	75.00%	1 Missing :warning:

Additional details and impacted files

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

stephherbers commented 1 week ago

We should probably also filter assistant versions from the assistants table, similar to what we do for instance for the consent forms here @SmittieC I opted to show the versioned assistants and modified the logic such that it does not link to the edit view & cannot sync. I opted for this just because it will also exist in OpenAI, so because of that felt wrong to hide from view in OCS (when for other things that lived only in OCS it feels more natural to hide things that are simply duplicates in time). But let me know if you disagree

SmittieC commented 1 week ago

We should probably also filter assistant versions from the assistants table, similar to what we do for instance for the consent forms here @SmittieC I opted to show the versioned assistants and modified the logic such that it does not link to the edit view & cannot sync. I opted for this just because it will also exist in OpenAI, so because of that felt wrong to hide from view in OCS (when for other things that lived only in OCS it feels more natural to hide things that are simply duplicates in time). But let me know if you disagree

I see. My only concern with this is that the assistants table will get cluttered, but let's see what the user feedback is. Maybe they like the fact that one can see the versions. Fine by me to leave as-is for now

SmittieC commented 1 week ago

I fixed some issues that came from the merge with the main branch and also a small issue when we try to duplicate files that doesn't really exist. This happens when we create a file that was uploaded through OpenAI, but since we can't pull its contents, we don't have a file associated with the record. See this commit. I hope you don't mind me making these changes.

All else looks good from my side, thanks @stephherbers. @snopoke, do you have any reservations about the last commit I made?

dimagi / open-chat-studio