Product Selector

Fusion 5.12
    Fusion 5.12

    LWAI Vectorize FieldLucidworks AI

    Table of Contents

    This feature is currently only available to clients who have contracted with Lucidworks for features related to Neural Hybrid Search and Lucidworks AI.

    This feature is only available in Managed Fusion 5.9.5.

    Lucidworks AI Vectorize Field is a Fusion index pipeline stage that invokes a Lucidworks AI model to encode a string field to a vector representation.

    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 Lucidworks AI vector search.

    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.

    Invokes a Lucidworks AI model to encode a string field to a vector representation. Will be skipped if the field to encode doesn't exist or is null on the pipeline document.

    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 Lucidworks AI Gateway Service. This entry should match the account name set in the LWAI Gateway.

    modelType - stringrequired

    Lucidworks AI API model to use for encoding.

    sourceFieldName - stringrequired

    Name of the string field whose value should be submitted to the model for encoding. If the field doesn't exist or is null in the pipeline document, this stage will be skipped. Supports Template Expressions, e.g. <doc.title_t> and <ctx.myVar>.

    destinationFieldName - stringrequired

    Name of the field into which the dense vector value from the model response will be saved.

    useCaseConfig - array[object]

    Default: {"key":"dataType","value":"passage"}

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

    modelConfig - array[object]

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

    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