Saltar al contenido principal

searchCorrect

Sugerencias de corrección de erratas de una consulta, según el diccionario de búsqueda del proyecto.

Descripción​

Devuelve la forma corregida de una consulta sin ejecutar la búsqueda, para que una tienda pueda ofrecer una sugerencia de «quizás quisiste decir» (GET /api/content/search/correct). Se resuelve en un ISearchCorrectResponse: la consulta original, la consulta corregida (null cuando no hay nada que corregir) y un desglose por palabra.

Cada token lleva from y to; to es null para una palabra que se dejó tal cual. Los campos de puntuación (distance, docFreq, reason) están presentes solo para una palabra que realmente se corrigió.

.searchCorrect(

, ,

);

Esquema de parámetros​

Esquema

query(required): string
Consulta a corregir.
ejemplo: "fish ladr"

langCode: string
Código de idioma. Por defecto: "en_US". El diccionario es por idioma.
ejemplo: "en_US"

scope: string
De qué conjunto de registros se toma la corrección. Omitido significa todo el proyecto.

Ejemplos​

Ejemplo mínimo​

const response = await Search.searchCorrect('prodct');

Sugerencia «quizás quisiste decir»​

const result = await Search.searchCorrect('fish ladr');

if ('statusCode' in result) {
console.error(result.message);
} else if (result.corrected) {
// Ofrezca al usuario la consulta corregida y luego ejecute la búsqueda con ella.
console.log(`¿Quizás quisiste decir: ${result.corrected}?`);
const products = await Search.globalSearch(result.corrected, ['products'], 'visible');
}

Ejemplo de respuesta​

{
"query": "fish ladr",
"corrected": "fish ladder",
"tokens": [
{
"from": "fish",
"to": null
},
{
"from": "ladr",
"to": "ladder",
"distance": 2,
"docFreq": 8,
"reason": "docFreq"
}
]
}

Esquema de la respuesta​

Esquema: ISearchCorrectResponse

query: string
La consulta tal como llegó.
ejemplo: "fish ladr"

corrected: string | null
La consulta corregida, o null cuando no hay nada que corregir.
ejemplo: "fish ladder"

tokens: ISearchCorrectToken[]
Desglose de la corrección por palabra.

tokens.from: string
La palabra tal como estaba en la consulta.
ejemplo: "ladr"

tokens.to: string | null
La corrección, o null cuando la palabra se dejó tal cual.
ejemplo: "ladder"

tokens.distance: number
Número de ediciones (Damerau–Levenshtein, OSA) entre from y to. Presente solo cuando la palabra se corrigió.
ejemplo: 2

tokens.docFreq: number
En cuántos documentos del ámbito de búsqueda aparece la corrección. Presente solo cuando la palabra se corrigió.
ejemplo: 8

tokens.reason: 'pair' | 'cooccurrence' | 'prefix' | 'docFreq'
Cómo se eligió la corrección. Presente solo cuando la palabra se corrigió.
ejemplo: "docFreq"

El token de una palabra no corregida tiene solo from y to (to: null); distance, docFreq y reason aparecen solo en una palabra corregida. corrected es null cuando nada en la consulta cambió.

El diccionario es por idioma. langCode toma por defecto el idioma definido en defineOneEntry. Para buscar con la consulta corregida, pásala a globalSearch (o activa su indicador correct para corregir y buscar en una sola llamada).