Versions - Export

Referência

Service:: Cognitive Services - LUIS

API Version:: 2.0

Exporta uma aplicação LUIS para o formato JSON.

GET {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/export

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
appId	path	True	string uuid	O ID da aplicação.
Endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus.api.cognitive.microsoft.com).
versionId	path	True	string	O ID da versão.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respostas

Name	Tipo	Description
200 OK	LuisApp	A estrutura da aplicação LUIS no formato JSON.
Other Status Codes	ErrorResponse	Resposta a Erros.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemplos

Successful Export Application Version

Sample Request

HTTP

GET {Endpoint}/luis/api/v2.0/apps/bd72e8d7-62b8-48f5-9dcb-e3b0588b803a/versions/0.2/export

Sample Response

Status code:: 200

{
  "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": []
    }
  ]
}

Definições

Name	Description
ClosedList	Modelo Exportado – uma entidade de lista.
ErrorResponse	Resposta de erro ao invocar uma operação na API.
HierarchicalModel
JSONEntity	Modelo Exportado – Entidade Extraída da expressão.
JSONModelFeature	Modelo Exportado – Funcionalidade de Modelo de Lista de Expressões.
JSONRegexFeature	Modelo Exportado – uma funcionalidade Padrão.
JSONUtterance	Modelo Exportado – Expressão utilizada para preparar o modelo.
LuisApp	Modelo Exportado - Uma Aplicação LUIS exportada.
PatternAny	Pattern.Any Entity Extractor.
PatternRule	Padrão
PrebuiltDomainObject
PrebuiltEntity	Extrator de Entidade pré-criado.
RegexEntity	Extrator de Entidades de Expressão Regular.
SubClosedList	Sublist de itens para uma entidade de lista.

ClosedList

Modelo Exportado – uma entidade de lista.

Name	Tipo	Description
name	string	Nome da entidade de lista.
roles	string[]
subLists	SubClosedList[]	Sublists para a entidade de lista.

ErrorResponse

Resposta de erro ao invocar uma operação na API.

Name	Tipo	Description
errorType	string

HierarchicalModel

Name	Tipo	Description
children	string[]
inherits	PrebuiltDomainObject
name	string
roles	string[]

JSONEntity

Modelo Exportado – Entidade Extraída da expressão.

Name	Tipo	Description
endPos	integer	O índice na expressão em que a entidade extraída termina.
entity	string	O nome da entidade.
role	string	A função da entidade na expressão.
startPos	integer	O índice na expressão onde a entidade extraída é iniciada.

JSONModelFeature

Modelo Exportado – Funcionalidade de Modelo de Lista de Expressões.

Name	Tipo	Description
activated	boolean	Indica se a funcionalidade está ativada.
mode	boolean	Uma funcionalidade de lista de expressões intercambiáveis serve como uma lista de sinónimos para preparação. Uma lista de expressões não permutáveis serve como funcionalidades separadas para preparação. Assim, se a sua lista de expressões não intercambiáveis contiver 5 expressões, serão mapeadas para 5 funcionalidades separadas. Pode considerar a lista de expressões não intercambiáveis como um saco de palavras adicional para adicionar às funcionalidades de vocabulário existentes do LUIS. É utilizado como uma funcionalidade de pesquisa léxico em que o seu valor é 1 se o léxico contiver uma determinada palavra ou 0 se não o fizer. O valor predefinido é verdadeiro.
name	string	O nome da Lista de Expressões.
words	string	Lista de expressões separadas por vírgulas que representam a Lista de Expressões.

JSONRegexFeature

Modelo Exportado – uma funcionalidade Padrão.

Name	Tipo	Description
activated	boolean	Indica se a funcionalidade Padrão está ativada.
name	string	Nome da funcionalidade.
pattern	string	A Expressão Regular a corresponder.

JSONUtterance

Modelo Exportado – Expressão utilizada para preparar o modelo.

Name	Tipo	Description
entities	JSONEntity[]	As entidades correspondentes.
intent	string	A intenção correspondida.
text	string	A expressão.

LuisApp

Modelo Exportado - Uma Aplicação LUIS exportada.

Name	Tipo	Description
closedLists	ClosedList[]	Lista de entidades de lista.
composites	HierarchicalModel[]	Lista de entidades compostas.
culture	string	A cultura da aplicação. Por exemplo, en-us.
desc	string	A descrição da aplicação.
entities	HierarchicalModel[]	Lista de entidades.
intents	HierarchicalModel[]	Lista de intenções.
model_features	JSONModelFeature[]	Lista de funcionalidades do modelo.
name	string	O nome da aplicação.
patternAnyEntities	PatternAny[]	Lista de Entidades Pattern.Any.
patterns	PatternRule[]	Lista de padrões.
prebuiltEntities	PrebuiltEntity[]	Lista de entidades pré-criadas.
regex_entities	RegexEntity[]	Lista de entidades de expressão regulares.
regex_features	JSONRegexFeature[]	Lista de funcionalidades de padrão.
utterances	JSONUtterance[]	Lista de expressões de exemplo.
versionId	string	O ID da versão da aplicação que foi exportada.

PatternAny

Pattern.Any Entity Extractor.

Name	Tipo	Description
explicitList	string[]
name	string
roles	string[]

PatternRule

Padrão

Name	Tipo	Description
intent	string	O nome da intenção ao qual o padrão pertence.
pattern	string	O texto do padrão.

PrebuiltDomainObject

Name	Tipo	Description
domain_name	string
model_name	string

PrebuiltEntity

Extrator de Entidade pré-criado.

Name	Tipo	Description
name	string
roles	string[]

RegexEntity

Extrator de Entidades de Expressão Regular.

Name	Tipo	Description
name	string
regexPattern	string
roles	string[]

SubClosedList

Sublist de itens para uma entidade de lista.

Name	Tipo	Description
canonicalForm	string	O formulário padrão que a lista representa.
list	string[]	Lista de palavras de sinónimo.