Kyma Companion AI Chat

[mrCherry97]

Description

As Sebastian and Mathew I would like to have Kyma Companion AI Chat in the Busola Dashboard that allows to talk with the kyma companion backend which helps to automate the process to analyze and troubleshoot a Kyma cluster by LLM (Language Model).

Acceptance Criteria

• AI chat is easily available in the Busola Dashboard
• UI is following the designs
  Kyma Companion-compressed.pdf
• The Busola Dashboard is integrated with Kyma Companion API (gh tools /kyma/ai-force/tree/main/docs/api-structure)
• User could be navigated from AI Chat to the specific edit/create view of the resource to copy paste response from AI Chat

To integrate the Kyma Companion into Busola based on the POC changes, the following steps are required:

API / Backend related:

• Add cluster authorization to all API requests
• Integrate and adjust POST /conversations endpoint #3602
• Integrate and adjust POST /conversations/{conversation_id}/messages endpoint #3605
• Integrate and adjust GET /conversations/{conversation_id}/questions endpoint #3606
• Enhance error handling of companion #3772

Frontend related:

• Update UI5 components to version 2 Migrate Kyma Companion to UI5v2 #3600
• Adjust Kyma Companion UI to align with designs #3601
• Adjust UI of intermediate steps #3658
• Open AI assistant from top toolbar, leave open upon resource / view changes
• Update UI flow to open Kyma Companion #3603
• Add "Place" button to Kyma Companion #3604
• Hide behind feature flag
• enhance typescript types
• Improve markdown formatting in companion responses #3749
• Disable input while message is loading #3750

Testing:

• Add unit tests Add tests for AI Assistant #3820
• Add integration tests Add tests for AI Assistant #3820

Business Value

This feature enhances user convenience by providing an AI Chat which helps automate the process of analyzing and troubleshooting a Kyma cluster by LLM (Language Model).

Reasons

Adopting this feature simplifies the user experience and increases efficiency, especially for users unfamiliar with Kubernetes and Kyma.

Dependencies

Depends on the Kyma Companion API requirements.

Non-functional Requirements

• Security and privacy must be ensured for stored user data.
• The system should maintain high availability and reliability.

Constraints

• Must comply with data protection and privacy laws.
• Should be designed for easy update and maintenance.

Additional Features

• Settings and configurations persistence across sessions.
• We should be able to enable and disable this feature for different users(experimental channel, restricted markets, etc)

Notes and Comments

• Couple months ago, there was some PoC: feat: add kyma companion #2861

Size or Effort

High effort, considering the development and integration of new functionalities.

Mockups or Diagrams

Useful Links

• tools/kyma/ai-force
• Designs

[mrCherry97]

UX review - features:

• AI Assistant - Joule icon in the shellbar should go into toggled state when joule is open. #3829
• Add retrying functionality to AI Assistant #3869
• AI Assistant - Code Snippet and actions should refer to the newest guidelines #3830
• AI Assistant - Input field should be adjusted to the newest designs #3831
• Add banner about Joule, the AI Assistant #3851
• AI Assistant - Add context label of the messages #3833
• AI Assistant - Information about Joule should be moved to the info section #3834
• AI Assistant - Add timestamps at the beginning of the conversation #3835
• AI Assistant: Add validation of the Place button #3846
• AI Assistant - Add proper loading screen of Joule #3836
• Improve feedback information and add Joule feedback survey #3850
• Add feedback message on the feedback response from the AI Assistant #3852

UX review - bugs:

• AI Assistance - Font size for Joule header should be 1 rem bold #3837
• AI Assistant stays open after log out from the cluster #3868
• Place button does not work correctly #3857
• AI Assistant - Suggestions loader shouldn't be inside of a chat bubble #3832

[mfaizanse]

Opened a bug: #3919