الطريقةEntity.search

يبحث في الرسم البياني المعرفي عن الكيانات التي تتطابق مع القيود.

طلب HTTP

GET https://kgsearch.googleapis.com/v1/entities:search

معامِلات طلب البحث

اسم المعلَمة النوع الوصف
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
    }
  ]
}

حقول الردّ

اسم الحقل النوع الوصف
@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 هي: