BaseSearchRequestOptions interface

الحزمة:

@azure/search-documents

معلمات للتصفية والفرز والوجه والترحيل وسلوكيات استعلام البحث الأخرى.

الخصائص

facets	قائمة تعبيرات الواجهة لتطبيقها على استعلام البحث. يحتوي كل تعبير واجهة على اسم حقل، متبوعا اختياريا بقائمة مفصولة بفواصل من أزواج الاسم:القيمة.
filter	$filter التعبير OData لتطبيقه على استعلام البحث.
highlightFields	قائمة أسماء الحقول المفصولة بفواصل لاستخدامها في تمييزات الضغط. يمكن استخدام الحقول القابلة للبحث فقط لتمييز الضغط.
highlightPostTag	علامة سلسلة يتم إلحاقها بعلامات التمييز. يجب تعيين مع highlightPreTag. الافتراضي هو </em>.
highlightPreTag	علامة سلسلة تم إلحاقها مسبقا بعلامات التمييز. يجب تعيين مع تمييزPostTag. الافتراضي هو <em>.
includeTotalCount	قيمة تحدد ما إذا كنت تريد إحضار العدد الإجمالي للنتائج. الافتراضي هو خطأ. قد يكون لتعيين هذه القيمة إلى true تأثير على الأداء. لاحظ أن العدد الذي تم إرجاعه هو تقريبي.
minimumCoverage	رقم بين 0 و100 يشير إلى النسبة المئوية للفهرس الذي يجب تغطيته بواسطة استعلام بحث من أجل الإبلاغ عن الاستعلام على أنه نجاح. يمكن أن تكون هذه المعلمة مفيدة لضمان توفر البحث حتى للخدمات التي تحتوي على نسخة متماثلة واحدة فقط. الافتراضي هو 100.
orderBy	$orderby قائمة OData التعبيرات التي سيتم فرز النتائج من خلالها. يمكن أن يكون كل تعبير إما اسم حقل أو استدعاء لوظائف geo.distance() أو search.score(). يمكن أن يتبع كل تعبير asc للإشارة إلى تصاعدي، أو desc للإشارة إلى تنازلي. الإعداد الافتراضي هو ترتيب تصاعدي. سيتم كسر الروابط من خلال نتائج المباراة من الوثائق. إذا لم يتم تحديد أي $orderby، يكون ترتيب الفرز الافتراضي تنازليا حسب درجة مطابقة المستند. يمكن أن يكون هناك على الأكثر 32 عبارة $orderby.
queryType	قيمة تحدد بناء جملة استعلام البحث. الإعداد الافتراضي هو "بسيط". استخدم "كامل" إذا كان الاستعلام يستخدم بناء جملة استعلام Lucene. تتضمن القيم المحتملة: "بسيط"، "كامل"، "دلالي"
scoringParameters	قائمة قيم المعلمات التي سيتم استخدامها في دوال التسجيل (على سبيل المثال، referencePointParameter) باستخدام تنسيق قيم الاسم. على سبيل المثال، إذا كان ملف تعريف التسجيل يعرف دالة مع معلمة تسمى "mylocation" ستكون سلسلة المعلمة "mylocation--122.2,44.8" (بدون علامات الاقتباس).
scoringProfile	اسم ملف تعريف تسجيل النقاط لتقييم درجات المطابقة للمستندات المطابقة من أجل فرز النتائج.
scoringStatistics	قيمة تحدد ما إذا كنا نريد حساب إحصائيات التسجيل (مثل تكرار المستند) على مستوى العالم للحصول على تسجيل أكثر اتساقا، أو محليا، للحصول على زمن انتقال أقل. تتضمن القيم المحتملة: "محلي" و"عمومي"
searchFields	قائمة أسماء الحقول المفصولة بفواصل والتي سيتم تحديد نطاق البحث عن النص الكامل لها. عند استخدام البحث الحقلي (fieldName:searchExpression) في استعلام Lucene كامل، تكون لأسماء الحقول لكل تعبير بحث حقلي الأسبقية على أي أسماء حقول مدرجة في هذه المعلمة.
searchMode	قيمة تحدد ما إذا كان يجب مطابقة أي من مصطلحات البحث أو كلها من أجل حساب المستند كمطابقة. تتضمن القيم المحتملة: "أي" و"الكل"
select	قائمة الحقول المراد استردادها. إذا لم يتم تحديدها، يتم تضمين كافة الحقول التي تم وضع علامة عليها على أنها قابلة للاسترداد في المخطط.
sessionId	قيمة لاستخدامها لإنشاء جلسة عمل ملصقة، والتي يمكن أن تساعد في الحصول على نتائج أكثر اتساقا. طالما يتم استخدام نفس sessionId، سيتم بذل أفضل محاولة لاستهداف نفس مجموعة النسخ المتماثلة. كن حذرا من أن إعادة استخدام نفس قيم sessionID بشكل متكرر يمكن أن تتداخل مع موازنة تحميل الطلبات عبر النسخ المتماثلة وتؤثر سلبا على أداء خدمة البحث. لا يمكن أن تبدأ القيمة المستخدمة كمعرف جلسة العمل بحرف '_'.
skip	عدد نتائج البحث التي يجب تخطيها. لا يمكن أن تكون هذه القيمة أكبر من 100,000. إذا كنت بحاجة إلى مسح المستندات ضوئيا بالتسلسل، ولكن لا يمكنك استخدام التخطي بسبب هذا القيد، ففكر في استخدام orderby على مفتاح مرتب بالكامل وتصفية باستخدام استعلام نطاق بدلا من ذلك.
top	عدد نتائج البحث المراد استردادها. يمكن استخدام هذا بالاقتران مع $skip لتنفيذ ترحيل نتائج البحث من جانب العميل. إذا تم اقتطاع النتائج بسبب الترحيل من جانب الخادم، فستتضمن الاستجابة رمز متابعة يمكن استخدامه لإصدار طلب بحث آخر للصفحة التالية من النتائج.
vectorSearchOptions	تحديد خيارات استعلامات البحث عن المتجهات

تفاصيل الخاصية

facets

قائمة تعبيرات الواجهة لتطبيقها على استعلام البحث. يحتوي كل تعبير واجهة على اسم حقل، متبوعا اختياريا بقائمة مفصولة بفواصل من أزواج الاسم:القيمة.

facets?: string[]

قيمة الخاصية

string[]

filter

$filter التعبير OData لتطبيقه على استعلام البحث.

filter?: string

قيمة الخاصية

string

highlightFields

قائمة أسماء الحقول المفصولة بفواصل لاستخدامها في تمييزات الضغط. يمكن استخدام الحقول القابلة للبحث فقط لتمييز الضغط.

highlightFields?: string

قيمة الخاصية

string

highlightPostTag

علامة سلسلة يتم إلحاقها بعلامات التمييز. يجب تعيين مع highlightPreTag. الافتراضي هو </em>.

highlightPostTag?: string

قيمة الخاصية

string

highlightPreTag

علامة سلسلة تم إلحاقها مسبقا بعلامات التمييز. يجب تعيين مع تمييزPostTag. الافتراضي هو <em>.

highlightPreTag?: string

قيمة الخاصية

string

includeTotalCount

قيمة تحدد ما إذا كنت تريد إحضار العدد الإجمالي للنتائج. الافتراضي هو خطأ. قد يكون لتعيين هذه القيمة إلى true تأثير على الأداء. لاحظ أن العدد الذي تم إرجاعه هو تقريبي.

includeTotalCount?: boolean

قيمة الخاصية

boolean

minimumCoverage

رقم بين 0 و100 يشير إلى النسبة المئوية للفهرس الذي يجب تغطيته بواسطة استعلام بحث من أجل الإبلاغ عن الاستعلام على أنه نجاح. يمكن أن تكون هذه المعلمة مفيدة لضمان توفر البحث حتى للخدمات التي تحتوي على نسخة متماثلة واحدة فقط. الافتراضي هو 100.

minimumCoverage?: number

قيمة الخاصية

number

orderBy

$orderby قائمة OData التعبيرات التي سيتم فرز النتائج من خلالها. يمكن أن يكون كل تعبير إما اسم حقل أو استدعاء لوظائف geo.distance() أو search.score(). يمكن أن يتبع كل تعبير asc للإشارة إلى تصاعدي، أو desc للإشارة إلى تنازلي. الإعداد الافتراضي هو ترتيب تصاعدي. سيتم كسر الروابط من خلال نتائج المباراة من الوثائق. إذا لم يتم تحديد أي $orderby، يكون ترتيب الفرز الافتراضي تنازليا حسب درجة مطابقة المستند. يمكن أن يكون هناك على الأكثر 32 عبارة $orderby.

orderBy?: string[]

قيمة الخاصية

string[]

queryType

قيمة تحدد بناء جملة استعلام البحث. الإعداد الافتراضي هو "بسيط". استخدم "كامل" إذا كان الاستعلام يستخدم بناء جملة استعلام Lucene. تتضمن القيم المحتملة: "بسيط"، "كامل"، "دلالي"

queryType?: QueryType

قيمة الخاصية

QueryType

scoringParameters

قائمة قيم المعلمات التي سيتم استخدامها في دوال التسجيل (على سبيل المثال، referencePointParameter) باستخدام تنسيق قيم الاسم. على سبيل المثال، إذا كان ملف تعريف التسجيل يعرف دالة مع معلمة تسمى "mylocation" ستكون سلسلة المعلمة "mylocation--122.2,44.8" (بدون علامات الاقتباس).

scoringParameters?: string[]

قيمة الخاصية

string[]

scoringProfile

اسم ملف تعريف تسجيل النقاط لتقييم درجات المطابقة للمستندات المطابقة من أجل فرز النتائج.

scoringProfile?: string

قيمة الخاصية

string

scoringStatistics

قيمة تحدد ما إذا كنا نريد حساب إحصائيات التسجيل (مثل تكرار المستند) على مستوى العالم للحصول على تسجيل أكثر اتساقا، أو محليا، للحصول على زمن انتقال أقل. تتضمن القيم المحتملة: "محلي" و"عمومي"

scoringStatistics?: ScoringStatistics

قيمة الخاصية

ScoringStatistics

searchFields

قائمة أسماء الحقول المفصولة بفواصل والتي سيتم تحديد نطاق البحث عن النص الكامل لها. عند استخدام البحث الحقلي (fieldName:searchExpression) في استعلام Lucene كامل، تكون لأسماء الحقول لكل تعبير بحث حقلي الأسبقية على أي أسماء حقول مدرجة في هذه المعلمة.

searchFields?: SearchFieldArray<TModel>

قيمة الخاصية

SearchFieldArray<TModel>

searchMode

قيمة تحدد ما إذا كان يجب مطابقة أي من مصطلحات البحث أو كلها من أجل حساب المستند كمطابقة. تتضمن القيم المحتملة: "أي" و"الكل"

searchMode?: SearchMode

قيمة الخاصية

SearchMode

select

قائمة الحقول المراد استردادها. إذا لم يتم تحديدها، يتم تضمين كافة الحقول التي تم وضع علامة عليها على أنها قابلة للاسترداد في المخطط.

select?: SelectArray<TFields>

قيمة الخاصية

SelectArray<TFields>

sessionId

قيمة لاستخدامها لإنشاء جلسة عمل ملصقة، والتي يمكن أن تساعد في الحصول على نتائج أكثر اتساقا. طالما يتم استخدام نفس sessionId، سيتم بذل أفضل محاولة لاستهداف نفس مجموعة النسخ المتماثلة. كن حذرا من أن إعادة استخدام نفس قيم sessionID بشكل متكرر يمكن أن تتداخل مع موازنة تحميل الطلبات عبر النسخ المتماثلة وتؤثر سلبا على أداء خدمة البحث. لا يمكن أن تبدأ القيمة المستخدمة كمعرف جلسة العمل بحرف '_'.

sessionId?: string

قيمة الخاصية

string

skip

عدد نتائج البحث التي يجب تخطيها. لا يمكن أن تكون هذه القيمة أكبر من 100,000. إذا كنت بحاجة إلى مسح المستندات ضوئيا بالتسلسل، ولكن لا يمكنك استخدام التخطي بسبب هذا القيد، ففكر في استخدام orderby على مفتاح مرتب بالكامل وتصفية باستخدام استعلام نطاق بدلا من ذلك.

skip?: number

قيمة الخاصية

number

top

عدد نتائج البحث المراد استردادها. يمكن استخدام هذا بالاقتران مع $skip لتنفيذ ترحيل نتائج البحث من جانب العميل. إذا تم اقتطاع النتائج بسبب الترحيل من جانب الخادم، فستتضمن الاستجابة رمز متابعة يمكن استخدامه لإصدار طلب بحث آخر للصفحة التالية من النتائج.

top?: number

قيمة الخاصية

number

vectorSearchOptions

تحديد خيارات استعلامات البحث عن المتجهات

vectorSearchOptions?: VectorSearchOptions<TModel>

قيمة الخاصية

VectorSearchOptions<TModel>