Rank - Rank

Referencia

Service:: Cognitive Services - Personalizer

API Version:: v1.0

Una solicitud de clasificación de Personalizer.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
actions	True	RankableAction[]	El conjunto de acciones entre las que puede elegir el servicio Personalizer. El conjunto no debe contener más de 50 acciones. El orden de las acciones no afecta al resultado de clasificación, pero el orden debe coincidir con la secuencia que la aplicación habría usado para mostrarlas.
contextFeatures		object[]	Características del contexto utilizado para Personalizer como diccionario de diccionarios. Esto depende de la aplicación y normalmente incluye características sobre el usuario actual, su dispositivo, información de perfil, datos sobre la hora y la fecha, etc.
deferActivation		boolean	Envíe false si el usuario verá los resultados de clasificación, por lo que Personalizer esperará una llamada Reward; de lo contrario, asignará la recompensa predeterminada al evento. Envíe true si es posible que el usuario no vea los resultados de clasificación, ya que la página se representa más adelante o el código puede invalidar los resultados de rank más abajo.
eventId		string	Opcionalmente, pase un eventId que identifique de forma única este evento Rank. Si es null, el servicio genera un eventId único. El eventId se usará para asociar esta solicitud con su recompensa, así como para inicializar el generador pseudoaleatorio al realizar una llamada a Personalizer.
excludedActions		string[]	Conjunto de identificadores de acción que se excluirán de la clasificación.

Respuestas

Nombre	Tipo	Description
201 Created	RankResponse	Correcto
Other Status Codes	ErrorResponse	Solicitud de clasificación no válida.

Seguridad

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Ejemplos

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

Definiciones

Nombre	Description
ErrorCode	Código de error de alto nivel.
ErrorResponse	Se usa para devolver un error al cliente
InternalError	Objeto que contiene información más específica que el objeto primario sobre el error.
PersonalizerError	Objeto de error.
RankableAction	Una acción con las características asociadas que se usan para la clasificación.
RankedAction	Una acción clasificada con su probabilidad resultante.
RankRequest	Solicite que el servicio Personalizer clasifique un conjunto de acciones.
RankResponse	Lista ordenada resultante de acciones resultantes de una solicitud de clasificación.

ErrorCode

Código de error de alto nivel.

Nombre	Tipo	Description
BadRequest	string	El servidor no pudo entender la solicitud.
InternalServerError	string	Se ha producido un error genérico en el servidor.
ResourceNotFound	string	El recurso solicitado no existe en el servidor.

ErrorResponse

Se usa para devolver un error al cliente

Nombre	Tipo	Description
error	PersonalizerError	Objeto de error.

InternalError

Objeto que contiene información más específica que el objeto primario sobre el error.

Nombre	Tipo	Description
code	string	Código de error detallado.
innererror	InternalError	Objeto de error.

PersonalizerError

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Código de error de alto nivel.
details	PersonalizerError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innerError	InternalError	Detalles del error más fino.
message	string	Mensaje que explica el error notificado por el servicio.
target	string	Elemento de origen de error.

RankableAction

Una acción con las características asociadas que se usan para la clasificación.

Nombre	Tipo	Description
features	object[]	Lista de diccionarios que contienen características.
id	string	Identificador de la acción.

RankedAction

Una acción clasificada con su probabilidad resultante.

Nombre	Tipo	Description
id	string	Identificador de la acción
probability	number	Probabilidad de la acción

RankRequest

Solicite que el servicio Personalizer clasifique un conjunto de acciones.

Nombre	Tipo	Valor predeterminado	Description
actions	RankableAction[]		El conjunto de acciones entre las que puede elegir el servicio Personalizer. El conjunto no debe contener más de 50 acciones. El orden de las acciones no afecta al resultado de clasificación, pero el orden debe coincidir con la secuencia que la aplicación habría usado para mostrarlas.
contextFeatures	object[]		Características del contexto utilizado para Personalizer como diccionario de diccionarios. Esto depende de la aplicación y normalmente incluye características sobre el usuario actual, su dispositivo, información de perfil, datos sobre la hora y la fecha, etc.
deferActivation	boolean	False	Envíe false si el usuario verá los resultados de clasificación, por lo que Personalizer esperará una llamada Reward; de lo contrario, asignará la recompensa predeterminada al evento. Envíe true si es posible que el usuario no vea los resultados de clasificación, ya que la página se representa más adelante o el código puede invalidar los resultados de rank más abajo.
eventId	string		Opcionalmente, pase un eventId que identifique de forma única este evento Rank. Si es null, el servicio genera un eventId único. El eventId se usará para asociar esta solicitud con su recompensa, así como para inicializar el generador pseudoaleatorio al realizar una llamada a Personalizer.
excludedActions	string[]		Conjunto de identificadores de acción que se excluirán de la clasificación.

RankResponse

Lista ordenada resultante de acciones resultantes de una solicitud de clasificación.

Nombre	Tipo	Description
eventId	string	EventId del recorrido de ida y vuelta de la solicitud a la respuesta.
ranking	RankedAction[]	Clasificación calculada para la solicitud actual.
rewardActionId	string	Acción elegida por el servicio Personalizer. Esta es la acción para la que notificar la recompensa. Es posible que no sea la primera que se encuentra en "ranking" si una acción de la solicitud en primera posición formaba parte de los identificadores excluidos.