Rank - Rank

Referencia

Service:: Cognitive Services - Personalizer

API Version:: v1.0

A Personalizer rangsorolási kérése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string	Támogatott Cognitive Services-végpont.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string

Kérelem törzse

Name	Kötelező	Típus	Description
actions	True	RankableAction[]	Az a műveletkészlet, amelyből a Personalizer szolgáltatás választhat. A készlet legfeljebb 50 műveletet tartalmazhat. A műveletek sorrendje nincs hatással a rangsor eredményére, de a sorrendnek meg kell egyeznie az alkalmazás által a megjelenítéshez használt sorrenddel.
contextFeatures		object[]	A Personalizer szótárként használt környezet funkciói. Ez az alkalmazástól függ, és általában magában foglalja az aktuális felhasználó, az eszköz, a profiladatok, az idő és a dátum adatait stb.
deferActivation		boolean	Hamis küldése, ha a felhasználó látni fogja a rangsoreredményeket, ezért a Personalizer reward hívást vár, ellenkező esetben hozzárendeli az alapértelmezett Reward-et az eseményhez. Igaz küldése, ha lehetséges, hogy a felhasználó nem látja a rangsoreredményeket, mert az oldal később jelenik meg, vagy a rangsoreredményeket felül lehet bírálni a kód további alsóbb rétegében.
eventId		string	Opcionálisan megadhat egy eventId azonosítót, amely egyedileg azonosítja ezt a Rangsor eseményt. Ha null, a szolgáltatás létrehoz egy egyedi eventId azonosítót. A rendszer az eventId azonosítót használja a kérés jutalomhoz való társításához, valamint a pszeudo-véletlenszerű generátor beírásához a Personalizer-hívás során.
excludedActions		string[]	A rangsorolásból kizárandó műveletazonosítók halmaza.

Válaszok

Name	Típus	Description
201 Created	RankResponse	Siker
Other Status Codes	ErrorResponse	Érvénytelen rangsorolási kérelem.

Biztonság

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Példák

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"
}

Definíciók

Name	Description
ErrorCode	Magas szintű hibakód.
ErrorResponse	Hiba visszaadására szolgál az ügyfélnek
InternalError	Olyan objektum, amely a szülőobjektumnál pontosabb információt tartalmaz a hibáról.
PersonalizerError	A hibaobjektum.
RankableAction	A rangsoroláshoz használt társított funkciókkal rendelkező művelet.
RankedAction	Egy rangsorolt művelet az eredményként kapott valószínűségével.
RankRequest	A Personalizer szolgáltatás által rangsorolt műveletek halmazának kérése.
RankResponse	Egy rangsorolási kérelemből eredő műveletek rendezett listája.

ErrorCode

Magas szintű hibakód.

Name	Típus	Description
BadRequest	string	A kiszolgáló nem tudta értelmezni a kérést.
InternalServerError	string	Általános hiba történt a kiszolgálón.
ResourceNotFound	string	A kért erőforrás nem létezik a kiszolgálón.

ErrorResponse

Hiba visszaadására szolgál az ügyfélnek

Name	Típus	Description
error	PersonalizerError	A hibaobjektum.

InternalError

Olyan objektum, amely a szülőobjektumnál pontosabb információt tartalmaz a hibáról.

Name	Típus	Description
code	string	Részletes hibakód.
innererror	InternalError	A hibaobjektum.

PersonalizerError

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	Magas szintű hibakód.
details	PersonalizerError[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innerError	InternalError	Finomabb hiba részletei.
message	string	A szolgáltatás által jelentett hibát magyarázó üzenet.
target	string	Hibaforráselem.

RankableAction

A rangsoroláshoz használt társított funkciókkal rendelkező művelet.

Name	Típus	Description
features	object[]	A funkciókat tartalmazó szótárak listája.
id	string	A művelet azonosítója.

RankedAction

Egy rangsorolt művelet az eredményként kapott valószínűségével.

Name	Típus	Description
id	string	A művelet azonosítója
probability	number	A művelet valószínűsége

RankRequest

A Personalizer szolgáltatás által rangsorolt műveletek halmazának kérése.

Name	Típus	Alapértelmezett érték	Description
actions	RankableAction[]		Az a műveletkészlet, amelyből a Personalizer szolgáltatás választhat. A készlet legfeljebb 50 műveletet tartalmazhat. A műveletek sorrendje nincs hatással a rangsor eredményére, de a sorrendnek meg kell egyeznie az alkalmazás által a megjelenítéshez használt sorrenddel.
contextFeatures	object[]		A Personalizer szótárként használt környezet funkciói. Ez az alkalmazástól függ, és általában magában foglalja az aktuális felhasználó, az eszköz, a profiladatok, az idő és a dátum adatait stb.
deferActivation	boolean	False	Hamis küldése, ha a felhasználó látni fogja a rangsoreredményeket, ezért a Personalizer reward hívást vár, ellenkező esetben hozzárendeli az alapértelmezett Reward-et az eseményhez. Igaz küldése, ha lehetséges, hogy a felhasználó nem látja a rangsoreredményeket, mert az oldal később jelenik meg, vagy a rangsoreredményeket felül lehet bírálni a kód további alsóbb rétegében.
eventId	string		Opcionálisan megadhat egy eventId azonosítót, amely egyedileg azonosítja ezt a Rangsor eseményt. Ha null, a szolgáltatás létrehoz egy egyedi eventId azonosítót. A rendszer az eventId azonosítót használja a kérés jutalomhoz való társításához, valamint a pszeudo-véletlenszerű generátor beírásához a Personalizer-hívás során.
excludedActions	string[]		A rangsorolásból kizárandó műveletazonosítók halmaza.

RankResponse

Egy rangsorolási kérelemből eredő műveletek rendezett listája.

Name	Típus	Description
eventId	string	A kéréstől a válaszig tartó oda-vissza út eventId azonosítója.
ranking	RankedAction[]	Az aktuális kérelem számított rangsora.
rewardActionId	string	A Personalizer szolgáltatás által kiválasztott művelet. Ez az a művelet, amelynek a jutalmát jelentenie kell. Előfordulhat, hogy nem ez az első találat a "rangsorolásban", ha a kérelem első pozíciójában lévő művelet a kizárt azonosítók részét képezte.