Rank - Rank

Referência

Serviço:: Cognitive Services - Personalizer

Versão da API:: v1.0

Uma solicitação de classificação do Personalizador.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade dos Serviços Cognitivos com suporte.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
actions	True	RankableAction[]	O conjunto de ações que o serviço Personalizador pode escolher. O conjunto não deve conter mais de 50 ações. A ordem das ações não afeta o resultado da classificação, mas a ordem deve corresponder à sequência que seu aplicativo teria usado para exibi-las.
contextFeatures		object[]	Recursos do contexto usado para o Personalizador como um dicionário de dicionários. Isso depende do aplicativo e normalmente inclui recursos sobre o usuário atual, seu dispositivo, informações de perfil, dados sobre hora e data, etc.
deferActivation		boolean	Envie false se o usuário vir os resultados da classificação, portanto, o Personalizador esperará uma chamada de Recompensa, caso contrário, atribuirá a Recompensa padrão ao evento. Envie true se for possível que o usuário não veja os resultados da classificação, porque a página está sendo renderizada posteriormente ou os resultados de Classificação podem ser substituídos pelo código mais downstream.
eventId		string	Opcionalmente, passe uma eventId que identifique exclusivamente esse evento rank. Se for nulo, o serviço gerará uma eventId exclusiva. A eventId será usada para associar essa solicitação à sua recompensa, bem como propagar o gerador pseudo-aleatório ao fazer uma chamada do Personalizador.
excludedActions		string[]	O conjunto de IDs de ação a serem excluídas da classificação.

Respostas

Nome	Tipo	Description
201 Created	RankResponse	Êxito
Other Status Codes	ErrorResponse	Solicitação de classificação inválida.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful Rank request

Solicitação de exemplo

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
}

Resposta de exemplo

Código de status:: 201

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

Definições

Nome	Description
ErrorCode	Código de erro de alto nível.
ErrorResponse	Usado para retornar um erro ao cliente
InternalError	Um objeto que contém informações mais específicas do que o objeto pai sobre o erro.
PersonalizerError	O objeto de erro.
RankableAction	Uma ação com seus recursos associados usados para classificação.
RankedAction	Uma ação classificada com sua probabilidade resultante.
RankRequest	Solicite um conjunto de ações a serem classificadas pelo serviço Personalizador.
RankResponse	Uma lista ordenada resultante de ações resultantes de uma solicitação de classificação.

ErrorCode

Código de erro de alto nível.

Nome	Tipo	Description
BadRequest	string	Não foi possível entender a solicitação pelo servidor.
InternalServerError	string	Erro genérico no servidor.
ResourceNotFound	string	O recurso solicitado não existe no servidor.

ErrorResponse

Usado para retornar um erro ao cliente

Nome	Tipo	Description
error	PersonalizerError	O objeto de erro.

InternalError

Um objeto que contém informações mais específicas do que o objeto pai sobre o erro.

Nome	Tipo	Description
code	string	Código de erro detalhado.
innererror	InternalError	O objeto de erro.

PersonalizerError

O objeto de erro.

Nome	Tipo	Description
code	ErrorCode	Código de erro de alto nível.
details	PersonalizerError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innerError	InternalError	Detalhes mais finos do erro.
message	string	Uma mensagem explicando o erro relatado pelo serviço.
target	string	Elemento de origem do erro.

RankableAction

Uma ação com seus recursos associados usados para classificação.

Nome	Tipo	Description
features	object[]	Lista de dicionários que contêm recursos.
id	string	Id da ação.

RankedAction

Uma ação classificada com sua probabilidade resultante.

Nome	Tipo	Description
id	string	Id da ação
probability	number	Probabilidade da ação

RankRequest

Solicite um conjunto de ações a serem classificadas pelo serviço Personalizador.

Nome	Tipo	Valor padrão	Description
actions	RankableAction[]		O conjunto de ações que o serviço Personalizador pode escolher. O conjunto não deve conter mais de 50 ações. A ordem das ações não afeta o resultado da classificação, mas a ordem deve corresponder à sequência que seu aplicativo teria usado para exibi-las.
contextFeatures	object[]		Recursos do contexto usado para o Personalizador como um dicionário de dicionários. Isso depende do aplicativo e normalmente inclui recursos sobre o usuário atual, seu dispositivo, informações de perfil, dados sobre hora e data, etc.
deferActivation	boolean	False	Envie false se o usuário vir os resultados da classificação, portanto, o Personalizador esperará uma chamada de Recompensa, caso contrário, atribuirá a Recompensa padrão ao evento. Envie true se for possível que o usuário não veja os resultados da classificação, porque a página está sendo renderizada posteriormente ou os resultados de Classificação podem ser substituídos pelo código mais downstream.
eventId	string		Opcionalmente, passe uma eventId que identifique exclusivamente esse evento rank. Se for nulo, o serviço gerará uma eventId exclusiva. A eventId será usada para associar essa solicitação à sua recompensa, bem como propagar o gerador pseudo-aleatório ao fazer uma chamada do Personalizador.
excludedActions	string[]		O conjunto de IDs de ação a serem excluídas da classificação.

RankResponse

Uma lista ordenada resultante de ações resultantes de uma solicitação de classificação.

Nome	Tipo	Description
eventId	string	A eventId para a viagem de ida e volta da solicitação para a resposta.
ranking	RankedAction[]	A classificação calculada para a solicitação atual.
rewardActionId	string	A ação escolhida pelo serviço Personalizador. Esta é a ação para a qual relatar a recompensa. Isso pode não ser o primeiro encontrado em 'ranking' se uma ação na solicitação na primeira posição fez parte das IDs excluídas.

Compartilhar via