Modellen API - Overzicht

Met de API Modellen, ook wel de Lijst van gewezen personen-API genoemd, kunnen gebruikers de lijst met functies weergeven en beheren die worden gebruikt in modellen voor machinaal leren voor Automated Personalization- (AP) en Auto-Target -activiteiten (AT). Als een gebruiker een eigenschap van door de modellen voor AP of bij activiteiten zou willen uitsluiten worden gebruikt, kunnen zij Modellen API gebruiken om die eigenschap aan de "lijst van gewezen personen toe te voegen."

Een blocklist definieert de reeks functies die door Adobe Target worden uitgesloten van zijn leermodellen voor computers. Voor meer informatie over eigenschappen, zie ​ Gegevens die door Target worden gebruikt machine-leert algoritmen ​.

Lijsten van gewezen personen kunnen worden gedefinieerd per activiteit (activiteitsniveau) of voor alle activiteiten binnen een Target -account (algemeen niveau).

Modellen API-specificatie

Bekijk hier de Modellen API specificatie ​ ​.

Vereisten

Om de Modellen API te gebruiken, moet u authentificatie vormen gebruikend ​ Adobe Developer Console ​, enkel zoals u met ​ Admin API van het Doel ​ zou. Voor meer informatie, zie ​ hoe te om Authentificatie ​ te vormen.

Richtlijnen voor gebruik van modellen-API

Hoe te om lijsten van gewezen personen te beheren

Stap 1: lijst van de Mening van eigenschappen voor een activiteit

Stap 2: controleer de lijst van gewezen personen van de activiteit

Stap 3: voegt eigenschappen aan de lijst van gewezen personen van de activiteit toe

Stap 4: (Facultatieve) Unblock

Stap 5: (Facultatief) beheert de globale lijst van gewezen personen

Stap 1: Lijst met functies voor een activiteit weergeven step1

Voordat u een functie voegt op lijst van gewenste personen, bekijkt u de lijst met functies die momenteel worden opgenomen in de modellen voor die activiteit.

GET https://mc.adobe.io/<tenant>/target/models/features/<campaignId>

{
    "features": [
        {
            "externalName": "Visitor Profile - Total Visits to Activity",
            "internalName": "SES_PREVIOUS_VISIT_COUNT",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Total Visits",
            "internalName": "SES_TOTAL_SESSIONS",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Pages Seen Before Activity",
            "internalName": "SES_PREVIOUS_VISIT_COUNT",
            "type": "CONTINUOUS"
        },
        {
            "externalName": "Visitor Profile - Activity Lifetime Time on Site",
            "internalName": "SES_TOTAL_TIME",
            "type": "CONTINUOUS"
        }
    ],
    "reportParameters": {
        "clientCode": <tenant>,
        "campaignId": <campaignId>
    }
}

In het hier getoonde voorbeeld, controleert de gebruiker om de lijst van eigenschappen te zien die in het model voor de activiteit worden gebruikt waarvan identiteitskaart van de Activiteit 260840 is.

externalName is een gebruiksvriendelijke naam voor een functie. Deze wordt gemaakt door Target en het is mogelijk dat deze waarde in de loop van de tijd verandert. De gebruikers kunnen deze gebruikersvriendelijke namen in het ​ rapport van de Inzichten van Personalization ​ bekijken.

De internalName is de werkelijke id van de functie. Deze wordt ook gemaakt door Target , maar kan niet worden gewijzigd. Dit is de waarde waarnaar u moet verwijzen om de functie(s) te identificeren die u wilt lijsten van gewezen personen.

Houd er rekening mee dat de lijst met functies alleen waarden kan bevatten (zodat deze niet null is) als een activiteit:

Stap 2: Controleer de lijst van gewezen personen van de activiteit step2

Bekijk nu de lijst van gewezen personen. Met andere woorden, controleer of er functies zijn die momenteel niet in de modellen voor deze activiteit kunnen worden opgenomen.

GET https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

In het hier weergegeven voorbeeld controleert de gebruiker de lijst met geblokkeerde functies voor de activiteit waarvan de activiteit-id 260840 is. De resultaten zijn leeg, wat betekent dat deze activiteit momenteel geen gevoegde op lijst van gewenste personen functies heeft.

Stap 3: voeg eigenschappen aan de lijst van gewezen personen van de activiteit toe step3

Als u functies wilt toevoegen aan de lijst van gewezen personen, wijzigt u de aanvraag van GET in PUT en wijzigt u de hoofdtekst van de aanvraag om de blockedFeatureSources of blockedFeatures naar wens op te geven.

blockedFeatureSources geeft aan waar een functie vandaan komt. Voor het voegend op lijst van gewenste personen maken dienen zij als groepen of categorieën eigenschappen, die gebruikers toelaten om volledige reeksen eigenschappen in één keer te blokkeren. De waarden van blockedFeatureSources komen overeen met de eerste tekens van de id van een functie (blockedFeatures of internalName waarden); daarom kunnen deze ook als 'functievoorvoegsels' worden beschouwd.

Tabel met blockedFeatureSources waarden table

PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

{
    "blockedFeatureSources": ["AAM"],
    "blockedFeatures": ["SES_PREVIOUS_VISIT_COUNT", "SES_TOTAL_SESSIONS"]
}

{
    "blockedFeatures": [
            "SES_PREVIOUS_VISIT_COUNT",
            "SES_TOTAL_SESSIONS"
        ],
    "blockedFeatureSources": [
            "AAM"
        ]
}

In het hier getoonde voorbeeld, blokkeert de gebruiker twee eigenschappen, SES_PREVIOUS_VISIT_COUNT en SES_TOTAL_SESSIONS, die zij eerder door de volledige lijst van eigenschappen voor de activiteit te vragen waarvan identiteitskaart van de Activiteit 260480 is, zoals die in ​ Stap 1 ​ wordt beschreven. Zij blokkeren ook alle eigenschappen die uit de Segmenten van Experience Cloud komen, die door eigenschappen met de prefix van "AAM,"zoals die in de ​ lijst ​ hierboven wordt beschreven te blokkeren worden bereikt.

Merk op dat na het voegend op lijst van gewenste personen een eigenschap, het wordt geadviseerd dat u de bijgewerkte lijst van gewezen personen door ​ Stap 2 ​ opnieuw uit te voeren (GET de lijst van gewezen personen) verifieert. Controleer of de resultaten er goed uitzien (controleer of de resultaten de functies bevatten die zijn toegevoegd uit de meest recente PUT-aanvraag).

Stap 4: (Optioneel) Blokkeren opheffen step4

Als u alle op de lijst met ongewenste personen staan functies wilt ontgrendelen, wist u de waarden uit blockedFeatureSources of blockedFeatures .

PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/<campaignId>

{
    "blockedFeatureSources": [],
    "blockedFeatures": []
}

{
    "blockedFeatures": [],
    "blockedFeatureSources": []
}

In het hier getoonde voorbeeld, ontruimt de gebruiker hun lijst van gewezen personen voor de activiteit waarvan identiteitskaart van de Activiteit 260840 is. Merk op dat de reactie lege series voor zowel geblokkeerde eigenschappen als hun bronnen bevestigt— blockedFeatureSources en blockedFeatures, respectievelijk.

Zoals altijd, na het wijzigen van de lijst van gewezen personen, adviseert men dat u ​ Stap 2 ​ opnieuw uitvoert (GET de lijst van gewezen personen om de lijst te verifiëren omvat eigenschappen zoals verwacht). In het hier weergegeven voorbeeld controleert de gebruiker of zijn lijst van gewezen personen nu leeg is.

Vraag: Hoe kan ik sommige, maar niet alle, lijsten van gewezen personen verwijderen?

Antwoord: Om een discrete ondergroep van op de lijst met ongewenste personen staan eigenschappen uit een multi-eigenschapslijst van gewezen personen te verwijderen, kunnen de gebruikers de bijgewerkte lijst van eigenschappen eenvoudig verzenden zij in ​ het verzoek van de lijst van gewezen personen ​, in tegenstelling tot het ontruimen van de volledige lijst van gewezen personen zouden willen blokkeren en de gewenste eigenschappen opnieuw toevoegen. Met andere woorden, verzend de bijgewerkte eigenschaplijst (zoals aangetoond in ​ Stap 3 ​), die ervoor zorgen om de eigenschappen uit te sluiten u wenst om "te schrappen"van de lijst van gewezen personen.

Stap 5: (Optioneel) Beheer de algemene lijst van gewezen personen step5

De bovenstaande voorbeelden hadden allemaal betrekking op één enkele activiteit. U kunt eigenschappen voor alle activiteiten over een bepaalde cliënt (huurder) ook blokkeren, in plaats van het moeten de lijst van gewezen personen voor elke activiteit afzonderlijk specificeren. Als u een algemene lijst van gewezen personen wilt uitvoeren, gebruikt u de aanroep /blockList/global in plaats van blockList/<campaignId> .

PUT https://mc.adobe.io/<tenant>/target/models/features/blockList/global

{
    "blockedFeatureSources": ["AAM", "PRO", "ENV"],
    "blockedFeatures": ["AAM_FEATURE_1", "AAM_FEATURE_2"]
}

{
    "blockedFeatures": [
        "AAM_FEATURE_1",
        "AAM_FEATURE_2"
    ],
    "blockedFeatureSources": [
        "AAM",
        "PRO",
        "ENV"
    ]
}

In de voorbeeldaanvraag hierboven blokkeert de gebruiker twee functies, "AAM_FEATURE_1" en "AAM_FEATURE_2", voor alle activiteiten in hun Target -account. Dit betekent dat, ongeacht de activiteit, "AAM_FEATURE_1" en "AAM_FEATURE_2" niet zullen worden opgenomen in de modellen voor machinaal leren voor dit account. Bovendien blokkeert de gebruiker wereldwijd ook alle functies waarvan het voorvoegsel "AAM", "PRO" of "ENV" is.

Vraag: Is het bovenstaande codevoorbeeld niet overbodig?

Antwoord: Ja. Het is overbodig om functies te blokkeren met waarden die beginnen met "AAM" en tegelijkertijd alle functies te blokkeren waarvan de bron "AAM" is. Het nettoresultaat is dat alle functies van AAM (Experience Cloud Segments) worden geblokkeerd. Daarom als het doel is om alle eigenschappen van de Segmenten van Experience Cloud te blokkeren, individueel het specificeren van bepaalde eigenschappen die met "AAM"beginnen is onnodig, in het bovenstaande voorbeeld.

Laatste stap: Of dit nu op het niveau van de activiteit of wereldwijd is, u wordt aangeraden de lijst van gewezen personen te verifiëren nadat u deze hebt gewijzigd, om er zeker van te zijn dat deze de waarden bevat die u verwacht. Dit doet u door de PUT in een GET te wijzigen.

De voorbeeldreactie hieronder geeft aan dat Target twee afzonderlijke functies blokkeert, plus alle functies die afkomstig zijn van "AAM", "PRO" en "ENV".