Paramètres avancés liés à la recherche

Les paramètres décrits ci-dessous sont spécifiés dans fess_config.properties. Un redémarrage de Fess est nécessaire après modification.

Recherche floue

Une recherche floue est appliquée aux mots-clés de 4 caractères ou plus, ce qui permet de trouver des correspondances avec une différence d’un caractère. Pour désactiver ce paramètre, spécifiez -1.

La valeur initiale est 4. Pour les paramètres détaillés de la recherche floue, consultez la section « Paramètres de pertinence (boost) » ci-dessous.

Valeur du délai d’expiration lors de la recherche

Vous pouvez spécifier la valeur du délai d’expiration lors de la recherche en millisecondes. La valeur initiale est de 10 secondes (10000 millisecondes).

Nombre maximum de caractères lors de la recherche

Vous pouvez spécifier le nombre maximum de caractères de la requête de recherche. Les requêtes dont la longueur dépasse cette valeur ne sont pas acceptées. La valeur initiale est de 1000 caractères.

Journalisation du délai d’expiration lors de la recherche

Indique si les recherches dont les résultats sont incomplets, parce que le délai d’expiration de la requête a été dépassé ou qu’un shard a échoué, sont journalisées. Lorsque ce paramètre est activé, une ligne de journal de niveau WARN est écrite dans les cas suivants :

[SEARCH TIMEOUT] : le délai d’expiration de la requête (query.timeout) a été dépassé et le moteur de recherche a cessé de collecter les résultats.
[SEARCH SHARD FAILURE] : un ou plusieurs shards ont échoué.

Si les deux se produisent, les deux lignes sont écrites. Chaque ligne contient exec_time (millisecondes), la requête et la réponse complète. En cas d’échec d’un shard, la cause figure dans _shards.failures de cette réponse ; le moteur de recherche lui-même ne la journalise qu’au niveau DEBUG. La valeur initiale est true (activé).

Affichage du nombre de correspondances

Spécifie la limite supérieure du nombre de correspondances comptabilisé avec précision. Par défaut, lorsque plus de 10 000 résultats sont trouvés, l’affichage est le suivant :

Résultats de recherche pour xxxxx environ 10 000 ou plus 1 - 10 sur (4.94 secondes)

Si l’affichage du nombre exact de correspondances supérieur à 10 000 est nécessaire, spécifiez une valeur plus grande.

Note

La définition d’une valeur élevée peut affecter les performances de recherche. Définissez une valeur appropriée en fonction de l’utilisation.

Décalage maximum des résultats de recherche

Spécifie la limite supérieure du décalage (position de départ de la recherche) pouvant être obtenu comme résultat de recherche. Si un décalage supérieur à cette valeur est spécifié, la recherche génère une erreur. Cette valeur fonctionne comme limite supérieure lors de la navigation vers des pages profondes par pagination. La valeur initiale est 100000.

Seuil de relance de recherche par opérateur OR

Si le nombre de correspondances lors d’une recherche normale est inférieur ou égal à la valeur spécifiée ici, la recherche est relancée avec l’opérateur OR. Cela permet de compléter les résultats même lorsque la recherche AND renvoie peu de correspondances. La valeur initiale est -1, ce qui désactive cette fonctionnalité.

Nom du champ lors de la recherche par géolocalisation

Spécifie le nom du champ cible lors de la recherche par géolocalisation. Pour spécifier plusieurs champs, séparez-les par des virgules. La valeur initiale est location.

Pour plus d’informations sur l’utilisation de la recherche par géolocalisation, consultez Recherche par géolocalisation.

Spécification de langue dans les paramètres de requête

Spécifie le nom du paramètre pour définir la langue dans les paramètres de requête. Par exemple, en passant browser_lang=en dans l’URL comme paramètre de requête, la langue d’affichage de l’écran passe à l’anglais.

Langue par défaut pour la recherche

Spécifie la langue par défaut ciblée lors de la recherche, séparée par des virgules. Si une valeur est définie, elle est utilisée en priorité par rapport à la langue du paramètre de requête ou du navigateur. La valeur initiale est vide (non spécifiée), et la langue du paramètre de requête ou du navigateur est utilisée.

Correspondance des codes de langue

Spécifie la correspondance de normalisation des codes de langue utilisés lors de la recherche. Convertit les codes de langue transmis par le navigateur ou la requête vers les codes de langue utilisés en interne par Fess. En règle générale, aucune modification n’est nécessaire. Les correspondances des principales langues sont définies dans les valeurs initiales.

Spécification de la recherche par préfixe

Si le terme de recherche est suivi de * (ex. : recherche*), ce terme est recherché en tant que requête de préfixe. La valeur initiale est true (activé). En spécifiant false, les termes se terminant par * sont recherchés tels quels.

Chaînes de mise en surbrillance

Les phrases sont délimitées par les chaînes spécifiées ici pour obtenir un affichage de surbrillance naturel. Les chaînes spécifiées sont des caractères Unicode avec u comme délimiteur de début.

La valeur initiale est définie comme suit (après décodage) :

! , . ? ։ ؟ ۔ ܀ ܁ ܂ । ၊ ။ ። ፧ ፨ ᙮ ᠃ ᠉ ‼ ‽ ⁇ ⁈ ⁉ 。 ﹒ ﹗ ！．？｡

Fragments de mise en surbrillance

Spécifie le nombre de caractères des fragments de mise en surbrillance récupérés d’OpenSearch et le nombre de fragments.

Méthode de génération de la mise en surbrillance

Spécifie la méthode de génération de la mise en surbrillance dans OpenSearch.

Balises cibles de mise en surbrillance

Spécifie les balises de début et de fin des cibles de mise en surbrillance.

Valeurs transmises au surligneur d’OpenSearch

Spécifie les valeurs transmises au surligneur d’OpenSearch.

Paramètres avancés de surlignage

Paramètres pour contrôler le comportement détaillé du surlignage.

query.highlight.force.source=false
query.highlight.fragmenter=span
query.highlight.fragment.offset=-1
query.highlight.no.match.size=0
query.highlight.order=score
query.highlight.phrase.limit=256
query.highlight.content.description.fields=hl_content,digest
query.highlight.boundary.position.detect=true
query.highlight.text.fragment.type=query
query.highlight.text.fragment.size=3
query.highlight.text.fragment.prefix.length=5
query.highlight.text.fragment.suffix.length=5

Noms de champs à ajouter à la réponse

Spécifie les noms de champs à ajouter à la réponse lors d’une recherche normale ou d’une recherche API. Correspond respectivement à la réponse lors d’une recherche normale, d’une recherche API (JSON/GSA), d’une recherche par défilement et de l’affichage du cache.

Note

query.additional.api.response.fields ne fait qu’ajouter des champs à la liste des champs autorisés dans la réponse de l’API de recherche (/api/v2/search). À lui seul, il ne fait pas apparaître un champ dans la réponse. L’API de recherche récupère auprès du moteur de recherche les mêmes champs qu’une recherche normale, y compris ceux de query.additional.response.fields, et ne renvoie que les champs récupérés qui figurent dans cette liste. Pour inclure un champ personnalisé dans la réponse de l’API de recherche, indiquez le même nom de champ dans les deux paramètres.

Pour plus de détails sur les champs de réponse de la recherche par défilement, consultez Récupération en masse des résultats de recherche.

Ajout de noms de champs

À spécifier lors de l’ajout de noms de champs de recherche, de noms de champs de facettes, de noms de champs de tri, etc.

query.additional.default.fields=
query.additional.search.fields=
query.additional.facet.fields=
query.additional.sort.fields=
query.additional.highlighted.fields=
query.additional.analyzed.fields=
query.additional.not.analyzed.fields=

La signification de chaque paramètre est la suivante :

Paramètre	Description
`query.additional.default.fields`	Ajoute aux champs par défaut ciblés par les requêtes sans spécification de champ.
`query.additional.search.fields`	Ajoute aux champs pouvant être recherchés avec une spécification de champ.
`query.additional.facet.fields`	Ajoute aux champs pouvant être utilisés comme facettes.
`query.additional.sort.fields`	Ajoute aux champs pouvant être utilisés comme critères de tri.
`query.additional.highlighted.fields`	Ajoute aux champs ciblés par la mise en surbrillance.
`query.additional.analyzed.fields`	Ajoute aux champs traités comme sujets à l’analyse par l’Analyzer.
`query.additional.not.analyzed.fields`	Ajoute aux champs non soumis à l’analyse par l’Analyzer.

Utiliser un champ personnalisé pour les facettes, le tri et la recherche par plage

Un champ ajouté par un script de banque de données ou par une configuration d’exploration, comme category ou price, n’a pas de définition dans le mapping de l’index. OpenSearch en crée une à partir de la première valeur qu’il indexe pour ce champ :

Une chaîne devient un champ text, avec un sous-champ keyword nommé <field>.keyword (les chaînes de plus de 256 caractères ne sont pas stockées dans le sous-champ).
Un nombre devient un champ numérique : long pour un nombre entier, float pour un nombre à virgule. Le moteur JavaScript transmet tous les nombres sous forme de valeurs à virgule flottante : une valeur convertie avec parseInt devient donc elle aussi float.

Chaque usage nécessite le bon champ :

Usage	Champ à utiliser	Paramètre
Facette	`<field>.keyword`. Une facette sur le champ `text` lui-même échoue avec `400`.	`query.additional.facet.fields`
Tri	Un champ numérique (ou date). La valeur de tri est `<field>.asc` ou `<field>.desc` : un nom de champ contenant un point, comme `<field>.keyword`, ne peut donc pas servir au tri, et un tri sur un champ `text` échoue avec `400`.	`query.additional.sort.fields`
Recherche par plage	Un champ numérique (ou date). Sur un champ de type chaîne, les bornes sont comparées comme du texte : `price:[1000 TO 5000]` correspond aussi à `120000`, sans erreur.	`query.additional.search.fields`. Un champ qui n’y figure pas n’est pas du tout recherché par plage.

Une valeur lue depuis un CSV, du JSON ou une base de données est une chaîne, sauf si le script la convertit : convertissez donc les valeurs que vous souhaitez trier ou rechercher par plage. Avec le moteur JavaScript, utilisé par défaut par les configurations de banque de données créées en 15.9 (script_type=javascript) :

Définissez un champ numérique dans le mapping de l’index avant d’indexer le premier document qui le contient. Le type float créé sinon ne conserve qu’environ sept chiffres significatifs, et un nombre entier supérieur à 16 777 216 peut être arrondi à une valeur voisine : un document dont le price vaut 20000001 correspond à price:[20000000 TO 20000000], et le tri ne peut pas les distinguer. Utilisez long pour les nombres entiers et double pour les nombres décimaux.

Ajoutez le champ à l’index de documents actuel via l’alias fess.update.

Ajoutez la même définition sous properties dans app/WEB-INF/classes/fess_indices/fess/doc.json de l’installation, afin qu’un index de documents que Fess crée plus tard (au premier démarrage sur un cluster vide, ou par une réindexation depuis la page Maintenance) la contienne aussi. Une mise à niveau remplace doc.json par le fichier de la nouvelle version : ajoutez de nouveau la définition après la mise à niveau.
```
"properties": {
  "price": {
    "type": "long"
  },
  "anchor": {
    "type": "keyword"
  },
  ...
```

Listez ensuite les champs dans fess_config.properties et redémarrez Fess :

Les champs peuvent alors être utilisés via l’API de recherche :

Note

Le type d’un champ est fixé lors de l’indexation du premier document qui le contient, et l’API de mapping ne peut plus le modifier ensuite. Pour changer le type d’un champ déjà indexé, comme chaîne ou comme float, ajoutez la définition à doc.json comme à l’étape 2 ci-dessus, puis lancez une réindexation depuis la page Maintenance avec « Mise à jour de l’alias » activée. Les documents sont copiés dans un nouvel index créé à partir de doc.json.

Note

L’écran de recherche fourni avec Fess (le thème statique bootstrap) n’affiche que la facette label (et les requêtes de facettes de query.facet.queries), et son menu de tri ne propose que les champs standard. Les facettes sur d’autres champs sont disponibles via l’API ou dans votre propre thème. Une recherche par plage, ainsi qu’un tri écrit dans la zone de recherche sous la forme sort:price.desc, fonctionnent également sur l’écran de recherche.

Regroupement (collapse) des documents similaires

Paramètres de la fonctionnalité collapse qui regroupe les documents similaires (quasi-doublons) par le champ content_minhash_bits. query.collapse.inner.hits.name est le nom du champ dans les résultats de recherche où sont stockés les documents similaires, query.collapse.inner.hits.size est le nombre de documents similaires récupérés par groupe (0 signifie aucune récupération), query.collapse.inner.hits.sorts est la condition de tri lors de la récupération des documents similaires, query.collapse.max.concurrent.group.results représente le nombre maximum de requêtes simultanées lors de la récupération des groupes.

Préférence de recherche

Spécifie la préférence (valeur déterminant le shard sur lequel effectuer la recherche) transmise à OpenSearch lors d’une recherche API au format JSON. En spécifiant _query, la valeur de hachage de la requête de recherche est utilisée comme préférence, ce qui oriente les requêtes identiques vers le même shard. La valeur initiale est _query.

Paramètres de pertinence (boost)

Spécifie les valeurs de boost utilisées pour le calcul de la pertinence (score) lors de la recherche. Les paramètres avec .lang correspondent aux valeurs de boost pour les champs par langue (ex. : content_ja).

Les valeurs de boost et le comportement de la recherche floue sont spécifiés ci-dessous. query.boost.fuzzy.min.length est le nombre minimum de caractères pour appliquer la recherche floue (-1 pour désactiver).

query.boost.fuzzy.min.length=4
query.boost.fuzzy.title=0.01
query.boost.fuzzy.title.fuzziness=AUTO
query.boost.fuzzy.title.expansions=10
query.boost.fuzzy.title.prefix_length=0
query.boost.fuzzy.title.transpositions=true
query.boost.fuzzy.content=0.005
query.boost.fuzzy.content.fuzziness=AUTO
query.boost.fuzzy.content.expansions=10
query.boost.fuzzy.content.prefix_length=0
query.boost.fuzzy.content.transpositions=true

Paramètres du type de requête

Spécifie le type de requête utilisé lors de la recherche et son comportement détaillé. query.default.query_type est le type de requête utilisé par défaut, query.dismax.tie_breaker est la valeur du tie breaker pour la requête dismax, query.bool.minimum_should_match est la valeur minimum_should_match pour la requête bool (non spécifiée si vide).

Paramètres détaillés de la recherche par préfixe et de la recherche floue

Spécifie le comportement détaillé des requêtes de préfixe et des requêtes floues.

Paramètres des facettes

Spécifie le comportement par défaut de la recherche par facettes. query.facet.fields est le champ cible des facettes, query.facet.fields.size est la limite supérieure du nombre de facettes récupérées, query.facet.fields.min_doc_count est le nombre minimum de documents à afficher dans les facettes, query.facet.fields.sort est l’ordre de tri des facettes, query.facet.fields.missing est la valeur attribuée aux documents sans valeur.

L’écran de recherche fourni avec Fess ne demande que la facette label, quelle que soit la valeur de query.facet.fields ; voir Utiliser un champ personnalisé pour les facettes, le tri et la recherche par plage.

Paramètres pour obtenir les résultats de recherche au format XML compatible GSA

Utilisé lors de l’obtention des résultats de recherche au format XML compatible GSA.

Spécifie les noms de champs à ajouter à la réponse lors de l’utilisation du format XML compatible GSA.

Spécifie la langue lors de l’utilisation du format XML compatible GSA.

Spécifie le tri par défaut lors de l’utilisation du format XML compatible GSA.

Spécifie le préfixe des métadonnées lors de l’utilisation du format XML compatible GSA.

Spécifie le champ charset lors de l’utilisation du format XML compatible GSA.

Spécifie le champ content_type lors de l’utilisation du format XML compatible GSA.

Spécifie la préférence par défaut lors de l’utilisation du format XML compatible GSA.