انتقل إلى المحتوى الرئيسي

searchCorrect

اقتراحات تصحيح الأخطاء المطبعية للاستعلام، وفق قاموس بحث المشروع.

الوصف​

تُعيد الصيغة المصحَّحة للاستعلام دون تنفيذ البحث، كي تتمكن الواجهة من عرض اقتراح «هل تقصد» (GET /api/content/search/correct). تُحَل إلى ISearchCorrectResponse: الاستعلام الأصلي، والاستعلام المصحَّح (null عندما لا يوجد ما يُصحَّح) وتفصيل لكل كلمة.

يحمل كل رمز from وto؛ وتكون to بقيمة null للكلمة التي تُركت كما هي. حقول التقييم (distance، docFreq، reason) تظهر فقط للكلمة التي صُحِّحت فعلاً.

.searchCorrect(

, ,

);

مخطط المعطيات​

المخطط

query(required): string
الاستعلام المراد تصحيحه.
مثال: "fish ladr"

langCode: string
رمز اللغة. الافتراضي: "en_US". القاموس خاص بكل لغة.
مثال: "en_US"

scope: string
مجموعة السجلات التي يُؤخذ منها التصحيح. الحذف يعني المشروع بأكمله.

أمثلة​

مثال بسيط​

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

اقتراح «هل تقصد»​

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

if ('statusCode' in result) {
console.error(result.message);
} else if (result.corrected) {
// اعرض الاستعلام المصحَّح على المستخدم، ثم نفّذ البحث به.
console.log(`هل تقصد: ${result.corrected}؟`);
const products = await Search.globalSearch(result.corrected, ['products'], 'visible');
}

مثال على الاستجابة​

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

مخطط الاستجابة​

المخطط: ISearchCorrectResponse

query: string
الاستعلام كما ورد.
مثال: "fish ladr"

corrected: string | null
الاستعلام المصحَّح، أو null عندما لا يوجد ما يُصحَّح.
مثال: "fish ladder"

tokens: ISearchCorrectToken[]
تفصيل التصحيح لكل كلمة.

tokens.from: string
الكلمة كما وردت في الاستعلام.
مثال: "ladr"

tokens.to: string | null
التصحيح، أو null عندما تُركت الكلمة كما هي.
مثال: "ladder"

tokens.distance: number
عدد التعديلات (داميراو–ليفنشتاين، OSA) بين from وto. يظهر فقط عندما تُصحَّح الكلمة.
مثال: 2

tokens.docFreq: number
في كم مستند من نطاق البحث يظهر التصحيح. يظهر فقط عندما تُصحَّح الكلمة.
مثال: 8

tokens.reason: 'pair' | 'cooccurrence' | 'prefix' | 'docFreq'
كيف اختير التصحيح. يظهر فقط عندما تُصحَّح الكلمة.
مثال: "docFreq"

رمز الكلمة غير المصحَّحة يحتوي فقط على from وto (to: null)؛ وتظهر distance وdocFreq وreason فقط للكلمة المصحَّحة. تكون corrected بقيمة null عندما لا يتغير شيء في الاستعلام.

القاموس خاص بكل لغة. تأخذ langCode افتراضياً اللغة المحددة في defineOneEntry. للبحث بالاستعلام المصحَّح، مرّره إلى globalSearch (أو فعّل الراية correct لتصحيحه والبحث في استدعاء واحد).