SuggestRequest interface
معلمات للتصفية والفرز والمطابقة الغامضة وسلوكيات استعلام الاقتراحات الأخرى.
الخصائص
| filter | تعبير OData الذي يقوم بتصفية المستندات التي تم أخذها في الاعتبار للاقتراحات. |
| highlight |
علامة سلسلة يتم إلحاقها بعلامات التمييز. يجب تعيين مع highlightPreTag. إذا تم حذفها، يتم تعطيل تمييز النقر على الاقتراحات. |
| highlight |
علامة سلسلة تم إلحاقها مسبقا بعلامات التمييز. يجب تعيين مع تمييزPostTag. إذا تم حذفها، يتم تعطيل تمييز النقر على الاقتراحات. |
| minimum |
رقم بين 0 و100 يشير إلى النسبة المئوية للفهرس الذي يجب تغطيته بواسطة استعلام اقتراح من أجل الإبلاغ عن الاستعلام كنجاح. يمكن أن تكون هذه المعلمة مفيدة لضمان توفر البحث حتى للخدمات التي تحتوي على نسخة متماثلة واحدة فقط. الافتراضي هو 80. |
| order |
$orderby قائمة OData التعبيرات التي سيتم فرز النتائج من خلالها. يمكن أن يكون كل تعبير إما اسم حقل أو استدعاء لوظائف geo.distance() أو search.score(). يمكن أن يتبع كل تعبير asc للإشارة إلى تصاعدي، أو desc للإشارة إلى تنازلي. الإعداد الافتراضي هو ترتيب تصاعدي. سيتم كسر الروابط من خلال نتائج المباراة من الوثائق. إذا لم يتم تحديد أي $orderby، يكون ترتيب الفرز الافتراضي تنازليا حسب درجة مطابقة المستند. يمكن أن يكون هناك على الأكثر 32 عبارة $orderby. |
| search |
قائمة أسماء الحقول المفصولة بفواصل للبحث عن نص البحث المحدد. يجب تضمين الحقول الهدف في المقترح المحدد. |
| select | قائمة الحقول المراد استردادها. إذا لم يتم تحديده، تضمين حقل المفتاح فقط في النتائج. |
| top | /**
|
| use |
قيمة تشير إلى ما إذا كنت تريد استخدام مطابقة غامضة لاستعلام الاقتراح. الافتراضي هو خطأ. عند التعيين إلى صحيح، سيعثر الاستعلام على اقتراحات حتى إذا كان هناك حرف بديل أو مفقود في نص البحث. في حين أن هذا يوفر تجربة أفضل في بعض السيناريوهات، فإنه يأتي بتكلفة أداء حيث تكون عمليات البحث في الاقتراحات الغامضة أبطأ وتستهلك المزيد من الموارد. |
تفاصيل الخاصية
filter
تعبير OData الذي يقوم بتصفية المستندات التي تم أخذها في الاعتبار للاقتراحات.
filter?: string
قيمة الخاصية
string
highlightPostTag
علامة سلسلة يتم إلحاقها بعلامات التمييز. يجب تعيين مع highlightPreTag. إذا تم حذفها، يتم تعطيل تمييز النقر على الاقتراحات.
highlightPostTag?: string
قيمة الخاصية
string
highlightPreTag
علامة سلسلة تم إلحاقها مسبقا بعلامات التمييز. يجب تعيين مع تمييزPostTag. إذا تم حذفها، يتم تعطيل تمييز النقر على الاقتراحات.
highlightPreTag?: string
قيمة الخاصية
string
minimumCoverage
رقم بين 0 و100 يشير إلى النسبة المئوية للفهرس الذي يجب تغطيته بواسطة استعلام اقتراح من أجل الإبلاغ عن الاستعلام كنجاح. يمكن أن تكون هذه المعلمة مفيدة لضمان توفر البحث حتى للخدمات التي تحتوي على نسخة متماثلة واحدة فقط. الافتراضي هو 80.
minimumCoverage?: number
قيمة الخاصية
number
orderBy
$orderby قائمة OData التعبيرات التي سيتم فرز النتائج من خلالها. يمكن أن يكون كل تعبير إما اسم حقل أو استدعاء لوظائف geo.distance() أو search.score(). يمكن أن يتبع كل تعبير asc للإشارة إلى تصاعدي، أو desc للإشارة إلى تنازلي. الإعداد الافتراضي هو ترتيب تصاعدي. سيتم كسر الروابط من خلال نتائج المباراة من الوثائق. إذا لم يتم تحديد أي $orderby، يكون ترتيب الفرز الافتراضي تنازليا حسب درجة مطابقة المستند. يمكن أن يكون هناك على الأكثر 32 عبارة $orderby.
orderBy?: string[]
قيمة الخاصية
string[]
searchFields
قائمة أسماء الحقول المفصولة بفواصل للبحث عن نص البحث المحدد. يجب تضمين الحقول الهدف في المقترح المحدد.
searchFields?: SearchFieldArray<TModel>
قيمة الخاصية
SearchFieldArray<TModel>
select
قائمة الحقول المراد استردادها. إذا لم يتم تحديده، تضمين حقل المفتاح فقط في النتائج.
select?: SelectArray<TFields>
قيمة الخاصية
SelectArray<TFields>
top
/**
- عدد الاقتراحات التي يجب استردادها. يجب أن تكون هذه قيمة بين 1 و100. الإعداد الافتراضي هو
-
top?: number
قيمة الخاصية
number
useFuzzyMatching
قيمة تشير إلى ما إذا كنت تريد استخدام مطابقة غامضة لاستعلام الاقتراح. الافتراضي هو خطأ. عند التعيين إلى صحيح، سيعثر الاستعلام على اقتراحات حتى إذا كان هناك حرف بديل أو مفقود في نص البحث. في حين أن هذا يوفر تجربة أفضل في بعض السيناريوهات، فإنه يأتي بتكلفة أداء حيث تكون عمليات البحث في الاقتراحات الغامضة أبطأ وتستهلك المزيد من الموارد.
useFuzzyMatching?: boolean
قيمة الخاصية
boolean