searchCorrect
Suggestions de correction des fautes de frappe d'une requête, d'après le dictionnaire de recherche du projet.
Description
Renvoie la forme corrigée d'une requête sans lancer la recherche, pour qu'une vitrine puisse proposer une suggestion « vouliez-vous dire » (GET /api/content/search/correct). Se résout en ISearchCorrectResponse : la requête d'origine, la requête corrigée (null quand il n'y a rien à corriger) et une ventilation par mot.
Chaque token porte from et to ; to vaut null pour un mot laissé tel quel. Les champs de score (distance, docFreq, reason) ne sont présents que pour un mot réellement corrigé.
.searchCorrect(
,
,
);
Schéma des paramètres
Schéma
query(required): string
Requête à corriger.
exemple : "fish ladr"
langCode: string
Code de langue. Par défaut : "en_US". Le dictionnaire est propre à chaque langue.
exemple : "en_US"
scope: string
Ensemble d'enregistrements d'où provient la correction. Omis signifie tout le projet.
Exemples
Exemple minimal
const response = await Search.searchCorrect('prodct');
Suggestion « vouliez-vous dire »
const result = await Search.searchCorrect('fish ladr');
if ('statusCode' in result) {
console.error(result.message);
} else if (result.corrected) {
// Proposez la requête corrigée à l'utilisateur, puis lancez la recherche dessus.
console.log(`Vouliez-vous dire : ${result.corrected} ?`);
const products = await Search.globalSearch(result.corrected, ['products'], 'visible');
}
Exemple de réponse
{
"query": "fish ladr",
"corrected": "fish ladder",
"tokens": [
{
"from": "fish",
"to": null
},
{
"from": "ladr",
"to": "ladder",
"distance": 2,
"docFreq": 8,
"reason": "docFreq"
}
]
}
Schéma de la réponse
Schéma : ISearchCorrectResponse
query: string
La requête telle qu'elle est arrivée.
exemple : "fish ladr"
corrected: string | null
La requête corrigée, ou null quand il n'y a rien à corriger.
exemple : "fish ladder"
tokens: ISearchCorrectToken[]
Ventilation de la correction par mot.
tokens.from: string
Le mot tel qu'il figurait dans la requête.
exemple : "ladr"
tokens.to: string | null
La correction, ou null quand le mot a été laissé tel quel.
exemple : "ladder"
tokens.distance: number
Nombre de modifications (Damerau–Levenshtein, OSA) entre from et to. Présent uniquement quand le mot a été corrigé.
exemple : 2
tokens.docFreq: number
Dans combien de documents du périmètre de recherche la correction apparaît. Présent uniquement quand le mot a été corrigé.
exemple : 8
tokens.reason: 'pair' | 'cooccurrence' | 'prefix' | 'docFreq'
Comment la correction a été choisie. Présent uniquement quand le mot a été corrigé.
exemple : "docFreq"
Le token d'un mot non corrigé n'a que
frometto(to: null) ;distance,docFreqetreasonn'apparaissent que sur un mot corrigé.correctedvautnullquand rien n'a changé dans la requête.
Le dictionnaire est propre à chaque langue.
langCodeprend par défaut la langue définie dansdefineOneEntry. Pour chercher sur la requête corrigée, passez-la àglobalSearch(ou activez son indicateurcorrectpour corriger et chercher en un seul appel).