Oracle Commerce Guided Search - Oracle Commerce Query Language interaction with other features

Oracle Commerce Query Language interaction with other features

Because EQL is a filtering language, it does not contain functionality to perform actions such as triggering Content Spotlighting, sorting, or relevance ranking.

However, EQL is compatible with other query parameters to provide these features for queries. A brief summary of these interactions is:

Nrs is freely composable with the N, Ntt, Nr, and Nf filtering parameters. EQL filtering can be conceptualized as occurring after record filtering in terms of side-effects such as spelling auto-correction. This means that a record search within EQL, using the endeca:matches() function, cannot auto-correct to a spelling suggestion outside of the record filter.
Ordering and relevance ranking parameters (Ns, Nrk, Nrt, Nrr, Nrm) are composable with EQL filters or other types of filters. The Nrk, Nrt, Nrr, and Nrm relevance ranking parameters take precedence over a relevance ranking declaration with the Ntt and Ntx parameters.

The following table provides an overview of these interactions. The sections after the table provide more information.

Parameter	Similar function in EQL?	Why use this parameter rather than Nrs?	Parameter interaction
`N`	Yes. Dimension filtering can be done in EQL.	Use `N` to trigger Content Spotlighting and refinement generation.	The results of `Nrs` are intersected with the results of `N`.
`Nr`	Yes. EQL can filter on properties or dimensions.	Use `Nr` for security reasons or to explicitly exclude certain records from being considered in the rest of the query (e.g., for spelling suggestions).	`Nr` is a pre-filter. Only the records that pass this filter are even considered in `Nrs`.
`Ntt, Ntk`	Yes. EQL provides the ability to do record search.	Use `Ntt/Ntk` to trigger Content Spotlighting, as record search within `Nrs` does not trigger it. Use `Ntt/Ntk` with `Nty` for DYM spelling suggestions. (`Nrs` record search does support autocorrection, but not DYM.)	Similar to `N` , the results of `Nrs` are intersected with the results of `Ntt/Ntk`.
`Nf`	Yes. EQL provides the ability to do range filtering.	No reason to do so. EQL actually provides greater flexibility because range filters within `Nrs` can be OR’ed, whereas `Nf` range filters cannot. Similar to `N`, the results of `Nrs` are intersected with the results of `Nf`.	Similar to `N`, the results of `Nrs` are intersected with the results of `Nf`.
`Ns`	No. EQL does not have the ability to sort results.	N/A	As long as the property specified in `Ns` exists on the records being returned, the `Ns` parameter will sort the results.
`Ne`	No. EQL does not have the ability to expose dimensions.	N/A	As long as the dimensions specified in `Ne` exist on the records being returned, the `Ne` parameter will expose those dimensions.
`Nrk, Nrt, Nrr, Nrm`	No. EQL does not provide the ability to relevance rank the results.	N/A	This set of parameters allow the ability to apply relevance ranking to results even if record search does not exist.
`Nrc`	No. EQL does not provide the ability to modify refinement configuration.	N/A	The `Nrc` parameter lets you modify refinement configuration at query time (for dynamic ranking, statistics, and so on).

Parameter

Similar function in EQL?

Why use this parameter rather than Nrs?

Parameter interaction

N

Yes. Dimension filtering can be done in EQL.

Use N to trigger Content Spotlighting and refinement generation.

The results of Nrs are intersected with the results of N.

Nr

Yes. EQL can filter on properties or dimensions.

Use Nr for security reasons or to explicitly exclude certain records from being considered in the rest of the query (e.g., for spelling suggestions).

Nr is a pre-filter. Only the records that pass this filter are even considered in Nrs.

Ntt, Ntk

Yes. EQL provides the ability to do record search.

Use Ntt/Ntk to trigger Content Spotlighting, as record search within Nrs does not trigger it. Use Ntt/Ntk with Nty for DYM spelling suggestions. (Nrs record search does support autocorrection, but not DYM.)

Similar to N , the results of Nrs are intersected with the results of Ntt/Ntk.

Nf

Yes. EQL provides the ability to do range filtering.

No reason to do so. EQL actually provides greater flexibility because range filters within Nrs can be OR’ed, whereas Nf range filters cannot. Similar to N, the results of Nrs are intersected with the results of Nf.

Similar to N, the results of Nrs are intersected with the results of Nf.

Ns

No. EQL does not have the ability to sort results.

N/A

As long as the property specified in Ns exists on the records being returned, the Ns parameter will sort the results.

Ne

No. EQL does not have the ability to expose dimensions.

N/A

As long as the dimensions specified in Ne exist on the records being returned, the Ne parameter will expose those dimensions.

Nrk, Nrt, Nrr, Nrm

No. EQL does not provide the ability to relevance rank the results.

N/A

This set of parameters allow the ability to apply relevance ranking to results even if record search does not exist.

Nrc

No. EQL does not provide the ability to modify refinement configuration.

N/A

The Nrc parameter lets you modify refinement configuration at query time (for dynamic ranking, statistics, and so on).

Oracle Commerce Query Language interaction with other features

MDEX Engine Developer's Guide