Solicitudes de API de muestra

Artículo
10/07/2024

Este artículo muestra algunos ejemplos de solicitudes de API y respuestas asociadas. Cada ejemplo muestra un escenario de recomendaciones base junto con otras funciones de modificación de respuesta, como filtrado, paginación, selección de un algoritmo alternativo y más. Si desea probar estos ejemplos en sus Intelligent Recommendations punto de conexión, asegúrese de reemplazar el nombre punto de conexión (parte DNS) y ajuste los parámetros a sus datos.

Nota

El parámetro de conteo controlará la cantidad de elementos devueltos en cada respuesta. Los ejemplos tendrán el conteo establecido en 5 para mayor claridad y brevedad. Para obtener más información sobre las formas de construir sus solicitudes de API, consulte API de Intelligent Recommendations y Guía de inicio rápido para llamar a la API.

Ejemplos

Estos son algunos ejemplos que puede probar con su cuenta de Intelligent Recommendations:

Si se encuentra con errores al probar las respuestas a continuación, consulte Registros de errores.

Obtener nuevos elementos

La API New Items devuelve una lista de productos ordenados por fecha de lanzamiento.

La solicitud de API tiene el aspecto siguiente:

https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/New?modeling=adw&Count=5

Una respuesta exitosa se ve así:

{
    "id": "Lists",
    "name": "Lists",
    "version": "v1.0",
    "interactionsVersion": "20220104115104",
    "items": [
        {
            "id": "70000",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "70002",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "70003",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "70004",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "70005",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "New",
    "longTitle": "New",
    "titleId": 3,
    "pagingInfo": {
        "totalItems": 278
    },
    "status": "Success"
}

AlgoType	Definición	API admitida
RecentPurchases	Las recomendaciones de selecciones se calculan en función de las compras más recientes del usuario.	Solo disponible con el API de selecciones de usuarios.
Objeto visual	Las similitudes de los elementos se calculan en función de las similitudes visuales de las imágenes del catálogo.	Solo disponible con el API similar.
Textual	Las similitudes de los elementos se calculan en función de las similitudes textuales (comprensión del idioma) de las descripciones textuales del catálogo.	Solo disponible con el API similar.

Código	Estado	Motivo	Cómo resolver
200	Correcto	La solicitud de API se realizó correctamente.	N/A
200	EmptyResults	Hay recomendaciones para este elemento semilla (itemId), pero, sin embargo, todos se filtraron.	El principal motivo de filtrado son los datos asociados a los artículos del catálogo. Cuando prevé la devolución de ciertos productos, es importante verificar sus fechas de disponibilidad y asegurarse de que estén configurados correctamente con las asignaciones de filtrado adecuadas, como categoría, canal, catálogo y disponibilidad.
200	DataDoesNotExist	El elemento semilla (itemId) no existe en los resultados. El itemId especificado puede faltar en los datos de entrada o no tiene suficientes datos para tener resultados calculados.	Compruebe que el artículo: - es válido - pertenece al canal correcto - Tiene suficientes interacciones/imágenes/texto. Para obtener más información, consulte Comprobar la guía de de formato del contrato de datos.
200	WaitingForData	Cuando se crea un nuevo componente de modelado, el cálculo puede tardar algún tiempo y es posible que no esté listo para devolver resultados.	Consulte los registros o el informe de estado de modelado para ver si hay errores. Si, después de 24 horas, el problema persiste sin registro de errores, contáctenos.
400	UnsupportedRequest	Uno de los parámetros de la API tiene un valor no admitido o hay otro problema con la solicitud de la API, como: un escenario no admitido o deshabilitado.	Verifique si el valor del encabezado es diferente al parámetro real. Para ver ejemplos de solicitudes de API en funcionamiento, vaya al principio de este artículo. Se deshabilitan diferentes solicitudes de API dependiendo de si su conjunto de características de modelado está configurado en Estándar o Premium. También puede consultar el informe de estado de modelado para ver si hay errores con alguno de los algoritmos.
400	UnsupportedFeature	Está intentando llamar a una API que no es compatible, según su conjunto de características de modelado actual.	Habilite la función de modelado correcta establecida en estándar o premium. Lista de los escenarios disponibles para cada conjunto de características.
401		Solicitud no autenticada	Asegúrese de que su inquilino tenga permisos asignados para que el servicio funcione. Siga estos pasos para comprobar la autenticación.
408	RequestTimeout	Se agotó el tiempo de espera de la solicitud.	Intente volver a llamar a la solicitud de API.
429		RPS está por encima del nivel preasignado y corre el riesgo de ser limitado.	Aumente la capacidad de RPS preasignada a un nivel superior o reduzca el RPS actual.
500	Error interno del servidor	Se produjo un error de Intelligent Recommendations.	Este problema puede ser temporal, así que vuelva a intentarlo después de un par de minutos. Consulte los registros o el informe de estado de modelado para ver si hay errores. Si el problema persiste sin registro de errores, contáctenos.
503	ServiceUnavailable	El servicio no puede procesar la cuenta.	Consulte los registros o el informe de estado de modelado para ver si hay errores. Si el problema persiste sin registro de errores, contáctenos.

Compartir a través de

Solicitudes de API de muestra

Ejemplos

Obtener nuevos elementos

Obtener nuevos artículos mientras salta los 3 principales

Obtener elementos populares

Obtener artículos populares en una categoría específica

Obtener artículos populares en una categoría específica con un filtro discreto

Obtener artículos populares en una categoría específica mientras filtra por un rango de valores

Obtener artículos similares

Obtener artículos similares con combinación aleatoria

Traiga el look

Completar estilos similares

Completar elementos similares

Obtener selecciones de usuario

Obtener selecciones de usuarios usando sessionId

Mejor siguiente acción

Etiquetado de metadatos y agrupación de usuarios

Cómo usar el parámetro AlgoType

AlgoTypes de ejemplo

Construir una solicitud de API con AlgoType

Cómo usar el parámetro Refinements

Construir una solicitud de API con Refinements

Códigos de estado de API

Consulte también

Recursos adicionales