Rank - Rank

Referenz

Service:: Cognitive Services - Personalizer

API Version:: v1.0

Eine Personalisierungsbewertungsanforderung.

POST {Endpoint}/personalizer/v1.0/rank

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützter Cognitive Services-Endpunkt.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
actions	True	RankableAction[]	Der Satz von Aktionen, aus dem der Personalisierungsdienst auswählen kann. Der Satz sollte nicht mehr als 50 Aktionen enthalten. Die Reihenfolge der Aktionen wirkt sich nicht auf das Rangergebnis aus, aber die Reihenfolge sollte der Reihenfolge entsprechen, die Ihre Anwendung verwendet hätte, um sie anzuzeigen.
contextFeatures		object[]	Features des Kontexts, der für die Personalisierung als Wörterbuch von Wörterbüchern verwendet wird. Dies hängt von der Anwendung ab und umfasst in der Regel Features über den aktuellen Benutzer, sein Gerät, Profilinformationen, Daten zu Uhrzeit und Datum usw.
deferActivation		boolean	Senden Sie false, wenn dem Benutzer die Bewertungsergebnisse angezeigt werden. Daher erwartet die Personalisierung einen Reward-Aufruf, andernfalls wird dem Ereignis die Standardbelohnung zugewiesen. Senden Sie true, wenn es möglich ist, dass dem Benutzer die Rangfolgenergebnisse nicht angezeigt werden, da die Seite später gerendert wird, oder die Rangfolgeergebnisse durch Code weiter nach unten überschrieben werden.
eventId		string	Übergeben Sie optional eine eventId, die dieses Rank-Ereignis eindeutig identifiziert. Wenn NULL, generiert der Dienst eine eindeutige eventId. Die eventId wird zum Zuordnen dieser Anforderung mit ihrer Belohnung sowie zum Seeding des Pseudo-Zufallsgenerators beim Ausführen eines Personalisierungsaufrufs verwendet.
excludedActions		string[]	Der Satz von Aktions-IDs, die von der Rangfolge ausgeschlossen werden sollen.

Antworten

Name	Typ	Beschreibung
201 Created	RankResponse	Erfolg
Other Status Codes	ErrorResponse	Ungültige Ranganforderung.

Sicherheit

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Beispiele

Successful Rank request

Sample Request

HTTP

POST {Endpoint}/personalizer/v1.0/rank


{
  "contextFeatures": [
    {
      "timeOfDay": "Morning"
    }
  ],
  "actions": [
    {
      "id": "NewsArticle",
      "features": [
        {
          "type": "News"
        }
      ]
    },
    {
      "id": "SportsArticle",
      "features": [
        {
          "type": "Sports"
        }
      ]
    },
    {
      "id": "EntertainmentArticle",
      "features": [
        {
          "type": "Entertainment"
        }
      ]
    }
  ],
  "excludedActions": [
    "SportsArticle"
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "deferActivation": false
}

Sample Response

Status code:: 201

{
  "ranking": [
    {
      "id": "EntertainmentArticle",
      "probability": 0.8
    },
    {
      "id": "SportsArticle",
      "probability": 0
    },
    {
      "id": "NewsArticle",
      "probability": 0.2
    }
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "rewardActionId": "EntertainmentArticle"
}

Definitionen

Name	Beschreibung
ErrorCode	Allgemeiner Fehlercode.
ErrorResponse	Wird verwendet, um einen Fehler an den Client zurückzugeben.
InternalError	Ein Objekt, das spezifischere Informationen enthält als das übergeordnete Objekt über den Fehler.
PersonalizerError	Das Fehlerobjekt.
RankableAction	Eine Aktion mit zugeordneten Features, die für die Rangfolge verwendet werden.
RankedAction	Eine klassifizierte Aktion mit ihrer resultierenden Wahrscheinlichkeit.
RankRequest	Fordern Sie eine Reihe von Aktionen an, die vom Personalisierungsdienst sortiert werden sollen.
RankResponse	Eine resultierende geordnete Liste von Aktionen, die aus einer Ranganforderung resultieren.

ErrorCode

Allgemeiner Fehlercode.

Name	Typ	Beschreibung
BadRequest	string	Die Anforderung konnte vom Server nicht verstanden werden.
InternalServerError	string	Auf dem Server ist ein allgemeiner Fehler aufgetreten.
ResourceNotFound	string	Die angeforderte Ressource ist auf dem Server nicht vorhanden.

ErrorResponse

Wird verwendet, um einen Fehler an den Client zurückzugeben.

Name	Typ	Beschreibung
error	PersonalizerError	Das Fehlerobjekt.

InternalError

Ein Objekt, das spezifischere Informationen enthält als das übergeordnete Objekt über den Fehler.

Name	Typ	Beschreibung
code	string	Detaillierter Fehlercode.
innererror	InternalError	Das Fehlerobjekt.

PersonalizerError

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Allgemeiner Fehlercode.
details	PersonalizerError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innerError	InternalError	Ausführlichere Fehlerdetails.
message	string	Eine Meldung, die den vom Dienst gemeldeten Fehler erläutert.
target	string	Fehlerquellenelement.

RankableAction

Eine Aktion mit zugeordneten Features, die für die Rangfolge verwendet werden.

Name	Typ	Beschreibung
features	object[]	Liste der Wörterbücher, die Features enthalten.
id	string	ID der Aktion.

RankedAction

Eine klassifizierte Aktion mit ihrer resultierenden Wahrscheinlichkeit.

Name	Typ	Beschreibung
id	string	ID der Aktion
probability	number	Wahrscheinlichkeit der Aktion

RankRequest

Fordern Sie eine Reihe von Aktionen an, die vom Personalisierungsdienst sortiert werden sollen.

Name	Typ	Standardwert	Beschreibung
actions	RankableAction[]		Der Satz von Aktionen, aus dem der Personalisierungsdienst auswählen kann. Der Satz sollte nicht mehr als 50 Aktionen enthalten. Die Reihenfolge der Aktionen wirkt sich nicht auf das Rangergebnis aus, aber die Reihenfolge sollte der Reihenfolge entsprechen, die Ihre Anwendung verwendet hätte, um sie anzuzeigen.
contextFeatures	object[]		Features des Kontexts, der für die Personalisierung als Wörterbuch von Wörterbüchern verwendet wird. Dies hängt von der Anwendung ab und umfasst in der Regel Features über den aktuellen Benutzer, sein Gerät, Profilinformationen, Daten zu Uhrzeit und Datum usw.
deferActivation	boolean	False	Senden Sie false, wenn dem Benutzer die Bewertungsergebnisse angezeigt werden. Daher erwartet die Personalisierung einen Reward-Aufruf, andernfalls wird dem Ereignis die Standardbelohnung zugewiesen. Senden Sie true, wenn es möglich ist, dass dem Benutzer die Rangfolgenergebnisse nicht angezeigt werden, da die Seite später gerendert wird, oder die Rangfolgeergebnisse durch Code weiter nach unten überschrieben werden.
eventId	string		Übergeben Sie optional eine eventId, die dieses Rank-Ereignis eindeutig identifiziert. Wenn NULL, generiert der Dienst eine eindeutige eventId. Die eventId wird zum Zuordnen dieser Anforderung mit ihrer Belohnung sowie zum Seeding des Pseudo-Zufallsgenerators beim Ausführen eines Personalisierungsaufrufs verwendet.
excludedActions	string[]		Der Satz von Aktions-IDs, die von der Rangfolge ausgeschlossen werden sollen.

RankResponse

Eine resultierende geordnete Liste von Aktionen, die aus einer Ranganforderung resultieren.

Name	Typ	Beschreibung
eventId	string	Die eventId für den Roundtrip von der Anforderung bis zur Antwort.
ranking	RankedAction[]	Die berechnete Rangfolge für die aktuelle Anforderung.
rewardActionId	string	Die vom Personalisierungsdienst ausgewählte Aktion. Dies ist die Aktion, für die die Belohnung gemeldet werden soll. Dies ist möglicherweise nicht die erste, die in der "Rangfolge" gefunden wurde, wenn eine Aktion in der Anforderung an erster Stelle Teil der ausgeschlossenen IDs war.