BMC AMI AI Services integration with Code Insights Explain

This topic explains the workflow for integrating various services within the BMC AMI AI platform, focusing on the interaction between the BMC AMI DevX space and the BMC AMI AI Services. The BMC AMI DevX space includes client applications such as BMC AMI DevX Workbench for Eclipse, BMC AMI DevX Workbench for VS Code, and BMC AMI Common Enterprise Services (CES), with CES acting as middleware.

The integration service provides access to all the generative AI features under BMC AMI DevX Code Insights. For more information about the services, see BMC-AMI-AI-Services-overview.

There are two different processes: the provisioning process and the usage process.

Overview of the provisioning process

After you complete the installation, you start the provisioning process. The provisioning process involves deploying AI services to the environment and configuring access for users. After AI services are deployed, they become visible in the UI environment, allowing administrators to manage them through the BMC AMI AI Manager console. The Discovery Service automatically detects features such as the Code Insights Explain service. When the Code Insights Explain feature is running, the system can discover it, and the BMC AMI AI Manager console displays its availability.

To enable access to the BMC AMI AI Manager console and other features, administrators must provision the service. This process generates an access token and URL for connecting to the Code Insights Explain service, with the necessary entries added to CES, which acts as middleware. CES facilitates provisioning for any AI services feature and manages access through the generated URL and token. This integration allows client applications such as BMC AMI DevX Workbench for Eclipse to interact with CES without requiring configuration changes, because CES automatically provides the necessary information.

For more information, see Managing-the-platform-in-the-BMC-AMI-AI-Manager-console.

Overview of the usage process

The usage process is as follows:

Code Insights Explain service registers itself with the Discovery Service.
Code Insights Explain service is now available in the BMC AMI AI Manager console.
BMC AMI AI Services Platform administrator can now provision the Code Insights Explain service by using the BMC AMI AI Manager console, which enables functionality.
During the provisioning process, the gateway URL and access token are sent to CES.
The BMC AMI DevX Workbench for Eclipse communicates with CES. It passes the code snippet to explain to CES, which passes it on to the Platform.

This process ensures secure and efficient communication between the user, the AI services, and the client applications.

Code Insights Explain workflow

The following figure displays the workflow and the integration between the BMC AMI AI Services and Code Insights Explain.

Code Insights Explain Workflow.png

For more information, see the following topics:

BMC AMI DevX Workbench for Eclipse—Using Code Insights Explain
BMC AMI DevX Workbench for VS Code—Using the Code Insights Explain

Where to go from here

For more information about BMC AMI AI Services, see Getting-started.

To prepare for installation, see Planning.