Przeczytaj w języku angielskim

Udostępnij za pośrednictwem


Przykładowe żądania interfejsu API

W tym artykule przedstawiono kilka przykładowych żądań interfejsu API i skojarzonych z nimi odpowiedzi. W każdym przykładzie przedstawiono scenariusz podstawowych zaleceń wraz z innymi funkcjami modyfikacji odpowiedzi, takimi jak filtrowanie, stronicowanie, wybór alternatywnych algorytmów i nie tylko. Aby spróbować tych przykładów w ramach Intelligent Recommendations, punkt końcowy należy zastąpić nazwę punkt końcowy (część DNS) i dostosować parametry do danych.

Uwaga

Parametr liczba będzie określać liczbę elementów zwróconych w każdej odpowiedzi. Przykłady będą miały liczbę ustawioną na 5 dla jasności i zwięzłości. Aby uzyskać więcej informacji na temat sposobów tworzenia żądań interfejsu API, zobacz interfejs API Intelligent Recommendations i przewodnik Szybki start dotyczący wywoływania interfejsu API.

Przykłady

Oto kilka przykładów, które możesz przetestować na koncie Intelligent Recommendations:

Jeśli podczas testowania odpowiedzi wystąpią błędy, zobacz Dzienniki błędów.

Zdobądź nowe przedmioty

Interfejs API nowych elementów zwraca listę produktów zamówinych według daty wydania.

Żądanie API wygląda następująco:

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Zdobądź nowe przedmioty, pomijając 3 najlepsze

Możesz pominąć elementy na liście, dołączając do żądania „SkipItems”.

Żądanie API wygląda następująco:

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Interfejs API Get Popular Items zwraca listę elementów uporządkowanych według liczby interakcji, takich jak transakcja, zakup, wyświetlenie, wybór lub pobranie. Niezależnie od tego, co w Twojej firmie oznacza interakcja użytkownika z elementem, pierwszy element na liście to ten, który ma najwięcej interakcji, a pozostałe są uporządkowane malejąco.

Żądanie API wygląda następująco:

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Kategorie można definiować w encji danych ItemCategories. Aby uzyskać więcej informacji, zobacz Omówienie kontraktu danych.

Żądanie interfejsu API podczas wyszukiwania najpopularniejszych elementów odzieżowych wygląda następująco:

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Filtry można definiować w encji danych ItemAndVariantFilters. Aby uzyskać więcej informacji, zobacz Omówienie kontraktu danych.

Żądanie API wygląda następująco:

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Aby uzyskać więcej informacji dotyczących składni filtrowania według zakresu, zobacz przewodnik po filtrach zakresu.

Żądanie API wygląda następująco:

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Zdobądź podobne przedmioty

Interfejs API podobnych elementów zawiera zalecenia kontekstowe oparte na określonych elementach. Element najechań jest punktem przestawny, na podstawie którym będą oparte sugestie dotyczące produktu. Żądanie API podane dla identyfikatora elementu początkowego następuje bezpośrednio po podobnym/. Na przykład sweter w paski będzie ma inne propozycje produktów niż męska marynarka.

Żądanie API wygląda następująco:

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Zdobądź podobne przedmioty za pomocą tasowania

Aby użytkownicy nie widzieli tych samych rekomendacji w kółko, Intelligent Recommendations mają funkcję mieszania ważonego, która nieznacznie zmienia kolejność elementów bez znaczącego wpływu na trafność. Wyniki można przetasować, dodając uściślenie enableshuffling. Możesz dowiedzieć się więcej o rafinacjach i ich różnych typach tutaj.

Żądanie API wygląda następująco:

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Bring the Look

To żądanie interfejsu API umożliwia użycie obrazu złożonego i zwraca listę zalecanych elementów, które są wizualnie podobne do elementów wymienionych na obrazie złożonym. Obraz złożony i jego mapowanie identyfikatorów elementów można w tym miejscu skonfigurować, używając encji danych typu obraz do elementu.

Żądanie interfejsu API wygląda następująco w przypadku danego obrazu złożonego (642):

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Ukończ podobne style

To żądanie interfejsu API wymaga identyfikatora elementu i zwraca listę identyfikatorów obrazów złożonych zawierających element lub zawierających różne podobne elementy, w których podobieństwo wynika z wizualnego stylu.

Żądanie API wygląda następująco dla danego identyfikatora elementu (64702):

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Ukończ podobne przedmioty

To żądanie interfejsu API wymaga identyfikatora elementu, znajduje zdjęcia złożone zawierające element lub podobny element wizualnie, i zwraca listę identyfikatorów elementów wyodrębnione z tych obrazów złożonych.

Żądanie API wygląda następująco dla danego identyfikatora elementu (64702):

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Pobierz wybory użytkownika

Interfejs API wyboru zwraca spersonalizowany zestaw zaleceń oparty na historii interakcji danego użytkownika.

Żądanie API wygląda następująco:

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Pobierz wybór użytkownika przy użyciu funkcji sessionId

Picks API zwraca spersonalizowane rekomendacje na podstawie bieżących wyświetleń w sesji, niezależnie od tego, czy użytkownik jest znany (zalogowany), czy nieznany (anonimowy). Parametr sessionId identyfikuje produkty, które użytkownik przegląda w bieżącej sesji przeglądania, i interfejs API zwraca listę rekomendacji opartą na najnowszym działaniu użytkownika zalogowanego lub anonimowego.

Zmodyfikowane żądanie Picks API zastępuje identyfikator użytkownika identyfikatorem sesji i używa AlgoType „Ostatnie wyświetlenia”, podane w następujący sposób:

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

Uwaga

Parametr SessionId powinien być używany w podobnym żądaniu interfejsu API w danej sesji przed wywołaniem interfejsu API wyboru, gdyż w przeciwnym razie zalecenia ostatnio używanych działań zwrócą puste wyniki.

Podczas korzystania z podobnego interfejsu API:

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

Odpowiedź na ostatnio udane działanie ma następującą odpowiedź:


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

Uwaga

W tym przykładzie parametr SessionId został dodany do żądania interfejsu API.

Powrót do góry

Następna najlepsza akcja

Żądanie interfejsu API zwraca listę elementów, które są najczęściej nabywane razem z elementami platformy rozsyłania użytkownika (lub najczęściej nie w scenariuszu sprzedaży detalicznej).

Żądanie API dla pojedynczego elementu początkowego/działań to:

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

Żądanie API dla wielu elementów/działań początkowych to:

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

Pomyślna odpowiedź to:

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

Powrót do góry

Tagowanie metadanych i tworzenie przedziałów użytkowników

Implementacja tagowania metadanych i przetwarzania zasobników użytkowników wymaga pewnych konfiguracji w kontrakcie danych. Zapoznaj się z przewodnikiem po oznaczaniu metadanych i obsłudze użytkowników, aby uzyskać przegląd zmian kontraktów danych i przykładów interfejsów API, w tym instruktaż dwóch typowych spraw, które korzystają z funkcji oznaczania metadanych, i podać kilka przykładów dotyczących danych pokazowych dla każdej z nich.

  1. Aby uzyskać "najpopularniejsze pozycje dla użytkowników". Aby zobaczyć przykład, zobacz sekcję „Pobierz najpopularniejsze pozycje dla użytkowników programu Cold Users”.
  2. Aby utworzyć machiną mapę wartości metadanych użytkowników. Aby zobaczyć przykład, zobacz sekcję „Tworzenie mapy METADANYCH użytkowników”.

Powrót do góry

Jak używać parametru AlgoType

Funkcja inteligentnych rekomendacji oferuje wiele algorytmów obliczających rekomendacje dla różnych scenariuszy. Jeśli chcesz użyć konkretnego algorytmu, innego niż domyślny, możesz wykorzystać parametr AlgoTyp.

Przykładowy typy AlgoTypes

W tabeli AlgoTypes, aby uzyskać pełną listę obecnie obsługiwanych typów AlgoType. Przykłady AlgoType obejmują:

AlgoType Definicja Obsługiwane API
RecentPurchases Zalecenia dotyczące wyboru są obliczane na podstawie najnowszych zakupów użytkownika. Dostępne tylko za pomocą Interfejsu API wyboru użytkownika.
Element wizualny Podobieństwa elementów są obliczane na podstawie wizualnego podobieństwa obrazów katalogu. Dostępne tylko przy użyciu podobnego interfejsu API.
Tekstowy Podobieństwa elementów są obliczane na podstawie tekstu (znajomości języka) podobieństw opisów katalogu. Dostępne tylko przy użyciu podobnego interfejsu API.

Tworzenie żądania interfejsu API za pomocą typu AlgoType

Żądanie interfejsu API dotyczące dodawania typu Algo do pobrania przez użytkownika żądania interfejsu API wygląda następująco:

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

Prawidłowa odpowiedź wygląda następująco:

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

Powrót do góry

Jak korzystać z parametru Udoskonalenia

Funkcja Intelligent Recommendations oferuje różne zachowania w celu obliczenia i zwrócenia rekomendacji, ale czasami trzeba zażądać innego zachowania niż domyślne, aby uzyskać lepsze wrażenia z zakupów. Na przykład wyświetlanie rekomendacji tylko w przypadku niezakupionych przedmiotów lub zapobieganie powtarzaniu tego samego zamówienia. Parametr Udoskonalenia może być wykorzystywany w takich przypadkach w celu uzyskania żądanego zachowania rekomendacji.

W tabeli Tabela udoskonalenia, aby uzyskać pełną listę obecnie obsługiwanych typów udoskonaleń.

Tworzenie żądania interfejsu API za pomocą Udoskonaleń

Możesz dodać wiele udoskonaleń oddzielonych przecinkami, o ile nie są one sprzeczne ze sobą. Przykładowe żądanie interfejsu API służące do dodawania ulepszenia do podobnego interfejsu API można znaleźć tutaj.

Kody stanu API

Pełna lista kodów stanów interfejsu API, opisów i sposobu rozwiązywania błędów jest następująca:

Kod Stan Przyczyna Jak rozwiązać problem
200 Sukces Żądanie interfejsu API powiodło się. Brak
200 EmptyResults Dla tego elementu (itemId) istnieją zalecenia, jednak wszystkie zostały odfiltrowane. Głównym powodem filtrowania są dane skojarzone z elementami katalogu. Jeśli przewidujesz, że pewne produkty zostaną zwrócone, ważne jest, aby sprawdzić daty ich dostępności i upewnić się, że są one poprawnie skonfigurowane z odpowiednimi zadaniami filtrowania, takimi jak kategoria, kanał, katalog i dostępność.
200 DataDoesNotExist Element chybny (itemId) nie istnieje w wynikach. W danych wejściowych może brakować określonego elementuId lub nie ma danych wystarczających do obliczenia wyników. Sprawdź, czy element:
- jest prawidłowy
- należy do odpowiedniego kanału
- ma wystarczającą ilość interakcji/obrazów/tekstu. Aby uzyskać więcej informacji, zobacz Wytyczne dotyczące formatu danych kontraktu danych w danych.
200 WaitingForData Podczas tworzenia nowego składnika modelowania obliczenia mogą zająć dużo czasu i mogą nie być gotowe do zwrotu wyników. Aby sprawdzić, czy istnieją błędy, należy sprawdzić dzienniki lub raport o stanie modelowania. Jeśli po 24 godzinach problem występuje nadal bez rejestrowania błędów, skontaktuj się z nami.
400 UnsupportedRequest Jeden z parametrów interfejsu API ma nieobsługiwaną wartość lub występuje inny problem z żądaniem interfejsu API, taki jak: nieobsługiwany lub wyłączony scenariusz. Sprawdź, czy wartość nagłówka jest inna niż parametr rzeczywisty. Przykłady roboczych żądań interfejsu API można znaleźć w górnej części tego artykułu. Różne żądania interfejsów API są wyłączone w zależności od tego, czy zestaw funkcji modelowania jest skonfigurowany jako Standard lub Premium. Można także sprawdzić raport o stanie modelowania, aby sprawdzić, czy nie wystąpiły błędy z dowolnymi algorytmami.
400 UnsupportedFeature Próbujesz wywołać interfejs API, który jest nieobsługiwany w oparciu o bieżący zestaw funkcji Modelowanie. Włącz prawidłową funkcję modelowania ustawioną na standardową lub premium. Lista scenariuszy, które są dostępne dla każdego zestawu funkcji.
401 Nieuwierzytelnione żądanie Upewnij się, że dzierżawca ma przypisane uprawnienia do usługi do działania. Wykonaj poniższe kroki, aby sprawdzić swoje uwierzytelnienie.
408 RequestTimeout Przekroczono limit czasu żądania. Spróbuj ponownie wywołując żądanie interfejsu API.
429 Zestaw RPS jest powyżej wstępnie otwartej warstwy i istnieje ryzyko, że zostanie uszkodzony. Zwiększ wstępnie zlokalizowaną wydajność usługi RPS do wyższego poziomu lub zmniejsz bieżący zestaw RPS.
500 Wewnętrzny błąd serwera Wystąpił błąd po stronie Intelligent Recommendations. Ten problem może być tymczasowy, więc spróbuj ponownie po kilku minutach. Aby sprawdzić, czy istnieją błędy, należy sprawdzić dzienniki lub raport o stanie modelowania. Jeśli problem występuje nadal bez rejestrowania błędów, skontaktuj się z nami.
503 ServiceUnavailable Usługa nie może przetworzyć klienta. Aby sprawdzić, czy istnieją błędy, należy sprawdzić dzienniki lub raport o stanie modelowania. Jeśli problem występuje nadal bez rejestrowania błędów, skontaktuj się z nami.

Powrót do góry

Zobacz też

Intelligent Recommendations API
Skrócony przewodnik dotyczący wywoływania interfejsu API
Typowe błędy logowania
Omówienie kontraktu danych