Provisioning and setting up the generative AI provider for your application

BMC Software uses the Retrieval Augmented Generation (RAG) framework to provide generative AI capabilities. In RAG, the answers are targeted and based on an automatically determined set of knowledge articles derived from the following sources:

BMC Helix Digital Workplace
BMC Helix Knowledge Management by ComAround
BMC Helix ITSM: Knowledge Management
BMC Helix Business Workflows: Knowledge Management

Before you begin

Make sure you have the HelixGPT Administrator role to provision your AI provider.
Specify the API endpoint URL and API key of the generative AI provider that you want to use.
We recommend that you setthe Tokens Per Minute (TPM) in your third-party GenAI provider console to at least 100,000 TPM. You can review and adjust this setting based on your usage patterns.
(For version 23.3.02 and version 23.3.03) Set the Content Filter for the model to Default.

Process for setting up BMC HelixGPT

The following image shows the process of setting up BMC HelixGPT and the current step that you are on:

To add an AI model

Log in to BMC Helix Innovation Studio.
On the Workspace tab, from the Application launcher, select HelixGPT Agent Studio.
In HelixGPT Agent Studio, click Settings.
On the Settings page, select HelixGPT > Connections > AI service providers.
The details of the AI service provider models that are supported by default are displayed in the card format.
Use the toggle button to switch from Card View to Table View.
To add a new model, click Add.
The Add model window opens.

In the Add model window, specify the following details:

Field	Description
Vendor	Name of the AI model vendor
Name	Name of the AI model to be added
Authentication type	Authentication method that you want to set up for your application
	API Key	Specify the following fields for this authentication type: Authentication type: API key Version for the AI model API endpoint URL API key
	OAuth2	Specify the following fields for this authentication type: Authentication type: OAuth2 Version API endpoint URL Auth URL Auth client ID Auth grant type: Password: Authentication user name Password Client credentials: Client secret Authentication scopes
Version	A version of the AI model
API endpoint URL	URL of the API
Max output tokens	Maximum number of tokens (words or parts of words) generated as prompt output
Default config	The additional configurations required for the specified vendor

(For API type authentication) After specifying all the required fields, click Test Connection
to test the AI service provider settings.
If the connection test fails, verify that you have entered the correct details.
Click Save.

To add Auth headers

Perform the following steps to add the Auth Headers in the OAuth2 authentication method:

Log in to BMC Helix Innovation Studio.
In Workspace, go to HelixGPT Agent Studio.
Select Model and click Edit data.
The Data Editor (Model) page opens.
On the Data editor page, select the record for which you want to add the auth headers.
The Edit record window opens.
In the edit record window, select the OAuth2 authentication type and add the auth headers.
Click Save.

To edit a model

Perform the following steps to edit the out-of-the-box AI service provider connection in the HelixGPT Agent Studio:

Log in to BMC Helix Innovation Studio.
On Workspace tab, from the Application launcher, select HelixGPT Agent Studio.
In HelixGPT Agent Studio, click Settings.
On the Settings page, select HelixGPT > Connections > AI service providers.
In the card view, click the name of the model you want to edit; if you have the list view, select the model you want to update and click Edit.
The Edit model window opens.
Make changes in the required fields.
(For API type authentication) After specifying all the required fields, click Test Connection
to test the AI service provider settings.
If the connection test fails, verify that you have entered the correct details.
Click Save.

API keys for Azure OpenAI

BMC HelixGPT supports the Azure OpenAI generative AI provider. BMC strongly recommends using GPT-4. To use BMC HelixGPT, you must obtain and configure the keys from the Azure OpenAI: portal.azure.com website.

To obtain the API key for Google

For Google, we support only the API Key method of authentication.

Before you begin

You must have a service account on https://cloud.google.com/.
You must populate the API key field in the Model record with the Credential.json file.

Perform the following steps:

Open https://cloud.google.com/ and log in with your administrator account credentials.
In the Admin account from the Main menu, select IAM admin > Service Accounts.
The following screenshot shows the Service Accounts option:
Select the Keys tab and click Add keys, and then select Create New keys.
The following screenshot shows the option to create new keys:

The following screenshot shows the option to create new keys:
Select JSON and click CREATE.
The following JSON response is generated:

Click here to view the JSON response

{
  "type": "service_account",
  "project_id": "redacted",
  "private_key_id": " redacted ",
  "private_key": redacted ",
  "client_email": " redacted ",
  "client_id": " redacted ",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": " redacted ",
  "universe_domain": "googleapis.com"

To obtain API keys for Oracle Cloud Infrastructure (OCI)

For OCI, we support only the API Key method of authentication.

Log in to https://www.oracle.com/cloud/.
Click My Profile on the top right corner as shown in the following image:
Click the API Keys tab.
The following screenshot shows the API Keys tab:
To obtain a new key, click Add API key.
Download and save the private key in a file.
The following screenshot shows an option to download the private key:
From the downloaded private key, copy the section starting from '----BEGIN PRIVATE KEY-----’ to ‘-----END PRIVATE KEY-----‘ and use this value.
Use this value in the API Key field on the Model record.
To obtain user, fingerprint, and tenancy, click the More button in the Add API screen and click the View Configuration option.
The following screenshot shows the View Configuration option:

The user, fingerprint, and tenancy details, as shown in the following screenshot are displayed:

Note these values.
To obtain the compartment ID, go to the Main Menu.
Click Identity & Security and select Compartments.
The following screenshot shows the Identity & Security option:

Obtain your compartment ID from the list of compartments:
The Default Config field of the Model record can be filled with user, tenancy, fingerprint, compartment_id, and region values.