Apps - Import

Référence

Service:: Cognitive Services - LUIS

API Version:: 2.0

Importe une application dans LUIS, la structure de l’application est incluse dans le corps de la demande.

POST {Endpoint}/luis/api/v2.0/apps/import

With optional parameters:

POST {Endpoint}/luis/api/v2.0/apps/import?appName={appName}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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).
appName	query		string	Nom de l’application à créer. S’il n’est pas spécifié, le nom de l’application est lu à partir de l’objet importé. Si le nom de l’application existe déjà, une erreur est retournée.

En-tête de la demande

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

Corps de la demande

Nom	Type	Description
closedLists	ClosedList[]	Liste des entités de liste.
composites	HierarchicalModel[]	Liste des entités composites.
culture	string	Culture de l'application. Par exemple : en-us.
desc	string	Description de l’application.
entities	HierarchicalModel[]	Liste des entités.
intents	HierarchicalModel[]	Liste des intentions.
model_features	JSONModelFeature[]	Liste des fonctionnalités du modèle.
name	string	Le nom de l’application.
patternAnyEntities	PatternAny[]	Liste des entités Pattern.Any.
patterns	PatternRule[]	Liste de modèles.
prebuiltEntities	PrebuiltEntity[]	Liste des entités prédéfinies.
regex_entities	RegexEntity[]	Liste des entités d’expression régulière.
regex_features	JSONRegexFeature[]	Liste des fonctionnalités de modèle.
utterances	JSONUtterance[]	Liste d’exemples d’énoncés.
versionId	string	ID de version de l’application qui a été exportée.

Réponses

Nom	Type	Description
201 Created	string	ID de l’application importée.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

Successful Import Application

Sample Request

HTTP

POST {Endpoint}/luis/api/v2.0/apps/import?appName=Test LUIS App


{
  "luis_schema_version": "3.0.0",
  "versionId": "0.1",
  "name": "LuisBot",
  "desc": "",
  "culture": "en-us",
  "intents": [
    {
      "name": "HomeAutomation.TurnOff",
      "inherits": {
        "domain_name": "HomeAutomation",
        "model_name": "TurnOff"
      }
    },
    {
      "name": "dateintent"
    },
    {
      "name": "Help"
    },
    {
      "name": "None"
    },
    {
      "name": "SearchHotels"
    },
    {
      "name": "ShowHotelsReviews"
    }
  ],
  "entities": [
    {
      "name": "AirportCode",
      "roles": [
        "destination"
      ]
    },
    {
      "name": "Hotel",
      "roles": []
    }
  ],
  "composites": [],
  "closedLists": [],
  "patternAnyEntities": [
    {
      "name": "patternAny1",
      "explicitList": [],
      "roles": [
        "role1",
        "role2"
      ]
    }
  ],
  "regex_entities": [
    {
      "name": "regex1",
      "regexPattern": "[^a]+",
      "roles": [
        "regex role"
      ]
    }
  ],
  "prebuiltEntities": [
    {
      "name": "datetimeV2",
      "roles": [
        "datetime role"
      ]
    }
  ],
  "model_features": [
    {
      "name": "Near",
      "mode": true,
      "words": "near,around,close,nearby",
      "activated": true
    },
    {
      "name": "Show",
      "mode": true,
      "words": "show,find,look,search",
      "activated": true
    }
  ],
  "regex_features": [
    {
      "name": "AirportCodeRegex",
      "pattern": "[a-z]{3}",
      "activated": true
    }
  ],
  "patterns": [
    {
      "pattern": "this is [a test] {patternAny1:role1}",
      "intent": "Help"
    }
  ],
  "utterances": [
    {
      "text": "i need help",
      "intent": "Help",
      "entities": []
    },
    {
      "text": "help me",
      "intent": "Help",
      "entities": []
    },
    {
      "text": "tomorrow",
      "intent": "dateintent",
      "entities": []
    },
    {
      "text": "search for hotels in seattle",
      "intent": "SearchHotels",
      "entities": []
    },
    {
      "text": "what can i do?",
      "intent": "Help",
      "entities": []
    },
    {
      "text": "next monday",
      "intent": "dateintent",
      "entities": []
    },
    {
      "text": "next year",
      "intent": "dateintent",
      "entities": []
    },
    {
      "text": "look for hotels in miami",
      "intent": "SearchHotels",
      "entities": []
    },
    {
      "text": "show me hotels in california",
      "intent": "SearchHotels",
      "entities": []
    },
    {
      "text": "show me the reviews of the amazing bot resort",
      "intent": "ShowHotelsReviews",
      "entities": [
        {
          "entity": "Hotel",
          "startPos": 23,
          "endPos": 44
        }
      ]
    },
    {
      "text": "can i see the reviews of extended bot hotel?",
      "intent": "ShowHotelsReviews",
      "entities": [
        {
          "entity": "Hotel",
          "startPos": 25,
          "endPos": 42
        }
      ]
    },
    {
      "text": "find reviews of hotelxya",
      "intent": "ShowHotelsReviews",
      "entities": [
        {
          "entity": "Hotel",
          "startPos": 16,
          "endPos": 23
        }
      ]
    },
    {
      "text": "show me reviews of the amazing hotel",
      "intent": "ShowHotelsReviews",
      "entities": [
        {
          "entity": "Hotel",
          "startPos": 19,
          "endPos": 35
        }
      ]
    },
    {
      "text": "what are the available options?",
      "intent": "Help",
      "entities": []
    },
    {
      "text": "best hotels in seattle",
      "intent": "SearchHotels",
      "entities": []
    },
    {
      "text": "hotels in los angeles",
      "intent": "SearchHotels",
      "entities": []
    },
    {
      "text": "can you show me hotels from los angeles?",
      "intent": "SearchHotels",
      "entities": []
    },
    {
      "text": "can you show me the reviews of the amazing resort & hotel",
      "intent": "ShowHotelsReviews",
      "entities": [
        {
          "entity": "Hotel",
          "startPos": 31,
          "endPos": 56
        }
      ]
    },
    {
      "text": "what are the reviews of the hotel bot framework?",
      "intent": "ShowHotelsReviews",
      "entities": [
        {
          "entity": "Hotel",
          "startPos": 24,
          "endPos": 46
        }
      ]
    },
    {
      "text": "find hotels near eze",
      "intent": "SearchHotels",
      "entities": [
        {
          "entity": "AirportCode",
          "startPos": 17,
          "endPos": 19
        }
      ]
    },
    {
      "text": "where can i stay near nnn?",
      "intent": "SearchHotels",
      "entities": [
        {
          "entity": "AirportCode",
          "startPos": 22,
          "endPos": 24
        }
      ]
    },
    {
      "text": "show hotels near att airport",
      "intent": "SearchHotels",
      "entities": [
        {
          "entity": "AirportCode",
          "startPos": 17,
          "endPos": 19
        }
      ]
    },
    {
      "text": "find hotels near agl",
      "intent": "SearchHotels",
      "entities": [
        {
          "entity": "AirportCode",
          "startPos": 17,
          "endPos": 19
        }
      ]
    },
    {
      "text": "find hotels around eze airport",
      "intent": "SearchHotels",
      "entities": [
        {
          "entity": "AirportCode",
          "startPos": 19,
          "endPos": 21
        }
      ]
    },
    {
      "text": "01/7",
      "intent": "dateintent",
      "entities": []
    }
  ]
}

Sample Response

Status code:: 201

Location: https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/374fac89-ae12-4afd-8c21-8a6424ce1c1f

Response Body

"374fac89-ae12-4afd-8c21-8a6424ce1c1f"

Définitions

Nom	Description
ClosedList	Modèle exporté : entité de liste.
ErrorResponse	Réponse d’erreur lors de l’appel d’une opération sur l’API.
HierarchicalModel
JSONEntity	Modèle exporté - Entité extraite de l’énoncé.
JSONModelFeature	Modèle exporté - Fonctionnalité de modèle de liste d’expressions.
JSONRegexFeature	Modèle exporté : fonctionnalité de modèle.
JSONUtterance	Modèle exporté : énoncé utilisé pour effectuer l’apprentissage du modèle.
LuisApp	Modèle exporté : application LUIS exportée.
PatternAny	Pattern.Any Entity Extractor.
PatternRule	Modèle
PrebuiltDomainObject
PrebuiltEntity	Extracteur d’entité prédéfini.
RegexEntity	Extracteur d’entité d’expression régulière.
SubClosedList	Sous-liste d’éléments pour une entité de liste.

ClosedList

Modèle exporté : entité de liste.

Nom	Type	Description
name	string	Nom de l’entité de liste.
roles	string[]
subLists	SubClosedList[]	Sous-listes pour l’entité de liste.

ErrorResponse

Réponse d’erreur lors de l’appel d’une opération sur l’API.

Nom	Type	Description
errorType	string

HierarchicalModel

Nom	Type	Description
children	string[]
inherits	PrebuiltDomainObject
name	string
roles	string[]

JSONEntity

Modèle exporté - Entité extraite de l’énoncé.

Nom	Type	Description
endPos	integer	Index dans l’énoncé où se termine l’entité extraite.
entity	string	Nom de l’entité.
role	string	Rôle de l’entité dans l’énoncé.
startPos	integer	Index dans l’énoncé où l’entité extraite démarre.

JSONModelFeature

Modèle exporté - Fonctionnalité de modèle de liste d’expressions.

Nom	Type	Description
activated	boolean	Indique si la fonctionnalité est activée.
mode	boolean	Une fonctionnalité de liste d’expressions interchangeables sert de liste de synonymes pour l’entraînement. Une liste d’expressions non échangeables sert de fonctionnalités distinctes pour l’entraînement. Par conséquent, si votre liste d’expressions non interchangeables contient 5 expressions, elles seront mappées à 5 fonctionnalités distinctes. Vous pouvez considérer la liste d’expressions non interchangeables comme un sac de mots supplémentaire à ajouter aux fonctionnalités de vocabulaire existantes de LUIS. Il est utilisé comme fonctionnalité de recherche de lexique où sa valeur est 1 si le lexique contient un mot donné ou 0 s’il ne le fait pas. La valeur par défaut est true.
name	string	Nom de la liste d’expressions.
words	string	Liste d’expressions séparées par des virgules qui représentent la liste d’expressions.

JSONRegexFeature

Modèle exporté : fonctionnalité de modèle.

Nom	Type	Description
activated	boolean	Indique si la fonctionnalité Modèle est activée.
name	string	Nom de la fonctionnalité.
pattern	string	Expression régulière à mettre en correspondance.

JSONUtterance

Modèle exporté : énoncé utilisé pour effectuer l’apprentissage du modèle.

Nom	Type	Description
entities	JSONEntity[]	Entités correspondantes.
intent	string	Intention correspondante.
text	string	Énoncé.

LuisApp

Modèle exporté : application LUIS exportée.

Nom	Type	Description
closedLists	ClosedList[]	Liste des entités de liste.
composites	HierarchicalModel[]	Liste des entités composites.
culture	string	Culture de l'application. Par exemple : en-us.
desc	string	Description de l’application.
entities	HierarchicalModel[]	Liste des entités.
intents	HierarchicalModel[]	Liste des intentions.
model_features	JSONModelFeature[]	Liste des fonctionnalités du modèle.
name	string	Le nom de l’application.
patternAnyEntities	PatternAny[]	Liste des entités Pattern.Any.
patterns	PatternRule[]	Liste de modèles.
prebuiltEntities	PrebuiltEntity[]	Liste des entités prédéfinies.
regex_entities	RegexEntity[]	Liste des entités d’expression régulière.
regex_features	JSONRegexFeature[]	Liste des fonctionnalités de modèle.
utterances	JSONUtterance[]	Liste d’exemples d’énoncés.
versionId	string	ID de version de l’application qui a été exportée.

PatternAny

Pattern.Any Entity Extractor.

Nom	Type	Description
explicitList	string[]
name	string
roles	string[]

PatternRule

Modèle

Nom	Type	Description
intent	string	Nom de l’intention à laquelle le modèle appartient.
pattern	string	Texte du modèle.

PrebuiltDomainObject

Nom	Type	Description
domain_name	string
model_name	string

PrebuiltEntity

Extracteur d’entité prédéfini.

Nom	Type	Description
name	string
roles	string[]

RegexEntity

Extracteur d’entité d’expression régulière.

Nom	Type	Description
name	string
regexPattern	string
roles	string[]

SubClosedList

Sous-liste d’éléments pour une entité de liste.

Nom	Type	Description
canonicalForm	string	Formulaire standard que représente la liste.
list	string[]	Liste des mots synonymes.

Partager via