Voorbeeld API-aanvragen

In dit artikel worden enkele voorbeeld-API-aanvragen en bijbehorende reacties weergegeven. Elk voorbeeld toont een scenario met basisaanbevelingen samen met andere functies voor het wijzigen van respons, zoals filteren, pagineren, het selecteren van een alternatief algoritme en meer. Wilt u deze voorbeelden uitproberen op uw Intelligent Recommendations-eindpunt, zorg er dan voor dat u de eindpuntnaam (DNS-gedeelte) vervangt en de parameters aan uw gegevens aanpast.

Notitie

De parameter aantal bepaalt het aantal artikelen dat in elke respons wordt geretourneerd. Voor de voorbeelden is het aantal ingesteld op 5 voor duidelijkheid en beknoptheid. Ga voor meer informatie over manieren om uw API-aanvragen op te stellen naar Intelligent Recommendations-API en Aan de slag voor het aanroepen van de API.

Voorbeelden

Hier zijn enkele voorbeelden die u kunt testen met uw Intelligent Recommendations-account:

Als u fouten tegenkomt tijdens het testen van de respons, raadpleeg dan Foutenlogboeken.

Nieuwe artikelen ophalen

De Nieuwe artikelen-API retourneert een lijst met producten gerangschikt op releasedatum.

De API-aanvraag ziet er als volgt uit:

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

Een geslaagde respons ziet er als volgt uit:

{
    "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"
}

Terug naar boven

Nieuwe artikelen ophalen en de top 3 overslaan

U kunt artikelen in een lijst overslaan door "SkipItems" toe te voegen aan de aanvraag.

De API-aanvraag ziet er als volgt uit:

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

Een geslaagde respons ziet er als volgt uit:

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

Terug naar boven

De Populaire artikelen ophalen-API retourneert een lijst met artikelen die zijn gerangschikt op het aantal interacties, zoals transactie, aankoop, weergave, selecteer of download. Wat een interactie tussen een gebruiker en een artikel in uw bedrijf ook betekent, het eerste artikel in de lijst is het artikel met de meeste interacties en de rest is in aflopende volgorde gerangschikt.

De API-aanvraag ziet er als volgt uit:

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

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Lists",
    "name": "Lists",
    "version": "v1.0",
    "interactionsVersion": "20220104115104",
    "items": [
        {
            "id": "65106",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62604",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "70006",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "63503",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62452",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Popular",
    "longTitle": "Popular",
    "titleId": 5,
    "pagingInfo": {
        "totalItems": 278
    },
    "status": "Success"
}

Terug naar boven

U kunt categorieën definiëren binnen de gegevensentiteit ItemCategories. Ga voor meer informatie naar Gegevenscontractoverzicht.

De API-aanvraag bij het zoeken naar de meest populaire kledingstukken ziet er als volgt uit:

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

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Lists",
    "name": "Lists",
    "version": "v1.0",
    "interactionsVersion": "20220104115104",
    "items": [
        {
            "id": "62604",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62452",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62502",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62606",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "63402",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Popular",
    "longTitle": "Popular",
    "titleId": 5,
    "pagingInfo": {
        "totalItems": 95
    },
    "status": "Success"
}

Terug naar boven

U kunt filters definiëren binnen de gegevensentiteit ItemAndVariantFilters. Ga voor meer informatie naar Gegevenscontractoverzicht.

De API-aanvraag ziet er als volgt uit:

https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Popular?modeling=adw&Count=5&Category=Clothing&Size=S

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Lists",
    "name": "Lists",
    "version": "v1.0",
    "interactionsVersion": "20220104115104",
    "items": [
        {
            "id": "61453",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62104",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62100",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62103",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61406",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Popular",
    "longTitle": "Popular",
    "titleId": 5,
    "pagingInfo": {
        "totalItems": 32
    },
    "status": "Success"
}

Terug naar boven

Ga voor meer informatie over de syntaxis bij filteren op bereik naar guide voor bereikfilters.

De API-aanvraag ziet er als volgt uit:

https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Popular?modeling=adw&Count=10&Category=Clothing&$filter=rating gt 2 and rating lt 5

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Lists",
    "name": "Lists",
    "version": "v1.0",
    "interactionsVersion": "20220104115104",
    "items": [
        {
            "id": "62604",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62452",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62502",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62507",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62106",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Popular",
    "longTitle": "Popular",
    "titleId": 5,
    "pagingInfo": {
        "totalItems": 5
    },
    "status": "Success"
}

Terug naar boven

Vergelijkbare artikelen ophalen

De Vergelijkbare artikelen-API biedt contextuele aanbevelingen op basis van specifieke seed-artikelen. Het seed-artikel is het draaipunt waarop productsuggesties worden gebaseerd. In de API-aanvraag opgegeven voor seed-artikel-id volgt onmiddellijk Similar/. Een gestreepte trui als seed-artikel zal bijvoorbeeld andere productsuggesties opleveren dan een colbert voor heren.

De API-aanvraag ziet er als volgt uit:

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

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Related",
    "name": "Related",
    "version": "v1.0",
    "interactionsVersion": "20220104115104",
    "items": [
        {
            "id": "63102",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62106",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61511",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "63503",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "68100",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "People also like",
    "longTitle": "People also like",
    "titleId": 1,
    "pagingInfo": {
        "totalItems": 138
    },
    "status": "Success"
}

Terug naar boven

Vergelijkbare artikelen ophalen met herschikken

Om te voorkomen dat gebruikers dezelfde aanbevelingen steeds opnieuw zien, heeft Intelligent Recommendations een gewogen herschikkingsfunctie die de volgorde van artikelen enigszins verandert zonder de relevantie significant te beïnvloeden. Resultaten kunnen worden herschikt door de verfijning enableshuffling toe te voegen. Meer informatie over verfijningen en de verschillende typen ervan vindt u hier.

De API-aanvraag ziet er als volgt uit:

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

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Related",
    "name": "Related",
    "version": "v1.0",
    "interactionsVersion": "20220104115104",
    "items": [
        {
            "id": "62403",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61511",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "71603",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "64201",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62452",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "People also like",
    "longTitle": "People also like",
    "titleId": 1,
    "pagingInfo": {
        "totalItems": 138
    },
    "status": "Success"
}

Terug naar boven

Shop de look

Dit API-verzoek neemt een samengestelde afbeelding en retourneert een lijst met aanbevolen items die visueel overeenkomen met de items die worden vermeld in de samengestelde afbeelding. Een samengestelde afbeelding en de itemIds-toewijzing kunnen worden geconfigureerd met behulp van de gegevensentiteit Afbeelding-naar-item hier.

Het API-verzoek ziet er als volgt uit voor een bepaalde samengestelde afbeelding (642):

https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Similar/642?AlgoType=BringSimilarItems

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Related",
    "name": "Related",
    "version": "v1.0",
    "interactionsVersion": "20220104115104",
    "items": [
        {
            "id": "62403",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61511",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "71603",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "64201",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62452",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Bring Similar Items",
    "longTitle": "Bring Similar Items",
    "titleId": 1,
    "pagingInfo": {
        "totalItems": 138
    },
    "status": "Success"
}

Terug naar boven

Vergelijkbare stijlen voltooien

Deze API-aanvraag neemt een item-id en retourneert een lijst met samengestelde afbeeldings-id's die het artikel bevatten of een ander soortgelijk artikel bevatten, waarbij de gelijkenis is gebaseerd op visuele stijl.

De API-aanvraag ziet er als volgt uit voor een bepaalde artikel-id (64702):

https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Similar/64702?AlgoType=CompleteSimilarStyles

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Related",
    "name": "Related",
    "version": "v1.0",
    "interactionsVersion": "20220104115104",
    "items": [
        {
            "id": "403",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "511",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "603",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "201",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "452",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Complete Similar Styles",
    "longTitle": "Complete Similar Styles",
    "titleId": 1,
    "pagingInfo": {
        "totalItems": 138
    },
    "status": "Success"
}

Terug naar boven

Vergelijkbare artikelen voltooien

Deze API-aanvraag neemt een artikel-id, zoekt samengestelde afbeeldingen die het artikel of een visueel vergelijkbaar artikel bevatten, en retourneert een lijst met artikel-id's die uit die samengestelde afbeeldingen zijn gehaald.

De API-aanvraag ziet er als volgt uit voor een bepaalde artikel-id (64702):

https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Similar/64702?AlgoType=CompleteSimilarItems

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Related",
    "name": "Related",
    "version": "v1.0",
    "interactionsVersion": "20220104115104",
    "items": [
        {
            "id": "62403",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61511",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "71603",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "64201",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62452",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Complete Similar Items",
    "longTitle": "Complete Similar Items",
    "titleId": 1,
    "pagingInfo": {
        "totalItems": 138
    },
    "status": "Success"
}

Terug naar boven

Gebruikerskeuzes ophalen

De Keuzes-API retourneert een gepersonaliseerde reeks aanbevelingen op basis van de interactiegeschiedenis van een bepaalde gebruiker.

De API-aanvraag ziet er als volgt uit:

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

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Picks",
    "name": "Picks",
    "version": "v1.0",
    "items": [
        {
            "id": "68100",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62500",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61504",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "65103",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61401",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Picks for you",
    "longTitle": "Picks for you",
    "titleId": 6,
    "personalizationConfidence": 1.0,
    "pagingInfo": {
        "totalItems": 139
    },
    "status": "Success"
}

Terug naar boven

Gebruikersselecties ophalen met sessionID

De Picks-API retourneert gepersonaliseerde aanbevelingen op basis van de huidige weergaven in een sessie, ongeacht of de gebruiker bekend (aangemeld) of onbekend (anoniem) is. De parameter sessionId identificeert de producten die een gebruiker heeft bekeken in zijn huidige browsesessie, en de API retourneert een lijst met aanbevelingen op basis van de recente kijkactiviteit van de aangemelde of anonieme gebruiker.

De gewijzigde Picks-API-aanvraag vervangt userId door de sessionId en gebruikt het AlgoType "Recente weergaven", dat als volgt wordt weergegeven:

https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/picks?SessionId=123&AlgoType=RecentViews.

Notitie

De parameter SessionId moet worden gebruikt in een vergelijkbare API-aanvraag in de gegeven sessie voordat de picks-API wordt aangeroepen, anders retourneren de aanbevelingen voor recente activiteiten lege resultaten.

Bij gebruik van de Similar API:

https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Similar/64702?SessionId=123 

een succesvolle recente activiteit kiest respons is als volgt:


```json
{
    "id": "Picks",
    "name": "Picks",
    "version": "v1.0",
    "items": [
        {
            "id": "68100",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62500",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61504",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "65103",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61401",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Picks for you",
    "longTitle": "Picks for you",
    "titleId": 6,
    "personalizationConfidence": 1.0,
    "pagingInfo": {
        "totalItems": 139
    },
    "status": "Success"
}

Notitie

De parameter SessionId is in dit voorbeeld toegevoegd aan de API-aanvraag.

Terug naar boven

De beste vervolgactie

De API-aanvraag retourneert een lijst met artikelen die het vaakst samen met de seed-artikelen in de winkelwagen van een gebruiker worden gekocht (of aan elkaar zijn gekoppeld, wanneer ze zich niet in een winkelwagentje bevinden).

De API-aanvraag voor één seed-artikel/acties is:

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

De API-aanvraag voor meerdere seed-artikelen/acties is:

https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Cart/Items?SeedItemIds=22565300000,41023461-0005-0000-ffff-00ffffffff00,22565300000,22565300001&Count=5

Een succesvolle respons is:

{
    "id": "Cart",
    "name": "Cart",
    "version": "v1.0",
    "items": [
        {
            "id": "63102",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "62106",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61511",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "63503",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "68100",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Frequently bought together",
    "longTitle": "Frequently bought together",
    "titleId": 2,
    "pagingInfo": {
        "totalItems": 138
    },
    "status": "Success"
}

Terug naar boven

Taggen van metagegevens en bucketing van gebruikers

Het implementeren van tagging van metagegevens en user bucketing vereist enkele configuraties voor het gegevenscontract. Raadpleeg onze Gids voor het taggen van metagegevens en bucketing van gebruikers voor een overzicht van wijzigingen in gegevenscontracten en API-voorbeelden, inclusief een overzicht van twee veelvoorkomende gebruiksscenario´s die gebruikmaken van het taggen van metagegevens en enkele voorbeelden met demogegevens voor elk.

  1. "Meest populaire artikelen voor u" ophalen voor koude gebruikers. Om een voorbeeld te zien, raadpleegt u het gedeelte met de titel "Meest populaire artikelen voor u" ophalen voor koude gebruikers.
  2. Een Op Machine Learning gebaseerd overzicht van de metagegevenswaarden van gebruikers maken. Zie voor een voorbeeld het gedeelte met de titel "Een ML-overzicht van de metagegevenswaarden van gebruikers maken".

Terug naar boven

De parameter AlgoType gebruiken

De functie Intelligent Recommendations biedt meerdere algoritmen om aanbevelingen voor verschillende scenario's te berekenen. Als u een ander algoritme dan het standaardalgoritme wilt gebruiken, kunt u de AlgoType-parameter gebruiken.

Voorbeelden van AlgoTypes

Zie de AlgoTypes-tabel voor de volledige lijst met momenteel ondersteunde AlgoTypes. Voorbeelden van AlgoTypes zijn:

AlgoType Definitie Ondersteunde API
RecentPurchases Aanbevelingen voor keuzes worden berekend op basis van de meest recente aankopen van de gebruiker. Alleen verkrijgbaar met de User Picks-API.
Visual Artikelovereenkomsten worden berekend op basis van visuele overeenkomsten van catalogusafbeeldingen. Alleen verkrijgbaar met de Similar-API.
Tekstueel Artikelovereenkomsten worden berekend op basis van tekstuele overeenkomsten (taalbegrip) in tekstuele beschrijvingen in de catalogus. Alleen verkrijgbaar met de Similar-API.

Een API-aanvraag opstellen met AlgoType

De API-aanvraag voor het toevoegen van een Algo Type aan een API-aanvraag voor het ophalen van gebruikerskeuzes ziet er als volgt uit:

https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Picks?AlgoType=RecentPurchases&modeling=adw&UserId=ID1644&Count=5

Een geslaagde respons ziet er als volgt uit:

{
    "id": "Picks",
    "name": "Picks",
    "version": "v1.0",
    "items": [
        {
            "id": "61100",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "61406",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "63203",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "73401",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        },
        {
            "id": "71801",
            "trackingId": "00000000-0000-0000-0000-000000000003"
        }
    ],
    "title": "Picks for you",
    "longTitle": "Picks for you",
    "titleId": 6,
    "pagingInfo": {
        "totalItems": 327
    },
    "status": "Success"
}

Terug naar boven

De parameter voor verfijningen gebruiken

De functie Intelligent Recommendations biedt verschillende gedragingen om aanbevelingen te berekenen en te retourneren, maar soms is het nodig om een ander gedrag aan te vragen dan het standaardgedrag voor een betere koopervaring. Bijvoorbeeld alleen aanbevelingen weergeven voor niet-gekochte artikelen of herhaling van dezelfde bestelling voorkomen. De parameter voor verfijningen kan in dergelijke gevallen worden gebruikt om het gewenste aanbevelingsgedrag te bereiken.

Zie de Tabel met verfijningen voor de volledige lijst van momenteel ondersteunde verfijningen.

Een API-aanvraag opstellen met verfijningen

U kunt meerdere verfijningen toevoegen, gescheiden door komma's, zolang ze niet tegenstrijdig zijn. Een voorbeeld van een API-aanvraag voor het toevoegen van een verfijning aan Similar API vindt u hier.

API-statuscodes

Een volledige lijst met API-statuscodes, beschrijvingen en het oplossen van fouten is als volgt:

Code -Status Reden Instructies voor oplossen
200 Voltooid De API-aanvraag was geslaagd. N.v.t.
200 EmptyResults Er zijn aanbevelingen voor dit seed-item (itemId), maar deze zijn allemaal uitgefilterd. De belangrijkste reden om te filteren zijn gegevens die zijn gekoppeld aan de artikelen in de catalogus. Wanneer u verwacht dat bepaalde producten worden geretourneerd, is het belangrijk om de beschikbaarheidsdatums ervan te verifiëren en ervoor te zorgen dat ze correct zijn geconfigureerd met de juiste filtertoewijzingen, zoals categorie, kanaal, catalogus en beschikbaarheid.
200 DataDoesNotExist Het seed-item (itemId) bestaat niet in de resultaten. De opgegeven itemId ontbreekt mogelijk in de invoergegevens of heeft onvoldoende gegevens om berekende resultaten te hebben. Controleer of het artikel:
- geldig is
- hoort in het juiste kanaal
- Voldoende interacties/afbeeldingen/tekst heeft. Zie voor meer informatie de richtlijnen voor gegevensindelingen voor gegevenscontracten.
200 WaitingForData Wanneer een nieuwe modelleringscomponent wordt gemaakt, kan de berekening enige tijd duren en zijn de resultaten mogelijk nog niet gereed. Controleer de logboeken of het modelleerstatusrapport om te zien of er fouten zijn. Als het probleem na 24 uur aanhoudt zonder foutregistratie, neem dan contact met ons op.
400 UnsupportedRequest Een van de API-parameters heeft een niet-ondersteunde waarde, of er is een ander probleem met de API-aanvraag, zoals: een niet-ondersteund of uitgeschakeld scenario. Controleer of de headerwaarde afwijkt van de daadwerkelijke parameter. Voor voorbeelden van werkende API-aanvragen, ga naar het begin van dit artikel. Verschillende API-aanvragen zijn uitgeschakeld, afhankelijk van of uw modelfunctieset is geconfigureerd op Standaard of Premium. U kunt ook het modelleringsstatusrapport controleren om te zien of er fouten zijn met een van de algoritmen.
400 UnsupportedFeature U probeert een API aan te roepen die niet wordt ondersteund op basis van uw huidige functieset voor modellering. Schakel de juiste modelleringsfunctieset in op standaard of premium. Lijst met scenario's die beschikbaar zijn voor elke functieset.
401 Niet-geverifieerde aanvraag Zorg ervoor dat uw tenant machtigingen heeft toegewezen om de service te laten werken. Volg deze stappen om uw verificatie te controleren.
408 RequestTimeout Er is een time-out opgetreden voor de aanvraag. Probeer de API-aanvraag opnieuw aan te roepen.
429 RPS bevindt zich boven het vooraf toegewezen niveau en dreigt te worden beperkt. Verhoog de vooraf toegewezen RPS-capaciteit naar een hoger niveau of verlaag de huidige RPS.
500 Interne serverfout Er is een fout opgetreden aan de kant van Intelligent Recommendations. Dit probleem kan tijdelijk zijn, dus probeer het over een paar minuten opnieuw. Controleer de logboeken of het modelleerstatusrapport om te zien of er fouten zijn. Als het probleem aanhoudt zonder foutregistratie, neem dan contact met ons op.
503 ServiceUnavailable De service kan het account niet verwerken. Controleer de logboeken of het modelleerstatusrapport om te zien of er fouten zijn. Als het probleem aanhoudt zonder foutregistratie, neem dan contact met ons op.

Terug naar boven

Zie ook

Intelligent Recommendations-API
Snelstartgids voor het aanroepen van de API
Veelvoorkomende logboekfouten
Overzicht van gegevenscontract