Hi All,
AI Mentor Studio API Integration - Is it possible to integrate AI Mentor studio with OutSystems applications to know the technical debt using this forge component . For e.g: I have a case management application and I want to integrate AI Mentor studio into the case management application. Also, Can it help in giving code suggestions and recommendations to enhance application while developing the application.
Hello, Lincy.
Thank you for your question. The AIMS is a SaaS product that is included with your OutSystems 11 platform subscription. Once it is installed in your environment any applications that have not been marked to ignore will be analyzed by the AI Mentor Studio. It does not specifically give code recommendations, but it does analyze your code for violations of best practices in the categories of architecture, maintainability, performance, and security. The system also provides information on why the pattern is against best practices and information on how you can mitigate the risks associated with each code pattern.
Here is a good overview of the AI Mentor Studio
https://success.outsystems.com/documentation/11/monitoring_and_troubleshooting_apps/manage_technical_debt/getting_started_with_ai_mentor_studio/getting_started_as_an_architect/
Here is the list of code patterns the aI Mentor Studio currently analyzes
https://success.outsystems.com/documentation/11/monitoring_and_troubleshooting_apps/manage_technical_debt/code_analysis_patterns/
Please note that you can do all of this from the AIMS interface and do not require this forge component to make these features available to you. This forge component handles the use case where you would like to use the API to collect information from the AI Mentor System for long-term storage and comparison of previous values, or when you would like to check technical debt as part of your CI/CD pipeline, etc.
I hope all is well,
Jeremy
Hello Jeremy ,
Thanks for the response.
What type of information is been collected through the API
The point I’m trying to address is whether we can achieve recommendations on best practices for architecture, maintainability, performance, and security directly within OutSystems Service Studio by integrating with this forge component while developing the application, rather than relying on AI Mentor Studio for these insights.
This forge component is a set of actions and entities that allow you to easily connect to the AIMS API to store and/or use this information in your applications. With that in mind, your application(s) must be scanned by AI Mentor Studio before the information will be available via the API for this forge component to access that information.
In other words, using the AI Mentor Studio is a prerequisite for this forge component to work.
Using this forge component, you could build a different interface to show the information found in the AIMS, but it would still not be directly in Service Studio. It would be in an application that you build that leverages the AIMS API.
Please feel free to send further questions my way,