Prediction - Get Slot Prediction

Référence

Service:: Cognitive Services - LUIS

API Version:: 3.0

Obtient les prédictions pour un emplacement d’application.

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
appId	path	True	string uuid	L’ID de l'application.
Endpoint	path	True	string	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com).
slotName	path	True	string	Nom de l’emplacement de l’application.
log	query		boolean	Indique s’il faut enregistrer ou non la requête de point de terminaison.
show-all-intents	query		boolean	Indique s’il faut retourner toutes les intentions dans la réponse ou uniquement l’intention supérieure.
verbose	query		boolean	Indique s’il faut ou non obtenir des métadonnées supplémentaires pour les prédictions d’entités.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Corps de la demande

Nom	Obligatoire	Type	Description
query	True	string	Requête à prédire.
dynamicLists		DynamicList[]	Entités de liste créées dynamiquement pour cette demande.
externalEntities		ExternalEntity[]	Entités prédites en externe pour cette demande.
options		PredictionRequestOptions	Options personnalisées définies pour cette demande.

Réponses

Nom	Type	Description
200 OK	PredictionResponse	Prédiction de la requête fournie.
Other Status Codes	Error	Erreur inattendue.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

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

Définitions

Nom	Description
DynamicList	Définit une extension pour une entité de liste.
Error	Représente l’erreur qui s’est produite.
ErrorBody	Représente la définition de l’erreur qui s’est produite.
ExternalEntity	Définit une entité prédite par l’utilisateur qui étend une entité déjà existante.
Intent	Représente une prédiction d’intention.
Prediction	Représente la prédiction d’une requête.
PredictionRequest	Représente les paramètres de demande de prédiction.
PredictionRequestOptions	Options personnalisées pour la demande de prédiction.
PredictionResponse	Représente la réponse de prédiction.
RequestList	Définit une sous-liste à ajouter à une entité de liste existante.
Sentiment	Résultat de l’analyse des sentiments.

DynamicList

Définit une extension pour une entité de liste.

Nom	Type	Description
listEntityName	string	Nom de l’entité de liste à étendre.
requestLists	RequestList[]	Listes à ajouter sur l’entité de liste étendue.

Error

Représente l’erreur qui s’est produite.

Nom	Type	Description
error	ErrorBody	Représente la définition de l’erreur qui s’est produite.

ErrorBody

Représente la définition de l’erreur qui s’est produite.

Nom	Type	Description
code	string	Code d'erreur.
message	string	Message d’erreur.

ExternalEntity

Définit une entité prédite par l’utilisateur qui étend une entité déjà existante.

Nom	Type	Description
entityLength	integer	Longueur de l’entité prédite.
entityName	string	Nom de l’entité à étendre.
resolution		Un utilisateur a fourni une résolution personnalisée à retourner comme prédiction de l’entité.
score	number	Un utilisateur a fourni un score à retourner comme score de prédiction de l’entité.
startIndex	integer	Index de caractères de début de l’entité prédite.

Intent

Représente une prédiction d’intention.

Nom	Type	Description
childApp	Prediction	Prédiction de l’application distribuée.
score	number	Score de l’intention déclenchée.

Prediction

Représente la prédiction d’une requête.

Nom	Type	Description
alteredQuery	string	Requête après vérification orthographique. Défini uniquement si la case activée orthographique a été activée et qu’une faute d’orthographe a été détectée.
entities		Dictionnaire représentant les entités qui se sont déclenchées.
intents	<string, Intent>	Dictionnaire représentant les intentions déclenchées.
sentiment	Sentiment	Résultat de l’analyse des sentiments.
topIntent	string	Nom de l’intention de scoring la plus haute.

PredictionRequest

Représente les paramètres de demande de prédiction.

Nom	Type	Description
dynamicLists	DynamicList[]	Entités de liste créées dynamiquement pour cette demande.
externalEntities	ExternalEntity[]	Entités prédites en externe pour cette demande.
options	PredictionRequestOptions	Options personnalisées définies pour cette demande.
query	string	Requête à prédire.

PredictionRequestOptions

Options personnalisées pour la demande de prédiction.

Nom	Type	Description
datetimeReference	string	Référence DateTime utilisée pour prédire les entités datetime.
preferExternalEntities	boolean	Indique s’il faut que la résolution des entités externes remplace les prédictions en cas de chevauchement.

PredictionResponse

Représente la réponse de prédiction.

Nom	Type	Description
prediction	Prediction	Prédiction de la requête demandée.
query	string	Requête utilisée dans la prédiction.

RequestList

Définit une sous-liste à ajouter à une entité de liste existante.

Nom	Type	Description
canonicalForm	string	Forme canonique de la sous-liste.
name	string	Nom de la sous-liste.
synonyms	string[]	Synonymes de la forme canonique.

Sentiment

Résultat de l’analyse des sentiments.

Nom	Type	Description
label	string	Étiquette du résultat de l’analyse des sentiments.
score	number	Score de sentiment de la requête.

Share via