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

يجب أن نعرض مع كل نتيجة معرّف الموارد المنتظم لصورتها المصغّرة (عند الاقتضاء).
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 تقترح طلبات بحث أصدرَها المستخدم في السابق. لا تكون صالحة إلا عند استخدامها مع Suggest API. يتم تجاهلها عند استخدامها في واجهة برمجة التطبيقات لطلبات البحث.
PERSON تقترح المستخدمين في المؤسسة. لا تكون صالحة إلا عند استخدامها مع Suggest API. يؤدي ذلك إلى ظهور خطأ عند استخدامه في واجهة برمجة التطبيقات لطلبات البحث.
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. ضبط فلتر للقيمة يجب أن يتطابق الاسم مع operatorName محدّد في مخطّط مصدر البيانات.

2- ضبط CompositeFilter يتم تقييم الفلاتر باستخدام عامل التشغيل المنطقي. يمكن أن تكون عوامل التشغيل ذات المستوى الأعلى إما 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 لا يمكن تطبيق "ليس" إلا على فلتر فرعي واحد.

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

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

boolean

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

الطُرق

create

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

delete

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

get

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

list

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

patch

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

reset

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

update

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