Configuración del complemento

Tras instalar el complemento Amazon Personalize Search Ranking, podrás configurarlo mediante la creación de un canal OpenSearch de búsqueda.

Una canalización de búsqueda es un conjunto de procesadores de solicitudes y respuestas que se ejecutan secuencialmente en el orden en que se crean. Cuando crea una canalización de búsqueda para el complemento, especifica un procesador de respuestas personalized_search_ranking. Para obtener información sobre las canalizaciones de búsqueda, consulta Buscar canalizaciones.

Campos para el procesador de respuestas personalized_search_ranking

Para el procesador de respuestas personalized_search_ranking, especifique los campos siguientes:

• campaign_arn (obligatorio): especifique el nombre del recurso de Amazon (ARN) de la campaña de Amazon Personalize que se utilizará para personalizar los resultados.

• item_id_field (opcional): si el _id campo de un documento indexado OpenSearch no se corresponde con tus ItemIDs de Amazon Personalize, especifica el nombre del campo que sí lo hace. De forma predeterminada, el complemento asume que los datos _id coinciden con el itemId de sus datos de Amazon Personalize.

• recipe (obligatorio): especifica el nombre de la receta de Amazon Personalize que se va a utilizar. Puede especificar solo aws-personalized-ranking.

• weight (obligatorio): especifique el énfasis que el procesador de respuestas pone en la personalización cuando reclasifica los resultados. Especifique un valor dentro de un rango de 0,0—1,0. Cuanto más cerca esté de 1.0, más probable es que los resultados de Amazon Personalize tengan una clasificación más alta. Si lo especifica, no se realizará ninguna personalización y tendrá 0.0 prioridad. OpenSearch

• tag (opcional): especifique un identificador para el procesador.

• iam_role_arn (obligatorio para el OpenSearch servicio, opcional para el código abierto OpenSearch): para el servicio OpenSearch , proporcione el nombre de recurso de Amazon (ARN) para el rol que creó al configurar los permisos para que el Servicio acceda a sus recursos de Amazon Personalize. OpenSearch Si sus recursos de OpenSearch Service y Amazon Personalize existen en cuentas diferentes, especifique el rol que concede AssumeRole los permisos para el OpenSearch Servicio. Para obtener más información, consulte Configurar permisos cuando los recursos están en cuentas diferentes.

  En el caso del código abierto OpenSearch, si utiliza varios roles para restringir los permisos a distintos grupos de usuarios de su organización, especifique el ARN del rol que tiene permiso para acceder a Amazon Personalize. Si utiliza únicamente las AWS credenciales de su OpenSearch almacén de claves, puede omitir este campo.

• aws_region (obligatorio): la AWS región en la que creaste tu campaña Amazon Personalize.

• ignore_failure (opcional): especifique si el complemento ignora los errores del procesador. Para los valores, especifique true o false. Para sus entornos de producción, le recomendamos que lo especifique true para evitar interrupciones en las respuestas a las consultas. En el caso de los entornos de prueba, puede especificar false para ver los errores que genera el complemento.

• external_account_iam_role_arn: si utiliza OpenSearch Service y sus recursos de Amazon Personalize y Service están en cuentas diferentes, especifique el OpenSearch ARN del rol que tiene permiso para acceder a sus recursos de Amazon Personalize. Este rol debe existir en la misma cuenta que tus recursos de Amazon Personalize. Para obtener más información, consulte Configurar permisos cuando los recursos están en cuentas diferentes.

Creación de una canalización con Amazon OpenSearch Service

Puede usar el siguiente código de Python para crear una canalización de búsqueda con un procesador de personalized_search_ranking respuestas en un dominio OpenSearch de servicio. Sustituya domain endpoint por la URL del punto de conexión de su dominio. Por ejemplo: 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}")

Tras crear una canalización de búsqueda con un procesador de personalized_search_ranking respuestas, estará listo para empezar a aplicar el complemento a OpenSearch las consultas. Puedes aplicarlo a un OpenSearch índice o a una OpenSearch consulta individual. Para obtener más información, consulte Aplicar el complemento a OpenSearch las consultas.

Crear una canalización con código abierto OpenSearch

Puedes usar el siguiente comando curl para crear una canalización de búsqueda con un procesador de personalized_search_ranking respuestas en un OpenSearch clúster de código abierto.

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

Tras crear una canalización de búsqueda con un procesador de personalized_search_ranking respuestas, estará listo para empezar a aplicar el complemento a OpenSearch las consultas. Puedes aplicarlo a un OpenSearch índice o a una OpenSearch consulta individual. Para obtener más información, consulte Aplicar el complemento a OpenSearch las consultas.