Beispiele für API-Anfragen
Dieser Artikel zeigt einige Beispiel-API-Anfragen und die dazugehörigen Antworten. Jedes Beispiel zeigt ein Basisszenario für Empfehlungen zusammen mit anderen Funktionen zur Änderung von Antworten, wie z.B. Filtern, Paging, Auswahl eines alternativen Algorithmus und mehr. Wenn Sie diese Beispiele an Ihrem Endpunkt für Intelligent Recommendations ausprobieren möchten, müssen Sie den Endpunktnamen (DNS-Teil) ersetzen und die Parameter an Ihre Daten anpassen.
Notiz
Der Parameter count steuert die Anzahl der Elemente, die in jeder Antwort zurückgegeben werden. Bei den Beispielen ist die Anzahl auf 5 festgelegt, um die Übersichtlichkeit zu wahren. Weitere Informationen zum Aufbau Ihrer API-Anfragen finden Sie unter Intelligent Recommendations API und Schnellstartanleitung für den Aufruf der API.
Beispiele
Hier sind einige Beispiele, die Sie mit Ihrem Konto für Intelligent Recommendations testen können:
- Neue Elemente abrufen
- Beliebte Elemente abrufen
- Ähnliche Elemente abrufen
- Benutzer-Kommissionierungen erhalten
- Nächste Beste Aktion (Warenkorb)
- Metadaten-Tagging und User Bucketing
- Wie verwende ich den Parameter AlgoType
- Wie Sie den Parameter Refinements verwenden
- API-Statuscodes
Wenn Sie beim Testen der Antworten Fehler ausführen, lesen Sie Fehler-Log-Dateien.
Neue Elemente abrufen
Die API für neue Elemente gibt eine Liste von Produkten zurück, die nach dem Veröffentlichungsdatum geordnet ist.
Die API-Anfrage sieht wie folgt aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/New?modeling=adw&Count=5
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Erhalten Sie neue Elemente und überspringen Sie die Top 3
Sie können Elemente in einer Liste auslassen, indem Sie „SkipItems“ an die Anfrage anhängen.
Die API-Anfrage sieht wie folgt aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/New?modeling=adw&Count=5&SkipItems=3
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Beliebte Elemente abrufen
Die API Get Popular Items gibt eine Liste von Elementen zurück, die nach der Anzahl der Interaktionen geordnet sind, z.B. Transaktion, Kauf, Ansicht, Auswahl oder Download. Was auch immer eine Interaktion zwischen Benutzer und Element in Ihrem Unternehmen bedeutet, das erste Element in der Liste ist das mit den meisten Interaktionen, und die übrigen sind in absteigender Reihenfolge angeordnet.
Die API-Anfrage sieht wie folgt aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Popular?modeling=adw&Count=5
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Abrufen beliebter Elemente in einer bestimmten Kategorie
Sie können Kategorien innerhalb der Entität ItemCategories definieren. Weitere Informationen finden Sie unter Übersicht über Datenverträge.
Die API-Anfrage bei der Suche nach den beliebtesten Kleidungsstücken sieht so aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Popular?modeling=adw&Count=5&Category=Clothing
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Beliebte Artikel in einer bestimmten Kategorie mit einem diskreten Filter abrufen
Sie können Filter innerhalb der ItemAndVariantFilters Daten Entität definieren. Weitere Informationen finden Sie unter Übersicht über Datenverträge.
Die API-Anfrage sieht wie folgt aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Popular?modeling=adw&Count=5&Category=Clothing&Size=S
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Beliebte Elemente in einer bestimmten Kategorie abrufen und dabei nach einer Reihe von Werten filtern
Weitere Informationen über die Syntax der Filterung nach Bereichen finden Sie in der Anleitung zu Bereichsfiltern.
Die API-Anfrage sieht wie folgt aus:
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
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Ähnliche Elemente abrufen
Die Similar Items API bietet kontextbezogene Empfehlungen auf der Grundlage bestimmter Seed Items. Das Seed-Element ist der Dreh- und Angelpunkt, auf dem die Produktvorschläge basieren. Die API-Anfrage für Seed Element Id folgt unmittelbar auf Similar/. Ein gestreiftes Element wird beispielsweise andere Produktvorschläge haben als eine Anzugsjacke für Herren.
Die API-Anfrage sieht wie folgt aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Similar/64702?modeling=adw&Count=5
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Ermitteln ähnlicher Elemente mit Shuffling
Um zu verhindern, dass Benutzer immer wieder die gleichen Empfehlungen sehen, verfügen die Intelligent Recommendations über eine gewichtete Shuffle-Funktion, die die Reihenfolge der Elemente leicht verändert, ohne die Relevanz wesentlich zu beeinflussen. Ergebnisse können gemischt werden, indem Sie die Verfeinerung enableshuffling hinzufügen. Mehr über Verfeinerungen und ihre verschiedenen Typen erfahren Sie hier.
Die API-Anfrage sieht wie folgt aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Similar/64702?modeling=adw&Count=5&Refinements=EnableShuffling
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Bringen Sie den Look
Diese API-Anforderung verwendet ein zusammengesetztes Bild und gibt eine Liste empfohlener Artikel zurück, die den im zusammengesetzten Bild aufgelisteten Artikeln optisch ähnlich sind. Ein zusammengesetztes Bild und seine itemIds-Zuordnung können mithilfe der Bild-zu-Artikel-Datenentität hier konfiguriert werden.
Die API-Anforderung sieht für ein bestimmtes zusammengesetztes Bild (642) folgendermaßen aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Similar/642?AlgoType=BringSimilarItems
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Ähnliche Stile abschließen
Diese API-Anforderung nimmt eine Elemente-ID und gibt eine Liste zusammengesetzter Bild-IDs zurück, die das Element oder verschiedene ähnliche Artikel enthalten, wobei die Ähnlichkeit auf dem visuellen Stil basiert.
Die API-Anforderung sieht für eine bestimmte Elemente-ID (64702) folgendermaßen aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Similar/64702?AlgoType=CompleteSimilarStyles
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Ähnliche Elemente abschließen
Diese API-Anforderung nimmt eine Elemente-ID, findet zusammengesetzte Bilder, die das Element oder einen visuell ähnliches Element enthalten, und gibt eine Liste von Elemente-IDs zurück, die aus diesen zusammengesetzten Bildern extrahiert wurden.
Die API-Anforderung sieht für eine bestimmte Elemente-ID (64702) folgendermaßen aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Similar/64702?AlgoType=CompleteSimilarItems
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Benutzer kommissionieren
Die Kommissionierungen API gibt eine personalisierte Reihe von Empfehlungen zurück, die auf dem Interaktionsverlauf eines bestimmten Benutzers basieren.
Die API-Anfrage sieht wie folgt aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Picks?modeling=adw&UserId=ID1644&Count=5
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Entnehmen Sie Benutzer-Kommissionierungen über sessionId
Die Kommissionierungen API liefert personalisierte Empfehlungen auf der Grundlage der aktuellen Ansichten in einer Sitzung, unabhängig davon, ob der Benutzer bekannt (angemeldet) oder unbekannt (anonym) ist. Der Parameter sessionId identifiziert die Produkte, die ein Benutzer in seiner aktuellen Browsersitzung angesehen hat, und die API gibt eine Liste mit Empfehlungen zurück, die auf der letzten Anzeigeaktivität des angemeldeten oder anonymen Benutzers basiert.
Die geänderte Anfrage der Kommissionierungen API ersetzt die UserId durch die SessionId und verwendet den AlgoType „Recent Views“, der wie folgt angegeben wird:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/picks?SessionId=123&AlgoType=RecentViews.
Notiz
Der SessionId-Parameter sollte in einer Similar-API-Anfrage in der jeweiligen Sitzung verwendet werden, bevor die Auswahl-API aufgerufen wird, andernfalls geben die aktuellen Aktivitätsempfehlungen leere Ergebnisse zurück.
Wenn Sie die Similar API verwenden:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Similar/64702?SessionId=123
Eine erfolgreiche Antwort auf die Auswahl der letzten Aktivität lautet wie folgt:
```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"
}
Anmerkung
In diesem Beispiel wurde der API-Anfrage der Parameter SessionId hinzugefügt.
Nächste Beste Aktion
Die API-Anfrage gibt eine Liste der Elemente zurück, die am häufigsten zusammen mit dem/den Startelement(en) im Einkaufswagen eines Benutzers gekauft werden (oder zusammen, wenn es sich nicht um einen Einkaufswagen handelt).
Die API-Anfrage für einzelne Elemente/Aktionen lautet:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Cart/64702?AlgoType=DAS&modeling=adw&Count=5
Die API-Anfrage für mehrere gesetzte Elemente/Aktionen lautet:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Cart/Items?SeedItemIds=22565300000,41023461-0005-0000-ffff-00ffffffff00,22565300000,22565300001&Count=5
Eine erfolgreiche Antwort ist:
{
"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"
}
Metadaten-Tagging und User Bucketing
Für die Implementierung von Metadaten-Tagging und Benutzer-Bucketing sind einige Konfigurationen im Datenvertrag erforderlich. In unserer Anleitung zu Metadaten-Tagging und User Bucket finden Sie eine Übersicht über die Änderungen am Datenvertrag und API-Beispiele, einschließlich einer exemplarischen Vorgehensweise für zwei häufige Anwendungsfälle, die von Metadaten-Tagging profitieren, sowie jeweils einige Beispiele mit Demodaten.
- Um „die beliebtesten Elemente für Sie“ für kalte Benutzer zu erhalten. Ein Beispiel finden Sie im Abschnitt „Abrufen der beliebtesten Artikel für Sie für Cold Users“.
- So erstellen Sie eine Machine-Learning-Zuordnung der Metadaten-Werte von Benutzern. Ein Beispiel finden Sie im Abschnitt „Erstellen einer ML Map der Metadatenwerte von Benutzern“.
So verwenden Sie den Parameter AlgoType
Die Funktion Intelligente Empfehlungen bietet mehrere Algorithmen zur Berechnung von Empfehlungen für verschiedene Szenarien. Wenn Sie einen bestimmten Algorithmus verwenden möchten, der nicht der Standard ist, können Sie den Parameter AlgoType verwenden.
Beispiel AlgoTypes
In der AlgoTypes Tabelle finden Sie die vollständige Liste der derzeit unterstützten AlgoTypes. Beispiele für AlgoTypes umfassen:
| AlgoType | Definition | Unterstützte API |
|---|---|---|
| RecentPurchases | Die kommissionierten Empfehlungen werden auf der Grundlage der letzten Käufe des Benutzers errechnet. | Nur verfügbar mit der Benutzer kommissioniert API. |
| Visuell | Element-Ähnlichkeiten werden auf der Grundlage visueller Ähnlichkeiten von Katalogbildern berechnet. | Nur verfügbar mit der Similar-API. |
| Textuelle | Element-Ähnlichkeiten werden auf der Grundlage von textlichen (sprachlichen) Ähnlichkeiten von Katalogtextbeschreibungen berechnet. | Nur verfügbar mit der Similar-API. |
Konstruieren einer API-Anfrage mit AlgoType
Die API-Anfrage für das Hinzufügen eines Algo-Typs zu einer GET user picks API-Anfrage sieht so aus:
https://ir-example.mir.prod.reco.microsoft.com/Reco/V1.0/Picks?AlgoType=RecentPurchases&modeling=adw&UserId=ID1644&Count=5
Eine erfolgreiche Antwort sieht wie folgt aus:
{
"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"
}
Wie Sie den Parameter Refinements verwenden
Die Funktion Intelligente Empfehlungen bietet verschiedene Verhaltensweisen zur Berechnung und Rückgabe von Empfehlungen, aber manchmal ist es notwendig, ein anderes Verhalten als das Standardverhalten anzufordern, um ein besseres Kauferlebnis zu erhalten. Zum Beispiel die Anzeige von Empfehlungen nur für nicht gekaufte Artikel oder die Verhinderung der Wiederholung der gleichen Bestellung. Der Parameter Verfeinerungen kann in solchen Fällen verwendet werden, um das gewünschte Empfehlungsverhalten zu erreichen.
Sehen Sie die Tabelle der Verfeinerungen für die vollständige Liste der derzeit unterstützten Verfeinerungen.
Konstruieren einer API-Anfrage mit Refinements
Sie können mehrere durch Komma getrennte Verfeinerungen hinzufügen, solange sie sich nicht gegenseitig widersprechen. Eine Beispiel-API-Anfrage für das Hinzufügen einer Verfeinerung zu Similar API finden Sie hier.
API-Statuscodes
Eine vollständige Liste der API-Statuscodes, -Beschreibungen und -Anleitungen zur Behebung von Fehlern lautet wie folgt:
| Code | Status | Ursache | Behebung |
|---|---|---|---|
| 200 | Erfolg | Die API-Anforderung war erfolgreich. | NICHT ZUTREFFEND |
| 200 | EmptyResults | Für dieses Startelement (itemId) gibt es Empfehlungen, die jedoch alle herausgefiltert wurden. | Der Hauptgrund für das Filtern sind Daten, die den Elementen im Katalog zugeordnet sind. Wenn Sie erwarten, dass bestimmte Produkte zurückgegeben werden, ist es wichtig, deren Verfügbarkeitsdaten zu überprüfen und sicherzustellen, dass sie mit den entsprechenden Filterzuweisungen, wie Kategorie, Kanal, Katalog und Verfügbarkeit, korrekt konfiguriert sind. |
| 200 | DataDoesNotExist | Das Startelement (itemId) ist in den Ergebnissen nicht vorhanden. Die angegebene itemId fehlt möglicherweise in den Eingabedaten oder enthält nicht genügend Daten, um berechnete Ergebnisse auszugeben. | Überprüfen Sie, ob das Element: - gültig ist - in den richtigen Kanal gehört - genug Interaktionen/Bilder/Text hat. Weitere Informationen finden Sie in den Richtlinien zur Formatierung von Datenvertragsdaten. |
| 200 | WaitingForData | Wenn eine neue Modellierungskomponente erstellt wird, kann die Berechnung einige Zeit dauern und ist möglicherweise nicht bereit, Ergebnisse zurückzugeben. | Überprüfen Sie die Protokolle oder den Statusbericht zur Modellierung auf Fehler. Wenn das Problem nach 24 Stunden ohne Fehlerprotokollierung weiterhin besteht, wenden Sie sich an uns. |
| 400 | UnsupportedRequest | Einer der API-Parameter hat einen nicht unterstützten Wert oder es gibt ein anderes Problem mit der API-Anforderung, z. B.: ein nicht unterstütztes oder deaktiviertes Szenario. | Überprüfen Sie, ob sich der Kopfzeilenwert vom eigentlichen Parameter unterscheidet. Beispiele für funktionierende API-Anforderungen finden Sie am Anfang dieses Artikels. Verschiedene API-Anforderungen werden deaktiviert, je nachdem, ob Ihre Modellierungs-Featuregruppe auf Standard oder Premium konfiguriert ist. Sie können auch den Statusbericht zur Modellierung auf Fehler in einem der Algorithmen überprüfen. |
| 400 | UnsupportedFeature | Sie versuchen, eine API aufzurufen, die basierend auf Ihrer aktuellen Modellierungs-Featuregruppe nicht unterstützt wird. | Aktivieren Sie die richtige Modellierungs-Featuregruppe auf Standard oder Premium. Liste der Szenarien, die für jede Featuregruppe verfügbar sind. |
| 401 | Nicht authentifizierte Anforderung | Stellen Sie sicher, dass Ihr Mandant Berechtigungen zugewiesen hat, damit der Dienst durchgeführt werden darf. Gehen Sie wie folgt vor, um Ihre Authentifizierung zu überprüfen. | |
| 408 | RequestTimeout | Das Zeitlimit für Ihre Anforderung ist abgelaufen. | Versuchen Sie erneut, die API-Anforderung aufzurufen. |
| 429 | RPS liegt über der vorab zugewiesenen Stufe und es besteht die Gefahr einer Drosselung. | Erhöhen Sie die vorab zugewiesene RPS-Kapazität auf eine höhere Stufe oder verringern Sie die aktuelle RPS. | |
| 500 | Interner Server-Fehler | Auf der „Intelligent Recommendations“-Seite ist ein Fehler aufgetreten. | Dieses Problem kann vorübergehend sein, also versuchen Sie es nach ein paar Minuten erneut. Überprüfen Sie die Protokolle oder den Statusbericht zur Modellierung auf Fehler. Wenn das Problem ohne Fehlerprotokollierung weiterhin besteht, wenden Sie sich an uns. |
| 503 | ServiceUnavailable | Der Dienst kann das Konto nicht verarbeiten. | Überprüfen Sie die Protokolle oder den Statusbericht zur Modellierung auf Fehler. Wenn das Problem ohne Fehlerprotokollierung weiterhin besteht, wenden Sie sich an uns. |
Siehe auch
Intelligent Recommendations API
Schnellstartanleitung für den Aufruf der API
Gängige Log-Dateien
Übersicht über den Datenvertrag