Katalogdataobjekter
Denne artikel giver vejledning om, hvordan du konfigurerer katalogdataobjekter i datakontrakten til Intelligent Recommendations.
Gennemgang af dataobjekter
Et dataobjekt er et sæt af en eller flere datatekstfiler, der hver især har en liste over kolonner (også kaldet attributter) og rækker, der indeholder de faktiske dataværdier.
Intelligent Recommendations definerer logiske grupper af dataobjekter, som har deres egne formål.
Bemærk
Dataobjekter er valgfrie, medmindre andet udtrykkeligt er angivet, hvilket betyder, at deres data kan være tomme eller mangle.
Gå til hele listen over dataobjekter
Introduktion til katalogdataobjekter
Katalogdataobjektet repræsenterer alle varer og varevarianter, der kan blive vist i anbefalingsresultaterne. Kandidaterne bestemmes ved at anvende tilgængeligheder på varer – en dato, der fortæller systemet, at der skal inkluderes en vare i anbefalingsresultaterne. Hvis der ikke er en gyldig tilgængelighed, ignoreres varer, når der returneres resultater.
Intelligent Recommendations understøtter følgende funktioner og scenarier:
Varer med flere varianter (f.eks. en skjorte i forskellige størrelser eller farver) eller slet ingen varianter. Vi refererer til disse variationer som varianter. Varer, der ikke har nogen varianter, kaldes enkeltstående varer, mens varer, der har mindst én variant, kaldes varemastere.
Tildeling af filterværdier til varer (f.eks. kategori, farve eller størrelse). Når du forespørger efter anbefalinger på et senere tidspunkt, kan du filtrere efter disse filterværdier.
Tildeling af billeder til varer.
Varer kan være tilgængelige i forskellige logiske objekter inden for organisationen. Intelligent Recommendations understøtter to niveauer af hierarkier:
Kanal: Varer kan tildeles til en kanal, så Intelligent Recommendations kan komme med anbefalinger, der kun gælder for produkter, som er inkluderet i en bestemt kanal. Alle varer knyttes automatisk til standardkanalen, der bruger strengen 0 (nul) som reserveret kanal-id.
Eksempel:
I dette eksempel indeholder datasættet kun tre varer: X, Y og Z. Disse tre varer tildeles automatisk til standardkanalen (Channel=0). Du kan også tildele disse varer til dine egne brugerdefinerede kanaler. Du kan f.eks. tildele varerne X og Y til Channel=C1 og varerne Y og Z til Channel=C2.
Når du anmoder om anbefalinger, kan du således sende disse øvrige forespørgselsparametre:
- Ingen kanalparameter (er lig med standardkanalen): Alle tre varer kan returneres i svaret
- Channel=0: Det samme som ingen parameter, da dette er standardkanalen
- Channel=C1: Det er kun varer, som tilhører C1-kanalen (vare X og Y), der kan returneres som svar
- Channel=C2: Det er kun varer, som tilhører C2-kanalen (vare Y og Z), der kan returneres som svar
- Channel=SomethingElse: Tomt svar, fordi denne kanal ikke er defineret, og der ikke er tildelt varer til den
Katalog: Et katalog er et andet og finere detaljegradsniveau for tilgængelighed. Det giver dig mulighed for at definere flere kataloger inden for en kanal og få anbefalinger til bestemte kataloger. Ligesom i en kanal knyttes alle varer automatisk til standardkataloget inden for en kanal, som bruger strengen 0 (nul) som reserveret katalog-id.
Eksempel:
Hvis vi går videre med kanal-eksemplet, har du varererne X, Y og Z. Du har tildelt vare X og Y til kanal C1, og de tildeles automatisk til standardkataloget i kanalen (ved hjælp af Catalog=0). Du kan få større detaljegrad ved at tildele disse elementer til brugerdefinerede kataloger i kanalen. Lad os tildele vare X til Catalog=A og vare X og Y til Catalog=B.
Når du anmoder om anbefalinger, kan du således sende disse øvrige forespørgselsparametre:
- Channel=C1: Ingen katalogparameter er lig med standardkataloget. Både vare X og Y kan returneres i svaret.
- Channel=C1&Catalog=0: Det samme som ingen katalogparameter, da dette er standardkataloget.
- Channel=C1&Catalog=A: Det er kun varer, som tilhører kataloget A i kanalen C1 (kun vare X), der kan returneres i svaret.
- Channel=C1&Catalog=B: Det er kun varer, som tilhører kataloget B i kanalen C1 (vare X og Y), der kan returneres i svaret.
- Channel=C1&Catalog=SomethingElse: Tomt svar, fordi dette katalog ikke er defineret i kanalen C1, og der ikke er tildelt varer til det.
Erklær tilgængeligheder for varer:
- Start-/slutdatoer for tilgængelighed: Varer, der ikke ligger inden for deres tidsinterval for tilgængelighed, medtages ikke i anbefalingssvaret.
- Fin detaljegrad for tilgængelighed: Definer start-/slutdatoerne inden for bestemte kanal-/katalog-id'er.
Kataloget består af flere dataobjekter, som alle er valgfrie (afhængigt af, hvilke funktioner du vil bruge), og det kan forblive tomt (eller mangle) i rodmappen til Intelligent Recommendations. Følg retningslinjerne i dataobjektet Reco_ItemsAndVariants, der beskrives nedenfor, hvis du ikke vil angive dette dataobjekt.
Liste over katalogdataobjekter
Følgende dataobjekter er en del af kataloget:
- Varer og varianter
- Varekategorier
- Vare- og variantbilleder
- Vare- og variantfiltre
- Tilgængeligheder af varer og varianter
Gå til hele listen over dataobjekter
Varer og varianter
Navn på dataobjekt:Reco_ItemsAndVariants
Beskrivelse: Alle varer og varevarianter
Attributter:
| Navn | Datatype | Obligatorisk | Standardværdi | Ugyldig funktionsmåde for værdi | Kommentarer |
|---|---|---|---|---|---|
| ItemId | Streng(16) | Ja | Leveringspost | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist vare-id'et. | |
| ItemVariantId | Streng(16) | Nej | Leveringspost | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist varevariant-id'et. | |
| titel | Streng(256) | Nej | Begrænsningsværdi | Længden er begrænset til 256 tegn. | |
| Beskrivelse | Streng(2048) | Nej | Begrænsningsværdi | Længden er begrænset til 2048 tegn. | |
| ReleaseDate | Datetime | Nej | 1970-01-01T00:00:00.000Z | Leveringspost | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist DateTime-værdier. |
Retningslinjer:
Varevarianter nedarver attributterne til deres varemaster. Hvis en varevariant f.eks. ikke har en titel, nedarver den titlen på varemasteren (dvs. rækken med samme ItemId, men med et tomt ItemVariantId), hvis den findes.
ItemIds kan have en en til mange-relation med ItemVariantIds. Det er muligt, at et enkelt ItemId er knyttet til mere end ét ItemVariantId, så relationen kan registreres fra en varemaster til dens varevarianter. Det er muligt at angive en enkelt post for en bestemt kombination af ItemId og ItemVariantId uden at angive andre kombinationer af ItemId til ItemVariantId.
Attributten ReleaseDate repræsenterer den dato, hvor varen blev frigivet (udgivet, introduceret) på markedet. Denne attribut er forskellig fra en vares tilgængelighed (når en vare/et produkt kan returneres under et API-kald), men ReleaseDate kan bruges i scenarier som Nye og Trending, som er afhængige af datoer for bestilling af varer.
Hvis dette dataobjekt er tomt (eller mangler), vil Intelligent Recommendations automatisk bruge alle varer og varevarianter, der findes i Reco_Interactions-dataobjektet, som sættet af katalogvarer og tildele hver enkelt vare og varevariant med standardtitlen, beskrivelsen og udgivelsesdatoen. Disse elementer betragtes som altid tilgængelige, medmindre de er tildelt eksplicit tilgængelighed i Reco_ItemAndVariantAvailabilities-dataobjektet.
Intelligent Recommendations kan bruge attributterne Titel og Beskrivelse til at komme med tekstbaserede anbefalinger. Da Intelligent Recommendations i øjeblikket kun understøtter landestandarden en-us til tekstmæssige anbefalinger, kan kvaliteten af de tekstbaserede anbefalinger blive forringet, hvis Titel og Beskrivelse angives i andre landestandarder.
Eksempeldata:
Overskrifter vises kun for nemheds skyld og bør ikke være en del af de faktiske data.
| ItemId | ItemVariantId | titel | Beskrivelse | ReleaseDate |
|---|---|---|---|---|
| Element1 | 2018-05-15T13:30:00.000Z | |||
| Element1 | Item1Var1 | Sorte solbriller | Sorte solbriller til børn | 2018-08-01T10:45:00.000Z |
| Element1 | Item1Var2 | Brune solbriller | Brune solbriller til voksne | |
| Element2 | Pudseklud til briller | 2019-09-20T18:00:00.000Z | ||
| Item3 | Item3Var1 |
Gå tilbage til listen over katalogdataobjekter
Varekategorier
Navn på dataobjekt:Reco_ItemCategories
Beskrivelse: Alle elementkategorier.
Attributter:
| Navn | Datatype | Obligatorisk | Standardværdi | Ugyldig funktionsmåde for værdi | Kommentarer |
|---|---|---|---|---|---|
| ItemId | Streng(16) | Ja | Leveringspost | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist vare-id'et. | |
| Kategori | Streng(64) | Ja | Begrænsningsværdi | Længden er begrænset til 64 tegn. |
Retningslinjer:
Hvert ItemId kan have flere kategorier, hvilket betyder, at det kan blive vist i flere poster i dataene.
Hvis dine data er opbygget ved hjælp af kategoritræer, skal du levere det fulde sæt kategorier (komprimeret) for hver vare.
Eksempeldata:
Overskrifter vises kun for nemheds skyld og bør ikke være en del af de faktiske data.
| ItemId | Kategori |
|---|---|
| Element1 | Category1 |
| Element1 | Category1_subCategoryX |
| Element1 | Category1_subCategoryY |
| Element2 | Category1_subCategoryX |
Gå tilbage til listen over katalogdataobjekter
Vare- og variantbilleder
Navn på dataobjekt:Reco_ItemAndVariantImages
Beskrivelse: Alle vare- og varevariantbilleder
Attributter:
| Navn | Datatype | Obligatorisk | Standardværdi | Ugyldig funktionsmåde for værdi | Kommentarer |
|---|---|---|---|---|---|
| ItemId | Streng(16) | Ja | Leveringspost | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist vare-id'et. | |
| ItemVariantId | Streng(16) | Nej | Leveringspost | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist varevariant-id'et. | |
| ImageFullUrl | Streng(2048) | Ja | Leveringspost | Skal være en absolut URL-adresse. URL-adressen skal kodes korrekt (ved hjælp af procentkodning). Længden er begrænset til 2048 tegn. | |
| IsPrimaryImage | Bool | Ja | Se retningslinjer | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist booleske værdier. |
Retningslinjer:
Du skal eksplicit tildele billeder til et ItemId og til hvert relevant ItemVariantId. Billeder, der er tildelt til en vare, tildeles ikke automatisk til alle varevarianter og omvendt. Billeder, der er tildelt til en varevariant, tildeles ikke automatisk til alle varemasteren for den pågældende variant.
Hvis der er angivet mere end ét primært billede for den samme <ItemId, ItemVariantId>-kombination, bruges kun ét af disse billeder til trinnet til visuelle anbefalinger, og de andre bruges kun, når hele den visuelle model optrædes.
I forbindelse med billeder, hvor Intelligent Recommendations ikke fik adgang, ignoreres URL-adressen til billedet, og det bruges ikke til anbefalingsmodellen.
Hvis værdien IsPrimaryImage er ugyldig, bruges der en værdi af false (f.eks. et ikke-primært billede).
Hvis der kun er angivet ikke-primære billeder for en vare eller en varevariant, bruger Intelligent Recommendations et af de angivne billeder som primært billede til stadig at give visuelle anbefalinger til varen eller varevarianten.
Der er to typer URL-adresser, der understøttes:
- Offentligt tilgængelige HTTPS-URL-adresser: Kræver ikke en godkendelsesheader. Dette omfatter ikke URL-adresser til Azure-blobs, der er offentligt/anonymt tilgængelige, og som ikke understøttes.
-
URL-adresser til Azure Blob-lagre, der kræver godkendelse: Er ikke offentligt/anonymt tilgængelige. Tilladelser til at læse billed-blobs skal tildeles intelligent anbefalinger som forklaret i Installation af Intelligent Recommendations). Blob-URL-adresser skal starte med præfikset:
https://<StorageAccountName>.blob.core.windows.net/.
Den maksimale understøttede størrelse for et enkelt billede er 512 KB. Et billede, der er større end 512 KB, ignoreres af systemet.
ContentType for billedet skal have en billedindholdstype (den skal starte med billede). Dette krav gælder for alle billeder, både når de er tilgængelige via HTTPS og via billed-blobs (via blob-egenskaben ContentType).
Eksempeldata:
Overskrifter vises kun for nemheds skyld og bør ikke være en del af de faktiske data.
| ItemId | ItemVariantId | ImageFullUrl | IsPrimaryImage |
|---|---|---|---|
| Element1 | https://my.server.org/images/Item1_primary.jpg |
True | |
| Element1 | https://my.server.org/images/Item1_secondary.jpg |
Falsk | |
| Element1 | Item1Var1 | https://my.server.org/images/Item1Var1.jpg |
True |
| Element2 | https://my.server.org/images/Item2.jpg |
True |
Gå tilbage til listen over katalogobjekttyper
Vare- og variantfiltre
Navn på dataobjekt:Reco_ItemAndVariantFilters
Beskrivelse: Egenskaber for vare og varevariant, der bruges til filtrering af kørselsresultater
Attributter:
| Navn | Datatype | Obligatorisk | Standardværdi | Ugyldig funktionsmåde for værdi | Kommentarer |
|---|---|---|---|---|---|
| ItemId | Streng(16) | Ja | Leveringspost | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist vare-id'et. | |
| ItemVariantId | Streng(16) | Nej | Leveringspost | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist varevariant-id'et. | |
| FilterName | Streng(64) | Ja | Begrænsningsværdi | ||
| FilterValue | Streng(64) | Ja | Begrænsningsværdi | Længden er begrænset til 64 tegn. | |
| FilterType | Streng | Ja | Leveringspost | Mulige værdier omfatter: Tekstbaseret, Numerisk. |
Retningslinjer:
Varer og varevarianter har en overordnet/underordnet relation. Den retningslinje betyder, at varevarianter nedarver filtrene i deres varemaster. Hvis filteret "Farve" f.eks. er angivet for et bestemt ItemId, får alle elementvarianter af samme ItemId den samme filterværdi for "Farve", medmindre der er angivet en anden værdi af "Farve" for elementvarianten.
Tekstfiltertyper understøtter filtreringshandlingen "er lig med". API-forespørgsler kan f.eks. filtrere varer med "Farve"="Blå".
Numeriske filtertyper understøtter filtreringshandlinger for "område". API-forespørgsler kan f.eks. filtrere varer med "Størrelse" > 40.
Du kan tildele flere filterværdier til det samme filter. Du kan f.eks. angive flere værdier som "Grøn" og "Blå" for filteret "Farve". I dette eksempel har den relevante vare to værdier for filteret "Farve" og returneres, når du filtrerer efter varer, der enten har farven "Grøn" eller "Blå". Hvis du vil tildele flere værdier til det samme filter, skal du tilføje en post for hver filterværdi, du vil tildele, ved hjælp af de samme værdier for FilterName og FilterType.
For hvert FilterName kan en varevariant enten nedarve de overordnede filterværdier eller tilsidesætte dem. Fletning af disse to understøttes ikke. Hvis der ikke er tildelt nogen værdier til et filter for en variant, nedarver den som standard filterværdierne for den overordnede vare. Hvis der er tildelt mindst én filterværdi til et filter for en varevariant, tilsidesættes tilstanden, og det er kun filterværdierne for varianter, der er i kraft (kun for det specifikke filter). Denne værdi betyder, at varevarianten skal gentage de overordnede filterværdier for at opnå en "flettet" funktionsmåde. En vare understøtter f.eks. to farver, Blå og Grøn. Hvis en variant understøtter en anden farve, rød, skal der i varianten angives alle tre farver, der er tildelt til variant-id'et: Blå, Grøn og Rød. I dette eksempel har varevarianten tilsidesat værdierne for filteret "Farve", men den kan stadig nedarve værdierne for andre filtre fra den overordnede vare.
Poster med ikke-understøttede filtertyper ignoreres.
Du kan angive op til 20 forskellige FilterName.
Hvis der angives flere poster med samme FilterName, men en anden FilterType, mislykkes dataindtagelsesprocessen med Intelligent Recommendations.
Der kan ikke angives filtre for varer eller varevarianter. Hvis du angiver et filter i API-anmodningen, bortfiltreres varerne eller varevarianterne uden det angivne filter.
Eksempeldata:
Overskrifter vises kun for nemheds skyld og bør ikke være en del af de faktiske data.
| ItemId | ItemVariantId | FilterName | FilterValue | FilterType |
|---|---|---|---|---|
| Element1 | Color | Rød | Tekstbaserede | |
| Element1 | Item1Var1 | Color | Burgundy | Tekstbaserede |
| Element1 | Item1Var2 | Typografi | Rektangulær | Tekstbaserede |
| Element2 | Size | 38 | Numerisk | |
| Element2 | Color | Blå | Tekstbaserede | |
| Element2 | Color | Grøn | Tekstbaserede |
Gå tilbage til listen over katalogobjekttyper
Tilgængeligheder af varer og varianter
Navn på dataobjekt:Reco_ItemAndVariantAvailabilities
Beskrivelse: Alle tilgængeligheder af varer og varevarianter
Attributter:
| Navn | Datatype | Obligatorisk | Standardværdi | Ugyldig funktionsmåde for værdi | Kommentarer |
|---|---|---|---|---|---|
| ItemId | Streng(16) | Ja | Leveringspost | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist vare-id'et. | |
| ItemVariantId | Streng(16) | Nej | Leveringspost | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist varevariant-id'et. | |
| StartDate | Datetime | Nej | 0001-01-01T00:00:00.000Z | Se retningslinjer | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist DateTime-værdier. |
| EndDate | Datetime | Nej | 9999-12-31T23:59:59.999Z | Se retningslinjer | Se Påkrævede dataobjekter for hvert anbefalingsscenarie for at få vist DateTime-værdier. |
| Dobbeltattribut | Dobbelt | Nej | En dobbeltattribut, der kan bruges i overensstemmelse med virksomhedens behov, og som ikke påvirker modelprocessen. | ||
| Kanal | Streng (64) | Nej | 0 | Begrænsningsværdi | Længden er begrænset til 64 tegn. |
| Katalog | Streng (64) | Nej | 0 | Begrænsningsværdi | Længden er begrænset til 64 tegn. |
Retningslinjer:
Påmindelse: Tilgængeligheder fortæller systemet, hvilke varer eller varevarianter der opfattes som kandidater til anbefalingsresultater.
Tilgængeligheden af en varevariant er sammenlægningen af tilgængeligheder for dens varemaster med tilgængeligheden af selve varevarianten. Selv varevarianter, der ikke har nogen poster, nedarver tilgængelighederne for deres varemaster.
En vare, der mangler i dette dataobjekt, opfattes som altid tilgængelig i standardkanalen og i standardkataloget. Helt konkret fungerer Intelligent Recommendations nøjagtigt, som om varen vises i dataene med standardværdier for alle attributter.
ItemIds har en en til mange-relation med ItemVariantIds. Selvom et itemId ikke er påkrævet for at have et ItemVariantId, er det muligt, at mere end ét ItemVariantId kan knyttes til et enkelt ItemId. Du kan f.eks. tilføje en post for en bestemt kombination af ItemId og ItemVariantId uden eksplicit at tilføje endnu en post til ItemId (og et tomt ItemVariantId). Når det afgøres, om varevarianter har gyldige tilgængeligheder, er det kun de angivne varevarianter, der opfattes som tilgængelige (med de angivne tidsintervaller for hver variant).
Et katalog er kun relevant i forbindelse med en kanal (kataloger er et undersæt af en kanal). catalog=MySale i channel=Europe er f.eks. et andet katalog end catalog=MySale i channel=Asia.
Hvis din datasæt indeholder flere kanaler og kataloger, skal du tilføje en post for hver relevant kombination af kanal og katalog for hver relevant vare og varevariant.
Datoer for tilgængelighed er kun relevante for den angivne kanal og det angivne katalog. Hvis du vil angive de samme tilgængelighedsdatoer for forskellige kanaler og kataloger, skal du eksplicit tilføje en post for de enkelte kanaler og kataloger.
Hvis der er en ugyldig værdi for enten attributterne StartDate eller EndDate, ændres hele posten, så det repræsenterer et ikke-tilgængeligt element. Både værdierne StartDate og EndDate tilsidesættes med DateTime-værdier fra tidligere.
'Dobbeltattributten' kan være tom.
Brug ikke "0" som værdi for "Kanal". Denne værdi er reserveret til systemet. Hvis du bruger "0", opstår der en behandlingsfejl.
Eksempeldata:
Overskrifter vises kun for nemheds skyld og bør ikke være en del af de faktiske data.
| ItemId | ItemVariantId | StartDate | EndDate | Dobbeltattribut | Kanal | Katalog |
|---|---|---|---|---|---|---|
| Element1 | 2020-08-20T10:00:00.000Z | |||||
| Element1 | Item1Var1 | 2020-08-01T12:00:00.000Z | ||||
| Element2 | 2020-04-01T10:00:00.000Z | 2020-04-15T23:59:59.999Z | 15.0 | |||
| Element2 | 2020-04-01T10:00:00.000Z | 9.76 | ||||
| Item3 | 2020-05-01T12:00:00.000Z | Europa | MySale |
Gå tilbage til listen over katalogobjekttyper
Se også
Oversigt over datakontrakt
Tabel over tilknytning af dataobjekter
Interaktionsdataobjekter
Dataobjekter for konfigurationer af anbefalinger
Dataobjekter for fravalgte brugere
Dataobjekter for eksterne lister
Dataobjekter for forbedring af anbefalinger
Dataobjekter for tilknytning af billede til vare
Intelligent Recommendations-API
Startvejledning: Konfigurer og kør Intelligent Recommendations med prøvedata