- تمثيل JSON
- ObjectDefinition
- ObjectOptions
- ObjectOptions.FreshnessOptions
- ObjectDisplayOptions
- ObjectDisplayOptions.Metaline
- ObjectDisplayOptions.DisplayedProperty
- PropertyDefinition
- IntegerPropertyOptions
- IntegerPropertyOptions.OrderedRanking
- IntegerPropertyOptions.IntegerOperatorOptions
- DoublePropertyOptions
- DoublePropertyOptions.DoubleOperatorOptions
- TimestampPropertyOptions
- TimestampPropertyOptions.TimestampOperatorOptions
- BooleanPropertyOptions
- BooleanPropertyOptions.BooleanOperatorOptions
- ObjectPropertyOptions
- EnumPropertyOptions
- EnumPropertyOptions.EnumValuePair
- EnumPropertyOptions.OrderedRanking
- EnumPropertyOptions.EnumOperatorOptions
- DatePropertyOptions
- DatePropertyOptions.DateOperatorOptions
- TextPropertyOptions
- RetrievalImportance
- RetrievalImportance.Importance
- TextPropertyOptions.TextOperatorOptions
- HtmlPropertyOptions
- HtmlPropertyOptions.HtmlOperatorOptions
- PropertyDisplayOptions
تعريف المخطط لمصدر بيانات.
تمثيل JSON |
---|
{
"objectDefinitions": [
{
object ( |
الحقول | |
---|---|
objectDefinitions[] |
قائمة عناصر المستوى الأعلى لمصدر البيانات. الحد الأقصى لعدد العناصر هو 10. |
operationIds[] |
معرّفات العمليات الطويلة التشغيل (LROs) التي تعمل حاليًا لهذا المخطط. بعد تعديل المخطط، انتظر حتى تكتمل العمليات قبل فهرسة المحتوى الإضافي. |
ObjectDefinition
تعريف عنصر داخل مصدر بيانات.
تمثيل JSON |
---|
{ "name": string, "options": { object ( |
الحقول | |
---|---|
name |
اسم الكائن، والذي يحدد نوعه بعد ذلك. يجب ضبط الحقل |
options |
تمثّل هذه السمة الخيارات الاختيارية الخاصة بالكائن. |
propertyDefinitions[] |
تعريفات السمة للعنصر. الحد الأقصى لعدد العناصر هو 1000. |
ObjectOptions
تمثّل هذه السمة الخيارات لعنصر.
تمثيل JSON |
---|
{ "freshnessOptions": { object ( |
الحقول | |
---|---|
freshnessOptions |
خيارات تحديث العنصر |
displayOptions |
الخيارات التي تحدد كيفية عرض العنصر في صفحة نتائج Cloud Search. |
suggestionFilteringOperators[] |
عوامل التشغيل التي يمكن استخدامها لفلترة الاقتراحات بالنسبة إلى واجهة برمجة تطبيقات ملاحظة: "نوع الكائن"، "النوع" و"mimetype" متاحة حاليًا. هذه السمة مخصصة لإعداد عوامل التشغيل الخاصة بالمخطط. على الرغم من أن هذه مصفوفة، يمكن تحديد عامل تشغيل واحد فقط. هذا صفيف قابل للتوسع في المستقبل. لا تتوفّر عوامل التشغيل التي يتم ربطها بمواقع متعددة ضمن العنصر نفسه. إذا كان العامل يمتد عبر أنواع مختلفة من الكائنات، يجب تعيين هذا الخيار مرة واحدة لكل تعريف كائن. |
ObjectOptions.FreshnessOptions
يشير إلى خاصية التعديل المطلوب استخدامها عند ضبط ترتيب البحث لعنصر. وتشير التواريخ الأحدث والأكثر حداثة إلى جودة أعلى. استخدِم خاصية خيار الحداثة التي تناسب بياناتك على أفضل نحو. بالنسبة إلى مستندات مشاركة الملفات، يكون وقت آخر تعديل هو الأكثر صلة. بالنسبة إلى بيانات أحداث التقويم، يكون الوقت الذي يقع فيه الحدث مؤشر حداثة أكثر صلة. وبهذه الطريقة، يتم اعتبار أحداث التقويم التي تقع في وقت أقرب إلى وقت طلب البحث أعلى جودة ويتم ترتيبها وفقًا لذلك.
تمثيل JSON |
---|
{ "freshnessProperty": string, "freshnessDuration": string } |
الحقول | |
---|---|
freshnessProperty |
تشير هذه السمة إلى مستوى حداثة العنصر في الفهرس. وفي حال ضبطها، يجب أن تكون هذه السمة موقعًا من المستوى الأعلى ضمن عند استخدام سمة لاحتساب مدى الحداثة، يتم ضبط القيمة تلقائيًا على عامَين من الوقت الحالي. |
freshnessDuration |
المدة التي يجب بعد انقضائها أن يصبح العنصر قديمًا. القيمة التلقائية هي 180 يومًا (بالثواني). مدة بالثواني مكونة من تسعة أرقام كسور كحد أقصى وتنتهي بالأرقام " |
ObjectDisplayOptions
خيارات العرض لعنصر.
تمثيل JSON |
---|
{
"objectDisplayLabel": string,
"metalines": [
{
object ( |
الحقول | |
---|---|
objectDisplayLabel |
تشير هذه السمة إلى تصنيف سهل الاستخدام ليتم عرضه في نتيجة البحث للإشارة إلى نوع العنصر. هذا اختياري؛ وإذا لم يتم توفيرها، لن يتم عرض تصنيف الكائن في سطر السياق لنتائج البحث. يجب ألّا يزيد عدد الأحرف عن 64 حرفًا. |
metalines[] |
تحدد السمات التي يتم عرضها في العلامات الوصفية لنتائج البحث. يتم عرض قيم الخصائص بالترتيب الموضح هنا. وإذا كان أحد المواقع يحتوي على قيم متعددة، سيتم عرض جميع القيم قبل السمات التالية. لهذا السبب، من الممارسات الجيدة تحديد خصائص المفرد قبل الخصائص المتكررة في هذه القائمة. يجب ضبط |
ObjectDisplayOptions.Metaline
الوصفة هي قائمة من الخصائص التي يتم عرضها مع نتيجة البحث لتوفير السياق.
تمثيل JSON |
---|
{
"properties": [
{
object ( |
الحقول | |
---|---|
properties[] |
هذه قائمة بالسمات المعروضة الخاصة بالمجموعة الوصفية. يبلغ الحدّ الأقصى لعدد المواقع 5 مواقع. |
ObjectDisplayOptions.DisplayedProperty
مرجع إلى خاصية من المستوى الأعلى داخل العنصر يجب عرضه في نتائج البحث. يتم عرض قيم الخصائص التي تم اختيارها في نتائج البحث مع display label
لتلك السمة في حال تحديد قيمة. وفي حال عدم تحديد تصنيف عرض، ستظهر القيم فقط.
تمثيل JSON |
---|
{ "propertyName": string } |
الحقول | |
---|---|
propertyName |
اسم خاصية المستوى الأعلى كما هو محدّد في تعريف السمة للعنصر. إذا لم يكن الاسم سمة محدّدة في المخطط، سيظهر خطأ عند محاولة تعديل المخطط. |
PropertyDefinition
تعريف خاصية داخل كائن.
تمثيل JSON |
---|
{ "name": string, "isReturnable": boolean, "isRepeatable": boolean, "isSortable": boolean, "isFacetable": boolean, "isSuggestable": boolean, "isWildcardSearchable": boolean, "displayOptions": { object ( |
الحقول | |
---|---|
name |
تمثّل هذه السمة اسم المكان المخصّص للاستئجار. إنّ طلبات فهرسة العناصر التي تم إرسالها إلى Indexing API يجب أن تضبط |
isReturnable |
تشير هذه السمة إلى أنّ السمة تحدّد البيانات التي يجب عرضها في نتائج البحث من خلال Query API. في حال ضبط هذه السياسة على true، يشير ذلك إلى أنّ مستخدمي Query API يمكنهم استخدام حقول السمات المطابقة في النتائج. ومع ذلك، يتطلب تخزين الحقول تخصيص المزيد من المساحة ويستخدم معدل نقل بيانات أكبر لطلبات البحث، ما يؤثر في الأداء على مجموعات البيانات الكبيرة. اضبط القيمة على true هنا فقط إذا كان الحقل مطلوبًا لنتائج البحث. لا يمكن أن يكون هذا الحقل صحيحًا بالنسبة إلى المواقع الإلكترونية التي يكون نوعها كائنًا. |
isRepeatable |
تشير هذه السمة إلى أنّه يُسمح باستخدام عدة قيم للسمة. على سبيل المثال، يمكن أن يحتوي المستند على وصف واحد فقط، ولكن يمكن أن يتضمّن تعليقات متعددة. لا يمكن أن تكون القيمة true للخصائص التي يكون نوعها قيمة منطقية. وفي حال ضبط هذه السياسة على "خطأ"، فإنّ الخصائص التي تحتوي على أكثر من قيمة تؤدي إلى رفض طلب الفهرسة لهذا العنصر. |
isSortable |
يشير هذا الحقل إلى أنّه يمكن استخدام السمة للترتيب. لا يمكن أن يكون هذا الحقل صحيحًا للسمات القابلة للتكرار. لا يمكن أن يكون صحيحًا بالنسبة إلى المواقع التي يكون نوعها كائنًا. يجب أن يكون IsReturnable صحيحًا لتعيين هذا الخيار. هذا الخيار متاح فقط للسمات المنطقية والتاريخ والمزدوج والعدد الصحيح والطابع الزمني. |
isFacetable |
تشير إلى إمكانية استخدام الخاصية لإنشاء الواجهات. لا يمكن أن يكون صحيحًا بالنسبة إلى المواقع التي يكون نوعها كائنًا. يجب أن يكون IsReturnable صحيحًا لتعيين هذا الخيار. لا يمكن استخدامها إلا للسمات المنطقية والتعداد والعدد الصحيح والنص. |
isSuggestable |
تشير إلى إمكانية استخدام السمة لإنشاء اقتراحات لطلب البحث. |
isWildcardSearchable |
يشير هذا الرمز إلى أنّه يمكن للمستخدمين البحث بحرف البدل عن هذا الموقع. يمكن استخدام هذه السمة فقط للخصائص النصية. يجب أن تكون سمة IsReturnable true لإعداد هذا الخيار. في مصدر بيانات معيّن، يمكن تصنيف 5 مواقع كحدّ أقصى على أنّها isWildcardSearchable. لمزيد من التفاصيل، راجِع تحديد خصائص العنصر. |
displayOptions |
تشير هذه السمة إلى الخيارات التي تحدِّد كيفية عرض السمة في صفحة نتائج Cloud Search إذا كان محدّدًا لعرضها في |
حقل الاتحاد property_options . الخيارات الخاصة بالنوع التي تحدّد كيفية فهرسة الموقع واستخدامه. في الحالة التي يجب أن تكون فيها الخيارات هي الخيارات التلقائية لنوع ما، يجب أن يظل هذا الحقل معيّنًا على أحد الأنواع. وفي حال عدم ضبط هذا الحقل، يتم رفض تعديلات المخطط. يمكن أن يكون property_options واحدًا فقط مما يلي: |
|
integerPropertyOptions |
|
doublePropertyOptions |
|
timestampPropertyOptions |
|
booleanPropertyOptions |
|
objectPropertyOptions |
|
enumPropertyOptions |
|
datePropertyOptions |
|
textPropertyOptions |
|
htmlPropertyOptions |
|
IntegerPropertyOptions
خيارات خصائص الأعداد الصحيحة.
تمثيل JSON |
---|
{ "orderedRanking": enum ( |
الحقول | |
---|---|
orderedRanking |
يُستخدَم لتحديد الترتيب المُرتَّب لعدد صحيح. لا يمكن استخدام هذه السياسة إلا إذا كانت قيمة السمة |
minimumValue |
تمثّل هذه السمة القيمة الصغرى للسمة. يتم استخدام القيم الدنيا والقصوى للسمة لترتيب النتائج وفقًا للنوع |
maximumValue |
تمثّل هذه السمة الحدّ الأقصى لقيمة الموقع. يتم استخدام القيم الدنيا والقصوى للسمة لترتيب النتائج وفقًا للنوع |
operatorOptions |
في حال تحديده، يصف كيف يجب استخدام العدد الصحيح كعامل تشغيل بحث. |
integerFacetingOptions |
في حال تحديد هذه السمة، تقدّم وصفًا لخيارات تحديد واجهات الأعداد الصحيحة لخاصية العدد الصحيح. يجب وضع علامة isFacetable على خاصية العدد الصحيح. |
IntegerPropertyOptions.OrderedRanking
يُستخدم لتحديد كيفية ترتيب قيمة عدد صحيح بالنسبة إلى القيم الأخرى. يشير العدد الصحيح ذو الترتيب الأعلى إلى أهمية أكبر. على سبيل المثال، في بعض مصادر البيانات، تشير الأولوية الأقل إلى أهمية أكبر بينما تشير الأولوية الأعلى في البعض الآخر إلى أهمية أكبر.
عمليات التعداد | |
---|---|
NO_ORDER |
ما مِن ترتيب لترتيب الموقع. لا يتم تعديل النتائج حسب قيمة هذا الموقع. |
ASCENDING |
تم ترتيب هذا الموقع تصاعديًا. وتشير القيم المنخفضة إلى الترتيب الأقل. |
DESCENDING |
تم ترتيب هذا الموقع تنازليًا. وتشير القيم المنخفضة إلى الترتيب الأعلى. |
IntegerPropertyOptions.IntegerOperatorOptions
يُستخدَم لتوفير عامل تشغيل بحث لخصائص الأعداد الصحيحة. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.
تمثيل JSON |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
الحقول | |
---|---|
operatorName |
تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية العدد الصحيح. على سبيل المثال، إذا كانت قيمة filterName هي priority، وكان اسم الموقع هو priorityVal، تعرض طلبات البحث مثل priority:<value> نتائج فقط عندما تتطابق قيمة السمة priorityVal مع <value>. في المقابل، يؤدي البحث الذي يستخدم <value> نفسها بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها <value> مع قيمة أي خصائص سلسلة أو نص داخل حقل المحتوى للعنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
lessThanOperatorName |
تشير هذه السمة إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية العدد الصحيح باستخدام عامل التشغيل أقل من. على سبيل المثال، إذا كانت قيمة lessThanOperatorName هي priority below واسم الموقع الإلكتروني priorityVal، تعرِض طلبات البحث مثل priority below:<value> نتائج فقط عندما تكون قيمة السمة المسمّاة priorityVal أقل من <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
greaterThanOperatorName |
تشير هذه السمة إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية العدد الصحيح باستخدام عامل التشغيل "أكبر من". على سبيل المثال، إذا كان اسم السمة maxThanOperatorName هو priority above واسم الموقع الإلكتروني priorityVal، تعرِض طلبات البحث مثل priority above:<value> نتائج فقط عندما تكون قيمة السمة المسمّاة priorityVal أكبر من <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
DoublePropertyOptions
تمثّل هذه السمة خيارات المواقع المزدوجة.
تمثيل JSON |
---|
{
"operatorOptions": {
object ( |
الحقول | |
---|---|
operatorOptions |
وفي حال ضبطها، تصف كيفية استخدام القيمة المزدوجة كعامل تشغيل بحث. |
DoublePropertyOptions.DoubleOperatorOptions
تُستخدَم لتوفير عامل تشغيل بحث للمواقع الإلكترونية المزدوجة. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.
تمثيل JSON |
---|
{ "operatorName": string } |
الحقول | |
---|---|
operatorName |
يشير إلى اسم عامل التشغيل المطلوب في الاستعلام من أجل استخدام الخاصية المزدوجة في الفرز أو كواجهة. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
TimestampPropertyOptions
خيارات خصائص الطابع الزمني.
تمثيل JSON |
---|
{
"operatorOptions": {
object ( |
الحقول | |
---|---|
operatorOptions |
في حال ضبط هذه السمة، يوضِّح كيفية استخدام الطابع الزمني كعامل تشغيل بحث. |
TimestampPropertyOptions.TimestampOperatorOptions
تُستخدَم لتوفير عامل تشغيل بحث في سمات الطابع الزمني. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.
تمثيل JSON |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
الحقول | |
---|---|
operatorName |
يشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية الطابع الزمني. على سبيل المثال، إذا كان عامل التشغيل userName هو closedon وكان اسم الموقع هو CloseDate، تعرض طلبات البحث مثل closedon:<value> نتائج فقط تتطابق فيها قيمة السمة المُسمّاة CloseDate مع <value>. في المقابل، يؤدي البحث الذي يستخدم <value> نفسها بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها <value> مع قيمة أي خصائص سلسلة أو نص داخل حقل المحتوى للعنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
lessThanOperatorName |
تشير هذه السمة إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية الطابع الزمني باستخدام عامل التشغيل أقل من. على سبيل المثال، إذا كانت عملية lessThanOperatorName هي closedbefore وكان اسم الخاصية CloseDate، تعرض طلبات البحث مثل closedbefore:<value> نتائج فقط تكون فيها قيمة الخاصية المُسماة CloseDate أقدم من <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
greaterThanOperatorName |
تشير هذه السمة إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية الطابع الزمني باستخدام عامل التشغيل "أكبر من". على سبيل المثال، إذا تم ضبط اسم أكبر ThanOperatorName على closedafter وكان اسم الموقع هو CloseDate، تعرض طلبات البحث مثل closedafter:<value> نتائج فقط تكون فيها قيمة الخاصية المُسمّاة CloseDate بعد <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
BooleanPropertyOptions
خيارات السمات المنطقية.
تمثيل JSON |
---|
{
"operatorOptions": {
object ( |
الحقول | |
---|---|
operatorOptions |
في حال ضبطها، تصف كيفية استخدام القيمة المنطقية كعامل تشغيل بحث. |
BooleanPropertyOptions.BooleanOperatorOptions
يُستخدَم لتوفير عامل تشغيل بحث للخصائص المنطقية. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.
تمثيل JSON |
---|
{ "operatorName": string } |
الحقول | |
---|---|
operatorName |
تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل الخاصية المنطقية. على سبيل المثال، إذا كان filterName مغلقًا وكان اسم الموقع isclosed، تعرض طلبات البحث مثل closed:<value> نتائج فقط عندما تتطابق قيمة السمة isClosed مع <value>. في المقابل، يؤدي البحث الذي يستخدم <value> نفسها بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها <value> مع قيمة أي خصائص سلسلة أو نص داخل حقل المحتوى للعنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
ObjectPropertyOptions
خيارات خصائص العنصر
تمثيل JSON |
---|
{
"subobjectProperties": [
{
object ( |
الحقول | |
---|---|
subobjectProperties[] |
خصائص الكائن الفرعي. تمثل هذه الخصائص كائنًا مدمجًا. على سبيل المثال، إذا كانت هذه السمة تمثّل عنوانًا بريديًا، يمكن تسمية عناصر SubobjectProperties street وcity وstate. الحد الأقصى لعدد العناصر هو 1000. |
EnumPropertyOptions
تتيح لك خيارات خصائص enum تحديد مجموعة محدودة من السلاسل لمطابقة طلبات بحث المستخدمين، وضبط الترتيب لقيم السلسلة هذه، وتحديد اسم عامل تشغيل ليتم إقرانه بهذه السلاسل، حتى يتمكّن المستخدمون من تضييق نطاق النتائج لتقتصر على العناصر التي لها قيمة معيّنة فقط. على سبيل المثال، بالنسبة إلى العناصر في نظام تتبُّع الطلبات الذي يتضمن معلومات الأولوية، يمكنك تحديد p0 باعتبارها قيمة تعداد مسموح بها وربط هذا التعداد باسم عامل التشغيل الأولوية كي يتمكّن مستخدمو البحث من إضافة priority:p0 إلى طلب البحث لحصر مجموعة النتائج بالعناصر المفهرَسة ذات القيمة p0 فقط.
تمثيل JSON |
---|
{ "possibleValues": [ { object ( |
الحقول | |
---|---|
possibleValues[] |
قائمة القيم المحتملة لخاصية التعداد. يجب أن توفّر كل EnumValueValues قيمة سلسلة. إذا حددت قيمة عدد صحيح لزوج واحد من قيم زوج التساوي، يجب أن توفر كل أزواج قيم القيم المحتملة عددًا صحيحًا. يجب أن تكون قيمة السلسلة وقيمة العدد الصحيح فريدة على جميع القيم المحتملة. بعد الضبط، لا يمكن إزالة القيم المحتملة أو تعديلها. إذا قدّمت ترتيبًا مرتَّبًا وتعتقد أنّه يمكنك إدراج قيم تعداد إضافية في المستقبل، اترك فجوات في قيم الأعداد الصحيحة الأولية للسماح بإضافة قيمة بين القيم المسجَّلة سابقًا. الحد الأقصى لعدد العناصر هو 100. |
orderedRanking |
يُستخدَم لتحديد الترتيب المرتَّب للتعداد الذي يحدد كيفية استخدام قيم الأعداد الصحيحة المقدَّمة في أزواج قيم القيم المحتملة المتاحة لترتيب النتائج. في حال تحديد قيم عدد صحيح، يجب تقديم قيم عدد صحيح لجميع قيم EnumValue اللازمة المقدّمة لهذه السمة. لا يمكن استخدام هذه السياسة إلا إذا كانت قيمة السمة |
operatorOptions |
في حال ضبط هذه السمة، يصف كيفية استخدام التعداد كعامل تشغيل. |
EnumPropertyOptions.EnumValuePair
يحدد زوج قيمة التعداد شيئين: قيمة سلسلة مطلوبة وقيمة عدد صحيح اختيارية. تحدد قيمة السلسلة عبارة طلب البحث الضرورية المطلوبة لاسترداد هذا العنصر، مثل p0 لعنصر ذي أولوية. تحدّد قيمة العدد الصحيح ترتيب قيمة السلسلة تلك بالنسبة إلى القيم الأخرى المحتسبة للسمة نفسها. على سبيل المثال، يمكنك ربط p0 بـ 0 وتحديد زوج enum آخر مثل p1 و1. يجب استخدام قيمة العدد الصحيح مع ordered ranking
لضبط ترتيب قيمة معيّنة بالنسبة إلى القيم الأخرى المحتسبة لاسم السمة نفسه. في هذا المثال، يؤدي ترتيب DESCENDING الخاص بسمات الأولوية إلى تحسين ترتيب العناصر المفهرسة باستخدام القيمة p0 مقارنةً بالعناصر المفهرَسة ذات القيمة p1. وبدون ترتيب ترتيب محدد، لا تؤثر قيمة العدد الصحيح في ترتيب العنصر.
تمثيل JSON |
---|
{ "stringValue": string, "integerValue": integer } |
الحقول | |
---|---|
stringValue |
قيمة السلسلة لـ EnumValue الواردة. يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
integerValue |
قيمة العدد الصحيح لـ EnumValue الواردة والتي يجب أن تكون غير سالبة. اختياريّ. |
EnumPropertyOptions.OrderedRanking
يتم استخدامه لتحديد اتجاه الترتيب لعدد EnumValuePair
صحيح بالنسبة إلى قيم الأعداد الصحيحة الأخرى في EnumValue دراسة. بالنسبة إلى بعض السمات، تشير قيم الأعداد الصحيحة المنخفضة إلى أهمية أعلى، بينما يشير العدد الصحيح الأعلى إلى أهمية أعلى في البعض الآخر.
عمليات التعداد | |
---|---|
NO_ORDER |
ما مِن ترتيب لترتيب الموقع. لا يتم تعديل النتائج حسب قيمة هذا الموقع. |
ASCENDING |
تم ترتيب هذا الموقع تصاعديًا. وتشير القيم المنخفضة إلى الترتيب الأقل. |
DESCENDING |
تم ترتيب هذا الموقع تنازليًا. وتشير القيم المنخفضة إلى الترتيب الأعلى. |
EnumPropertyOptions.EnumOperatorOptions
يُستخدَم لتوفير عامل تشغيل بحث لخصائص enum. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه. على سبيل المثال، إذا لم يتم توفير أي عامل تشغيل لخاصية enum priority بالقيم المحتملة p0 وp1، سيعرض طلب البحث الذي يحتوي على المصطلح p0 عناصر تحتوي على p0 كقيمة السمة priority، بالإضافة إلى أي عناصر تحتوي على السلسلة p0 في حقول أخرى. إذا وفّرت اسم عامل تشغيل للتعداد، مثل priority، يمكن لمستخدمي البحث استخدام عامل التشغيل هذا لتحسين النتائج إلى العناصر التي تتضمّن p0 كقيمة السمة فقط، مع طلب البحث priority:p0.
تمثيل JSON |
---|
{ "operatorName": string } |
الحقول | |
---|---|
operatorName |
يشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية enum. على سبيل المثال، إذا كانت قيمة filterName هي priority، وكان اسم الموقع هو priorityVal، تعرض طلبات البحث مثل priority:<value> نتائج فقط عندما تتطابق قيمة السمة priorityVal مع <value>. في المقابل، يؤدي البحث الذي يستخدم <value> نفسها بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها <value> مع قيمة أي خصائص سلسلة أو نص داخل حقل المحتوى للعنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
DatePropertyOptions
خيارات خصائص التاريخ.
تمثيل JSON |
---|
{
"operatorOptions": {
object ( |
الحقول | |
---|---|
operatorOptions |
في حال تحديده، يصف كيف يجب استخدام التاريخ كعامل تشغيل بحث. |
DatePropertyOptions.DateOperatorOptions
اختياريّ. توفّر هذه السياسة عامل تشغيل بحث لخصائص التاريخ. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.
تمثيل JSON |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
الحقول | |
---|---|
operatorName |
تشير إلى السلسلة الفعلية المطلوبة في طلب البحث لعزل خاصية التاريخ. على سبيل المثال، لنفترض أنّ كائن مخطط تتبُّع المشاكل يحتوي على خاصية باسم closeDate التي تحدّد عامل تشغيل يتضمّن عامل التشغيل closeDate. وعند إجراء عمليات بحث عن هذه البيانات، لا تعرض طلبات البحث مثل closedon:<value> نتائج إلا عندما تتطابق قيمة السمة closedon:<value> مع closedon:<value>. في المقابل، يؤدي البحث الذي يستخدم <value> نفسها بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها <value> مع قيمة أي سمات سلسلة أو نص ضمن حقل المحتوى لمصدر البيانات المفهرَس. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
lessThanOperatorName |
تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية التاريخ باستخدام عامل التشغيل أقل من. على سبيل المثال، إذا كانت عملية lessThanOperatorName هي closedbefore وكان اسم الخاصية CloseDate، تعرض طلبات البحث مثل closedbefore:<value> نتائج فقط تكون فيها قيمة الخاصية المُسماة CloseDate أقدم من <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
greaterThanOperatorName |
تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية التاريخ باستخدام عامل التشغيل "أكبر من". على سبيل المثال، إذا تم ضبط اسم أكبر ThanOperatorName على closedafter وكان اسم الموقع هو CloseDate، تعرض طلبات البحث مثل closedafter:<value> نتائج فقط تكون فيها قيمة الخاصية المُسمّاة CloseDate بعد <value>. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
TextPropertyOptions
خيارات خصائص النص
تمثيل JSON |
---|
{ "retrievalImportance": { object ( |
الحقول | |
---|---|
retrievalImportance |
يشير إلى أهمية جودة البحث للرموز المميزة داخل الحقل عند استخدامها للاسترجاع. |
operatorOptions |
في حال تحديد هذه السمة، سنوضّح كيفية استخدام السمة كعامل تشغيل بحث. |
RetrievalImportance
تمثيل JSON |
---|
{
"importance": enum ( |
الحقول | |
---|---|
importance |
ويشير إلى أهمية الترتيب الممنوحة للخاصية عند مطابقتها أثناء الاسترجاع. وبعد الضبط، لا يمكن تغيير أهمية الرمز المميّز لإحدى السمات. |
RetrievalImportance.Importance
عمليات التعداد | |
---|---|
DEFAULT |
تعامل مع المطابقة كمطابقة نص أساسي. |
HIGHEST |
التعامل مع المطابقة على أنها مطابقة لعنوان العنصر. |
HIGH |
تعامل مع المطابقة بأهمية أعلى من النص الأساسي. |
LOW |
تعامل مع المطابقة بأهمية أقل من النص الأساسي. |
NONE |
لا تطابق هذا الحقل أثناء الاسترجاع. لا يزال من الممكن استخدام السمة لمطابقة عامل التشغيل والواجهات والاقتراح إذا رغبت في ذلك. |
TextPropertyOptions.TextOperatorOptions
يُستخدَم لتوفير عامل تشغيل بحث للخصائص النصية. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.
تمثيل JSON |
---|
{ "operatorName": string, "exactMatchWithOperator": boolean } |
الحقول | |
---|---|
operatorName |
يشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل الخاصية النصية. على سبيل المثال، إذا كانت قيمة filterName هي subject واسم الخاصية subjectLine، تعرض طلبات البحث مثل subject:<value> نتائج فقط حيث تتطابق قيمة السمة subjectLine مع <value>. في المقابل، يؤدي البحث الذي يستخدم نفس <value> بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها <value> مع قيمة أي خصائص نصية أو نص داخل حقل محتوى العنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
exactMatchWithOperator |
إذا كانت القيمة true، يتم تحويل القيمة النصية إلى رمز مميّز كقيمة بسيطة واحدة في عمليات البحث عن عوامل التشغيل وتطابقات الواجهات. على سبيل المثال، إذا كان اسم عامل التشغيل هو "genre" والقيمة هي "الخيال العلمي" قيود طلب البحث "genre:science" و"genre:خيال" لا تتطابق مع العنصر؛ "genre:خيال علمي" بالفعل. تُعدّ مطابقة القيمة النصية حسّاسة لحالة الأحرف ولا تزيل الرموز الخاصة. أما إذا كانت القيمة "false"، فسيتم تحويل النص إلى رمز مميّز. على سبيل المثال، إذا كانت القيمة هي "الخيال العلمي" طلبات البحث "genre:science" و"genre:خيال" يطابق العنصر. |
HtmlPropertyOptions
خيارات خصائص HTML.
تمثيل JSON |
---|
{ "retrievalImportance": { object ( |
الحقول | |
---|---|
retrievalImportance |
يشير إلى أهمية جودة البحث للرموز المميزة داخل الحقل عند استخدامها للاسترجاع. لا يمكن ضبطها إلا على DEFAULT أو NONE. |
operatorOptions |
في حال تحديد هذه السمة، سنوضّح كيفية استخدام السمة كعامل تشغيل بحث. |
HtmlPropertyOptions.HtmlOperatorOptions
يُستخدَم لتوفير عامل تشغيل بحث لخصائص html. وهذه خطوة اختيارية. تتيح عوامل تشغيل query.search للمستخدمين حصر طلب البحث في حقول محدّدة ذات صلة بنوع العنصر الذي يتم البحث عنه.
تمثيل JSON |
---|
{ "operatorName": string } |
الحقول | |
---|---|
operatorName |
تشير إلى اسم عامل التشغيل المطلوب في طلب البحث لعزل خاصية html. على سبيل المثال، إذا كانت قيمة filterName هي subject واسم الخاصية subjectLine، تعرض طلبات البحث مثل subject:<value> نتائج فقط حيث تتطابق قيمة السمة subjectLine مع <value>. في المقابل، يؤدي البحث الذي يستخدم نفس <value> بدون عامل تشغيل إلى عرض جميع العناصر التي تتطابق فيها <value> مع قيمة أي خصائص html أو نص داخل حقل المحتوى للعنصر. لا يمكن أن يحتوي اسم عامل التشغيل إلا على أحرف صغيرة (a-z). يجب ألّا يزيد عدد الأحرف عن 32 حرفًا. |
PropertyDisplayOptions
خيارات العرض الخاصة بالموقع.
تمثيل JSON |
---|
{ "displayLabel": string } |
الحقول | |
---|---|
displayLabel |
تشير هذه السمة إلى تصنيف سهل الاستخدام للسمة، ويتم استخدامه إذا كانت السمة محدَّدة ليتم عرضها في ObjectDisplayOptions. وفي حال توفير هذه السمة، سيظهر تصنيف العرض أمام قيم الخصائص عندما تكون السمة جزءًا من خيارات عرض العناصر. على سبيل المثال، إذا كانت قيمة السمة هي "1"، قد لا تكون القيمة في حد ذاتها سياقًا مفيدًا للمستخدم. إذا كان الاسم المعروض الذي تم تقديمه هو "الأولوية"، يرى المستخدم "الأولوية : 1". في نتائج البحث مما يوفر سياقًا واضحًا لمستخدمي البحث. هذا اختياري؛ وإذا لم يتم تقديمها، فسيتم عرض قيم الخصائص فقط. يجب ألّا يزيد عدد الأحرف عن 64 حرفًا. |