View a markdown version of this page

GetRecommendations - Amazon Personalize
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

GetRecommendations

Gibt eine Liste der empfohlenen Artikel zurück. Für Kampagnen ist der Amazon-Ressourcenname (ARN) der Kampagne erforderlich. Die erforderlichen Benutzer- und Artikeleingaben hängen wie folgt von der Rezeptur ab, mit der die Kampagne unterstützt wird:

  • USER_PERSONALIZATION — userId erforderlich, wird nicht verwendet itemId

  • RELATED_ITEMS — erforderlich, nicht verwendet itemId userId

Anmerkung

Kampagnen, die von einer Lösung unterstützt werden, die mit einem Rezept des Typs PERSONALIZED_RANKING erstellt wurde, verwenden die API. GetPersonalizedRanking

Für Empfehlungsgeber ist der ARN des Empfehlenden erforderlich, und die erforderlichen Artikel- und Benutzereingaben hängen vom Anwendungsfall (domänenbasiertes Rezept) ab, der dem Empfehlenden zugrunde liegt. Informationen zu den Anforderungen für Anwendungsfälle finden Sie unter Anwendungsfälle für Empfehlungsempfehler auswählen.

Anforderungssyntax

POST /recommendations HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "itemId": "string",
   "metadataColumns": { 
      "string" : [ "string" ]
   },
   "numResults": number,
   "promotions": [ 
      { 
         "filterArn": "string",
         "filterValues": { 
            "string" : "string" 
         },
         "name": "string",
         "percentPromotedItems": number
      }
   ],
   "recommenderArn": "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 das Einholen von Empfehlungen verwendet werden soll.

Typ: Zeichenfolge

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

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

Erforderlich: Nein

context

Die kontextbezogenen Metadaten, die beim Abrufen von Empfehlungen verwendet werden sollen. Zu den kontextbezogenen Metadaten gehören alle Interaktionsinformationen, die für das Abrufen der 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: Die maximale Länge beträgt 150.

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

Beschränkungen der Wertelänge: Die maximale Länge beträgt 1000.

Erforderlich: Nein

filterArn

Der ARN des Filters, der auf die zurückgegebenen Empfehlungen angewendet werden soll. Weitere Informationen finden Sie unter Filtern von Empfehlungen.

Wenn Sie diesen Parameter verwenden, stellen Sie sicher, dass die Filterressource ACTIVE

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 (in passender 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 Empfehlungen und Benutzersegmente filtern.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Karteneinträge: Maximale Anzahl von 25 Elementen.

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

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

Beschränkungen der Wertelänge: Die maximale Länge beträgt 1000.

Erforderlich: Nein

itemId

Die Artikel-ID, für die Empfehlungen abgegeben werden sollen.

Erforderlich für den RELATED_ITEMS Rezepttyp.

Typ: Zeichenfolge

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

Erforderlich: Nein

metadataColumns

Wenn Sie Metadaten in Empfehlungen aktiviert haben, als Sie die Kampagne oder den Empfehlungsgeber erstellt oder aktualisiert haben, geben Sie die Metadatenspalten aus Ihrem Artikel-Datensatz an, die in die Artikelempfehlungen aufgenommen werden sollen. Der Kartenschlü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 Metadaten in Empfehlungen für eine Kampagne aktivieren. Informationen zum Aktivieren von Metadaten für einen Empfehlungsgeber finden Sie unter Metadaten in Empfehlungen für einen Empfehlungsgeber aktivieren.

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

numResults

Die Anzahl der zurückzugebenden Ergebnisse. Der Standardwert ist 25. Wenn Sie Metadaten in Empfehlungen einbeziehen, ist das Maximum 50. Andernfalls liegt das Maximum bei 500.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 0.

Erforderlich: Nein

promotions

Die Werbeaktionen, die für die Empfehlungsanfrage gelten sollen. Eine Werbeaktion definiert zusätzliche Geschäftsregeln, die für eine konfigurierbare Untergruppe empfohlener Artikel gelten.

Typ: Array von Promotion-Objekten

Array-Mitglieder: Maximale Anzahl von 1 Element.

Erforderlich: Nein

recommenderArn

Der Amazon-Ressourcenname (ARN) des Empfehlenden, der zum Abrufen von Empfehlungen verwendet werden soll. Geben Sie einen Empfehlungs-ARN an, wenn Sie eine Domain-Datensatzgruppe mit einem Empfehlungsgeber für einen Domain-Anwendungsfall erstellt haben.

Typ: Zeichenfolge

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

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

Erforderlich: Nein

userId

Die Benutzer-ID, für die Empfehlungen abgegeben werden sollen.

Erforderlich für den USER_PERSONALIZATION Rezepttyp.

Typ: Zeichenfolge

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

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "itemList": [ 
      { 
         "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.

itemList

Eine Liste von Empfehlungen, die in absteigender Reihenfolge nach dem Prognosewert sortiert sind. Die Liste kann maximal 500 Elemente enthalten.

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-Statuscode: 400

ResourceNotFoundException

Die angegebene Ressource ist nicht vorhanden.

HTTP-Statuscode: 404

Weitere Informationen finden Sie unter:

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