GetPersonalizedRanking

Sortiert eine Liste empfohlener Artikel für den angegebenen Benutzer neu. Das erste Element in der Liste wird als das Element angesehen, das für den Benutzer am wahrscheinlichsten von Interesse ist.

Anmerkung

Die der Kampagne zugrunde liegende Lösung muss mit einem Rezept vom Typ PERSONALIZED_RANKING.erstellt worden sein.

Anforderungssyntax

POST /personalize-ranking HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "inputList": [ "string" ],
   "metadataColumns": { 
      "string" : [ "string" ]
   },
   "userId": "string"
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

campaignArn

Der Amazon-Ressourcenname (ARN) der Kampagne, die für die Erstellung des personalisierten Rankings verwendet werden soll.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 256 Zeichen.

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Erforderlich: Ja

context

Die kontextbezogenen Metadaten, die beim Abrufen von Empfehlungen verwendet werden sollen. Zu den kontextuellen Metadaten gehören alle Interaktionsinformationen, die für das Abrufen von Empfehlungen eines Benutzers relevant sein könnten, z. B. der aktuelle Standort oder der Gerätetyp des Benutzers.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Karteneinträge: Maximale Anzahl von 150 Elementen.

Einschränkungen der Schlüssellänge: Maximale Länge von 150.

Schlüssel-Muster: [A-Za-z\d_]+

Längenbeschränkungen für Werte: Maximale Länge von 1000.

Erforderlich: Nein

filterArn

Der Amazon-Ressourcenname (ARN) eines Filters, den Sie erstellt haben, um Artikel für einen bestimmten Benutzer einzubeziehen oder Artikel von Empfehlungen auszuschließen. Weitere Informationen finden Sie unter Filtern von Empfehlungen.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 256 Zeichen.

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Erforderlich: Nein

filterValues

Die Werte, die beim Filtern von Empfehlungen verwendet werden sollen. Geben Sie für jeden Platzhalterparameter in Ihrem Filterausdruck den Parameternamen (bei entsprechender Groß- und Kleinschreibung) als Schlüssel und die Filterwerte als entsprechenden Wert an. Trennen Sie mehrere Werte für einen Parameter durch ein Komma.

Für Filterausdrücke, die ein INCLUDE Element verwenden, um Elemente einzuschließen, müssen Sie Werte für alle Parameter angeben, die im Ausdruck definiert sind. Bei Filtern mit Ausdrücken, die ein EXCLUDE Element verwenden, um Artikel auszuschließen, können Sie das weglassenfilter-values. In diesem Fall verwendet Amazon Personalize diesen Teil des Ausdrucks nicht, um Empfehlungen zu filtern.

Weitere Informationen finden Sie unter Filtern von Empfehlungen.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Karteneinträge: Maximale Anzahl von 25 Elementen.

Einschränkungen der Schlüssellänge: Maximale Länge von 50.

Schlüssel-Muster: [A-Za-z0-9_]+

Längenbeschränkungen für Werte: Maximale Länge von 1000.

Erforderlich: Nein

inputList

Eine Liste von Einträgen (nachitemId), denen eine Rangfolge zugewiesen werden soll. Wenn ein Element nicht im Trainingsdatensatz enthalten war, wird das Element an das Ende der neu eingestuften Liste angehängt. Wenn Sie Metadaten in Empfehlungen aufnehmen, ist der Höchstwert 50. Andernfalls ist das Maximum 500.

Typ: Zeichenfolgen-Array

Längenbeschränkungen: Maximale Länge beträgt 256 Zeichen.

Erforderlich: Ja

metadataColumns

Wenn Sie bei der Erstellung oder Aktualisierung der Kampagne Metadaten in Empfehlungen aktiviert haben, geben Sie Metadatenspalten aus Ihrem Artikeldatensatz an, die in das personalisierte Ranking aufgenommen werden sollen. Der Map-Schlüssel ist ITEMS und der Wert ist eine Liste von Spaltennamen aus Ihrem Artikel-Datensatz. Die maximale Anzahl von Spalten, die Sie angeben können, ist 10.

Informationen zum Aktivieren von Metadaten für eine Kampagne finden Sie unter Aktivieren von Metadaten in Empfehlungen für eine Kampagne.

Typ: Zeichenfolge zu Array von Zeichenfolgen-Mapping

Karteneinträge: Maximale Anzahl von 1 Element.

Einschränkungen der Schlüssellänge: Die maximale Länge beträgt 256.

Array-Mitglieder: Maximale Anzahl von 99 Elementen.

Längenbeschränkungen: Die maximale Länge beträgt 150.

Erforderlich: Nein

userId

Der Benutzer, für den die Kampagne ein personalisiertes Ranking bereitstellen soll.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 256 Zeichen.

Erforderlich: Ja

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "personalizedRanking": [ 
      { 
         "itemId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "promotionName": "string",
         "reason": [ "string" ],
         "score": number
      }
   ],
   "recommendationId": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

personalizedRanking

Eine Liste von Elementen in der Reihenfolge, in der sie für den Benutzer am wahrscheinlichsten von Interesse sind. Das Maximum ist 500.

Typ: Array von PredictedItem-Objekten

recommendationId

Die ID der Empfehlung.

Typ: Zeichenfolge

Fehler

InvalidInputException

Geben Sie einen gültigen Wert für das Feld oder den Parameter an.

HTTP Status Code: 400

ResourceNotFoundException

Die angegebene Ressource ist nicht vorhanden.

HTTP Status Code: 404

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden:

• AWS -Befehlszeilenschnittstelle

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK für JavaScript V3

• AWS SDK for PHP V3

• AWS SDK für Python

• AWS SDK for Ruby V3