Mengkonfigurasi plugin

Setelah menginstal plugin Amazon Personalize Search Ranking, Anda siap mengonfigurasinya dengan membuat pipeline OpenSearch pencarian.

Pipeline pencarian adalah sekumpulan prosesor permintaan dan respons yang berjalan secara berurutan sesuai urutan yang Anda buat. Saat Anda membuat pipeline pencarian untuk plugin, Anda menentukan prosesor personalized_search_ranking respons. Untuk informasi tentang saluran pipa pencarian, lihat Cari saluran pipa.

Bidang untuk prosesor personalized_search_ranking respons

Untuk prosesor personalized_search_ranking respons, Anda menentukan bidang berikut:

• campaign_arn (wajib) - Tentukan Nama Sumber Daya Amazon (ARN) dari kampanye Amazon Personalize yang akan digunakan untuk mempersonalisasi hasil.

• item_id_field (opsional) - Jika _id bidang untuk dokumen yang diindeks tidak OpenSearch sesuai dengan Amazon Personalize ItemIds Anda, tentukan nama bidang yang melakukannya. Secara default, plugin mengasumsikan bahwa _id data cocok dengan ItemID di Amazon Personalisasi data Anda.

• resep (wajib) — Tentukan nama resep Amazon Personalize yang akan digunakan. Anda hanya dapat menentukanaws-personalized-ranking.

• bobot (wajib) - Tentukan penekanan yang diberikan prosesor respons pada personalisasi saat memberi peringkat ulang hasil. Tentukan nilai dalam kisaran 0,0—1,0. Semakin dekat dengan 1.0 itu, semakin besar kemungkinan hasil dari Amazon Personalisasi peringkat lebih tinggi. Jika Anda menentukan0.0, tidak ada personalisasi yang terjadi dan OpenSearch diutamakan.

• tag (opsional) - Tentukan pengenal untuk prosesor.

• iam_role_arn (diperlukan untuk OpenSearch Layanan, opsional untuk sumber terbuka OpenSearch) — Untuk Layanan OpenSearch , berikan Nama Sumber Daya Amazon (ARN) untuk peran yang Anda buat saat menyiapkan izin untuk Layanan untuk mengakses sumber daya Amazon Personalisasi. OpenSearch Jika OpenSearch Layanan dan Amazon Personalisasi sumber daya Anda ada di akun yang berbeda, tentukan peran yang memberikan AssumeRole izin untuk Layanan. OpenSearch Untuk informasi selengkapnya, lihat Mengkonfigurasi izin saat sumber daya berada di akun yang berbeda.

  Untuk open source OpenSearch, jika Anda menggunakan beberapa peran untuk membatasi izin untuk grup pengguna yang berbeda di organisasi Anda, tentukan ARN peran yang memiliki izin untuk mengakses Amazon Personalize. Jika Anda hanya menggunakan AWS kredensyal di OpenSearch keystore Anda, Anda dapat menghilangkan bidang ini.

• aws_region (wajib) - AWS Wilayah tempat Anda membuat kampanye Amazon Personalisasi.

• ignore_failure (opsional) - Tentukan apakah plugin mengabaikan kegagalan prosesor. Untuk nilai, tentukan true ataufalse. Untuk lingkungan produksi Anda, kami sarankan Anda menentukan true untuk menghindari gangguan apa pun untuk respons kueri. Untuk lingkungan pengujian, Anda dapat menentukan false untuk melihat kesalahan apa pun yang dihasilkan plugin.

• external_account_iam_role_arn — Jika Anda menggunakan OpenSearch Layanan, dan sumber daya Amazon OpenSearch Personalisasi dan Layanan ada di akun yang berbeda, tentukan ARN peran yang memiliki izin untuk mengakses sumber daya Amazon Personalisasi Anda. Peran ini harus ada di akun yang sama dengan sumber daya Amazon Personalisasi Anda. Untuk informasi selengkapnya, lihat Mengkonfigurasi izin saat sumber daya berada di akun yang berbeda.

Membuat pipeline dengan Amazon OpenSearch Service

Anda dapat menggunakan kode Python berikut untuk membuat pipeline pencarian dengan prosesor personalized_search_ranking respons pada domain OpenSearch Layanan. Ganti domain endpoint dengan URL endpoint domain Anda. Misalnya: https://<domain name>.<AWS region>.es-staging.amazonaws.com.

import requests
from requests_auth_aws_sigv4 import AWSSigV4

domain_endpoint = 'domain endpoint'
pipeline_name = 'pipeline name'
url = f'{domain_endpoint}/_search/pipeline/{pipeline_name}'
auth = AWSSigV4('es')

headers = {'Content-Type': 'application/json'}

body = {
  "description": "A pipeline to apply custom re-ranking from Amazon Personalize",
  "response_processors": [
    {
      "personalized_search_ranking" : {
        "campaign_arn" : "Amazon Personalize Campaign ARN",
        "item_id_field" : "productId",
        "recipe" : "aws-personalized-ranking",
        "weight" : "0.3",
        "tag" : "personalize-processor",
        "iam_role_arn": "Role ARN",
        "aws_region": "AWS region",
        "ignore_failure": true
    }
  ]
}
try:
    response = requests.put(url, auth=auth, json=body, headers=headers, verify=False)
    print(response.text)
except Exception as e:
    print(f"Error: {e}")

Setelah membuat pipeline pencarian dengan prosesor personalized_search_ranking respons, Anda siap untuk mulai menerapkan plugin ke OpenSearch kueri. Anda dapat menerapkannya ke OpenSearch indeks atau OpenSearch kueri individual. Untuk informasi selengkapnya, lihat Menerapkan plugin ke OpenSearch kueri.

Membuat pipeline dengan open source OpenSearch

Anda dapat menggunakan perintah curl berikut untuk membuat pipeline pencarian dengan prosesor personalized_search_ranking respons pada OpenSearch cluster open source.

curl -X PUT "http://localhost:9200/_search/pipeline/pipeline-name" -ku 'admin:admin' --insecure -H 'Content-Type: application/json' -d'
{
  "description": "A pipeline to apply custom re-ranking from Amazon Personalize",
  "response_processors" : [
    {
      "personalized_search_ranking" : {
        "campaign_arn" : "Amazon Personalize Campaign ARN",
        "item_id_field" : "productId",
        "recipe" : "aws-personalized-ranking",
        "weight" : "0.3",
        "tag" : "personalize-processor",
        "iam_role_arn": "Role ARN",
        "aws_region": "AWS region",
        "ignore_failure": true
      }
    }
  ]
}'

Setelah membuat pipeline pencarian dengan prosesor personalized_search_ranking respons, Anda siap untuk mulai menerapkan plugin ke OpenSearch kueri. Anda dapat menerapkannya ke OpenSearch indeks atau OpenSearch kueri individual. Untuk informasi selengkapnya, lihat Menerapkan plugin ke OpenSearch kueri.