Prediction - Get Slot Prediction

Referencia

Service:: Cognitive Services - LUIS

API Version:: 3.0

Obtiene las predicciones de una ranura de aplicación.

POST {Endpoint}/luis/prediction/v3.0/apps/{appId}/slots/{slotName}/predict

With optional parameters:

POST {Endpoint}/luis/prediction/v3.0/apps/{appId}/slots/{slotName}/predict?verbose={verbose}&show-all-intents={show-all-intents}&log={log}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
appId	path	True	string uuid	El id. de aplicación.
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus.api.cognitive.microsoft.com).
slotName	path	True	string	Nombre de la ranura de aplicación.
log	query		boolean	Indica si se va a registrar la consulta del punto de conexión o no.
show-all-intents	query		boolean	Indica si se van a devolver todas las intenciones de la respuesta o solo la intención superior.
verbose	query		boolean	Indica si se van a obtener metadatos adicionales para las predicciones de entidades o no.

Encabezado de la solicitud

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

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
query	True	string	Consulta que se va a predecir.
dynamicLists		DynamicList[]	Las entidades de lista creadas dinámicamente para esta solicitud.
externalEntities		ExternalEntity[]	Las entidades predichas externamente para esta solicitud.
options		PredictionRequestOptions	Las opciones personalizadas definidas para esta solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	PredictionResponse	Predicción de la consulta proporcionada.
Other Status Codes	Error	error inesperado.

Seguridad

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Ejemplos

Successful Get Slot Predictions From Endpoint Via Post request

Sample Request

HTTP

POST {Endpoint}/luis/prediction/v3.0/apps/{Application Id}/slots/{Slot Name}/predict


{
  "query": "forward to frank 30 dollars through HSBC",
  "options": {
    "datetimeReference": "2015-02-13T13:15:00.000Z"
  },
  "externalEntities": [
    {
      "entityName": "Bank",
      "startIndex": 36,
      "entityLength": 4,
      "resolution": {
        "text": "International Bank"
      }
    }
  ],
  "dynamicLists": [
    {
      "listEntityName": "Employees",
      "requestLists": [
        {
          "name": "Management",
          "canonicalForm": "Frank",
          "synonyms": []
        }
      ]
    }
  ]
}

Sample Response

Status code:: 200

{
  "query": "forward to frank 30 dollars through HSBC",
  "prediction": {
    "topIntent": "give",
    "intents": {
      "give": {
        "score": 0.943442
      }
    },
    "entities": {
      "Employees": [
        [
          "frank"
        ]
      ],
      "number": [
        30
      ],
      "money": [
        {
          "units": "Dollar",
          "value": 30
        }
      ],
      "Bank": [
        {
          "text": "International Bank"
        }
      ]
    },
    "sentiment": {
      "label": "positive",
      "score": 0.9163064
    }
  }
}

Definiciones

Nombre	Description
DynamicList	Define una extensión para una entidad de lista.
Error	Representa el error que se produjo.
ErrorBody	Representa la definición del error que se produjo.
ExternalEntity	Define una entidad predicha por el usuario que extiende una ya existente.
Intent	Representa una predicción de intención.
Prediction	Representa la predicción de una consulta.
PredictionRequest	Representa los parámetros de solicitud de predicción.
PredictionRequestOptions	Las opciones personalizadas para la solicitud de predicción.
PredictionResponse	Representa la respuesta de predicción.
RequestList	Define una sub lista para anexar a una entidad de lista existente.
Sentiment	Resultado del análisis de opiniones.

DynamicList

Define una extensión para una entidad de lista.

Nombre	Tipo	Description
listEntityName	string	Nombre de la entidad de lista que se va a extender.
requestLists	RequestList[]	Las listas que se van a anexar en la entidad de lista extendida.

Error

Representa el error que se produjo.

Nombre	Tipo	Description
error	ErrorBody	Representa la definición del error que se produjo.

ErrorBody

Representa la definición del error que se produjo.

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.

ExternalEntity

Define una entidad predicha por el usuario que extiende una ya existente.

Nombre	Tipo	Description
entityLength	integer	Longitud de la entidad predicha.
entityName	string	Nombre de la entidad que se va a extender.
resolution		Un usuario proporcionó una resolución personalizada para devolverla como predicción de la entidad.
score	number	Una puntuación proporcionada por el usuario para devolverla como puntuación de predicción de la entidad.
startIndex	integer	Índice de caracteres inicial de la entidad predicha.

Intent

Representa una predicción de intención.

Nombre	Tipo	Description
childApp	Prediction	Predicción de la aplicación enviada.
score	number	Puntuación de la intención desencadenada.

Prediction

Representa la predicción de una consulta.

Nombre	Tipo	Description
alteredQuery	string	Consulta después de la revisión ortográfica. Solo se establece si se habilitó la revisión ortográfica y se encontró un error ortográfico.
entities		Diccionario que representa las entidades que se desencadenaron.
intents	<string, Intent>	Diccionario que representa las intenciones que se desencadenaron.
sentiment	Sentiment	Resultado del análisis de opiniones.
topIntent	string	Nombre de la intención de puntuación superior.

PredictionRequest

Representa los parámetros de solicitud de predicción.

Nombre	Tipo	Description
dynamicLists	DynamicList[]	Las entidades de lista creadas dinámicamente para esta solicitud.
externalEntities	ExternalEntity[]	Las entidades predichas externamente para esta solicitud.
options	PredictionRequestOptions	Las opciones personalizadas definidas para esta solicitud.
query	string	Consulta que se va a predecir.

PredictionRequestOptions

Las opciones personalizadas para la solicitud de predicción.

Nombre	Tipo	Description
datetimeReference	string	La referencia DateTime usada para predecir entidades datetime.
preferExternalEntities	boolean	Si se va a hacer que la resolución de entidades externas invalide las predicciones si se produce una superposición.

PredictionResponse

Representa la respuesta de predicción.

Nombre	Tipo	Description
prediction	Prediction	Predicción de la consulta solicitada.
query	string	Consulta usada en la predicción.

RequestList

Define una sub lista para anexar a una entidad de lista existente.

Nombre	Tipo	Description
canonicalForm	string	Forma canónica de la sub lista.
name	string	Nombre de la sublista.
synonyms	string[]	Sinónimos de la forma canónica.

Sentiment

Resultado del análisis de opiniones.

Nombre	Tipo	Description
label	string	Etiqueta del resultado del análisis de sentimiento.
score	number	Puntuación de opinión de la consulta.