SimpleField interface

الحزمة:

@azure/search-documents

يمثل حقلا في تعريف فهرس، والذي يصف الاسم ونوع البيانات وسلوك البحث للحقل.

الخصائص

analyzerName	اسم المحلل الذي يجب استخدامه للحقل. يمكن استخدام هذا الخيار فقط مع الحقول القابلة للبحث ولا يمكن تعيينه مع searchAnalyzer أو indexAnalyzer. بمجرد اختيار المحلل، لا يمكن تغييره للحقل.
facetable	قيمة تشير إلى ما إذا كان سيتم تمكين الحقل للإشارة إليه في استعلامات الواجهة. يستخدم عادة في عرض تقديمي لنتائج البحث يتضمن عدد مرات الوصول حسب الفئة (على سبيل المثال، البحث عن الكاميرات الرقمية والاطلاع على النتائج حسب العلامة التجارية، والميجابيكس، والسعر، وما إلى ذلك). لا يمكن أن تكون الحقول من النوع Edm.GeographyPoint أو المجموعة (Edm.GeographyPoint) قابلة للواجهات. الافتراضي هو خطأ.
filterable	قيمة تشير إلى ما إذا كان سيتم تمكين الإشارة إلى الحقل في استعلامات $filter. تختلف القابلة للتصفية عن القابلة للبحث في كيفية التعامل مع السلاسل. لا تخضع الحقول من نوع Edm.String أو Collection(Edm.String) القابلة للتصفية لكسر الكلمات، لذا فإن المقارنات مخصصة للمطابقات الدقيقة فقط. على سبيل المثال، إذا قمت بتعيين مثل هذا الحقل إلى "يوم مشمس"، $filter=f eq "مشمس" لن تجد أي مطابقات، ولكن $filter=f eq "يوم مشمس". الافتراضي هو خطأ.
hidden	قيمة تشير إلى ما إذا كان يمكن إرجاع الحقل في نتيجة بحث. يمكنك تعطيل هذا الخيار إذا كنت تريد استخدام حقل (على سبيل المثال، الهامش) كآلية تصفية أو فرز أو تسجيل ولكن لا تريد أن يكون الحقل مرئيا للمستخدم النهائي. يجب أن تكون هذه الخاصية خاطئة لحقول المفاتيح. يمكن تغيير هذه الخاصية في الحقول الموجودة. لا يؤدي تمكين هذه الخاصية إلى أي زيادة في متطلبات تخزين الفهرس. الافتراضي صحيح لحقول المتجهات، خطأ خلاف ذلك.
indexAnalyzerName	اسم المحلل المستخدم في وقت الفهرسة للحقل. يمكن استخدام هذا الخيار فقط مع الحقول القابلة للبحث. يجب تعيينه مع searchAnalyzer ولا يمكن تعيينه مع خيار المحلل. لا يمكن تعيين هذه الخاصية إلى اسم محلل اللغة؛ استخدم خاصية المحلل بدلا من ذلك إذا كنت بحاجة إلى محلل لغة. بمجرد اختيار المحلل، لا يمكن تغييره للحقل.
key	قيمة تشير إلى ما إذا كان الحقل يعرف المستندات في الفهرس بشكل فريد. يجب اختيار حقل واحد بالضبط من المستوى الأعلى في كل فهرس ك حقل مفتاح ويجب أن يكون من نوع Edm.String. يمكن استخدام الحقول الرئيسية للبحث عن المستندات مباشرة وتحديث مستندات معينة أو حذفها. الافتراضي هو خطأ.
name	اسم الحقل، الذي يجب أن يكون فريدا ضمن مجموعة الحقول للفهرس أو الحقل الأصل.
normalizerName	اسم التسوية المراد استخدامه في الحقل. يمكن استخدام هذا الخيار فقط مع الحقول القابلة للتصفية أو الفرز أو الواجهة الممكنة. بمجرد اختيار التطبيع ، لا يمكن تغييره في الحقل. يجب أن تكون فارغة للحقول المعقدة.
searchable	قيمة تشير إلى ما إذا كان الحقل قابلا للبحث في النص الكامل. وهذا يعني أنه سيخضع للتحليل مثل تقسيم الكلمات أثناء الفهرسة. إذا قمت بتعيين حقل قابل للبحث إلى قيمة مثل "يوم مشمس"، تقسيمه داخليا إلى الرموز المميزة الفردية "المشمسة" و"اليوم". يتيح ذلك عمليات البحث عن هذه المصطلحات في النص الكامل. الحقول من نوع Edm.String أو Collection(Edm.String) قابلة للبحث بشكل افتراضي. يجب أن تكون هذه الخاصية خاطئة لحقول بسيطة من أنواع بيانات أخرى غير سلسلة. ملاحظة: تستهلك الحقول القابلة للبحث مساحة إضافية في الفهرس لاستيعاب إصدارات رمزية إضافية من قيمة الحقل لعمليات البحث في النص الكامل. إذا كنت تريد توفير مساحة في الفهرس ولا تحتاج إلى حقل لتضمينه في عمليات البحث، فقم بتعيين قابل للبحث إلى خطأ. الافتراضي هو خطأ.
searchAnalyzerName	اسم المحلل المستخدم في وقت البحث عن الحقل. يمكن استخدام هذا الخيار فقط مع الحقول القابلة للبحث. يجب تعيينه مع indexAnalyzerName ولا يمكن تعيينه مع خيار analyzerName. لا يمكن تعيين هذه الخاصية إلى اسم محلل اللغة؛ استخدم خاصية analyzerName بدلا من ذلك إذا كنت بحاجة إلى محلل لغة. يمكن تحديث هذا المحلل في حقل موجود.
sortable	قيمة تشير إلى ما إذا كان يجب تمكين الإشارة إلى الحقل في تعبيرات $orderby. بشكل افتراضي، يفرز محرك البحث النتائج حسب النتيجة، ولكن في العديد من التجارب سيرغب المستخدمون في الفرز حسب الحقول في المستندات. يمكن أن يكون الحقل البسيط قابلا للفرز فقط إذا كان ذو قيمة مفردة (يحتوي على قيمة واحدة في نطاق المستند الأصل). لا يمكن فرز حقول المجموعة البسيطة، لأنها متعددة القيم. كما أن الحقول الفرعية البسيطة للمجموعات المعقدة متعددة القيم، وبالتالي لا يمكن فرزها. هذا صحيح سواء كان حقلا أصليا فوريا، أو حقل أصل، هذه هي المجموعة المعقدة. الإعداد الافتراضي خطأ.
stored	قيمة غير قابلة للتغيير تشير إلى ما إذا كان الحقل سيستمر بشكل منفصل على القرص لإرجاعه في نتيجة بحث. يمكنك تعطيل هذا الخيار إذا كنت لا تخطط لإرجاع محتويات الحقل في استجابة بحث لحفظها في حمل التخزين. يمكن تعيين هذا فقط أثناء إنشاء الفهرس وحقول المتجهات فقط. لا يمكن تغيير هذه الخاصية للحولات الموجودة أو تعيينها كخطأ لحقول جديدة. إذا تم تعيين هذه الخاصية على أنها خطأ، يجب تعيين الخاصية "مخفي" إلى "صحيح". يجب أن تكون هذه الخاصية صحيحة أو غير محددة للحقول الرئيسية والحقول الجديدة والحقول غير المتجهة. سيؤدي تعطيل هذه الخاصية إلى تقليل متطلبات تخزين الفهرس. الإعداد الافتراضي صحيح لحقول المتجهات.
synonymMapNames	قائمة بأسماء تعيينات المرادفات لإقرانها بهذا الحقل. يمكن استخدام هذا الخيار فقط مع الحقول القابلة للبحث. حاليا يتم دعم مخطط مرادف واحد فقط لكل حقل. يضمن تعيين خريطة مرادف لحقل توسيع مصطلحات الاستعلام التي تستهدف هذا الحقل في وقت الاستعلام باستخدام القواعد الموجودة في خريطة المرادفات. يمكن تغيير هذه السمة في الحقول الموجودة.
type	نوع بيانات الحقل.
vectorEncodingFormat	تنسيق الترميز لتفسير محتويات الحقل.
vectorSearchDimensions	أبعاد حقل المتجه.
vectorSearchProfileName	اسم ملف تعريف البحث المتجه الذي يحدد الخوارزمية والمتجه لاستخدامها عند البحث في حقل المتجه.

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

analyzerName

اسم المحلل الذي يجب استخدامه للحقل. يمكن استخدام هذا الخيار فقط مع الحقول القابلة للبحث ولا يمكن تعيينه مع searchAnalyzer أو indexAnalyzer. بمجرد اختيار المحلل، لا يمكن تغييره للحقل.

analyzerName?: string

قيمة الخاصية

string

facetable

قيمة تشير إلى ما إذا كان سيتم تمكين الحقل للإشارة إليه في استعلامات الواجهة. يستخدم عادة في عرض تقديمي لنتائج البحث يتضمن عدد مرات الوصول حسب الفئة (على سبيل المثال، البحث عن الكاميرات الرقمية والاطلاع على النتائج حسب العلامة التجارية، والميجابيكس، والسعر، وما إلى ذلك). لا يمكن أن تكون الحقول من النوع Edm.GeographyPoint أو المجموعة (Edm.GeographyPoint) قابلة للواجهات. الافتراضي هو خطأ.

facetable?: boolean

قيمة الخاصية

boolean

filterable

قيمة تشير إلى ما إذا كان سيتم تمكين الإشارة إلى الحقل في استعلامات $filter. تختلف القابلة للتصفية عن القابلة للبحث في كيفية التعامل مع السلاسل. لا تخضع الحقول من نوع Edm.String أو Collection(Edm.String) القابلة للتصفية لكسر الكلمات، لذا فإن المقارنات مخصصة للمطابقات الدقيقة فقط. على سبيل المثال، إذا قمت بتعيين مثل هذا الحقل إلى "يوم مشمس"، $filter=f eq "مشمس" لن تجد أي مطابقات، ولكن $filter=f eq "يوم مشمس". الافتراضي هو خطأ.

filterable?: boolean

قيمة الخاصية

boolean

hidden

قيمة تشير إلى ما إذا كان يمكن إرجاع الحقل في نتيجة بحث. يمكنك تعطيل هذا الخيار إذا كنت تريد استخدام حقل (على سبيل المثال، الهامش) كآلية تصفية أو فرز أو تسجيل ولكن لا تريد أن يكون الحقل مرئيا للمستخدم النهائي. يجب أن تكون هذه الخاصية خاطئة لحقول المفاتيح. يمكن تغيير هذه الخاصية في الحقول الموجودة. لا يؤدي تمكين هذه الخاصية إلى أي زيادة في متطلبات تخزين الفهرس. الافتراضي صحيح لحقول المتجهات، خطأ خلاف ذلك.

hidden?: boolean

قيمة الخاصية

boolean

indexAnalyzerName

اسم المحلل المستخدم في وقت الفهرسة للحقل. يمكن استخدام هذا الخيار فقط مع الحقول القابلة للبحث. يجب تعيينه مع searchAnalyzer ولا يمكن تعيينه مع خيار المحلل. لا يمكن تعيين هذه الخاصية إلى اسم محلل اللغة؛ استخدم خاصية المحلل بدلا من ذلك إذا كنت بحاجة إلى محلل لغة. بمجرد اختيار المحلل، لا يمكن تغييره للحقل.

indexAnalyzerName?: string

قيمة الخاصية

string

key

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

key?: boolean

قيمة الخاصية

boolean

name

اسم الحقل، الذي يجب أن يكون فريدا ضمن مجموعة الحقول للفهرس أو الحقل الأصل.

name: string

قيمة الخاصية

string

normalizerName

اسم التسوية المراد استخدامه في الحقل. يمكن استخدام هذا الخيار فقط مع الحقول القابلة للتصفية أو الفرز أو الواجهة الممكنة. بمجرد اختيار التطبيع ، لا يمكن تغييره في الحقل. يجب أن تكون فارغة للحقول المعقدة.

normalizerName?: string

قيمة الخاصية

string

searchable

قيمة تشير إلى ما إذا كان الحقل قابلا للبحث في النص الكامل. وهذا يعني أنه سيخضع للتحليل مثل تقسيم الكلمات أثناء الفهرسة. إذا قمت بتعيين حقل قابل للبحث إلى قيمة مثل "يوم مشمس"، تقسيمه داخليا إلى الرموز المميزة الفردية "المشمسة" و"اليوم". يتيح ذلك عمليات البحث عن هذه المصطلحات في النص الكامل. الحقول من نوع Edm.String أو Collection(Edm.String) قابلة للبحث بشكل افتراضي. يجب أن تكون هذه الخاصية خاطئة لحقول بسيطة من أنواع بيانات أخرى غير سلسلة. ملاحظة: تستهلك الحقول القابلة للبحث مساحة إضافية في الفهرس لاستيعاب إصدارات رمزية إضافية من قيمة الحقل لعمليات البحث في النص الكامل. إذا كنت تريد توفير مساحة في الفهرس ولا تحتاج إلى حقل لتضمينه في عمليات البحث، فقم بتعيين قابل للبحث إلى خطأ. الافتراضي هو خطأ.

searchable?: boolean

قيمة الخاصية

boolean

searchAnalyzerName

اسم المحلل المستخدم في وقت البحث عن الحقل. يمكن استخدام هذا الخيار فقط مع الحقول القابلة للبحث. يجب تعيينه مع indexAnalyzerName ولا يمكن تعيينه مع خيار analyzerName. لا يمكن تعيين هذه الخاصية إلى اسم محلل اللغة؛ استخدم خاصية analyzerName بدلا من ذلك إذا كنت بحاجة إلى محلل لغة. يمكن تحديث هذا المحلل في حقل موجود.

searchAnalyzerName?: string

قيمة الخاصية

string

sortable

قيمة تشير إلى ما إذا كان يجب تمكين الإشارة إلى الحقل في تعبيرات $orderby. بشكل افتراضي، يفرز محرك البحث النتائج حسب النتيجة، ولكن في العديد من التجارب سيرغب المستخدمون في الفرز حسب الحقول في المستندات. يمكن أن يكون الحقل البسيط قابلا للفرز فقط إذا كان ذو قيمة مفردة (يحتوي على قيمة واحدة في نطاق المستند الأصل). لا يمكن فرز حقول المجموعة البسيطة، لأنها متعددة القيم. كما أن الحقول الفرعية البسيطة للمجموعات المعقدة متعددة القيم، وبالتالي لا يمكن فرزها. هذا صحيح سواء كان حقلا أصليا فوريا، أو حقل أصل، هذه هي المجموعة المعقدة. الإعداد الافتراضي خطأ.

sortable?: boolean

قيمة الخاصية

boolean

stored

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

stored?: boolean

قيمة الخاصية

boolean

synonymMapNames

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

synonymMapNames?: string[]

قيمة الخاصية

string[]

type

نوع بيانات الحقل.

type: SearchFieldDataType

قيمة الخاصية

SearchFieldDataType

vectorEncodingFormat

تنسيق الترميز لتفسير محتويات الحقل.

vectorEncodingFormat?: string

قيمة الخاصية

string

vectorSearchDimensions

أبعاد حقل المتجه.

vectorSearchDimensions?: number

قيمة الخاصية

number

vectorSearchProfileName

اسم ملف تعريف البحث المتجه الذي يحدد الخوارزمية والمتجه لاستخدامها عند البحث في حقل المتجه.

vectorSearchProfileName?: string

قيمة الخاصية

string