Configure A Lucidworks AI Gateway IntegrationLucidworks AI

Before you can use Lucidworks AI with Lucidworks Platform, you must configure Lucidworks AI Gateway to provide a secure, authenticated integration between self-hosted Fusion and your hosted models. This configuration is done through a secret properties file that you can find in the Lucidworks Platform UI.

This feature is only available in Fusion 5.9.5 and later versions of Fusion 5.9.

You can configure multiple integrations with Lucidworks AI Gateway. Each account can have its own set of credentials and associated scopes, which define the operations it can perform. If configuration properties are not provided at the account level, default settings are used instead.

Integrations are created for you by the Lucidworks team. If you need additional integrations, contact your Lucidworks representative.

To configure Lucidworks AI Gateway, follow these steps:

Sign in to Lucidworks Platform as a workspace owner.
Navigate to Lucidworks AI > Integrations.
Select your integration.

If you don’t see your integration, contact your Lucidworks representative.

Download or copy the YAML code and paste it into a file called account.yaml.

The file for a single integration should look similar to this one:

lwai-gateway:
 lwai:
  credentials: |
     fusion.lwai.default.baseUrl: https://<application_id>.applications.lucidworks.com
     fusion.lwai.default.authEndpoint: https://identity.lucidworks.com/oauth2/XXXXXXXXXX/v1/token
     fusion.lwai.account[0].name: your-account-name
     fusion.lwai.account[0].scopes: signals.push,machinelearning.predict,machinelearning.model
     fusion.lwai.account[0].clientId: YYYYYYYYYYYYYYYYYY
     fusion.lwai.account[0].clientSecret: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY

For a configuration with multiple integrations, it should look like this:

lwai-gateway:
 lwai:
  credentials: |
     fusion.lwai.default.authEndpoint: https://identity.lucidworks.com/oauth2/XXXXXXXXXX/v1/token
     fusion.lwai.account[0].baseUrl: https://<application_id>.applications.lucidworks.com
     fusion.lwai.account[0].name: your-account-name
     fusion.lwai.account[0].scopes: signals.push,machinelearning.predict,machinelearning.model
     fusion.lwai.account[0].clientId: YYYYYYYYYYYYYYYYYY
     fusion.lwai.account[0].clientSecret: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY

     fusion.lwai.account[1].baseUrl: https://<application_id2>.applications.lucidworks.com
     fusion.lwai.account[1].name: your-other-account-name
     fusion.lwai.account[1].scopes: signals.push,machinelearning.predict,machinelearning.model
     fusion.lwai.account[1].clientId: XXXXXXXXXXXXXX
     fusion.lwai.account[1].clientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Non-admin users must have the following permissions to use Lucidworks AI integrations: POST:/your-account-name/** where your-account-name must match the value of fusion.lwai.account[n].name in the integration YAML.

Apply the file to your Fusion configuration file. For example:

helm upgrade <kubernetes-namespace> lucidworks/fusion -f <fusion-values>.yaml

You can confirm that the integration is working by configuring Lucidworks AI vector search.