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)

إعدادات لمصدر محدَّد في dataSourceقيود.

scoringConfig

object (ScoringConfig)

إعدادات ترتيب النتائج.

defaultSortOptions

object (SortOptions)

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

defaultFacetOptions[]

object (FacetOptions)

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

returnResultThumbnailUrls

boolean

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

operationIds[]

string

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

enableAuditLog

boolean

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

queryInterpretationConfig

object (QueryInterpretationConfig)

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

DataSourceRestriction

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

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

object (Source)

مصدر التقييد

filterOptions[]

object (FilterOptions)

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

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

ملاحظة: تتوافق واجهة برمجة تطبيقات Suggest مع عدد قليل من الفلاتر في الوقت الحالي: "نوع الكائن" و"النوع" و "نوع ميمي". في الوقت الحالي، لا يمكن استخدام الفلاتر الخاصة بالمخطط لفلترة الاقتراحات.

المصدر

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

تمثيل 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 يجب أن يتطابق الاسم مع عامل التشغيل المعلمة المعرّف في المخطط لمصدر البيانات.

2. ضبط فلتر مركّب يتم تقييم عوامل التصفية باستخدام العامل المنطقي. يمكن أن تكون عوامل المستوى الأعلى إما AND أو NOT فقط. لا يمكن أن تظهر "و" إلا في المستوى الأعلى. يمكن أن تظهر 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 "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 لا يمكن تطبيق 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

اسم المصدر المطلوب للواجهة عليه. التنسيق: 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

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

forceDisableSupplementalResults

boolean

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

الطُرق

create

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

delete

حذف تطبيق بحث

get

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

list

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

patch

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

reset

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

update

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