Configurazione del plugin

Dopo aver installato il plug-in Amazon Personalize Search Ranking, sei pronto per configurarlo creando una pipeline di OpenSearch ricerca.

Una pipeline di ricerca è un insieme di processori di richiesta e risposta che vengono eseguiti in sequenza nell'ordine in cui vengono creati. Quando create una pipeline di ricerca per il plugin, specificate un personalized_search_ranking processore di risposta. Per informazioni sulle pipeline di ricerca, consulta Search pipeline.

Campi per il processore di risposta personalized_search_ranking

Per il processore di personalized_search_ranking risposta, specificate i seguenti campi:

• campaign_arn (obbligatorio): specifica l'Amazon Resource Name (ARN) della campagna Amazon Personalize da utilizzare per personalizzare i risultati.

• item_id_field (opzionale): se il _id campo per un documento indicizzato in non OpenSearch corrisponde ai tuoi Amazon Personalize ItemID, specifica il nome del campo corrispondente. Per impostazione predefinita, il plug-in presuppone che i _id dati corrispondano all'ItemID nei dati di Amazon Personalize.

• ricetta (obbligatorio): specifica il nome della ricetta Amazon Personalize da utilizzare. Puoi specificare soloaws-personalized-ranking.

• peso (obbligatorio): specifica l'enfasi che il processore di risposta attribuisce alla personalizzazione quando riclassifica i risultati. Specificate un valore compreso tra 0,0 e 1,0. Più ci si 1.0 avvicina, più è probabile che i risultati di Amazon Personalize si posizionino più in alto. Se lo specifichi0.0, non viene effettuata alcuna personalizzazione e ha la OpenSearch precedenza.

• tag (opzionale) — Specificate un identificatore per il processore.

• iam_role_arn (obbligatorio per OpenSearch Service, opzionale per Open Source OpenSearch) — Per Service OpenSearch , fornisci l'Amazon Resource Name (ARN) per il ruolo che hai creato durante la configurazione delle autorizzazioni affinché Service OpenSearch acceda alle tue risorse Amazon Personalize. Se le tue risorse OpenSearch Service e Amazon Personalize esistono in account diversi, specifica il ruolo che concede le AssumeRole autorizzazioni per il Servizio. OpenSearch Per ulteriori informazioni, consulta Configurazione delle autorizzazioni quando le risorse si trovano in account diversi.

  Per quanto riguarda l'open source OpenSearch, se utilizzi più ruoli per limitare le autorizzazioni a diversi gruppi di utenti della tua organizzazione, specifica l'ARN del ruolo autorizzato ad accedere ad Amazon Personalize. Se utilizzi solo AWS le credenziali nel tuo OpenSearch keystore, puoi omettere questo campo.

• aws_region (obbligatorio): la AWS regione in cui hai creato la tua campagna Amazon Personalize.

• ignore_failure (opzionale) — Specificate se il plugin ignora eventuali errori del processore. Per i valori, specificate o. true false Per gli ambienti di produzione, si consiglia di specificare true per evitare interruzioni nelle risposte alle query. Per gli ambienti di test, puoi specificare false di visualizzare gli eventuali errori generati dal plug-in.

• external_account_iam_role_arn: se utilizzi Service e le tue risorse Amazon Personalize OpenSearch e OpenSearch Service esistono in account diversi, specifica l'ARN del ruolo autorizzato ad accedere alle tue risorse Amazon Personalize. Questo ruolo deve esistere nello stesso account delle tue risorse Amazon Personalize. Per ulteriori informazioni, consulta Configurazione delle autorizzazioni quando le risorse si trovano in account diversi.

Creazione di una pipeline con Amazon Service OpenSearch

È possibile utilizzare il seguente codice Python per creare una pipeline di ricerca con un processore di personalized_search_ranking risposta su un OpenSearch dominio di servizio. Sostituiscilo domain endpoint con l'URL dell'endpoint del tuo dominio. Ad esempio: 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}")

Dopo aver creato una pipeline di ricerca con un processore di personalized_search_ranking risposta, sei pronto per iniziare ad applicare il plug-in alle OpenSearch query. Puoi applicarlo a un OpenSearch indice o a una singola OpenSearch query. Per ulteriori informazioni, consulta Applicazione del plugin alle OpenSearch query.

Creazione di una pipeline con codice open source OpenSearch

È possibile utilizzare il seguente comando curl per creare una pipeline di ricerca con un processore di personalized_search_ranking risposta su un cluster open source. OpenSearch

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
      }
    }
  ]
}'

Dopo aver creato una pipeline di ricerca con un processore di personalized_search_ranking risposta, sei pronto per iniziare ad applicare il plugin alle query. OpenSearch Puoi applicarlo a un OpenSearch indice o a una singola OpenSearch query. Per ulteriori informazioni, consulta Applicazione del plugin alle OpenSearch query.