موجودیت های روش.جستجو

نمودار دانش را برای موجودیت هایی که با محدودیت ها مطابقت دارند جستجو می کند.

درخواست 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 موجودیت های برگشتی را به انواع مشخص شده محدود می کند. به عنوان مثال، می‌توانید «Person» را مشخص کنید (همانطور که در http://schema.org/Person تعریف شده است) تا نتایج را به نهادهایی که افراد را نمایندگی می‌کنند محدود کنید. اگر چندین نوع مشخص شده باشد، موجودیت های برگشتی حاوی یک یا چند نوع از این نوع خواهند بود.
indent boolean تورفتگی نتایج JSON را فعال می کند.
prefix boolean تطابق پیشوند (رشته فرعی اولیه) با نام ها و نام مستعار موجودیت ها را فعال می کند. برای مثال، پیشوند «جونگ» با موجودیت‌ها و نام‌های مستعار مانند «جونگ»، «جنگل» و «جونگ هو کانگ» مطابقت دارد.
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 نشانی وب سایت رسمی نهاد، در صورت وجود.
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 مربوطه موجود است.

لیست پسوندهای طرحواره

برنامه های افزودنی طرحواره استفاده شده در این API در http://schema.googleapis.com به عنوان پسوندهای خارجی میزبانی می شوند.

پسوند نوع Schema.org این است:

پسوندهای دارایی Schema.org عبارتند از: