Apps - Import V2 App

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 3.0-preview

Importuje aplikację do usługi LUIS, struktura aplikacji jest uwzględniona w treści żądania.

POST {Endpoint}/luis/authoring/v3.0-preview/apps/import

Z parametrami opcjonalnymi:

POST {Endpoint}/luis/authoring/v3.0-preview/apps/import?JsonVersion=V2&appName={appName}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
appName	query		string	Nazwa aplikacji do utworzenia. Jeśli nie zostanie określona, nazwa aplikacji będzie odczytywana z zaimportowanego obiektu. Jeśli nazwa aplikacji już istnieje, zwracany jest błąd.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Treść żądania

Nazwa	Typ	Opis
closedLists	ClosedList[]	Lista jednostek listy.
composites	HierarchicalModelV2[]	Lista jednostek złożonych.
culture	string	Kultura aplikacji. Na przykład: en-us.
desc	string	Opis aplikacji.
entities	HierarchicalModelV2[]	Lista jednostek.
intents	HierarchicalModelV2[]	Lista intencji.
luis_schema_version	string	Wersja deserializacji schematu usługi Luis.
model_features	JSONModelFeature[]	Lista funkcji modelu.
name	string	Nazwa aplikacji.
patternAnyEntities	PatternAny[]	Lista jednostek Pattern.Any.
patterns	PatternRule[]	Lista wzorców.
prebuiltEntities	PrebuiltEntity[]	Lista wstępnie utworzonych jednostek.
regex_entities	RegexEntity[]	Lista jednostek wyrażeń regularnych.
regex_features	JSONRegexFeature[]	Lista funkcji wzorca.
utterances	JSONUtterance[]	Lista przykładowych wypowiedzi.
versionId	string	Identyfikator wersji wyeksportowanej aplikacji.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	string	Identyfikator zaimportowanej aplikacji.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Successful Import Application

Przykładowe żądanie

HTTP

POST {Endpoint}/luis/authoring/v3.0-preview/apps/import?JsonVersion=V2&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": []
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:: 201

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

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

Definicje

Nazwa	Opis
ClosedList	Wyeksportowany model — jednostka listy.
ErrorResponse	Odpowiedź na błąd podczas wywoływania operacji w interfejsie API.
HierarchicalModelV2
JSONEntity	Wyeksportowany model — wyodrębniona jednostka z wypowiedzi.
JSONModelFeature	Wyeksportowany model — funkcja modelu listy fraz.
JSONRegexFeature	Wyeksportowany model — funkcja wzorca.
JSONUtterance	Wyeksportowany model — wypowiedź użyta do wytrenowania modelu.
LuisAppV2	Wyeksportowany model — wyeksportowana aplikacja usługi LUIS.
PatternAny	Pattern.Any Entity Extractor.
PatternRule	Wzorzec
PrebuiltDomainObject
PrebuiltEntity	Wstępnie utworzony moduł wyodrębniania jednostek.
RegexEntity	Ekstraktor jednostek wyrażeń regularnych.
SubClosedList	Lista podrzędna elementów jednostki listy.

ClosedList

Objekt

Wyeksportowany model — jednostka listy.

Nazwa	Typ	Opis
name	string	Nazwa jednostki listy.
roles	string[]
subLists	SubClosedList[]	Listy podrzędne jednostki listy.

ErrorResponse

Objekt

Odpowiedź na błąd podczas wywoływania operacji w interfejsie API.

Nazwa	Typ	Opis
errorType	string

HierarchicalModelV2

Objekt

Nazwa	Typ	Opis
children	string[]
inherits	PrebuiltDomainObject
name	string
roles	string[]

JSONEntity

Objekt

Wyeksportowany model — wyodrębniona jednostka z wypowiedzi.

Nazwa	Typ	Opis
children	JSONEntity[]	Wyeksportowany model — wyodrębniona jednostka z wypowiedzi.
endPos	integer	Indeks w wypowiedzi, w której kończy się wyodrębniona jednostka.
entity	string	Nazwa jednostki.
role	string	Rola, jaką jednostka odgrywa w wypowiedzi.
startPos	integer	Indeks w wypowiedzi, w której rozpoczyna się wyodrębniona jednostka.

JSONModelFeature

Objekt

Wyeksportowany model — funkcja modelu listy fraz.

Nazwa	Typ	Domyślna wartość	Opis
activated	boolean		Wskazuje, czy funkcja jest włączona.
enabledForAllModels	boolean	True	Wskazuje, czy lista fraz jest włączona dla wszystkich modeli w aplikacji.
mode	boolean		Funkcja listy fraz zamiennych służy jako lista synonimów szkoleniowych. Lista fraz, które nie można wymieniać, służy jako oddzielne funkcje do trenowania. Dlatego jeśli lista fraz niezamiennych zawiera 5 fraz, zostaną one zamapowane na 5 oddzielnych funkcji. Możesz traktować listę fraz niezamiennych jako dodatkową torbę słów do dodania do istniejących funkcji słownictwa usługi LUIS. Jest on używany jako funkcja odnośnika leksykonu, gdzie jego wartość wynosi 1, jeśli leksykon zawiera dany wyraz lub 0, jeśli nie. Wartość domyślna to true.
name	string		Nazwa listy fraz.
words	string		Lista fraz rozdzielonych przecinkami reprezentujących listę fraz.

JSONRegexFeature

Objekt

Wyeksportowany model — funkcja wzorca.

Nazwa	Typ	Opis
activated	boolean	Wskazuje, czy funkcja pattern jest włączona.
name	string	Nazwa funkcji.
pattern	string	Wyrażenie regularne do dopasowania.

JSONUtterance

Objekt

Wyeksportowany model — wypowiedź użyta do wytrenowania modelu.

Nazwa	Typ	Opis
entities	JSONEntity[]	Dopasowane jednostki.
intent	string	Dopasowana intencja.
text	string	Wypowiedź.

LuisAppV2

Objekt

Wyeksportowany model — wyeksportowana aplikacja usługi LUIS.

Nazwa	Typ	Opis
closedLists	ClosedList[]	Lista jednostek listy.
composites	HierarchicalModelV2[]	Lista jednostek złożonych.
culture	string	Kultura aplikacji. Na przykład: en-us.
desc	string	Opis aplikacji.
entities	HierarchicalModelV2[]	Lista jednostek.
intents	HierarchicalModelV2[]	Lista intencji.
luis_schema_version	string	Wersja deserializacji schematu usługi Luis.
model_features	JSONModelFeature[]	Lista funkcji modelu.
name	string	Nazwa aplikacji.
patternAnyEntities	PatternAny[]	Lista jednostek Pattern.Any.
patterns	PatternRule[]	Lista wzorców.
prebuiltEntities	PrebuiltEntity[]	Lista wstępnie utworzonych jednostek.
regex_entities	RegexEntity[]	Lista jednostek wyrażeń regularnych.
regex_features	JSONRegexFeature[]	Lista funkcji wzorca.
utterances	JSONUtterance[]	Lista przykładowych wypowiedzi.
versionId	string	Identyfikator wersji wyeksportowanej aplikacji.

PatternAny

Objekt

Pattern.Any Entity Extractor.

Nazwa	Typ	Opis
explicitList	string[]
name	string
roles	string[]

PatternRule

Objekt

Wzorzec

Nazwa	Typ	Opis
intent	string	Nazwa intencji, do której należy wzorzec.
pattern	string	Tekst wzorca.

PrebuiltDomainObject

Objekt

Nazwa	Typ	Opis
domain_name	string
model_name	string

PrebuiltEntity

Objekt

Wstępnie utworzony moduł wyodrębniania jednostek.

Nazwa	Typ	Opis
name	string
roles	string[]

RegexEntity

Objekt

Ekstraktor jednostek wyrażeń regularnych.

Nazwa	Typ	Opis
name	string
regexPattern	string
roles	string[]

SubClosedList

Objekt

Lista podrzędna elementów jednostki listy.

Nazwa	Typ	Opis
canonicalForm	string	Standardowy formularz reprezentowany przez listę.
list	string[]	Lista wyrazów synonimów.

Udostępnij za pośrednictwem

Apps - Import V2 App

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Przykłady

Successful Import Application

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ClosedList

ErrorResponse

HierarchicalModelV2

JSONEntity

JSONModelFeature

JSONRegexFeature

JSONUtterance

LuisAppV2

PatternAny

PatternRule

PrebuiltDomainObject

PrebuiltEntity

RegexEntity

SubClosedList

Dodatkowe zasoby