View a markdown version of this page

GetRecommendations - Amazon Personalize
Minta SintaksParameter Permintaan URIIsi PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

GetRecommendations

Mengembalikan daftar item yang direkomendasikan. Untuk kampanye, Nama Sumber Daya Amazon (ARN) kampanye diperlukan dan input pengguna dan item yang diperlukan tergantung pada jenis resep yang digunakan untuk membuat solusi yang mendukung kampanye sebagai berikut:

  • USER_PERSONALIZATION - userId diperlukan, tidak digunakan itemId

  • RELATED_ITEMS - itemId wajib, tidak digunakan userId

catatan

Kampanye yang didukung oleh solusi yang dibuat menggunakan resep jenis PERSONALIZED_RANKING menggunakan API. GetPersonalizedRanking

Untuk pemberi rekomendasi, ARN pemberi rekomendasi diperlukan dan item yang diperlukan serta masukan pengguna tergantung pada kasus penggunaan (resep berbasis domain) yang mendukung pemberi rekomendasi. Untuk informasi tentang persyaratan kasus penggunaan, lihat Memilih kasus penggunaan pemberi rekomendasi.

Minta Sintaks

POST /recommendations HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "itemId": "string",
   "metadataColumns": { 
      "string" : [ "string" ]
   },
   "numResults": number,
   "promotions": [ 
      { 
         "filterArn": "string",
         "filterValues": { 
            "string" : "string" 
         },
         "name": "string",
         "percentPromotedItems": number
      }
   ],
   "recommenderArn": "string",
   "userId": "string"
}

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

campaignArn

Nama Sumber Daya Amazon (ARN) dari kampanye yang akan digunakan untuk mendapatkan rekomendasi.

Tipe: String

Batasan Panjang: Panjang maksimum 256.

Pola: arn:([a-z\d-]+):personalize:.*:.*:.+

Wajib: Tidak

context

Metadata kontekstual untuk digunakan saat mendapatkan rekomendasi. Metadata kontekstual mencakup informasi interaksi apa pun yang mungkin relevan saat mendapatkan rekomendasi pengguna, seperti lokasi pengguna saat ini atau jenis perangkat.

Tipe: Peta string ke string

Entri Peta: Jumlah maksimum 150 item.

Kendala Panjang Kunci: Panjang maksimum 150.

Pola Kunci: [A-Za-z\d_]+

Batasan Panjang Nilai: Panjang maksimum 1000.

Wajib: Tidak

filterArn

ARN filter untuk diterapkan pada rekomendasi yang dikembalikan. Untuk informasi selengkapnya, lihat Rekomendasi Penyaringan.

Saat menggunakan parameter ini, pastikan sumber daya filter adalahACTIVE.

Tipe: String

Batasan Panjang: Panjang maksimum 256.

Pola: arn:([a-z\d-]+):personalize:.*:.*:.+

Wajib: Tidak

filterValues

Nilai yang digunakan saat memfilter rekomendasi. Untuk setiap parameter placeholder dalam ekspresi filter Anda, berikan nama parameter (dalam kasus yang cocok) sebagai kunci dan nilai filter sebagai nilai yang sesuai. Pisahkan beberapa nilai untuk satu parameter dengan koma.

Untuk ekspresi filter yang menggunakan INCLUDE elemen untuk menyertakan item, Anda harus memberikan nilai untuk semua parameter yang ditentukan dalam ekspresi. Untuk filter dengan ekspresi yang menggunakan EXCLUDE elemen untuk mengecualikan item, Anda dapat menghilangkan. Dalam hal ini, Amazon Personalize tidak menggunakan bagian ekspresi tersebut untuk memfilter rekomendasi. filter-values

Untuk informasi selengkapnya, lihat Memfilter rekomendasi dan segmen pengguna.

Tipe: Peta string ke string

Entri Peta: Jumlah maksimum 25 item.

Batasan Panjang Kunci: Panjang maksimum 50.

Pola Kunci: [A-Za-z0-9_]+

Batasan Panjang Nilai: Panjang maksimum 1000.

Wajib: Tidak

itemId

ID item untuk memberikan rekomendasi.

Diperlukan untuk jenis RELATED_ITEMS resep.

Tipe: String

Batasan Panjang: Panjang maksimum 256.

Wajib: Tidak

metadataColumns

Jika Anda mengaktifkan metadata dalam rekomendasi saat membuat atau memperbarui kampanye atau pemberi rekomendasi, tentukan kolom metadata dari kumpulan data Item untuk disertakan dalam rekomendasi item. Kunci peta adalah ITEMS dan nilainya adalah daftar nama kolom dari dataset Item Anda. Jumlah maksimum kolom yang dapat Anda berikan adalah 10.

Untuk informasi tentang mengaktifkan metadata untuk kampanye, lihat Mengaktifkan metadata dalam rekomendasi untuk kampanye. Untuk informasi tentang mengaktifkan metadata untuk pemberi rekomendasi, lihat Meng aktifkan metadata dalam rekomendasi untuk pemberi rekomendasi.

Tipe: Peta string ke array string

Entri Peta: Jumlah maksimum 1 item.

Batasan Panjang Kunci: Panjang maksimum 256.

Anggota Array: Jumlah maksimum 99 item.

Batasan Panjang: Panjang maksimum 150.

Wajib: Tidak

numResults

Jumlah hasil yang akan dikembalikan. Default-nya adalah 25. Jika Anda memasukkan metadata dalam rekomendasi, maksimumnya adalah 50. Kalau tidak, maksimumnya adalah 500.

Jenis: Integer

Rentang yang Valid: Nilai minimum 0.

Wajib: Tidak

promotions

Promosi yang berlaku untuk permintaan rekomendasi. Promosi mendefinisikan aturan bisnis tambahan yang berlaku untuk subset yang dapat dikonfigurasi dari item yang direkomendasikan.

Tipe: Array objek Promotion

Anggota Array: Jumlah maksimum 1 item.

Wajib: Tidak

recommenderArn

Nama Sumber Daya Amazon (ARN) dari pemberi rekomendasi untuk digunakan untuk mendapatkan rekomendasi. Berikan ARN rekomendasi jika Anda membuat grup dataset Domain dengan pemberi rekomendasi untuk kasus penggunaan domain.

Tipe: String

Batasan Panjang: Panjang maksimum 256.

Pola: arn:([a-z\d-]+):personalize:.*:.*:.+

Wajib: Tidak

userId

ID pengguna untuk memberikan rekomendasi.

Diperlukan untuk jenis USER_PERSONALIZATION resep.

Tipe: String

Batasan Panjang: Panjang maksimum 256.

Wajib: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "itemList": [ 
      { 
         "itemId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "promotionName": "string",
         "reason": [ "string" ],
         "score": number
      }
   ],
   "recommendationId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

itemList

Daftar rekomendasi yang diurutkan dalam urutan menurun berdasarkan skor prediksi. Maksimal bisa ada 500 item dalam daftar.

Tipe: Array objek PredictedItem

recommendationId

ID rekomendasi.

Tipe: String

Kesalahan

InvalidInputException

Berikan nilai yang valid untuk bidang atau parameter.

Kode Status HTTP: 400

ResourceNotFoundException

Sumber daya yang ditentukan tidak ada.

Kode Status HTTP: 404

Lihat Juga

Untuk informasi selengkapnya tentang menggunakan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: