En esta página, se muestra cómo obtener una vista previa de las recomendaciones con la consola de Google Cloud y obtener resultados de recomendaciones con la API. Consulta la pestaña REST para ver ejemplos de llamadas a la API que pueden ayudarte a integrar recomendaciones en tu app.
El procedimiento que uses dependerá de si tienes datos de medios o datos personalizados:
- Recibe recomendaciones de contenido multimedia
- Obtén recomendaciones personalizadas para una app con datos estructurados
Cómo obtener recomendaciones de contenido multimedia
Console
Para usar la consola de Google Cloud para obtener una vista previa de las recomendaciones de medios, sigue estos pasos:
En la consola de Google Cloud , ve a la página AI Applications.
Haz clic en el nombre de la app para la que deseas obtener una vista previa de las recomendaciones.
Haz clic en Configurations > Training. Si Listo para consultar es Sí, la app está lista para la vista previa.
Haz clic en Vista previa.
Haz clic en el campo ID del documento. Aparecerá una lista de los IDs de documento.
Haz clic en el ID correspondiente al documento del que deseas obtener recomendaciones. También puedes escribir un ID de documento en el campo ID de documento.
Haz clic en Seleccionar configuración de entrega y elige la configuración de entrega de la que deseas obtener una vista previa.
Opcional: Ingresa el ID de visitante (también llamado ID de seudousuario) de un usuario para el que recopilaste eventos del usuario. Si dejas este campo en blanco o ingresas un ID de visitante que no existe, obtendrás una vista previa de las recomendaciones como si fueras un usuario nuevo.
Haz clic en Obtener recomendaciones. Aparecerá una lista de documentos recomendados.
Haz clic en un documento para obtener los detalles.
REST
Para usar la API y obtener recomendaciones de contenido multimedia, usa el método servingConfigs.recommend
:
Busca el ID del motor y el ID de la configuración de entrega. Si ya tienes tu ID de motor y los IDs de configuración de publicación, ve al paso 2.
En la consola de Google Cloud , ve a la página AI Applications.
Haz clic en el nombre de la app.
En el panel de navegación, haz clic en Configuraciones.
Si solo tienes una configuración de entrega, obtén el ID de configuración de entrega que se muestra en la pestaña Entrega.
Si tienes varias configuraciones de entrega en la pestaña Entrega, busca la configuración de entrega de la que deseas obtener recomendaciones. El ID de tu configuración de entrega es el valor de la columna ID.
Haz clic en la pestaña Entrenamiento. El ID del motor es el valor de la fila ID de la app.
Asegúrate de que la app esté lista para la vista previa:
En la consola de Google Cloud , ve a la página AI Applications.
Haz clic en el nombre de la app.
Haz clic en Configurations > Training. Si Listo para consultar es Sí, la app está lista para la vista previa.
Obtener recomendaciones
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d '{ "validateOnly": false, "userEvent": { "eventType": "view-item", "userPseudoId": "USER_PSEUDO_ID", "documents": [{ "id": "DOCUMENT_ID" }], "filter": "FILTER_STRING" } }' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
Reemplaza lo siguiente:
PROJECT_ID
: el ID de tu proyecto.DATA_STORE_ID
: Es el ID de tu almacén de datos.DOCUMENT_ID
: Es el ID del documento para el que deseas obtener una vista previa de las recomendaciones. Usa el ID que usaste para este documento en el momento en que transferiste tus datos.USER_PSEUDO_ID
: Es un identificador seudonimizado del usuario. Puedes usar una cookie HTTP para este campo, que identifica de forma única a un visitante en un solo dispositivo. No establezcas este campo en el mismo identificador para varios usuarios, ya que esto combinaría sus historiales de eventos y degradaría la calidad del modelo. No incluyas información de identificación personal (PII) en este campo.SERVING_CONFIG_ID
: Es el ID de tu configuración de publicación.FILTER
: es opcional. Es un campo de texto que te permite filtrar un conjunto específico de campos con la sintaxis de expresión de filtro. El valor predeterminado es una cadena vacía, lo que significa que no se aplica ningún filtro. Para obtener más información, consulta Cómo filtrar recomendaciones.
Deberías ver resultados similares a los siguientes:
{ "results": [{"id": "sample-id-1"}, {"id": "sample-id-2"}], "attributionToken": "abc123" }
Google recomienda asociar los tokens de atribución, que incluimos con cada respuesta de búsqueda y recomendación, con las acciones que realiza un usuario en respuesta a esas respuestas de búsqueda y recomendaciones. Esto puede mejorar la calidad de tus respuestas y recomendaciones de búsqueda con el tiempo. Para ello, agrega valores de attributionToken
a las URLs de cada uno de los vínculos que se muestran en tu sitio web para las respuestas o recomendaciones de búsqueda, por ejemplo, https://www.example.com/54321/?rtoken=abc123
. Cuando un usuario haga clic en uno de estos vínculos, incluye el valor de attributionToken
en el evento del usuario que registres.
Obtén recomendaciones para una app con datos estructurados personalizados
Console
Para usar la consola de Google Cloud para obtener una vista previa de las recomendaciones personalizadas para tu app estructurada, sigue estos pasos:
En la consola de Google Cloud , ve a la página AI Applications.
Haz clic en el nombre de la app para la que deseas obtener una vista previa de las recomendaciones.
Haz clic en Vista previa.
Haz clic en el campo ID del documento. Aparecerá una lista de los IDs de documento.
Haz clic en el ID correspondiente al documento del que deseas obtener recomendaciones. También puedes escribir un ID de documento en el campo ID de documento.
Haz clic en Obtener recomendaciones. Aparecerá una lista de documentos recomendados.
Haz clic en un documento para obtener los detalles.
REST
Para usar la API y obtener recomendaciones personalizadas para una app con datos estructurados, usa el método servingConfigs.recommend
:
Encuentra el ID del motor. Si ya tienes el ID del motor, ve al paso 2.
En la consola de Google Cloud , ve a la página AI Applications.
Haz clic en el nombre de la app.
Obtén el ID del motor de la URL de la consola de Google Cloud . Es el texto entre
engines/
y/data
. Por ejemplo, si la URL contienegen-app-builder/engines/demo_1234567890123/data/records
entonces el ID del motor es
demo_1234567890123
.
Busca el ID de tu almacén de datos. Si ya tienes el ID del almacén de datos, ve al siguiente paso.
En la consola de Google Cloud , ve a la página AI Applications y, en el menú de navegación, haz clic en Data Stores.
Haz clic en el nombre de tu almacén de datos.
En la página Datos de tu almacén de datos, obtén el ID del almacén de datos.
Asegúrate de que tu motor esté listo para la vista previa sondeando el método
GetEngine
hasta que devuelva"servingState":"ACTIVE"
. En ese punto, el motor estará listo para la vista previa.curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/ENGINE_ID
Reemplaza lo siguiente:
PROJECT_ID
: el ID de tu proyecto.ENGINE_ID
: Es el ID de tu motor.
Obtener recomendaciones
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -d '{ "userEvent": { "eventType":"view-item", "userPseudoId":"USER_PSEUDO_ID", "documents":[{"id":"DOCUMENT_ID"}]}}' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
Reemplaza lo siguiente:
PROJECT_ID
: el ID de tu proyecto.DATA_STORE_ID
: Es el ID de tu almacén de datos.DOCUMENT_ID
: Es el ID del documento para el que deseas obtener una vista previa de las recomendaciones. Usa el ID que usaste para este documento en el momento en que transferiste tus datos.USER_PSEUDO_ID
: Es un identificador seudonimizado del usuario. Puedes usar una cookie HTTP para este campo, que identifica de forma única a un visitante en un solo dispositivo. No establezcas este campo en el mismo identificador para varios usuarios, ya que esto combinaría sus historiales de eventos y degradaría la calidad del modelo. No incluyas información de identificación personal (PII) en este campo.SERVING_CONFIG_ID
: Es el ID de tu configuración de publicación. Tu ID de configuración de entrega es el mismo que el ID del motor, así que usa el ID del motor aquí.
C#
Para obtener más información, consulta la documentación de referencia de la API de AI Applications C#.
Para autenticarte en AI Applications, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Go
Para obtener más información, consulta la documentación de referencia de la API de AI Applications Go.
Para autenticarte en AI Applications, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Para obtener más información, consulta la documentación de referencia de la API de AI Applications Java.
Para autenticarte en AI Applications, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Para obtener más información, consulta la documentación de referencia de la API de AI Applications Node.js.
Para autenticarte en AI Applications, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
PHP
Para obtener más información, consulta la documentación de referencia de la API de AI Applications PHP.
Para autenticarte en AI Applications, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Para obtener más información, consulta la documentación de referencia de la API de AI Applications Python.
Para autenticarte en AI Applications, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Ruby
Para obtener más información, consulta la documentación de referencia de la API de AI Applications Ruby.
Para autenticarte en AI Applications, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.