LWAI Prediction
Query pipeline stage configuration specifications
The LWAI Prediction query stage is an integration between Fusion and Lucidworks AI and invokes the following APIs:
You can also configure the stage using the parameters listed in this topic.
Run this stage when debugging is enabled:
Run this stage when the query includes a specific term:
Run this stage when multiple conditions are met:
The first condition checks that the request parameter “fusion-user-name” is present and has the value “SuperUser”.
The second condition checks that the request parameter “isFusionPluginQuery” is not present.
- Lucidworks AI Prediction API, which is used to send synchronous API calls that run predictions from pre-trained or custom embedding models.
- Lucidworks AI Async Prediction API, which is used to send asynchronous API calls that run predictions on specific models.
Configure the LWAI Prediction query stage
Configure the LWAI Prediction query stage
The LWAI Prediction AI query stage is a Fusion pipeline query stage that enriches your search results with Generative AI predictions.For reference information, see LWAI Prediction query stage.To use this stage, non-admin Fusion users must be granted the
PUT,POST,GET:/LWAI-ACCOUNT-NAME/** permission in Fusion, which is the Lucidworks AI API Account Name defined in Lucidworks AI Gateway when this stage is configured.To configure this stage:- Sign in to Fusion and click Querying > Query Pipelines.
- Click Add+ to add a new pipeline.
- Enter the name in Pipeline ID.
- Click Add a new pipeline stage.
- In the AI section, click LWAI Prediction.
- In the Label field, enter a unique identifier for this stage.
- In the Condition field, enter a script that results in true or false, which determines if the stage should process.
-
Select Asynchronous Execution Config if you want to run this stage asynchronously. If this field is enabled, complete the following fields:
- Select Enable Async Execution. Fusion automatically assigns an Async ID value to this stage. Change this to a more memorable string that describes the asynchronous stages you are merging, such as
signalsoraccess_control. - Copy the Async ID value.
- Select Enable Async Execution. Fusion automatically assigns an Async ID value to this stage. Change this to a more memorable string that describes the asynchronous stages you are merging, such as
- In the Account Name field, select the name of the Lucidworks AI integration defined when the integration was created.
- In the Use Case field, select the Lucidworks AI use case to associate with this stage.
- To generate a list of the use cases for your organization, see Use Case API.
- The available use cases are described in Prediction API.
- In the Model field, select the Lucidworks AI model to associate with this stage.
PUT,POST,GET:/LWAI-ACCOUNT-NAME/**Your Fusion account name must match the name of the account that you selected in the Account Name dropdown.For more information about models, see:- In the Input context variable variable field, enter the name of the variable in context to be used as input. Template expressions are supported.
- In the Destination variable name and context output field, enter the name that will be used as both the query response header in the prediction results and the context variable that contains the prediction.
-
If a value is entered in this field:
-
{destination name}_tis the full response. -
In the context:
_lw_ai_properties_sscontains the Lucidworks account, boolean setting for async, use case, input for the call, and the collection.
-
-
If no value is entered in this field:
-
_lw_ai_{use case}_tis theresponse.responseobject, which is the raw model output. -
_lw_ai_{use case}_response_sis the full response.
-
- Select the Include Response Documents? check box to include the response documents in the Lucidworks AI request. This option is only available for certain use cases. If this is selected, run the Solr Query stage to ensure documents exist before running the LWAI Prediction query stage.
- In the Document Field Mappings section, enter the LW AI Document field name and its corresponding Response document field name to map from input documents to the fields accepted by the Prediction API RAG use case. The fields are described in the Prediction API.
- The
bodyandsourcefields are required.body-description_tis the contents of the document.source-link_tis the URL/ID of the document.
- The
titleanddatefields are optional.title-title_tis the title of the document.date-_lw_file_modified_tdtis the creation date of the document in epoch time format.
- In the Use Case Configuration section, click the + sign to enter the parameter name and value to send to Lucidworks AI.
-
The
useCaseConfigparameter is only applicable to certain use cases. For more information, see the Async Prediction API and the Prediction API. -
The
memoryUuidparameter is required in the Standalone Query Rewriter use case, and is optional in the RAG use case. For more information, see Prediction API.
-
In the Model Configuration section, click the + sign to enter the parameter name and value to send to Lucidworks AI. Several
modelConfigparameters are common to generative AI use cases. For more information, see Prediction API. - In the API Key field, enter the secret value specified in the external model. For:
-
OpenAI models,
"apiKey"is the value in the model’s"[OPENAI_API_KEY]"field. For more information, see Authentication API keys. -
Azure OpenAI models,
"apiKey"is the value generated by Azure in either the model’s"[KEY1 or KEY2]"field. For requirements to use Azure models, see Generative AI models. -
Google VertexAI models,
"apiKey"is the value in the model’s"[BASE64_ENCODED_GOOGLE_SERVICE_ACCOUNT_KEY]"field. For more information, see Create and delete Google service account keys.
- Select the Fail on Error checkbox to generate an exception if an error occurs during this stage.
- Click Save.
To use this stage, non-admin Fusion users must be granted the
PUT,POST,GET:/LWAI-ACCOUNT-NAME/** permission in Fusion, which is the Lucidworks AI API Account Name defined in Lucidworks AI Gateway when this stage is configured.Query pipeline stage condition examples
Stages can be triggered conditionally when a script in the Condition field evaluates to true. Some examples are shown below. Run this stage only for mobile clients:Configuration
When entering configuration values in the UI, use unescaped characters, such as
\t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.