Ai model desc

[appflowy]

Feature Preview

---

PR Checklist

• My code adheres to AppFlowy's Conventions
• I've listed at least one issue that this PR fixes in the description above.
• I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
• All existing tests are passing.

Summary by Sourcery

Enhance AI model selection and description functionality across the AppFlowy application, adding support for model descriptions and improving model selection logic

New Features:

• Add support for AI model descriptions in the UI and backend
• Implement more robust model selection logic with fallback mechanisms

Enhancements:

• Improve AI model selection dropdown with optional sub-labels
• Update AI model state management to handle model descriptions
• Refactor AI model selection logic to be more flexible

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request enhances the AI model selection and description functionality in the AppFlowy AI system. It introduces a description field for AI models, improves model selection logic, and adds tracing for the model selection process. The changes include modifications to the AIModel entity, UI components, and the settings AI bloc.

Updated class diagram for AIModel

classDiagram
  class AIModel {
    String name
    bool is_local
    String desc
  }

Loading

File-Level Changes

Change	Details	Files
Introduced a description field for AI models, enhancing the model selection process by providing additional context.	Added a desc field to the AIModel and AIModelPB entities in flowy-ai-pub and flowy-ai crates respectively. Modified the AIModel struct to include a desc field, which defaults to an empty string. Updated the AIModelPB struct to include a desc field. Modified the From implementations to handle the new desc field when converting between AvailableModel and AIModel. Updated the UI components to display the AI model description. Modified the buildDropdownMenuEntry function to support a subLabel for displaying the model description. Updated the _ModelItem widget to display the model description below the model name. Updated the AIModelStateNotifier to reflect the change from Default to Auto. Updated the AIModelExtension to reflect the change from Default to Auto.	frontend/rust-lib/flowy-ai/src/entities.rs frontend/rust-lib/flowy-ai-pub/src/cloud.rs frontend/appflowy_flutter/lib/workspace/presentation/settings/shared/af_dropdown_menu_entry.dart frontend/appflowy_flutter/lib/ai/widgets/prompt_input/select_model_menu.dart frontend/appflowy_flutter/lib/ai/service/ai_model_state_notifier.dart frontend/appflowy_flutter/lib/workspace/presentation/settings/pages/setting_ai_view/model_selection.dart
Improved AI model selection logic by ensuring a default model is always available and correctly selected.	Added a check to return the DEFAULT_AI_MODEL_NAME if the model is empty. Modified the logic to select the global active model, ensuring it falls back to the server model if available. Added tracing for model selection process. Updated the logic to retrieve the global active model, ensuring it falls back to the server model if available. Added tracing to log available models, server active model, user selected model and final active model.	frontend/rust-lib/flowy-ai/src/ai_manager.rs frontend/rust-lib/flowy-ai-pub/src/cloud.rs
Refactored settings AI bloc to load user workspace settings and update selected model.	Added aiModelsGlobalActiveModel constant. Modified the AIModelSwitchListener objectId to aiModelsGlobalActiveModel. Added _loadUserWorkspaceSetting method to load user workspace settings. Added AIEventUpdateSelectedModel to update selected model. Called _loadUserWorkspaceSetting in onStarted event handler. Sent AIEventUpdateSelectedModel when a model is selected.	frontend/appflowy_flutter/lib/workspace/application/settings/ai/settings_ai_bloc.dart

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @appflowy - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a default value for the description field in the protobuf definition to avoid potential null issues.
• The tracing added for model selection is a good addition for debugging.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

issue (complexity): Consider removing the commented-out ts_gen function to reduce clutter if it is not needed for future use or reference purposes, as it can always be retrieved from version control if necessary later on .

It looks like you're leaving a large commented-out function (ts_gen) in the code. If this code isn't slated for future reactivation or reference, consider removing it completely to reduce clutter and confusion.

For example, instead of:

// #[allow(unused_variables)]
// fn ts_gen(crate_name: &str, dest_folder_name: &str, project: Project) {
//   // function body...
// }

Remove the commented-out code entirely. If you need to preserve it for future reference, consider storing it in version control or using a separate branch rather than keeping it in the main codebase.