Apply Rules Stage

Configuration

This stage looks up rules that have been deployed to the _query_rewrite collection and matches them against the query. Matching rules that perform query rewriting are applied at this stage, while matching rules that perform response rewriting are applied by the Modify Response with Rules stage later in the pipeline.

See Rules for additional details about how to configure this set of features.

This stage supports asynchronous processing.

Note	Although this stage is available without a Fusion AI license, it is only effective after creating rules in Fusion AI.

Configuration

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

When using Fusion's REST API, the type for this stage is: query-rules.

Property Description, Type

asyncConfig

Asynchronous Execution Config

type: object

object attributes: {
  asyncId : {
    display name: Async ID
    type: string
    description : A unique value to use as reference in downstream "Merge Async Results" stages.
    }
  enabled : {
    display name: Enable Async Execution
    type: boolean
    default value: 'false'
    description : Run the expensive data loading or processing part of this stage in a separate thread allowing the pipeline to continue executing. The results of this asynchronous execution can be merged into the pipeline request using a downstream "Merge Async Results" stage.
    }
  }

collection

Collection

The collection to read rules from. Leave blank to use the default rules collection for the current application.

type: string

handler

Request Handler

required

type: string

default value: 'select'

headers

Headers

type: array of object

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

hierarchicalFilter

Hierarchical Filter

Specify hierarchical filter and delimiter, e.g. category: clothing/dress/cocktail

type: array of object

object attributes: {
  delimiter (required) : {
    display name: Field Delimiter
    type: string
    }
  field (required) : {
    display name: Field Name
    type: string
    }
  }

matchPartialFilterQueries

Partially Matched Filter Queries Will Trigger the Rule

If checked, then this 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.

type: boolean

default value: 'true'

method

HTTP Method

required

type: string

default value: 'POST'

enum: { GET POST }

params

Query Parameters

Additional query parameters to use when querying the rules collection. NOTE: "rows" parameter set here will be overwritten by the config in "Rule Triggering Limit" section

type: array of object

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

ruleLimit

Rule Triggering Limit

Max number of business rules to be triggered by the same query. The default rules matching limit is 100. This config overwrites "rows" param set in "Query Parameters" section

type: string

default value: '100'

subqueryRewritePipelineId

Subquery Rewrite Pipeline Id

Option to call a Fusion query pipeline to modify rule-retrieving subquery

type: string

useEmbeddedSolrServer

Use Embedded Solr

If checked, then this stage will load the remote tagger collection into an embedded Solr to perform the lookup in memory. Only use this option if the tagger collection fits in the memory available to the Fusion API service.

type: boolean

default value: 'false'

useOriginalQueryIfNoRulesMatch

Use Original Query If No Rules Match

If checked, then this stage will try to match rules using the original query (un-tagged) sent into the tagger stage if available.

type: boolean

default value: 'true'