Product Selector

Fusion 5.9
    Fusion 5.9

    Lucidworks AI Prediction index stageLucidworks AI

    Table of Contents
    This article describes a beta feature

    This is draft documentation for a feature in our beta program. Documentation for this feature may contain outdated or inaccurate information. This article will not appear in search results.

    Consult with your Lucidworks representative for any questions or comments about the feature. To leave feedback about the documentation, click the Feedback button and follow the prompts.

    The Lucidworks AI Prediction index stage is a general purpose integration between Fusion and Lucidworks AI.

    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 Lucidworks AI 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 the Lucidworks AI Gateway service when this stage is configured.

    More detailed information to configure this stage is in Configure the Lucidworks AI Prediction index stage.

    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.

    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

    useCase - stringrequired

    Lucidworks AI Use Case as defined in documentation

    modelName - stringrequired

    Lucidworks AI Model Name as defined in Lucidworks AI Models

    inputContextVariable - stringrequired

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

    outputContextVariable - stringrequired

    Name of the variable in context to be used by this stage as output. Supports template expressions.

    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-'.

    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