Menelusuri Pustaka Pengetahuan untuk menemukan entity yang cocok dengan batasan.
Permintaan HTTP
GET https://kgsearch.googleapis.com/v1/entities:search
Parameter kueri
Nama parameter | Jenis | Deskripsi |
---|---|---|
query |
string |
String literal yang ditelusuri di Pustaka Pengetahuan. |
ids |
string |
Daftar ID entity untuk ditelusuri di Pustaka Pengetahuan. Untuk menentukan beberapa ID dalam permintaan HTTP, ulangi parameter dalam URL seperti di ...?ids=A&ids=B |
languages |
string |
Daftar kode bahasa (ditentukan dalam ISO 639) untuk menjalankan kueri, misalnya `en`. |
types |
string |
Membatasi entity yang ditampilkan ke entity dari jenis yang ditentukan. Misalnya, Anda dapat menentukan `Person` (seperti yang ditetapkan dalam http://schema.org/Person) untuk membatasi hasil agar hanya menampilkan entitas yang mewakili orang. Jika beberapa jenis ditentukan, entity yang ditampilkan akan berisi satu atau beberapa jenis tersebut. |
indent |
boolean |
Mengaktifkan indentasi hasil JSON. |
prefix |
boolean |
Mengaktifkan pencocokan awalan (substring awal) terhadap nama dan alias entity. Misalnya, awalan `Jung` akan cocok dengan entitas dan alias seperti `Jung`, `Jungle`, dan `Jung-ho Kang`. |
limit |
number |
Membatasi jumlah entity yang akan ditampilkan. Jumlah maksimumnya adalah 500. Defaultnya adalah 20. Permintaan dengan batas tinggi memiliki peluang waktu tunggu yang lebih tinggi. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Pesan respons berisi daftar entity, yang ditampilkan dalam format JSON-LD dan kompatibel dengan skema schema.org (dengan ekstensi eksternal terbatas).
Contoh JSON-LD berikut menunjukkan cara struktur isi respons:
{
"@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
}
]
}
Kolom respons
Nama kolom | Jenis | Deskripsi |
---|---|---|
@id |
string |
URI kanonis untuk entity. |
name |
string |
Nama entity. |
@type |
array |
Daftar jenis schema.org yang didukung dan cocok dengan entity. |
description |
string |
Deskripsi singkat tentang entity. |
image |
URL |
Gambar untuk membantu mengidentifikasi entitas. |
detailedDescription |
string |
Deskripsi mendetail tentang entity. |
url |
URL |
URL situs resmi entitas, jika tersedia. |
resultScore |
number |
Indikator seberapa baik entity cocok dengan batasan permintaan. |
Kata kunci JSON-LD
Untuk kata kunci JSON-LD seperti @context, @vocab, @type, atau @id, lihat spesifikasi JSON-LD.
Kompatibilitas schema.org
Respons menggunakan kosakata yang dihosting di schema.org, dengan ekstensi terbatas (misalnya, resultScore
) yang kompatibel dengan kosakata schema.org.
Untuk mengetahui detail lebih lanjut tentang ekstensi ini, lihat Daftar ekstensi skema.
Untuk setiap jenis Schema.org (seperti Person
) dan properti (seperti
name
), terdapat URI lengkap yang sesuai, seperti dalam contoh berikut:
- Orang -> http://schema.org/Person
Hal -> http://schema.org/Thing
nama -> http://schema.org/name
deskripsi -> http://schema.org/description
Jenis dan properti yang ditetapkan sebagai ekstensi skema Google dapat diperluas dengan http://schema.googleapis.com. Misalnya,
- EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
- detailDescription -> http://schema.googleapis.com/detailedDescription
Dokumentasi untuk setiap jenis dan properti tersedia di URI yang sesuai.
Daftar ekstensi skema
Ekstensi skema yang digunakan dalam API ini dihosting di http://schema.googleapis.com sebagai ekstensi eksternal.
Ekstensi type untuk Schema.org adalah:
Ekstensi properti untuk Schema.org adalah: