REST Resource: settings.searchapplications

المصدر: SearchApplication

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

النتائج فقط. معرّفات العمليات الطويلة التشغيل (LROs) التي تعمل حاليًا لهذا المخطط. حقل الإخراج فقط.
enableAuditLog

boolean

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

object (QueryInterpretationConfig)

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

DataSourceRestriction

القيود المفروضة على مصدر البيانات:

تمثيل 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.

Source.PredefinedSource

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

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

FilterOptions

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

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

string

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

object (Filter)

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

تصفية

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

1. إعداد ValueFilter. يجب أن يتطابق الاسم مع filterName المحدّد في المخطط لمصدر بياناتك.

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

تمثيل 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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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 NOT لا يمكن تطبيقها إلا على فلتر فرعي واحد.

SourceConfig

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

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

object (Source)

المصدر الذي سيتم استخدام هذا الإعداد له.
scoringConfig

object (SourceScoringConfig)

إعداد النتائج للمصدر.
crowdingConfig

object (SourceCrowdingConfig)

إعدادات التكديس للمصدر.

SourceScoringConfig

اضبط تهيئة النتيجة. يتيح هذا الإجراء تعديل ترتيب النتائج الخاصة بمصدر معيّن.

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

enum (SourceScoringConfig.SourceImportance)

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

SourceScoringConfig.SourceImportance

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

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

SourceCrowdingConfig

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

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

integer

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

integer

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

ScoringConfig

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

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

boolean

تحديد ما إذا كان يجب استخدام حداثة المحتوى كمؤشر ترتيب وتُستخدَم حداثة المحتوى كمؤشر ترتيب تلقائيًا. تجدر الإشارة إلى أنّ هذا الإعداد غير متوفّر في واجهة مستخدِم "المشرف".
disablePersonalization

boolean

تحديد ما إذا كان سيتم تخصيص النتائج أم لا. سيتم تلقائيًا استخدام الإشارات الشخصية لتحسين النتائج.

SortOptions

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

string

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

enum (SortOptions.SortOrder)

التصاعدي هو نظام الفرز التلقائي

SortOptions.SortOrder

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

FacetOptions

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

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

string

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

string

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

string

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

integer

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

object (IntegerFacetingOptions)

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

IntegerFacetingOptions

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

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

string (Int64Value format)

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

QueryInterpretationConfig

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

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

boolean

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

boolean

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

الطُرق

create

 ينشئ تطبيق بحث.

delete

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

get

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

list

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

patch

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

reset

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

update

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