Product Selector

Fusion 5.9
    Fusion 5.9

    Lucidworks AI Vectorize FieldLucidworks AI

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

    More detailed information to configure this stage is in Configure Neural Hybrid Search.

    Configurable vector quantization method

    In Fusion 5.9.13 and up, you can configure the vector quantization method. Quantization converts high-precision float vectors into compact 8-bit integer vectors, significantly lowering storage and compute costs. By default, no quantization is performed; you enable it by selecting a method.

    To select the quantization method, go to Model Configuration in the stage configuration and enter the vectorQuantizationMethod parameter with the value for the desired method:

    Vector quantization method configuration in an LWAI pipeline stage

    Available methods are:

    • min-max creates tensors of embeddings and converts them to uint8 by normalizing them to the range [0, 255].

      This method loses precision when evaluated against non-quantized vectors. Test it against your data to see if the loss is acceptable.

    • max-scale finds the maximum absolute value along each embedding, normalizes the embeddings by scaling them to a range of -127 to 127, and returns the quantized embeddings as an 8-bit integer tensor.

      This method has no loss at the ten-thousandths place during evaluation against non-quantized vectors.

    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