Product Selector

Fusion 5.9
    Fusion 5.9

    LWAI PredictionIndex pipeline stage configuration specifications

    Table of Contents

    The LWAI Prediction index stage is an integration between Fusion and Lucidworks AI to enrich your index with Generative AI predictions. More detailed information to configure this stage is in Configure the LWAI Prediction index stage.

    By default, the Fusion Call Asynchronously? field is selected, which specifies this stage uses the Lucidworks AI Async Prediction API endpoints.

    If the Fusion Call Asynchronously? field is not selected, this stage uses the LWAI Prediction API endpoints.

    To use this stage, non-admin Fusion users must be granted the POST:/LWAI-ACCOUNT-NAME/** permission in Fusion, which is the Lucidworks AI API Account Name defined in Lucidworks AI Gateway when this stage is configured.

    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.

    General purpose integration between Fusion and Lucidworks AI. By default, this stage is asynchronous, meaning that it will not block the pipeline while waiting for a response from Lucidworks AI. This default asynchronous configuration may benefit from the use of other stages, e.g. 'Solr Asynchronous Query' to incrementally handle the response from Lucidworks AI.

    skip - boolean

    Set to true to skip this stage.

    Default: false

    label - string

    A unique label for this stage.

    <= 255 characters

    condition - string

    Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.

    accountName - stringrequired

    Lucidworks AI API Account Name as defined in AI Gateway Service. This entry should match the account name set in the AI Gateway.

    useCase - stringrequired

    Lucidworks AI Use Case as defined in documentation

    modelName - stringrequired

    Lucidworks AI Model as defined in documentation

    inputContextVariable - stringrequired

    Name of the variable in context to be used as input. Supports template expressions.

    outputContextVariable - string

    The name here is used to populate two things with the prediction results: 1) The field name in the document that will contain the prediction, and 2) The name of the context variable that will contain the prediction.

    useCaseConfig - array[object]

    Additional Use Case keys and values to be sent to Lucidworks AI

    object attributes:{key required : {
     display name: Parameter Name
     type: string
    }    value : {
     display name: Parameter Value
     type: string
    }    }

    modelConfig - array[object]

    Additional Model configuration parameters to be sent to Lucidworks AI

    object attributes:{key required : {
     display name: Parameter Name
     type: string
    }    value : {
     display name: Parameter Value
     type: string
    }    }

    apiKey - string

    Secret associated with the model. For example, for OpenAI models, the value would start with 'sk-'.

    callAsynchronously - boolean

    Flag to indicate if this stage should call the Lucidworks AI API asynchronously or synchronously. Defaults to true.

    Default: true

    maxTries - integer

    The maximum number of attempts to issue an asynchronous Lucidworks AI API call

    >= 1

    exclusiveMinimum: false

    Default: 1

    failOnError - boolean

    Flag to indicate if this stage should throw an exception if an error occurs while generating a prediction for a document.

    Default: false