Aracılığıyla paylaş

Rank - Rank

  • Başvuru
Hizmet:
Azure AI Services
API Sürümü:
v1.0

Kişiselleştirme derecelendirme isteği.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
Endpoint
 path True

string

Desteklenen Bilişsel Hizmetler uç noktası.

İstek Başlığı

Name Gerekli Tür Description
Ocp-Apim-Subscription-Key True

string

İstek Gövdesi

Name Gerekli Tür Description
actions True

RankableAction[]

Kişiselleştirme hizmetinin seçebileceği eylemler kümesi. Küme 50'den fazla eylem içermemelidir. Eylemlerin sırası sıralama sonucunu etkilemez, ancak sıra uygulamanızın bunları görüntülemek için kullanacağı sırayla eşleşmelidir.
contextFeatures

object[]

Sözlük sözlüğü olarak Kişiselleştirme için kullanılan bağlamın özellikleri. Bu, uygulamaya bağlıdır ve genellikle geçerli kullanıcı, cihazı, profil bilgileri, saat ve tarih hakkındaki veriler gibi özellikler içerir.
deferActivation

boolean

Kullanıcı derecelendirme sonuçlarını görürse false gönderin, bu nedenle Kişiselleştirici bir Reward çağrısı bekler, aksi takdirde etkinliğe varsayılan Ödülü atar. Sayfa daha sonra işlendiğinden veya Sıralama sonuçları daha sonra aşağı akış kodu tarafından geçersiz kılınabileceğinden, mümkünse kullanıcı derecelendirme sonuçlarını görmezse true gönderin.
eventId

string

maxLength: 256

İsteğe bağlı olarak bu Rank olayını benzersiz olarak tanımlayan bir eventId geçirin. Null ise, hizmet benzersiz bir eventId oluşturur. EventId, bu isteği ödülüyle ilişkilendirmek ve kişiselleştirici çağrısı yaparken sahte rastgele oluşturucuyu tohumlama için kullanılır.
excludedActions

string[]

Sıralamanın dışında tutulacak eylem kimlikleri kümesi.

Yanıtlar

Name Tür Description
201 Created

RankResponse

Başarı
Other Status Codes

ErrorResponse

Geçersiz sıralama isteği.

Güvenlik

Ocp-Apim-Subscription-Key

Tür: apiKey
İçinde: header

Örnekler

Successful Rank request

Örnek isteği

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
}

Örnek yanıt

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

Tanımlar

Name Description
ErrorCode

Üst düzey hata kodu.
ErrorResponse

İstemciye hata döndürmek için kullanılır
InternalError

Hatayla ilgili üst nesneden daha belirli bilgiler içeren bir nesne.
PersonalizerError

Hata nesnesi.
RankableAction

Derecelendirme için kullanılan ilişkili özelliklere sahip bir eylem.
RankedAction

Elde edilen olasılığı olan dereceli bir eylem.
RankRequest

Kişiselleştirme hizmeti tarafından derecelendirilecek bir dizi eylem isteyin.
RankResponse

Sıralama isteğinden kaynaklanan eylemlerin sıralı listesi.

ErrorCode

Listeleme

Üst düzey hata kodu.

Değer Description
BadRequest

İstek sunucu tarafından anlaşılamadı.
InternalServerError

Sunucuda genel bir hata oluştu.
ResourceNotFound

İstenen kaynak sunucuda yok.

ErrorResponse

Object

İstemciye hata döndürmek için kullanılır

Name Tür Description
error

PersonalizerError

Hata nesnesi.

InternalError

Object

Hatayla ilgili üst nesneden daha belirli bilgiler içeren bir nesne.

Name Tür Description
code

string

Ayrıntılı hata kodu.
innererror

InternalError

Hata nesnesi.

PersonalizerError

Object

Hata nesnesi.

Name Tür Description
code

ErrorCode

Üst düzey hata kodu.
details

PersonalizerError[]

Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
innerError

InternalError

Daha ayrıntılı hata ayrıntıları.
message

string

Hizmet tarafından bildirilen hatayı açıklayan bir ileti.
target

string

Hata kaynağı öğesi.

RankableAction

Object

Derecelendirme için kullanılan ilişkili özelliklere sahip bir eylem.

Name Tür Description
features

object[]

Özellik içeren sözlüklerin listesi.
id

string

maxLength: 256

Eylemin kimliği.

RankedAction

Object

Elde edilen olasılığı olan dereceli bir eylem.

Name Tür Description
id

string

maxLength: 256

Eylemin kimliği
probability

number (float)

minimum: 0
maximum: 1

Eylemin olasılığı

RankRequest

Object

Kişiselleştirme hizmeti tarafından derecelendirilecek bir dizi eylem isteyin.

Name Tür Default value Description
actions

RankableAction[]

Kişiselleştirme hizmetinin seçebileceği eylemler kümesi. Küme 50'den fazla eylem içermemelidir. Eylemlerin sırası sıralama sonucunu etkilemez, ancak sıra uygulamanızın bunları görüntülemek için kullanacağı sırayla eşleşmelidir.
contextFeatures

object[]

Sözlük sözlüğü olarak Kişiselleştirme için kullanılan bağlamın özellikleri. Bu, uygulamaya bağlıdır ve genellikle geçerli kullanıcı, cihazı, profil bilgileri, saat ve tarih hakkındaki veriler gibi özellikler içerir.
deferActivation

boolean

False

Kullanıcı derecelendirme sonuçlarını görürse false gönderin, bu nedenle Kişiselleştirici bir Reward çağrısı bekler, aksi takdirde etkinliğe varsayılan Ödülü atar. Sayfa daha sonra işlendiğinden veya Sıralama sonuçları daha sonra aşağı akış kodu tarafından geçersiz kılınabileceğinden, mümkünse kullanıcı derecelendirme sonuçlarını görmezse true gönderin.
eventId

string

maxLength: 256

İsteğe bağlı olarak bu Rank olayını benzersiz olarak tanımlayan bir eventId geçirin. Null ise, hizmet benzersiz bir eventId oluşturur. EventId, bu isteği ödülüyle ilişkilendirmek ve kişiselleştirici çağrısı yaparken sahte rastgele oluşturucuyu tohumlama için kullanılır.
excludedActions

string[]

Sıralamanın dışında tutulacak eylem kimlikleri kümesi.

RankResponse

Object

Sıralama isteğinden kaynaklanan eylemlerin sıralı listesi.

Name Tür Description
eventId

string

maxLength: 256

İstekten yanıta gidiş dönüş için eventId.
ranking

RankedAction[]

Geçerli isteğin hesaplanan derecelendirmesi.
rewardActionId

string

maxLength: 256

Kişiselleştirme hizmeti tarafından seçilen eylem. Bu, ödülün bildirildiği eylemdir. İlk konumdaki istekteki bir eylem dışlanan kimliklerin bir parçasıysa, bu 'derecelendirme' içinde ilk bulunan olmayabilir.