Configure the LWAI Neural Hybrid Search pipelineLucidworks AI

In the Label field, enter a unique identifier for this stage or leave blank to use the default value.

In the Condition field, enter a script that results in true or false, which determines if the stage should process, or leave blank.

In the Tagger Collection field, enter where the tagger request is sent. The default is the query_rewrite collection for the application selected. You must enter a collection with only one shard because Text Tagger does not support multi-shard collections. Template expressions are supported.

In the Param to Tag field, enter a value of q, which is the name of the parameter in the request containing text to tag. This field is ignored on DSL requests.

In the Save Tags in Context field, enter the tags to save in context instead of applying directly to the incoming query in this stage. This enables downstream stages to apply the tags after completing other processing. This field is ignored on DSL requests.

Select the following checkboxes:

In the Filter Override field, enter your filter to override filtering for built-in tagger doc types.

In the Original Term Boost for Synonyms field, enter the boost to use for the original term during synonym expansion. For example, 2. To disable this function, enter -1.

In the Default Phrase Boost field, enter the boost to use as a default for phrases that do not have a boost value set. For example, 2. To disable this function, enter -1.

In the Default Phrase Slop field, enter the distance between the terms of the query while still considering it a phrase match. For example, 10.

In the Overlapping Tag Policy field, select the default value of longest_dominant_right to ensure the retained tags have no overlaps. The value is the algorithm that determines which tags in an overlapping set should be retained, versus being pruned away. On DSL requests, this field is ignored so the default value of longest_dominant_right is always used. The available options correspond to Solr Tagger Handler overlaps: all, no_sub, or longest_dominant_right. Setting the value to all or no_sub allows more rewrites to potentially be applied to a query, but can increase the chance of producing undesirable rewrites.

In the Additional Params to be included in the Text Tagger Request section, enter optional values you want to include.

In the Max Wait for Lookup (ms) field, enter the number of milliseconds to wait for the call to the remote tagger collection to return. For example, 500. To disable this function, enter -1.

In the Skip Query Regex field, enter the pattern that identifies queries that are skipped because they contain that pattern. For example, you may want to skip single term queries with wildcards.

Click Save.

In the Label field, enter a unique identifier for this stage or leave blank to use the default value.

In the Condition field, enter a script that results in true or false, which determines if the stage should process, or leave blank.

Select the Asynchronous Execution Config check box to process this stage asynchronously.

In the Number of Recommendations field, enter the number of documents to return in the query. For example, 10.

In the Number of Signals field, enter the number of signals to process when getting recommended items. For example, 100.

In the Aggregation Type field, enter an applicable value. For example, click@doc_id,filters,query.

In the Solr Field to Boost On field, enter which Solr field to use when applying recommendation boosts. For example, id.

In the Boost Method field, select the boost method to use. If the defType!=edismax for the main query, select query-parser. Another example is query-param.

In the Boost Param field, select one of the following values:

In the Solr Query parameters section, enter the following Parameter Name:Parameter Value entries:

In the Rollup Field, enter the field name to use when rolling up documents that have the same doc id. For example, doc_id_s.

In the Rollup weight field, enter the field name to use for signal weights. For example, weight_d.

In the Rollup weight strategy field, select one of the following methods to use when rolling up the weight:

In the Final Boost Weight Expression field, enter the optional expression to compute the final boost weight using a combination of fields returned by Solr. For example, score and weight_d. Set to weight_d for similar behavior as older versions. Another example is math:log(weight_d + 1) + 10 * math:log(score+1).

In the Document Weights Context Key field, enter the context key in which to save boosts for docId:weight_d.

In the Query Param field, enter the default value of q, which is the name of the parameter in the request containing query to boost.

Select the Include Enriched Query checkbox to:

In the Update Policy field, select to replace or append the boost parameter in the final query.

Click Save.

In the Label field, enter a unique identifier for this stage or leave blank to use the default value.

In the Condition field, enter a script that results in true or false, which determines if the stage should process, or leave blank.

In the Number of Results field, enter the number of query fields to return. For example, 10.

In the Result Offset field, enter the value that designates the starting position of the first result from the beginning of the data being queried. Offset is zero-based, so a value of 9 counts from 0 through 9 and the first record returned is the 10th record discovered in the query.

In the Results Sort Order section, enter values for the following fields:

In the Search Fields section, enter the field name and boost values to include in this stage.

In the Return Fields section, enter the field names to include in this stage.

Select the Return Score checkbox to set as true and determine if a score is determined for this stage.

In the Minimum Should Match field, enter the minimum string to match for this stage.

Select the Grouping Options checkbox to enter values in the following fields:

Click Save.

In the Label field, enter a unique identifier for this stage or leave blank to use the default value.

In the Condition field, enter a script that results in true or false, which determines if the stage should process, or leave blank.

Select the Account Name from the dropdown list. If Lucidworks AI is configured, your account name appears in this list.

Select the Model from the dropdown list to use for encoding. For more information, see:

In the Query Input field, enter the location from which the query is retrieved.

In the Output Context Variable field, enter the name of the variable where the vector value from the response is saved.

In the Use Case Configuration section, click the + sign to enter the parameter name and value to send to Lucidworks AI. The useCaseConfig parameter that is common to embedding use cases is dataType, but each use case may have other parameters. The value for the query stage is query.

The Model Configuration section is not applicable to vector search.

Select the Fail on Error checkbox to generate an exception if an error occurs during this stage.

Click Save.

In the Label field, enter a unique identifier for this stage or leave blank to use the default value.

In the Condition field, enter a script that results in true or false, which determines if the stage should process, or leave blank.

In the Lexical Query Input field, enter the location from which the lexical query is retrieved. For example, <request.params.q>. Template expressions are supported.

In the Lexical Query Weight field, enter the relative weight of the lexical query. For example, 0.3. If this value is 0, no re-ranking will be applied using the lexical query scores.

In the Number of Lexical Results field, enter the number of lexical search results to include in re-ranking. For example, 1000. A value is 0 is ignored.

In the Vector Query Field, enter the name of the Solr field for k-nearest neighbor (KNN) vector search.

In the Vector Input field, enter the location from which the vector is retrieved. Template expressions are supported. For example, a value of <ctx.vector> evaluates the context variable resulting from a previous stage, such as the LWAI Vectorize Query stage.

In the Vector Query Weight field, enter the relative weight of the vector query. For example, 0.7.

Select the Use KNN Query checkbox to use the knn query parser and configure its options. This option cannot be selected if Use VecSim Query checkbox is selected. In addition, Use KNN Query is used if neither Use KNN Query or Use VecSim Query is selected.

Select the Use VecSim Query checkbox to use the vecSim query parser and configure its options. This option cannot be selected if Use KNN Query checkbox is selected.

In the Minimum Vector Similarity Filter, enter the value for a minimum similarity threshold for filtering documents. This option applies to all documents, regardless of other score boosting such as rules or signals.

Click Save.

In the Label field, enter a unique identifier for this stage or leave blank to use the default value.

In the Condition field, enter a script that results in true or false, which determines if the stage should process, or leave blank.

Select the Asynchronous Execution Config check box to process this stage asynchronously.

In the Collection field, enter the name of the collection that contains the rules. If this field does not contain a value, the default rules collection for the selected application is used. Template expressions are supported.

In the Request Handler field, enter a value of select.

In the HTTP Method field, select POST.

In the Rule Triggering Limit field, enter the maximum number of business rules to be triggered by the query. The default rules matching limit is 100. This configuration overwrites the rows parameter set in Query Parameters section.

In the Query Parameters section, enter the names and values to use when querying the rules collection. If you set the rows parameter here, it will be overwritten by the configuration in the Rule Triggering Limit field.

In the Subquery Rewrite Pipeline id field, enter the value to call a Fusion query pipeline to modify the rule-retrieving subquery. Template expressions are supported.

In the Headers section, enter the names and values to use in this stage.

Select the Use Original Query If No Rules Match checkbox so the stage will try to match rules using the original query (un-tagged) sent into the Text Tagger stage, if available.

Select the Partially Matched Filter Queries Will Trigger the Rule checkbox so the stage will trigger filter rules as long as there is one filter query in the query parameter that matches the filter specified in the rule.

In the Max Wait for Lookup (ms), enter the number of milliseconds to wait for the the call to the remote tagger collection to return. For example, 500. To disable this function, enter -1.

Click Save.

In the Label field, enter a unique identifier for this stage or leave blank to use the default value.

In the Condition field, enter a script that results in true or false, which determines if the stage should process, or leave blank.

In the Configure Request Handlers Allowed for Queries section, enter a value for the request handlers used in this stage.

In the HTTP Method field, select POST.

Select the Allow Federated Search checkbox to enable the use of Solr collection and shards parameters for this stage.

Select the Generate Response Signal checkbox to generate a response signal containing metadata about the response from Solr. Response signals are used by App Insights and experiments. This setting only applies if the searchLogs and signals features are enabled for the collection. To avoid generating response signals as Users type, do not select this option.

In the Exclude Response Signal Criteria section, enter query parameters and Regex patterns to prevent generating a response signal based on specific parameters in the query. For example, use these fields to enable response signals in general, but to disable for auto-complete queries.

In the Preferred Replica Type field, select pull to specify a replicate type that will be given a higher order of precedence when querying Solr. This preference will only be applied for queries that target multiple shards.

Click Save.

In the Label field, enter a unique identifier for this stage or leave blank to use the default value.

In the Condition field, enter a script that results in true or false, which determines if the stage should process, or leave blank.

In the Facet Field Label Blob ID, enter the ID for a blob containing labels for facet fields to add to the response.

In the Facet Label Parse Delimiter field, enter || as the delimiter to parse each facet label mapping in the blob. A Java regular expression is also a valid value. Regex must start with ^ and end with $.

Click Save.