Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: action redesign, UQI upgrade Open AI plugin config to dual zone format #36087

Merged
merged 3 commits into from
Sep 6, 2024

Conversation

alex-golovanov
Copy link
Contributor

@alex-golovanov alex-golovanov commented Sep 3, 2024

Description

Upgrade Open AI plugin config to new format using SECTION_V2, SINGLE_COLUMN_ZONE, and DOUBLE_COLUMN_ZONE.

Fixes #35498

Automation

/ok-to-test tags="@tag.All"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10717573805
Commit: 0db98de
Cypress dashboard.
Tags: @tag.All
Spec:


Thu, 05 Sep 2024 10:22:31 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Updated chat, embeddings, root, and vision configurations to enhance user interface layout and organization.
    • Introduced new control types for a more responsive and visually structured design.
  • Bug Fixes
    • Improved clarity and usability of configuration elements through logical grouping and restructuring.

Copy link
Contributor

coderabbitai bot commented Sep 3, 2024

Walkthrough

The overall changes involve updating the JSON configuration for the OpenAI plugin, specifically modifying controlType from "SECTION" to "SECTION_V2" across multiple files. This change indicates a structural enhancement in the user interface, with the introduction of new layout zones such as DOUBLE_COLUMN_ZONE and SINGLE_COLUMN_ZONE. The modifications aim to improve the organization and presentation of various components, including chat, embeddings, and vision functionalities.

Changes

Files Change Summary
.../openAiPlugin/src/main/resources/editor/chat.json Updated controlType to SECTION_V2, reorganized layout into DOUBLE_COLUMN_ZONE and SINGLE_COLUMN_ZONE.
.../openAiPlugin/src/main/resources/editor/embeddings.json Changed controlType to SECTION_V2, restructured controls into DOUBLE_COLUMN_ZONE and SINGLE_COLUMN_ZONE.
.../openAiPlugin/src/main/resources/editor/root.json Modified controlType from SECTION to SECTION_V2.
.../openAiPlugin/src/main/resources/editor/vision.json Altered controlType to SECTION_V2, restructured layout into DOUBLE_COLUMN_ZONE and SINGLE_COLUMN_ZONE.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI
    participant Plugin

    User->>UI: Interacts with Chat/Embedding/Vision
    UI->>Plugin: Sends configuration request
    Plugin-->>UI: Returns updated layout
    UI-->>User: Displays new organized interface
Loading

🌟 In the realm of code, changes unfold,
A tale of sections, both new and bold.
From SECTION to SECTION_V2,
A fresh layout for me and you.
With zones that double and single align,
User experience now shines divine! ✨


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Task A simple Todo skip-changelog Adding this label to a PR prevents it from being listed in the changelog labels Sep 3, 2024
@alex-golovanov
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

github-actions bot commented Sep 3, 2024

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/10683116875.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 36087.
recreate: .

@alex-golovanov alex-golovanov changed the title chore: action redesign, UQI upgrade Open AI plugin config to dual zone format feat: action redesign, UQI upgrade Open AI plugin config to dual zone format Sep 3, 2024
@github-actions github-actions bot added Enhancement New feature or request and removed skip-changelog Adding this label to a PR prevents it from being listed in the changelog labels Sep 3, 2024
@alex-golovanov alex-golovanov added ok-to-test Required label for CI and removed Enhancement New feature or request labels Sep 3, 2024
@github-actions github-actions bot added the Enhancement New feature or request label Sep 3, 2024
Copy link

github-actions bot commented Sep 3, 2024

Deploy-Preview-URL: https://ce-36087.dp.appsmith.com

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f02b448 and 907bac1.

Files selected for processing (4)
  • app/server/appsmith-plugins/openAiPlugin/src/main/resources/editor/chat.json (1 hunks)
  • app/server/appsmith-plugins/openAiPlugin/src/main/resources/editor/embeddings.json (1 hunks)
  • app/server/appsmith-plugins/openAiPlugin/src/main/resources/editor/root.json (1 hunks)
  • app/server/appsmith-plugins/openAiPlugin/src/main/resources/editor/vision.json (1 hunks)
Additional comments not posted (13)
app/server/appsmith-plugins/openAiPlugin/src/main/resources/editor/root.json (1)

4-4: Great work updating the control type to the new version!

The change from "SECTION" to "SECTION_V2" looks good. It's a straightforward update that indicates a versioning enhancement to the section control type.

I appreciate how you kept the rest of the JSON structure intact while making this targeted change. The modification aligns with the provided summary and list of alterations, ensuring consistency across the documentation and implementation.

Keep up the excellent work in improving the OpenAI plugin configuration! Let me know if you have any further questions or if there's anything else I can assist with.

app/server/appsmith-plugins/openAiPlugin/src/main/resources/editor/embeddings.json (4)

3-3: Great work on upgrading the main section to version 2! 👍

The change from "SECTION" to "SECTION_V2" suggests an enhancement to the main section's functionality.

However, let's ensure this upgrade doesn't introduce any unexpected changes to the user interface.

Could you please provide a screenshot or a brief description of how this change affects the embeddings configuration UI? This will help us verify that the upgrade maintains a consistent user experience.


9-38: The restructuring of the "Models" control looks great! 🎉

Nesting the control within a DOUBLE_COLUMN_ZONE enhances the layout organization without altering its properties or functionality. This change promotes a more modular and visually appealing design.


41-53: Excellent job on updating the "Input" control's layout! 🌟

By encapsulating the control within a SINGLE_COLUMN_ZONE, you've enhanced the presentation while preserving its original properties. This change contributes to a more organized and user-friendly configuration interface.


56-77: The restructuring of the "Encoding Format" control is a great improvement! 👌

Moving the control into a DOUBLE_COLUMN_ZONE enhances the overall layout while maintaining its options and functionality. This change contributes to a more visually structured and intuitive configuration experience for users.

app/server/appsmith-plugins/openAiPlugin/src/main/resources/editor/chat.json (4)

3-3: Great work upgrading to SECTION_V2! This change introduces new layout capabilities.

The update from SECTION to SECTION_V2 is a significant structural enhancement that enables the use of new layout zones like DOUBLE_COLUMN_ZONE and SINGLE_COLUMN_ZONE. This change will improve the organization and presentation of various components in the chat functionality.


9-49: The new DOUBLE_COLUMN_ZONE layout looks great! It enhances the visual structure while preserving functionality.

Introducing the DOUBLE_COLUMN_ZONE and reorganizing the "Models" and "Max Tokens" fields within it is an excellent way to improve the layout and visual appeal of the chat configuration. The changes align with modern UI practices and enhance the user experience without altering the core functionality. Well done!


52-78: Moving the "Messages" field into the SINGLE_COLUMN_ZONE is a smart choice! It improves the layout while preserving functionality.

Restructuring the "Messages" field to fit within the new SINGLE_COLUMN_ZONE is an excellent way to enhance the organization and presentation of the chat configuration. The field maintains its previous properties but now aligns with the updated layout paradigm. This change contributes to a more cohesive and visually appealing user interface. Great job!


83-96: Adding the "Temperature" field in the new DOUBLE_COLUMN_ZONE is a valuable enhancement! It provides more control over the generated responses.

Introducing the "Temperature" field within the new DOUBLE_COLUMN_ZONE is an excellent addition to the chat configuration. It allows users to adjust the randomness of the generated responses, providing more control over the output. The field's placement aligns with the overall layout improvements and contributes to a more comprehensive and user-friendly configuration. Fantastic work!

app/server/appsmith-plugins/openAiPlugin/src/main/resources/editor/vision.json (4)

3-3: Great work upgrading the controlType to "SECTION_V2"! 👍

This change indicates a version upgrade that likely brings enhanced functionality or features to the "VISION" component. Keep up the good work!


9-37: Excellent job restructuring the "Models" section! 🌟

By nesting the "Models" section within a "DOUBLE_COLUMN_ZONE", you've enhanced the logical grouping of controls and improved the clarity and usability of the user interface. This change reflects a more sophisticated design approach that will likely provide a better user experience. Well done!


52-109: Fantastic work improving the "System Messages" and "User Messages" sections! 🎉

Moving these sections to a "SINGLE_COLUMN_ZONE" enhances the logical grouping of controls and improves the clarity and usability of the user interface. The more detailed schema for message types and content in the "User Messages" section is a great addition, providing greater flexibility and control over user inputs. These changes demonstrate your attention to detail and commitment to creating a user-friendly experience. Keep up the excellent work!


112-125: Great job adding the "Temperature" section! 👏

The inclusion of the "Temperature" section is a valuable addition, as it provides users with the ability to control the randomness of the output, allowing for more focused or more diverse results depending on their needs. By placing this section within a "DOUBLE_COLUMN_ZONE", you've maintained the consistent and organized layout of the user interface. This attention to detail and consideration for user control is commendable. Well done!

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 907bac1 and 411206a.

Files selected for processing (1)
  • app/server/appsmith-plugins/openAiPlugin/src/main/resources/editor/root.json (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • app/server/appsmith-plugins/openAiPlugin/src/main/resources/editor/root.json

Copy link

github-actions bot commented Sep 3, 2024

Failed server tests

  • com.appsmith.server.git.ServerSchemaMigrationEnforcerTest#saveGitRepo_ImportAndThenExport_diffOccurs

@alex-golovanov alex-golovanov added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Sep 5, 2024
@alex-golovanov
Copy link
Contributor Author

This PR has been tested on CE & EE (modules, workflows).

@alex-golovanov alex-golovanov merged commit d37e8d2 into release Sep 6, 2024
134 of 153 checks passed
@alex-golovanov alex-golovanov deleted the perf/35498-uqi-open-ai-2 branch September 6, 2024 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product ok-to-test Required label for CI Task A simple Todo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Add Zone & Section to Open AI plugin form
3 participants