Pular para o conteúdo principal

searchCorrect

Sugestões de correção de erros de digitação de uma consulta, pelo dicionário de busca do projeto.

Descrição​

Retorna a forma corrigida de uma consulta sem executar a busca, para que uma vitrine possa oferecer uma sugestão de «você quis dizer» (GET /api/content/search/correct). Resolve em um ISearchCorrectResponse: a consulta original, a consulta corrigida (null quando não há nada a corrigir) e um detalhamento por palavra.

Cada token traz from e to; to é null para uma palavra deixada como está. Os campos de pontuação (distance, docFreq, reason) estão presentes apenas para uma palavra que de fato foi corrigida.

.searchCorrect(

, ,

);

Esquema de parâmetros​

Esquema

query(required): string
Consulta a corrigir.
exemplo: "fish ladr"

langCode: string
Código de idioma. Padrão: "en_US". O dicionário é por idioma.
exemplo: "en_US"

scope: string
De qual conjunto de registros a correção é extraída. Omitido significa o projeto inteiro.

Exemplos​

Exemplo mínimo​

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

Sugestão «você quis dizer»​

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

if ('statusCode' in result) {
console.error(result.message);
} else if (result.corrected) {
// Ofereça ao usuário a consulta corrigida e então execute a busca com ela.
console.log(`Você quis dizer: ${result.corrected}?`);
const products = await Search.globalSearch(result.corrected, ['products'], 'visible');
}

Exemplo de resposta​

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

Esquema da resposta​

Esquema: ISearchCorrectResponse

query: string
A consulta como chegou.
exemplo: "fish ladr"

corrected: string | null
A consulta corrigida, ou null quando não há nada a corrigir.
exemplo: "fish ladder"

tokens: ISearchCorrectToken[]
Detalhamento da correção por palavra.

tokens.from: string
A palavra como estava na consulta.
exemplo: "ladr"

tokens.to: string | null
A correção, ou null quando a palavra foi deixada como está.
exemplo: "ladder"

tokens.distance: number
Número de edições (Damerau–Levenshtein, OSA) entre from e to. Presente apenas quando a palavra foi corrigida.
exemplo: 2

tokens.docFreq: number
Em quantos documentos do escopo de busca a correção ocorre. Presente apenas quando a palavra foi corrigida.
exemplo: 8

tokens.reason: 'pair' | 'cooccurrence' | 'prefix' | 'docFreq'
Como a correção foi escolhida. Presente apenas quando a palavra foi corrigida.
exemplo: "docFreq"

O token de uma palavra não corrigida tem apenas from e to (to: null); distance, docFreq e reason aparecem somente em uma palavra corrigida. corrected é null quando nada na consulta mudou.

O dicionário é por idioma. langCode assume por padrão o idioma definido em defineOneEntry. Para buscar na consulta corrigida, passe-a para globalSearch (ou defina seu sinalizador correct para corrigir e buscar em uma única chamada).