REST Resource: settings.searchapplications

المورد: SearchApplication

تطبيق البحث

تمثيل JSON 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
الحقول
name

string

اسم تطبيق البحث.

التنسيق: searchapplications/{applicationId}.
displayName

string

الاسم المعروض لتطبيق البحث. الحد الأقصى للطول هو 300 حرف.
dataSourceRestrictions[]

object (DataSourceRestriction)

القيود المطبقة على عمليات التهيئة. الحد الأقصى لعدد العناصر هو 10.
sourceConfig[]

object (SourceConfig)

ضبط مصادر محدَّدة في dataSourceRestrictions
scoringConfig

object (ScoringConfig)

تهيئة ترتيب النتائج.
defaultSortOptions

object (SortOptions)

الخيارات الافتراضية لترتيب نتائج البحث
defaultFacetOptions[]

object (FacetOptions)

الحقول التلقائية لعرض نتائج الواجهة. تم تضمين المصادر المحددة هنا أيضًا في dataSourceRestrictions أعلاه.
returnResultThumbnailUrls

boolean

مع كل نتيجة يجب أن نعرض معرف الموارد المنتظم (URI) للصورة المصغرة الخاصة به (إن أمكن)
operationIds[]

string

الإخراج فقط. أرقام تعريف العمليات الطويلة (LRO) قيد التشغيل حاليًا لهذا المخطط حقل الإخراج فقط.
enableAuditLog

boolean

يشير إلى ما إذا كان تسجيل التدقيق مفعَّلاً أم لا للطلبات المقدَّمة لتطبيق البحث في واجهات برمجة تطبيقات طلبات البحث.
queryInterpretationConfig

object (QueryInterpretationConfig)

الخيارات الافتراضية لتفسير طلب البحث

تقييد مصدر البيانات

تقييد على مصدر البيانات.

تمثيل JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
الحقول
source

object (Source)

مصدر التقييد.
filterOptions[]

object (FilterOptions)

خيارات التصفية التي تقيّد النتائج. وفي حال توفُّر فلاتر متعددة، سيتم تجميعها حسب نوع الكائن قبل الانضمام. يتم دمج الفلاتر من نوع الكائن نفسه بشكل متزامن، ثم يتم ضم التعبيرات الناتجة بشكلٍ غير قابل للدمج.

الحد الأقصى لعدد العناصر هو 20.

ملاحظة: تدعم Suggest API عددًا قليلاً من الفلاتر في الوقت الحالي: "objecttype" و"type" و"mimetype". في الوقت الحالي، لا يمكن استخدام فلاتر خاصة بالمخطط لفلترة الاقتراحات.

المصدر

لتحديد مصادر واجهات برمجة تطبيقات الاقتراحات/البحث.

تمثيل JSON 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
الحقول

حقل الاتحاد source.

يمكن أن يكون source واحدًا مما يلي فقط:
name

string

اسم المصدر للمحتوى المفهرَس بواسطة Indexing API.
predefinedSource

enum (Source.PredefinedSource)

مصدر المحتوى المحدد مسبقًا لـ Google Apps.

المصدر

المصادر المحددة مسبقًا:

عمليات التعداد
NONE
QUERY_HISTORY لاقتراح طلبات بحث أرسلها المستخدم في الماضي. صالحة فقط عند استخدامها مع واجهة برمجة تطبيقات الاقتراحات. يتم تجاهلها عند استخدامها في واجهة برمجة تطبيقات طلبات البحث.
PERSON لاقتراح أشخاص في المؤسسة. صالحة فقط عند استخدامها مع واجهة برمجة تطبيقات الاقتراحات. يؤدي إلى حدوث خطأ عند استخدامه في واجهة برمجة تطبيقات طلبات البحث.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

خيارات الفلتر

خيارات التصفية المراد تطبيقها على طلب البحث.

تمثيل JSON 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
الحقول
objectType

string

إذا تم تعيين objectType، فلن يتم عرض سوى الكائنات من هذا النوع. وينبغي أن يتوافق ذلك مع اسم الكائن الذي تم تسجيله ضمن تعريف المخطط. الحد الأقصى للطول هو 256 حرفًا.
filter

object (Filter)

فلتر عام لتقييد البحث، مثل lang:en، site:xyz.

تصفية

طريقة عامة للتعبير عن الفلاتر في طلب البحث، وتتوافق مع طريقتين:

1. إعداد "فلتر للقيمة". يجب أن يتطابق الاسم مع عامل تشغيل "الاسم" المحدد في المخطط لمصدر البيانات.

2- إعداد فلتر مركّب. يتم تقييم الفلاتر باستخدام عامل التشغيل المنطقي. لا يمكن أن تكون عوامل التشغيل عالية المستوى سوى AND أو NOT. ويمكن أن تظهر في المستوى الأعلى فقط. يمكن أن تظهر "أو" فقط ضمن المستوى الأعلى "و".

تمثيل JSON 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
الحقول

حقل الاتحاد filter.

يمكن أن يكون filter واحدًا مما يلي فقط:
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

تمثيل JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
الحقول
operatorName

string

يتم تطبيق operatorName على طلب البحث، مثل price_greater_than. يمكن أن يعمل الفلتر مع نوعي الفلاتر المحددين في المخطط لمصدر بياناتك:

  1. operatorName، حيث يصفي طلب البحث النتائج حسب الموقع الذي يطابق القيمة.

  2. greaterThanOperatorName أو lessThanOperatorName في المخطط. ويعمل طلب البحث على فلترة نتائج قيم الموقع التي تكون أكبر من القيمة المقدّمة في طلب البحث أو تقل عنه.
value

object (Value)

القيمة المطلوب مقارنتها.

القيمة

تعريف قيمة واحدة بنوع عام.

تمثيل JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
الحقول
حقل الاتحاد value. قيمة الخاصية المُسمّاة. يمكن أن يكون value واحدًا مما يلي فقط:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

طابع زمني بتنسيق RFC3339 UTC "Zulu"، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
booleanValue

boolean
dateValue

object (Date)

Filter.compositeFilter

تمثيل JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
الحقول
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

عامل تشغيل المنطق للفلتر الفرعي.
subFilters[]

object (Filter)

الفلاتر الفرعية.

Filter.compositeFilter.LogicOperator

عمليات التعداد
AND عوامل تشغيل منطقية لا يمكن تطبيقها إلا على الفلاتر الفرعية.
OR
NOT لا يمكن تطبيقها إلا على فلتر فرعي واحد.

تهيئة المصدر

عمليات الضبط لمصدر ما أثناء معالجة طلب query.search أو query.suggest.

تمثيل JSON 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
الحقول
source

object (Source)

المصدر الذي سيتم استخدام هذه التهيئة له.
scoringConfig

object (SourceScoringConfig)

تهيئة النتائج للمصدر.
crowdingConfig

object (SourceCrowdingConfig)

تهيئة التكديس للمصدر.

تهيئة نقاط المصدر

تعيين تهيئة النقاط. ويسمح ذلك بتعديل ترتيب النتائج للمصدر.

تمثيل JSON 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
الحقول
sourceImportance

enum (SourceScoringConfig.SourceImportance)

أهمية المصدر.

SourceScoringConfig.SourceImportance

أهمية المصدر الذي يمكن استخدامه للإشارة إلى ما إذا كان ينبغي منح المصدر الأولوية في الترتيب مقارنةً بمصدر آخر.

عمليات التعداد
DEFAULT
LOW
HIGH

تكوين الحشد المصدر

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

تمثيل JSON 
{
  "numResults": integer,
  "numSuggestions": integer
}
الحقول
numResults

integer

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

integer

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

تهيئة النقاط

تسجيل عمليات الضبط لأحد المصادر أثناء معالجة طلب query.search أو query.suggest

تمثيل JSON 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
الحقول
disableFreshness

boolean

لتحديد ما إذا كان سيتم استخدام الحداثة كإشارة ترتيب. يتم استخدام الحداثة كإشارة ترتيب بشكل افتراضي. لاحظ أن هذا الإعداد غير متاح في واجهة مستخدم المشرف.
disablePersonalization

boolean

تخصيص النتائج وسيتم استخدام الإشارات الشخصية تلقائيًا لتعزيز النتائج.

خيارات الترتيب

تمثيل JSON 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
الحقول
operatorName

string

اسم عامل التشغيل المطابق للحقل للترتيب وفقًا له. يجب وضع علامة sortable على السمة المقابلة.
sortOrder

enum (SortOptions.SortOrder)

الترتيب التصاعدي هو الترتيب التلقائي.

sortOptions.SortOrder

عمليات التعداد
ASCENDING
DESCENDING

خيارات الواجهة

لتحديد عوامل التشغيل لعرض نتائج الواجهة. سيكون هناك FacetResult واحدًا لكل مجموعة sourceName/objectType/operatorName.

تمثيل JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
الحقول
sourceName

string

اسم المصدر المراد التعامل معه. التنسيق: datasources/{sourceId} إذا كانت فارغة، فسيتم استخدام جميع مصادر البيانات.
objectType

string

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

string

اسم عامل التشغيل الذي تم اختياره للواجهات. @see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

الحد الأقصى لعدد حزم الواجهة التي يجب عرضها لهذه الواجهة. الإعداد التلقائي هو 10. الحد الأقصى للقيمة هو 100.
integerFacetingOptions

object (IntegerFacetingOptions)

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

خيارات عدد صحيح

يُستخدم لتحديد خيارات واجهات عدد صحيح.

تمثيل JSON 
{
  "integerBuckets": [
    string
  ]
}
الحقول
integerBuckets[]

string (Int64Value format)

يجب أن تكون مجموعات القيم الصحيحة الصحيحة تصاعديًا. على سبيل المثال، إذا كانت القيم المقدمة هي (1,5,10,100)، فستشكل مجموعات الواجهات التالية {<1, [1,5), [5-10), [10-100), >=100}.

تفسير طلبات البحث

الخيارات الافتراضية لتفسير طلب بحث المستخدم.

تمثيل JSON 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
الحقول
forceVerbatimMode

boolean

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

boolean

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

الطُرق

create

 لإنشاء تطبيق بحث.

delete

 حذف تطبيق بحث.

get

 الحصول على تطبيق البحث المحدد.

list

 يسرد جميع تطبيقات البحث.

patch

 تحديث تطبيق بحث.

reset

 لإعادة تعيين تطبيق بحث إلى الإعدادات الافتراضية.

update

 تحديث تطبيق بحث.