يبحث هذا المعامل في "الرسم البياني المعرفي" عن الكيانات التي تتطابق مع القيود.
طلب HTTP
GET https://kgsearch.googleapis.com/v1/entities:search
معلمات طلب البحث
اسم المعلَمة | Type | الوصف |
---|---|---|
query |
string |
سلسلة حرفية للبحث عنها في "الرسم البياني المعرفي". |
ids |
string |
قائمة بأرقام تعريف الكيانات المطلوب البحث عنها في "الرسم البياني المعرفي". لتحديد عدة معرّفات في طلب HTTP، كرِّر المَعلمة في عنوان URL كما في ...?ids=A&ids=B. |
languages |
string |
قائمة رموز اللغات (محددة في ISO 639) لتشغيل الاستعلام بها، على سبيل المثال `en`. |
types |
string |
تفرض هذه السمة قيودًا على الكيانات التي يتم عرضها على الأنواع المحدّدة. على سبيل المثال، يمكنك تحديد "شخص" (على النحو المحدّد في http://schema.org/Person) لحصر النتائج بالكيانات التي تمثّل أشخاصًا. إذا تم تحديد أنواع متعددة، ستحتوي الكيانات المعروضة على نوع واحد أو أكثر من هذه الأنواع. |
indent |
boolean |
تتيح هذه السياسة إضافة مسافة بادئة لنتائج JSON. |
prefix |
boolean |
تعمل هذه السياسة على تفعيل مطابقة البادئة (سلسلة فرعية مبدئية) مع الأسماء والأسماء المستعارة للكيانات. على سبيل المثال، تتطابق البادئة "Jung" مع الكيانات والأسماء المستعارة، مثل "Jung" و"Jungle" و"Jung-ho Kang". |
limit |
number |
تؤدي هذه السياسة إلى تقييد عدد الكيانات المطلوب عرضها. الحد الأقصى هو 500. والعدد التلقائي هو 20. تزيد فرصة انتهاء المهلة في الطلبات ذات الحدود القصوى. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
تحتوي رسالة الرد على قائمة بالكيانات، يتم عرضها بتنسيق JSON-LD ومتوافقة مع مخططات schema.org (مع إضافات خارجية محدودة).
يوضّح مثال JSON-LD التالي كيفية تنظيم نص الاستجابة:
{
"@context": {
"@vocab": "http://schema.org/",
"goog": "http://schema.googleapis.com/",
"resultScore": "goog:resultScore",
"detailedDescription": "goog:detailedDescription",
"EntitySearchResult": "goog:EntitySearchResult",
"kg": "http://g.co/kg"
},
"@type": "ItemList",
"itemListElement": [
{
"@type": "EntitySearchResult",
"result": {
"@id": "kg:/m/0dl567",
"name": "Taylor Swift",
"@type": [
"Thing",
"Person"
],
"description": "Singer-songwriter",
"image": {
"contentUrl": "https://t1.gstatic.com/images?q=tbn:ANd9GcQmVDAhjhWnN2OWys2ZMO3PGAhupp5tN2LwF_BJmiHgi19hf8Ku",
"url": "https://en.wikipedia.org/wiki/Taylor_Swift",
"license": "http://creativecommons.org/licenses/by-sa/2.0"
},
"detailedDescription": {
"articleBody": "Taylor Alison Swift is an American singer-songwriter and actress. Raised in Wyomissing, Pennsylvania, she moved to Nashville, Tennessee, at the age of 14 to pursue a career in country music. ",
"url": "http://en.wikipedia.org/wiki/Taylor_Swift",
"license": "https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License"
},
"url": "http://taylorswift.com/"
},
"resultScore": 4850
}
]
}
حقول الردّ
اسم الحقل | Type | الوصف |
---|---|---|
@id |
string |
هو معرّف الموارد المنتظم (URI) الأساسي للكيان. |
name |
string |
اسم الكيان. |
@type |
array |
قائمة بأنواع schema.org المتوافقة التي تتطابق مع الكيان. |
description |
string |
اكتب وصفًا موجزًا للكيان. |
image |
URL |
صورة للمساعدة في تحديد الكيان. |
detailedDescription |
string |
تمثّل هذه السمة وصفًا تفصيليًا للكيان. |
url |
URL |
عنوان URL للموقع الإلكتروني الرسمي للكيان، في حال توفّره. |
resultScore |
number |
يشير ذلك المصطلح إلى مؤشر لمدى مطابقة العنصر لقيود الطلب. |
كلمات رئيسية بتنسيق JSON-LD
بالنسبة إلى الكلمات الرئيسية بتنسيق JSON-LD، مثل @context أو @vocab أو @type أو @id، يُرجى الاطّلاع على مواصفات JSON-LD.
التوافق مع schema.org
يستخدم الردّ المفردات المستضافة على schema.org مع إضافات محدودة (مثل resultScore
) متوافقة مع مفردات schema.org.
لمزيد من التفاصيل حول هذه الإضافات، يمكنك الاطّلاع على
قائمة إضافات المخططات.
بالنسبة إلى كل نوع من أنواع Schema.org (مثل Person
) والخصائص (مثل
name
)، هناك معرّف موارد منتظم (URI) كامل مطابق، كما في الأمثلة التالية:
- شخص -> http://schema.org/person
Thing -> http://schema.org/Thing
الاسم -> http://schema.org/name
الوصف -> http://schema.org/description
يمكن توسيع الأنواع والخصائص المحدّدة كإضافات مخططات Google باستخدام http://schema.googleapis.com. على سبيل المثال،
- EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
- التفصيلية -> http://schema.googleapis.com/detailedDescription
تتوفر الوثائق المتعلقة بكل نوع وخاصية على عنوان URI المقابل.
قائمة إضافات المخططات
تتم استضافة إضافات المخطط المستخدَمة في واجهة برمجة التطبيقات هذه على http://schema.googleapis.com كـ إضافات خارجية.
الإضافة type في Schema.org هي:
إضافات الخاصية في Schema.org هي: