LUIS Authoring Client
Connect to LUIS Authoring Client with 1 MCP tools for AI-powered API automation.
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "azure.local",
"info": {
"title": "LUIS Authoring Client",
"version": "3.0-preview",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json",
"version": "2.0"
}
],
"x-preferred": true,
"x-providerName": "azure.com",
"x-serviceName": "cognitiveservices-LUIS-Authoring",
"x-tags": [
"Azure",
"Microsoft"
]
},
"securityDefinitions": {
"apiKeyHeader": {
"in": "header",
"name": "Ocp-Apim-Subscription-Key",
"type": "apiKey"
}
},
"security": [
{
"apiKeyHeader": []
}
],
"parameters": {
"AppIdInPath": {
"description": "The application ID.",
"format": "uuid",
"in": "path",
"name": "appId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"BearerAuthPath": {
"description": "The bearer authorization header to use; containing the user's ARM token used to validate Azure accounts information.",
"in": "header",
"name": "Authorization",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"CEntityIdInPath": {
"description": "The composite entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "cEntityId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"Endpoint": {
"description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).",
"in": "path",
"name": "Endpoint",
"required": true,
"type": "string",
"x-ms-parameter-location": "client",
"x-ms-skip-url-encoding": true
},
"EntityIdInPath": {
"description": "The entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"ForcePath": {
"default": false,
"description": "A flag to indicate whether to force an operation.",
"in": "query",
"name": "force",
"type": "boolean",
"x-ms-parameter-location": "method"
},
"HEntityIdInPath": {
"description": "The hierarchical entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "hEntityId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"IntentIdInPath": {
"description": "The intent classifier ID.",
"format": "uuid",
"in": "path",
"name": "intentId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"SkipInPath": {
"default": 0,
"description": "The number of entries to skip. Default value is 0.",
"in": "query",
"minimum": 0,
"name": "skip",
"type": "integer",
"x-ms-parameter-location": "method"
},
"SlotNameInPath": {
"description": "The publishing slot name.",
"in": "path",
"name": "slotName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"TakeInPath": {
"default": 100,
"description": "The number of entries to return. Maximum page size is 500. Default is 100.",
"in": "query",
"maximum": 500,
"minimum": 0,
"name": "take",
"type": "integer",
"x-ms-parameter-location": "method"
},
"VersionIdInPath": {
"description": "The version ID.",
"in": "path",
"name": "versionId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
},
"paths": {
"/apps/": {
"get": {
"description": "Lists all of the user's applications.",
"operationId": "Apps_List",
"parameters": [
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the user applications.",
"schema": {
"$ref": "#/definitions/ApplicationsInfoList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Applications List request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"skip": 0,
"take": 100
},
"responses": {
"200": {
"body": [
{
"createdDateTime": "2017-01-31T16:15:54Z",
"culture": "en-us",
"description": "This is my first dummy application",
"domain": "Comics",
"endpointHitsCount": 0,
"endpoints": {
"PRODUCTION": {
"assignedEndpointKey": "",
"endpointRegion": "westus",
"endpointUrl": "DummyUrl",
"isStaging": false,
"publishedDateTime": "2017-02-19T17:09:14Z",
"versionId": "0.1"
}
},
"id": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"name": "MyFirstDummyApp",
"usageScenario": "IoT",
"versionsCount": 3
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Creates a new LUIS app.",
"operationId": "Apps_Add",
"parameters": [
{
"description": "An application containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is \"0.1\". Note: the culture cannot be changed after the app is created.",
"in": "body",
"name": "applicationCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ApplicationCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created application.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Application Creation": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"applicationCreateObject": {
"culture": "en-us",
"description": "New LUIS App",
"domain": "Comics",
"name": "New LUIS App",
"usageScenario": "IoT"
}
},
"responses": {
"201": {
"body": "9e6703ec-56fe-48ce-8a72-10d592f6056d",
"headers": {
"location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/9e6703ec-56fe-48ce-8a72-10d592f6056d"
}
}
}
}
}
}
},
"/apps/assistants": {
"get": {
"description": "Gets the endpoint URLs for the prebuilt Cortana applications.",
"operationId": "Apps_ListCortanaEndpoints",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A personal assistant apps JSON object containing the endpoint URLs for Cortana applications and the user's endpoint keys.",
"schema": {
"$ref": "#/definitions/PersonalAssistantsResponse"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Personal Assistant Applications": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000"
},
"responses": {
"200": {
"body": {
"endpointKeys": [],
"endpointUrls": {
"Chinese": "ChineseDummyURL",
"English": "EnglishDummyURL",
"French": "FrenchDummyURL",
"Italian": "ItalianDummyURL",
"Spanish": "SpanishDummyURL"
}
},
"headers": {}
}
}
}
}
}
},
"/apps/cultures": {
"get": {
"description": "Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,\"en-us\" represents the U.S. variation of English.",
"operationId": "Apps_ListSupportedCultures",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list object containing the supported application cultures.",
"schema": {
"$ref": "#/definitions/AvailableCultures"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Cultures request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000"
},
"responses": {
"200": {
"body": [
{
"code": "en-us",
"name": "English"
},
{
"code": "zh-cn",
"name": "Chinese"
},
{
"code": "fr-fr",
"name": "French"
},
{
"code": "fr-ca",
"name": "French Canadian"
},
{
"code": "es-es",
"name": "Spanish"
},
{
"code": "es-mx",
"name": "Spanish Mexican"
},
{
"code": "it-it",
"name": "Italian"
},
{
"code": "de-de",
"name": "German"
},
{
"code": "ja-jp",
"name": "Japanese"
},
{
"code": "pt-br",
"name": "Brazilian Portuguese"
},
{
"code": "ko-kr",
"name": "Korean"
},
{
"code": "nl-nl",
"name": "Dutch"
}
],
"headers": {}
}
}
}
}
}
},
"/apps/customprebuiltdomains": {
"get": {
"description": "Gets all the available custom prebuilt domains for all cultures.",
"operationId": "Apps_ListAvailableCustomPrebuiltDomains",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns a list of all custom prebuilt domains and their intents/entities representation.",
"schema": {
"$ref": "#/definitions/PrebuiltDomainsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Available Custom Prebuilt Domains request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000"
},
"responses": {
"200": {
"body": [
{
"culture": "en-us",
"description": "A custom prebuilt domain for taxi booking",
"entities": [
{
"description": "Route starting point",
"examples": "find taxi x to take me to 9th street from space needle",
"name": "from_place_name"
}
],
"examples": "book taxi x on friday at 6 pm, take me to Tinga's from Westin hotel with taxi lux",
"intents": [
{
"description": "Requests/Books taxi",
"examples": "book taxi x on friday at 6 pm",
"name": "book_taxi"
},
{
"description": "Cancels taxi request",
"examples": "I just called an taxi SUV , please cancel, Cancel my taxi",
"name": "cancel_taxi"
}
],
"name": "taxi"
},
{
"culture": "en-us",
"description": "A custom prebuilt domain that gets weather forecast and condition",
"entities": [
{
"description": "Location of the queried weather",
"examples": "What's the weather like in Minneapolis",
"name": "location"
},
{
"description": "Temperature measurement unit",
"examples": "Please change the weather from Fahrenheit to Celsius",
"name": "unit"
}
],
"examples": "Show me the weather for this weekend, What's the weather?",
"intents": [
{
"description": "Gets weather forecast",
"examples": "What's the weather like tomorrow?",
"name": "get_forecast"
},
{
"description": "Gets weather condition",
"examples": "what's the average temperature in India in September?",
"name": "get_condition"
}
],
"name": "weather"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a prebuilt domain along with its intent and entity models as a new application.",
"operationId": "Apps_AddCustomPrebuiltDomain",
"parameters": [
{
"description": "A prebuilt domain create object containing the name and culture of the domain.",
"in": "body",
"name": "prebuiltDomainCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/PrebuiltDomainCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created application.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Custom Prebuilt Application request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"prebuiltDomainCreateObject": {
"culture": "en-US",
"domainName": "Web"
}
},
"responses": {
"201": {
"body": "00000000-0000-0000-0000-000000000000",
"headers": {
"location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/customprebuiltdomains/00000000-0000-0000-0000-000000000000"
}
}
}
}
}
}
},
"/apps/customprebuiltdomains/{culture}": {
"get": {
"description": "Gets all the available prebuilt domains for a specific culture.",
"operationId": "Apps_ListAvailableCustomPrebuiltDomainsForCulture",
"parameters": [
{
"description": "Culture.",
"in": "path",
"name": "culture",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns a list of all domains and their intents and entities for a specific culture.",
"schema": {
"$ref": "#/definitions/PrebuiltDomainsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get AvailableCustomPrebuiltDomainsForCulture request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"culture": "{culture}"
},
"responses": {
"200": {
"body": [
{
"culture": "en-us",
"description": "A custom prebuilt domain for taxi booking",
"entities": [
{
"description": "Route starting point",
"examples": "find taxi x to take me to 9th street from space needle",
"name": "from_place_name"
}
],
"examples": "book taxi x on friday at 6 pm, take me to Tinga's from Westin hotel with taxi lux",
"intents": [
{
"description": "Requests/Books taxi",
"examples": "book taxi x on friday at 6 pm",
"name": "book_taxi"
},
{
"description": "Cancels taxi request",
"examples": "I just called an taxi SUV , please cancel, Cancel my taxi",
"name": "cancel_taxi"
}
],
"name": "taxi"
},
{
"culture": "en-us",
"description": "A custom prebuilt domain that gets weather forecast and condition",
"entities": [
{
"description": "Location of the queried weather",
"examples": "What's the weather like in Minneapolis",
"name": "location"
},
{
"description": "Temperature measurement unit",
"examples": "Please change the weather from Fahrenheit to Celsius",
"name": "unit"
}
],
"examples": "Show me the weather for this weekend, What's the weather?",
"intents": [
{
"description": "Gets weather forecast",
"examples": "What's the weather like tomorrow?",
"name": "get_forecast"
},
{
"description": "Gets weather condition",
"examples": "what's the average temperature in India in September?",
"name": "get_condition"
}
],
"name": "weather"
}
],
"headers": {}
}
}
}
}
}
},
"/apps/domains": {
"get": {
"description": "Gets the available application domains.",
"operationId": "Apps_ListDomains",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list object containing the available application domains.",
"schema": {
"$ref": "#/definitions/AvailableDomains"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Domains request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000"
},
"responses": {
"200": {
"body": [
"Booking & Reference",
"Business",
"Comics",
"Communication",
"Education",
"Entertainment",
"Finance",
"Food & Nutrition",
"Gaming",
"Health & Fitness",
"Home Automation",
"Media & Video",
"Medical",
"Music & Audio",
"Navigation & Maps",
"News & Magazines",
"Personalization",
"Productivity",
"Real Estate",
"Scheduler",
"Shopping",
"Social Network",
"Sports",
"Telecom",
"Tools",
"Transportation",
"Translation",
"Travel & Local",
"Weather",
"Others"
],
"headers": {}
}
}
}
}
}
},
"/apps/import": {
"post": {
"consumes": [
"application/json"
],
"description": "Imports an application to LUIS, the application's structure is included in the request body.",
"operationId": "Apps_Import",
"parameters": [
{
"description": "The application name to create. If not specified, the application name will be read from the imported object. If the application name already exists, an error is returned.",
"in": "query",
"name": "appName",
"type": "string"
},
{
"description": "A LUIS application structure.",
"in": "body",
"name": "luisApp",
"required": true,
"schema": {
"$ref": "#/definitions/LuisApp"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the imported application.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Import Application": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appName": "Test LUIS App",
"luisApp": {
"closedLists": [],
"composites": [],
"culture": "en-us",
"desc": "",
"entities": [
{
"name": "AirportCode",
"roles": [
"destination"
]
},
{
"name": "Hotel",
"roles": []
}
],
"intents": [
{
"inherits": {
"domain_name": "HomeAutomation",
"model_name": "TurnOff"
},
"name": "HomeAutomation.TurnOff"
},
{
"name": "dateintent"
},
{
"name": "Help"
},
{
"name": "None"
},
{
"name": "SearchHotels"
},
{
"name": "ShowHotelsReviews"
}
],
"luis_schema_version": "3.0.0",
"model_features": [
{
"activated": true,
"mode": true,
"name": "Near",
"words": "near,around,close,nearby"
},
{
"activated": true,
"mode": true,
"name": "Show",
"words": "show,find,look,search"
}
],
"name": "LuisBot",
"patternAnyEntities": [
{
"explicitList": [],
"name": "patternAny1",
"roles": [
"role1",
"role2"
]
}
],
"patterns": [
{
"intent": "Help",
"pattern": "this is [a test] {patternAny1:role1}"
}
],
"prebuiltEntities": [
{
"name": "datetimeV2",
"roles": [
"datetime role"
]
}
],
"regex_entities": [
{
"name": "regex1",
"regexPattern": "[^a]+",
"roles": [
"regex role"
]
}
],
"regex_features": [
{
"activated": true,
"name": "AirportCodeRegex",
"pattern": "[a-z]{3}"
}
],
"utterances": [
{
"entities": [],
"intent": "Help",
"text": "i need help"
},
{
"entities": [],
"intent": "Help",
"text": "help me"
},
{
"entities": [],
"intent": "dateintent",
"text": "tomorrow"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "search for hotels in seattle"
},
{
"entities": [],
"intent": "Help",
"text": "what can i do?"
},
{
"entities": [],
"intent": "dateintent",
"text": "next monday"
},
{
"entities": [],
"intent": "dateintent",
"text": "next year"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "look for hotels in miami"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "show me hotels in california"
},
{
"entities": [
{
"endPos": 44,
"entity": "Hotel",
"startPos": 23
}
],
"intent": "ShowHotelsReviews",
"text": "show me the reviews of the amazing bot resort"
},
{
"entities": [
{
"endPos": 42,
"entity": "Hotel",
"startPos": 25
}
],
"intent": "ShowHotelsReviews",
"text": "can i see the reviews of extended bot hotel?"
},
{
"entities": [
{
"endPos": 23,
"entity": "Hotel",
"startPos": 16
}
],
"intent": "ShowHotelsReviews",
"text": "find reviews of hotelxya"
},
{
"entities": [
{
"endPos": 35,
"entity": "Hotel",
"startPos": 19
}
],
"intent": "ShowHotelsReviews",
"text": "show me reviews of the amazing hotel"
},
{
"entities": [],
"intent": "Help",
"text": "what are the available options?"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "best hotels in seattle"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "hotels in los angeles"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "can you show me hotels from los angeles?"
},
{
"entities": [
{
"endPos": 56,
"entity": "Hotel",
"startPos": 31
}
],
"intent": "ShowHotelsReviews",
"text": "can you show me the reviews of the amazing resort & hotel"
},
{
"entities": [
{
"endPos": 46,
"entity": "Hotel",
"startPos": 24
}
],
"intent": "ShowHotelsReviews",
"text": "what are the reviews of the hotel bot framework?"
},
{
"entities": [
{
"endPos": 19,
"entity": "AirportCode",
"startPos": 17
}
],
"intent": "SearchHotels",
"text": "find hotels near eze"
},
{
"entities": [
{
"endPos": 24,
"entity": "AirportCode",
"startPos": 22
}
],
"intent": "SearchHotels",
"text": "where can i stay near nnn?"
},
{
"entities": [
{
"endPos": 19,
"entity": "AirportCode",
"startPos": 17
}
],
"intent": "SearchHotels",
"text": "show hotels near att airport"
},
{
"entities": [
{
"endPos": 19,
"entity": "AirportCode",
"startPos": 17
}
],
"intent": "SearchHotels",
"text": "find hotels near agl"
},
{
"entities": [
{
"endPos": 21,
"entity": "AirportCode",
"startPos": 19
}
],
"intent": "SearchHotels",
"text": "find hotels around eze airport"
},
{
"entities": [],
"intent": "dateintent",
"text": "01/7"
}
],
"versionId": "0.1"
}
},
"responses": {
"201": {
"body": "374fac89-ae12-4afd-8c21-8a6424ce1c1f",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/374fac89-ae12-4afd-8c21-8a6424ce1c1f"
}
}
}
}
}
}
},
"/apps/usagescenarios": {
"get": {
"description": "Gets the application available usage scenarios.",
"operationId": "Apps_ListUsageScenarios",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list object containing the available application usage scenarios.",
"schema": {
"$ref": "#/definitions/ApplicationUsageScenarios"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Usage Scenarios request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000"
},
"responses": {
"200": {
"body": [
"IoT",
"Bot",
"Mobile Application",
"Other"
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}": {
"delete": {
"description": "Deletes an application.",
"operationId": "Apps_Delete",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/ForcePath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully deleted application.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Rename Application request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets the application info.",
"operationId": "Apps_Get",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The application info.",
"schema": {
"$ref": "#/definitions/ApplicationInfoResponse"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e"
},
"responses": {
"200": {
"body": {
"createdDateTime": "2017-01-31T16:15:54Z",
"culture": "en-us",
"description": "This is my first dummy application",
"domain": "Comics",
"endpointHitsCount": 0,
"endpoints": {
"PRODUCTION": {
"assignedEndpointKey": "",
"endpointRegion": "westus",
"endpointUrl": "DummyUrl",
"isStaging": false,
"publishedDateTime": "2017-02-19T17:09:14Z",
"versionId": "0.1"
}
},
"id": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"name": "MyFirstDummyAp",
"usageScenario": "IoT",
"versionsCount": 3
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the name or description of the application.",
"operationId": "Apps_Update",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"description": "A model containing Name and Description of the application.",
"in": "body",
"name": "applicationUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ApplicationUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated application name and description.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Rename Application request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"applicationUpdateObject": {
"description": "LUIS App description updated",
"name": "LUIS App name updated"
}
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/azureaccounts": {
"delete": {
"consumes": [
"application/json"
],
"description": "Removes assigned Azure account from the application.",
"operationId": "AzureAccounts_RemoveFromApp",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/BearerAuthPath"
},
{
"description": "The Azure account information object.",
"in": "body",
"name": "azureAccountInfoObject",
"schema": {
"$ref": "#/definitions/AzureAccountInfoObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "apps - Removes an assigned LUIS Azure account from an application",
"x-ms-examples": {
"Successful delete assigned azure account request": {
"parameters": {
"Authorization": "Bearer {ARM Token}",
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"azureAccountInfoObject": {
"accountName": "{account_name}",
"azureSubscriptionId": "{azure_subscription_id}",
"resourceGroup": "{resource_group_name}"
}
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets the LUIS Azure accounts assigned to the application for the user using his ARM token.",
"operationId": "AzureAccounts_GetAssigned",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/BearerAuthPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of azure account information objects.",
"schema": {
"$ref": "#/definitions/AzureAccountInfoList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "apps - Get LUIS Azure accounts assigned to the application",
"x-ms-examples": {
"Successful Get assigned azure accounts request": {
"parameters": {
"Authorization": "Bearer {ARM Token}",
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e"
},
"responses": {
"200": {
"body": [
{
"accountName": "{account_name}",
"azureSubscriptionId": "{azure_subscription_id}",
"resourceGroup": "{resource_group_name}"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Assigns an Azure account to the application.",
"operationId": "AzureAccounts_AssignToApp",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/BearerAuthPath"
},
{
"description": "The Azure account information object.",
"in": "body",
"name": "azureAccountInfoObject",
"schema": {
"$ref": "#/definitions/AzureAccountInfoObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "apps - Assign a LUIS Azure account to an application",
"x-ms-examples": {
"Successful Assign azure account request": {
"parameters": {
"Authorization": "Bearer {ARM Token}",
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"azureAccountInfoObject": {
"accountName": "{account_name}",
"azureSubscriptionId": "{azure_subscription_id}",
"resourceGroup": "{resource_group_name}"
}
},
"responses": {
"201": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/endpoints": {
"get": {
"description": "Returns the available endpoint deployment regions and URLs.",
"operationId": "Apps_ListEndpoints",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns a list of endpoints regions and their corresponding endpoint URL.",
"schema": {
"$ref": "#/definitions/AvailableEndpoints"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Endpoints request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e"
},
"responses": {
"200": {
"body": {
"eastus2": "https://eastus2.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a",
"southeastasia": "https://southeastasia.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a",
"westcentralus": "https://westcentralus.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a",
"westus": "https://westus.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/permissions": {
"delete": {
"consumes": [
"application/json"
],
"description": "Removes a user from the allowed list of users to access this LUIS application. Users are removed using their email address.",
"operationId": "Permissions_Delete",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"description": "A model containing the user's email address.",
"in": "body",
"name": "userToDelete",
"required": true,
"schema": {
"$ref": "#/definitions/UserCollaborator"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Remove User From Access List": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"userToDelete": {
"email": "guest@outlook.com"
}
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets the list of user emails that have permissions to access your application.",
"operationId": "Permissions_List",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list includes a single owner. All collaborators are listed in the emails array.",
"schema": {
"$ref": "#/definitions/UserAccessList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application User Access List": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e"
},
"responses": {
"200": {
"body": {
"emails": [
"yourname@outlook.com"
],
"owner": "owner@email.com"
},
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a user to the allowed list of users to access this LUIS application. Users are added using their email address.",
"operationId": "Permissions_Add",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"description": "A model containing the user's email address.",
"in": "body",
"name": "userToAdd",
"required": true,
"schema": {
"$ref": "#/definitions/UserCollaborator"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add User To Access List": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"userToAdd": {
"email": "guest@outlook.com"
}
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Replaces the current user access list with the new list sent in the body. If an empty list is sent, all access to other users will be removed.",
"operationId": "Permissions_Update",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"description": "A model containing a list of user email addresses.",
"in": "body",
"name": "collaborators",
"required": true,
"schema": {
"$ref": "#/definitions/CollaboratorsArray"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Replaces Users From Access List": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"collaborators": {
"emails": [
"guest@outlook.com",
"invited.user@live.com"
]
}
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/publish": {
"post": {
"consumes": [
"application/json"
],
"description": "Publishes a specific version of the application.",
"operationId": "Apps_Publish",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"description": "The application publish object. The region is the target region that the application is published to.",
"in": "body",
"name": "applicationPublishObject",
"required": true,
"schema": {
"$ref": "#/definitions/ApplicationPublishObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "An object containing the application endpoint URL, its assigned endpoint key and publishing status.",
"schema": {
"$ref": "#/definitions/ProductionOrStagingEndpointInfo"
}
},
"207": {
"description": "An object containing the application endpoint URL, its assigned endpoint key and publishing status in case that publishing one or more regions failed.",
"schema": {
"$ref": "#/definitions/ProductionOrStagingEndpointInfo"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Publish Application request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "11be6373fca44ded80fbe2afa8597c18",
"applicationPublishObject": {
"isStaging": false,
"versionId": "0.1"
}
},
"responses": {
"201": {
"body": {
"assignedEndpointKey": "11be6373fca44ded80fbe2afa8597c18",
"endpointRegion": "westus, cus",
"endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/11be6373fca44ded80fbe2afa8597c18",
"failedRegions": null,
"isStaging": false,
"publishedDateTime": "2017-11-28T19:20:28Z"
},
"headers": {}
},
"207": {
"body": {
"assignedEndpointKey": "11be6373fca44ded80fbe2afa8597c18",
"endpointRegion": "westus, cus",
"endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/11be6373fca44ded80fbe2afa8597c18",
"failedRegions": "cus",
"isStaging": false,
"publishedDateTime": "2017-11-28T19:20:28Z"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/publishsettings": {
"get": {
"description": "Get the application publish settings including 'UseAllTrainingData'.",
"operationId": "Apps_GetPublishSettings",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The application publish settings.",
"schema": {
"$ref": "#/definitions/PublishSettings"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Publish Settings request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b"
},
"responses": {
"200": {
"body": {
"id": "51963bf0-08a1-44b7-9c69-735dbb92ce74",
"sentimentAnalysis": true,
"speech": true,
"spellChecker": true
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the application publish settings including 'UseAllTrainingData'.",
"operationId": "Apps_UpdatePublishSettings",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"description": "An object containing the new publish application settings.",
"in": "body",
"name": "publishSettingUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/PublishSettingUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated application settings.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Update Publish Settings request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"publishSettingUpdateObject": {
"sentimentAnalysis": true,
"speech": true,
"spellChecker": true
}
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/querylogs": {
"get": {
"description": "Gets the logs of the past month's endpoint queries for the application.",
"operationId": "Apps_DownloadQueryLogs",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
}
],
"produces": [
"application/octet-stream"
],
"responses": {
"200": {
"description": "A CSV file containing the query logs for the past month.",
"schema": {
"description": "The query logs of an application for the past month in CSV format.",
"format": "file",
"type": "object"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Download Application Query logs request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"appId": "{appId}"
},
"responses": {
"200": {
"body": "\"Query\",\"UTC DateTime\",\"Response\" \"hello, world!\",01/31/2017 17:17:41,\"{ \"\"query\"\": \"\"Hello, World!\"\", \"\"topScoringIntent\"\": { \"\"intent\"\": \"\"None\"\", \"\"score\"\": 0.6277761 }, \"\"intents\"\": [ { \"\"intent\"\": \"\"None\"\", \"\"score\"\": 0.6277761 }, { \"\"intent\"\": \"\"BookFlight\"\", \"\"score\"\": 0.002136109 }, { \"\"intent\"\": \"\"GetWeather\"\", \"\"score\"\": 0.00142168161 } ], \"\"entities\"\": []}\"",
"headers": {
"Content-Type": "application/octet-stream"
}
}
}
}
}
}
},
"/apps/{appId}/settings": {
"get": {
"description": "Get the application settings including 'UseAllTrainingData'.",
"operationId": "Apps_GetSettings",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The application settings.",
"schema": {
"$ref": "#/definitions/ApplicationSettings"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Settings request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b"
},
"responses": {
"200": {
"body": {
"id": "51963bf0-08a1-44b7-9c69-735dbb92ce74",
"public": false
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the application settings including 'UseAllTrainingData'.",
"operationId": "Apps_UpdateSettings",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"description": "An object containing the new application settings.",
"in": "body",
"name": "applicationSettingUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ApplicationSettingUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated application settings.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Update Application Settings request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"applicationSettingUpdateObject": {
"public": false
}
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions": {
"get": {
"description": "Gets a list of versions for this application ID.",
"operationId": "Versions_List",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of all versions of the application.",
"schema": {
"items": {
"$ref": "#/definitions/VersionInfo"
},
"type": "array"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Versions info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"skip": 0,
"take": 100
},
"responses": {
"200": {
"body": [
{
"assignedEndpointKey": {
"SubscriptionKey": "",
"SubscriptionName": "",
"SubscriptionRegion": "westus"
},
"createdDateTime": "2017-08-01T14:34:15Z",
"endpointHitsCount": 175,
"endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e",
"entitiesCount": 0,
"externalApiKeys": {},
"intentsCount": 4,
"lastModifiedDateTime": "2017-11-28T20:12:09Z",
"lastPublishedDateTime": "2017-11-28T20:12:35Z",
"lastTrainedDateTime": "2017-11-28T20:12:12Z",
"trainingStatus": "Trained",
"version": "0.1"
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/import": {
"post": {
"consumes": [
"application/json"
],
"description": "Imports a new version into a LUIS application.",
"operationId": "Versions_Import",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"description": "The new versionId to import. If not specified, the versionId will be read from the imported object.",
"in": "query",
"name": "versionId",
"type": "string"
},
{
"description": "A LUIS application structure.",
"in": "body",
"name": "luisApp",
"required": true,
"schema": {
"$ref": "#/definitions/LuisApp"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The created application version.",
"schema": {
"$ref": "#/definitions/VersionResponse"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Import Application": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a",
"luisApp": {
"closedLists": [],
"composites": [],
"culture": "en-us",
"desc": "",
"entities": [
{
"name": "AirportCode",
"roles": [
"destination"
]
},
{
"name": "Hotel",
"roles": []
}
],
"intents": [
{
"inherits": {
"domain_name": "HomeAutomation",
"model_name": "TurnOff"
},
"name": "HomeAutomation.TurnOff"
},
{
"name": "dateintent"
},
{
"name": "Help"
},
{
"name": "None"
},
{
"name": "SearchHotels"
},
{
"name": "ShowHotelsReviews"
}
],
"luis_schema_version": "3.0.0",
"model_features": [
{
"activated": true,
"mode": true,
"name": "Near",
"words": "near,around,close,nearby"
},
{
"activated": true,
"mode": true,
"name": "Show",
"words": "show,find,look,search"
}
],
"name": "LuisBot",
"patternAnyEntities": [
{
"explicitList": [],
"name": "patternAny1",
"roles": [
"role1",
"role2"
]
}
],
"patterns": [
{
"intent": "Help",
"pattern": "this is [a test] {patternAny1:role1}"
}
],
"prebuiltEntities": [
{
"name": "datetimeV2",
"roles": [
"datetime role"
]
}
],
"regex_entities": [
{
"name": "regex1",
"regexPattern": "[^a]+",
"roles": [
"regex role"
]
}
],
"regex_features": [
{
"activated": true,
"name": "AirportCodeRegex",
"pattern": "[a-z]{3}"
}
],
"utterances": [
{
"entities": [],
"intent": "Help",
"text": "i need help"
},
{
"entities": [],
"intent": "Help",
"text": "help me"
},
{
"entities": [],
"intent": "dateintent",
"text": "tomorrow"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "search for hotels in seattle"
},
{
"entities": [],
"intent": "Help",
"text": "what can i do?"
},
{
"entities": [],
"intent": "dateintent",
"text": "next monday"
},
{
"entities": [],
"intent": "dateintent",
"text": "next year"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "look for hotels in miami"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "show me hotels in california"
},
{
"entities": [
{
"endPos": 44,
"entity": "Hotel",
"startPos": 23
}
],
"intent": "ShowHotelsReviews",
"text": "show me the reviews of the amazing bot resort"
},
{
"entities": [
{
"endPos": 42,
"entity": "Hotel",
"startPos": 25
}
],
"intent": "ShowHotelsReviews",
"text": "can i see the reviews of extended bot hotel?"
},
{
"entities": [
{
"endPos": 23,
"entity": "Hotel",
"startPos": 16
}
],
"intent": "ShowHotelsReviews",
"text": "find reviews of hotelxya"
},
{
"entities": [
{
"endPos": 35,
"entity": "Hotel",
"startPos": 19
}
],
"intent": "ShowHotelsReviews",
"text": "show me reviews of the amazing hotel"
},
{
"entities": [],
"intent": "Help",
"text": "what are the available options?"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "best hotels in seattle"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "hotels in los angeles"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "can you show me hotels from los angeles?"
},
{
"entities": [
{
"endPos": 56,
"entity": "Hotel",
"startPos": 31
}
],
"intent": "ShowHotelsReviews",
"text": "can you show me the reviews of the amazing resort & hotel"
},
{
"entities": [
{
"endPos": 46,
"entity": "Hotel",
"startPos": 24
}
],
"intent": "ShowHotelsReviews",
"text": "what are the reviews of the hotel bot framework?"
},
{
"entities": [
{
"endPos": 19,
"entity": "AirportCode",
"startPos": 17
}
],
"intent": "SearchHotels",
"text": "find hotels near eze"
},
{
"entities": [
{
"endPos": 24,
"entity": "AirportCode",
"startPos": 22
}
],
"intent": "SearchHotels",
"text": "where can i stay near nnn?"
},
{
"entities": [
{
"endPos": 19,
"entity": "AirportCode",
"startPos": 17
}
],
"intent": "SearchHotels",
"text": "show hotels near att airport"
},
{
"entities": [
{
"endPos": 19,
"entity": "AirportCode",
"startPos": 17
}
],
"intent": "SearchHotels",
"text": "find hotels near agl"
},
{
"entities": [
{
"endPos": 21,
"entity": "AirportCode",
"startPos": 19
}
],
"intent": "SearchHotels",
"text": "find hotels around eze airport"
},
{
"entities": [],
"intent": "dateintent",
"text": "01/7"
}
],
"versionId": "0.1"
},
"versionId": "0.2"
},
"responses": {
"201": {
"body": "0.2",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/bd72e8d7-62b8-48f5-9dcb-e3b0588b803a/versions/0.2"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/": {
"delete": {
"description": "Deletes an application version.",
"operationId": "Versions_Delete",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Application Version request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.",
"operationId": "Versions_Get",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A model containing the version info.",
"schema": {
"$ref": "#/definitions/VersionInfo"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"assignedEndpointKey": {
"SubscriptionKey": "",
"SubscriptionName": "",
"SubscriptionRegion": "westus"
},
"createdDateTime": "2017-08-01T14:34:15Z",
"endpointHitsCount": 175,
"endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e",
"entitiesCount": 0,
"externalApiKeys": {},
"intentsCount": 4,
"lastModifiedDateTime": "2017-11-28T20:12:09Z",
"lastPublishedDateTime": "2017-11-28T20:12:35Z",
"lastTrainedDateTime": "2017-11-28T20:12:12Z",
"trainingStatus": "Trained",
"version": "0.1"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the name or description of the application version.",
"operationId": "Versions_Update",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model containing Name and Description of the application.",
"in": "body",
"name": "versionUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/TaskUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Rename Application Version request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"versionId": "0.1",
"versionUpdateObject": {
"version": "1.0"
}
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/clone": {
"post": {
"consumes": [
"application/json"
],
"description": "Creates a new version from the selected version.",
"operationId": "Versions_Clone",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model containing the new version ID.",
"in": "body",
"name": "versionCloneObject",
"required": true,
"schema": {
"$ref": "#/definitions/TaskUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The new version ID.",
"schema": {
"type": "string"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Clone Application Version request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"versionCloneObject": {
"version": "1.0"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "1.0",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/closedlists": {
"get": {
"description": "Gets information about all the list entity models in a version of the application.",
"operationId": "Model_ListClosedLists",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of list entity model infos.",
"schema": {
"$ref": "#/definitions/ClosedListEntityExtractorsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Closed List Infos request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "11be6373fca44ded80fbe2afa8597c18",
"skip": 0,
"take": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "8713b104-78ec-4c4f-9f96-f2e53562cc16",
"name": "States",
"readableType": "Closed List Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"subLists": [
{
"canonicalForm": "new york",
"id": 1,
"list": [
"ny",
"new york"
]
},
{
"canonicalForm": "washington",
"id": 2,
"list": [
"washington",
"wa"
]
},
{
"canonicalForm": "california",
"id": 3,
"list": [
"california",
"ca",
"calif.",
"cal."
]
}
],
"typeId": 5
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a list entity model to a version of the application.",
"operationId": "Model_AddClosedList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model containing the name and words for the new list entity extractor.",
"in": "body",
"name": "closedListModelCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ClosedListModelCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created model.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Create Closed List Entity Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"closedListModelCreateObject": {
"name": "States",
"subLists": [
{
"canonicalForm": "New York",
"list": [
"NY",
"New York"
]
},
{
"canonicalForm": "Washington",
"list": [
"Washington",
"WA"
]
},
{
"canonicalForm": "California",
"list": [
"California",
"CA",
"Calif.",
"Cal."
]
}
]
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "8713b104-78ec-4c4f-9f96-f2e53562cc16",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}": {
"delete": {
"description": "Deletes a list entity model from a version of the application.",
"operationId": "Model_DeleteClosedList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The list entity model ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully delete list entity from a version of application.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Closed List Entity Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets information about a list entity in a version of the application.",
"operationId": "Model_GetClosedList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The list model ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list model info.",
"schema": {
"$ref": "#/definitions/ClosedListEntityExtractor"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Closed List Entity Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"clEntityId": "8713b104-78ec-4c4f-9f96-f2e53562cc16",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "8713b104-78ec-4c4f-9f96-f2e53562cc16",
"name": "States",
"readableType": "Closed List Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"subLists": [
{
"canonicalForm": "new york",
"id": 1,
"list": [
"ny",
"new york"
]
},
{
"canonicalForm": "washington",
"id": 2,
"list": [
"washington",
"wa"
]
},
{
"canonicalForm": "california",
"id": 3,
"list": [
"california",
"ca",
"calif.",
"cal."
]
}
],
"typeId": 5
},
"headers": {}
}
}
}
}
},
"patch": {
"consumes": [
"application/json"
],
"description": "Adds a batch of sublists to an existing list entity in a version of the application.",
"operationId": "Model_PatchClosedList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The list entity model ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
},
{
"description": "A words list batch.",
"in": "body",
"name": "closedListModelPatchObject",
"required": true,
"schema": {
"$ref": "#/definitions/ClosedListModelPatchObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully added sublists to the list entity.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add SubLists to Closed List Entity request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf",
"closedListModelPatchObject": {
"subLists": [
{
"canonicalForm": "Texas",
"list": [
"tx",
"texas"
]
}
]
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the list entity in a version of the application.",
"operationId": "Model_UpdateClosedList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The list model ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
},
{
"description": "The new list entity name and words list.",
"in": "body",
"name": "closedListModelUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ClosedListModelUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated list entity name and words list.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Update Closed List Entity Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf",
"closedListModelUpdateObject": {
"name": "States",
"subLists": [
{
"canonicalForm": "Texas",
"list": [
"TX",
"Texas"
]
}
]
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists": {
"post": {
"consumes": [
"application/json"
],
"description": "Adds a sublist to an existing list entity in a version of the application.",
"operationId": "Model_AddSubList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The list entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
},
{
"description": "Words list.",
"in": "body",
"name": "wordListCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/WordListObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the newly created sublist.",
"schema": {
"format": "int64",
"type": "integer"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Sublist request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf",
"versionId": "0.1",
"wordListCreateObject": {
"canonicalForm": "Texas",
"list": [
"tx",
"texas"
]
}
},
"responses": {
"201": {
"body": 6134877,
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/28027e3b-8356-4cdf-b395-24afb94e9469/sublists/6134877"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}": {
"delete": {
"description": "Deletes a sublist of a specific list entity model from a version of the application.",
"operationId": "Model_DeleteSubList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The list entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
},
{
"description": "The sublist ID.",
"format": "int64",
"in": "path",
"name": "subListId",
"required": true,
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully deleted sublist.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Sublist request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf",
"subListId": 123,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates one of the list entity's sublists in a version of the application.",
"operationId": "Model_UpdateSubList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The list entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
},
{
"description": "The sublist ID.",
"format": "int64",
"in": "path",
"name": "subListId",
"required": true,
"type": "integer"
},
{
"description": "A sublist update object containing the new canonical form and the list of words.",
"in": "body",
"name": "wordListBaseUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/WordListBaseUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated sublist.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Update Sublist request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf",
"subListId": 123,
"versionId": "0.1",
"wordListBaseUpdateObject": {
"canonicalForm": "Texas",
"list": [
"tx",
"texas"
]
}
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles": {
"get": {
"operationId": "Model_ListClosedListEntityRoles",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity Id",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the entity roles",
"schema": {
"$ref": "#/definitions/EntityRoleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get all roles for a list entity in a version of the application.",
"x-ms-examples": {
"Successful Get Closed List Entity Roles request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_CreateClosedListEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity model ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "An entity role object containing the name of role.",
"in": "body",
"name": "entityRoleCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created entity role",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Create a role for a list entity in a version of the application.",
"x-ms-examples": {
"Successful Create Closed List Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d",
"entityRoleCreateObject": {
"name": "sample role"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles/{roleId}": {
"delete": {
"operationId": "Model_DeleteClosedListEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role Id.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Delete a role for a given list entity in a version of the application.",
"x-ms-examples": {
"Successful Delete Prebuilt Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetClosedListEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An entity role",
"schema": {
"$ref": "#/definitions/EntityRole"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get one role for a given list entity in a version of the application.",
"x-ms-examples": {
"Successful Get Closed List Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"name": "role 1"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdateClosedListEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
},
{
"description": "The new entity role.",
"in": "body",
"name": "entityRoleUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the entity role.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Update a role for a given list entity in a version of the application.",
"x-ms-examples": {
"Successful Update Closed List Entity Extractor Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"entityRoleUpdateObject": {
"name": "New Name"
},
"roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/compositeentities": {
"get": {
"description": "Gets information about all the composite entity models in a version of the application.",
"operationId": "Model_ListCompositeEntities",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of composite entity model infos.",
"schema": {
"$ref": "#/definitions/CompositeEntityExtractorsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Composite Entity Infos request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"appId": "{appId}",
"skip": 0,
"take": 100,
"versionId": "{versionId}"
},
"responses": {
"200": {
"body": [
{
"children": [
{
"id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
"name": "Location::To"
},
{
"id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e",
"name": "datetime"
}
],
"id": "bc1bae43-7904-48ad-a165-88b1910174f9",
"name": "Reservation",
"readableType": "Composite Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 4
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": {
"delete": {
"description": "Deletes a composite entity from a version of the application.",
"operationId": "Model_DeleteCompositeEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/CEntityIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully deleted composite entity.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Entity Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{apiKey}",
"appId": "{appId}",
"cEntityId": "{cEntityId}",
"versionId": "{versionId}"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets information about a composite entity in a version of the application.",
"operationId": "Model_GetCompositeEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/CEntityIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The composite entity model info.",
"schema": {
"$ref": "#/definitions/CompositeEntityExtractor"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Composite Entity Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"appId": "{appId}",
"cEntityId": "{cEntityId}",
"versionId": "{versionId}"
},
"responses": {
"200": {
"body": {
"children": [
{
"id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
"name": "Location::To"
},
{
"id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e",
"name": "datetime"
}
],
"id": "bc1bae43-7904-48ad-a165-88b1910174f9",
"name": "Reservation",
"readableType": "Composite Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 4
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates a composite entity in a version of the application.",
"operationId": "Model_UpdateCompositeEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/CEntityIdInPath"
},
{
"description": "A model object containing the new entity extractor name and children.",
"in": "body",
"name": "compositeModelUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/CompositeEntityModel"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated composite entity.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Update Composite Entity Extractor request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{apiKey}",
"appId": "{appId}",
"cEntityId": "{cEntityId}",
"compositeModelUpdateObject": {
"name": "Renamed Entity"
},
"versionId": "{versionId}"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children": {
"post": {
"consumes": [
"application/json"
],
"description": "Creates a single child in an existing composite entity model in a version of the application.",
"operationId": "Model_AddCompositeEntityChild",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/CEntityIdInPath"
},
{
"description": "A model object containing the name of the new composite child model.",
"in": "body",
"name": "compositeChildModelCreateObject",
"required": true,
"schema": {
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created model.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Create Composite Entity Child Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"cEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"compositeChildModelCreateObject": {
"name": "dateFrame"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "891c235f-4f42-4320-bc36-b6256b6c3f2b",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children/{cChildId}": {
"delete": {
"description": "Deletes a composite entity extractor child from a version of the application.",
"operationId": "Model_DeleteCompositeEntityChild",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/CEntityIdInPath"
},
{
"description": "The hierarchical entity extractor child ID.",
"format": "uuid",
"in": "path",
"name": "cChildId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully deleted entity.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Composite Entity Child Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"cChildId": "891c235f-4f42-4320-bc36-b6256b6c3f2b",
"cEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles": {
"get": {
"operationId": "Model_ListCompositeEntityRoles",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/CEntityIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the entity roles",
"schema": {
"$ref": "#/definitions/EntityRoleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get all roles for a composite entity in a version of the application",
"x-ms-examples": {
"Successful Get Composite Entity Roles request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"cEntityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_CreateCompositeEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/CEntityIdInPath"
},
{
"description": "An entity role object containing the name of role.",
"in": "body",
"name": "entityRoleCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created entity role",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Create a role for a composite entity in a version of the application.",
"x-ms-examples": {
"Successful Create Composite Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"cEntityId": "fc821c4e-a2f8-4074-9410-7271b38a692d",
"entityRoleCreateObject": {
"name": "sample role"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/compositeentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles/{roleId}": {
"delete": {
"operationId": "Model_DeleteCompositeEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/CEntityIdInPath"
},
{
"description": "The entity role Id.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Delete a role for a given composite entity in a version of the application.",
"x-ms-examples": {
"Successful Delete Composite Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetCompositeEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/CEntityIdInPath"
},
{
"description": "entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An entity role",
"schema": {
"$ref": "#/definitions/EntityRole"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get one role for a given composite entity in a version of the application",
"x-ms-examples": {
"Successful Get Composite Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"name": "role 1"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdateCompositeEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/CEntityIdInPath"
},
{
"description": "The entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
},
{
"description": "The new entity role.",
"in": "body",
"name": "entityRoleUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the entity role.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Update a role for a given composite entity in a version of the application",
"x-ms-examples": {
"Successful Update Composite Entity Extractor Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"entityRoleUpdateObject": {
"name": "New Name"
},
"roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/customprebuiltdomains": {
"post": {
"consumes": [
"application/json"
],
"description": "Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.",
"operationId": "Model_AddCustomPrebuiltDomain",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A prebuilt domain create object containing the name of the domain.",
"in": "body",
"name": "prebuiltDomainObject",
"required": true,
"schema": {
"$ref": "#/definitions/PrebuiltDomainCreateBaseObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "An array of the created customizable prebuilt domain intent and entity model Ids.",
"schema": {
"$ref": "#/definitions/GuidList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Custom Prebuilt Domain to Application request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"prebuiltDomainObject": {
"domainName": "Web"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": [
"2639049a-e41d-4285-a3c6-8a17ed299473",
"200d6173-ecfa-4967-bf95-3c319902dc52",
"f80aa9ba-64c8-4a36-8cc5-92010d0aadf1",
"f50d6f0f-b2dd-4973-9270-c114312b3a10"
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/customprebuiltdomains/{domainName}": {
"delete": {
"description": "Deletes a prebuilt domain's models in a version of the application.",
"operationId": "Model_DeleteCustomPrebuiltDomain",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "Domain name.",
"in": "path",
"name": "domainName",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Prebuilt Domain from Application request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"domainName": "Web",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/customprebuiltentities": {
"get": {
"description": "Gets all prebuilt entities used in a version of the application.",
"operationId": "Model_ListCustomPrebuiltEntities",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns a list of all prebuilt entities and their representations.",
"schema": {
"$ref": "#/definitions/EntityExtractorsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Custom Prebuilt Domain Entities request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"versionId": "1.0"
},
"responses": {
"200": {
"body": [
{
"customPrebuiltDomainName": "Camera",
"customPrebuiltModelName": "AppName",
"id": "b8e31be4-300f-455e-894b-6f079abca0a2",
"name": "Camera.AppName",
"readableType": "Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 1
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a prebuilt entity model to a version of the application.",
"operationId": "Model_AddCustomPrebuiltEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model object containing the name of the prebuilt entity and the name of the domain to which this model belongs.",
"in": "body",
"name": "prebuiltDomainModelCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/PrebuiltDomainModelCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created prebuilt model.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Custom Prebuilt Entity request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"prebuiltDomainModelCreateObject": {
"domainName": "Camera",
"modelName": "AppName"
},
"versionId": "1.0"
},
"responses": {
"201": {
"body": "1c2e70c1-3cbf-4e89-9703-9583b81102b9",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles": {
"get": {
"operationId": "Model_ListCustomPrebuiltEntityRoles",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity Id",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the entity roles",
"schema": {
"$ref": "#/definitions/EntityRoleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get all roles for a prebuilt entity in a version of the application",
"x-ms-examples": {
"Successful Get Custom Prebuilt Entity Roles request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_CreateCustomPrebuiltEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity model ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "An entity role object containing the name of role.",
"in": "body",
"name": "entityRoleCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created entity role",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Create a role for a prebuilt entity in a version of the application.",
"x-ms-examples": {
"Successful Create Custom Prebuilt Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d",
"entityRoleCreateObject": {
"name": "sample role"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/customprebuiltentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles/{roleId}": {
"delete": {
"operationId": "Model_DeleteCustomEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role Id.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Delete a role for a given prebuilt entity in a version of the application.",
"x-ms-examples": {
"Successful Delete Custom Prebuilt Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetCustomEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An entity role",
"schema": {
"$ref": "#/definitions/EntityRole"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get one role for a given prebuilt entity in a version of the application.",
"x-ms-examples": {
"Successful Get Custom Prebuilt Domain Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"name": "role 1"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdateCustomPrebuiltEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
},
{
"description": "The new entity role.",
"in": "body",
"name": "entityRoleUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the entity role.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Update a role for a given prebuilt entity in a version of the application.",
"x-ms-examples": {
"Successful Update Custom Prebuilt Entity Extractor Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"entityRoleUpdateObject": {
"name": "New Name"
},
"roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/customprebuiltintents": {
"get": {
"description": "Gets information about customizable prebuilt intents added to a version of the application.",
"operationId": "Model_ListCustomPrebuiltIntents",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns a list of all customizable prebuilt intents and their representations in a version of the application.",
"schema": {
"$ref": "#/definitions/IntentClassifiersList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Custom Prebuilt Intent request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"versionId": "1.0"
},
"responses": {
"200": {
"body": [
{
"customPrebuiltDomainName": "Calendar",
"customPrebuiltModelName": "Add",
"id": "b8e31be4-300f-455e-894b-6f079abca0a2",
"name": "Camera.AppName",
"readableType": "Intent Classifier",
"typeId": 1
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a customizable prebuilt intent model to a version of the application.",
"operationId": "Model_AddCustomPrebuiltIntent",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model object containing the name of the customizable prebuilt intent and the name of the domain to which this model belongs.",
"in": "body",
"name": "prebuiltDomainModelCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/PrebuiltDomainModelCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created intent model.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Custom Prebuilt Intent request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"prebuiltDomainModelCreateObject": {
"domainName": "Calendar",
"modelName": "Add"
},
"versionId": "1.0"
},
"responses": {
"201": {
"body": "1c2e70c1-3cbf-4e89-9703-9583b81102b9",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/customprebuiltmodels": {
"get": {
"description": "Gets all prebuilt intent and entity model information used in a version of this application.",
"operationId": "Model_ListCustomPrebuiltModels",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns a list of all prebuilt models and their representations.",
"schema": {
"$ref": "#/definitions/CustomPrebuiltModelList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Custom Prebuilt Domain Models request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"versionId": "1.0"
},
"responses": {
"200": {
"body": [
{
"customPrebuiltDomainName": "Calendar",
"customPrebuiltModelName": "Find",
"id": "1aa813da-8d36-4d16-bb13-d6f193290fea",
"name": "Calendar.Find",
"readableType": "Intent Classifier",
"typeId": 0
},
{
"customPrebuiltDomainName": "Calendar",
"customPrebuiltModelName": "Location",
"id": "d02b2e38-6b3c-412e-bf9e-f6770a40c9a0",
"name": "Calendar.Location",
"readableType": "Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 1
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/entities": {
"get": {
"description": "Gets information about all the simple entity models in a version of the application.",
"operationId": "Model_ListEntities",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of entity model infos.",
"schema": {
"$ref": "#/definitions/NDepthEntityExtractorsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Entity Infos request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"skip": 0,
"take": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "DayOfWeek",
"readableType": "Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 1
},
{
"customPrebuiltDomainName": "Camera",
"customPrebuiltModelName": "AppName",
"id": "b8e31be4-300f-455e-894b-6f079abca0a2",
"name": "$Camera.AppName",
"readableType": "Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 1
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds an entity extractor to a version of the application.",
"operationId": "Model_AddEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model object containing the name of the new entity extractor and its children.",
"in": "body",
"name": "entityModelCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityModelCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created model.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Create Entity Extractor request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityModelCreateObject": {
"children": [
{
"instanceOf": "datetimeV2",
"name": "Day"
}
],
"name": "DayOfWeek"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/7e838199-a5db-47a6-8931-d79f1729a922"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/entities/{entityId}": {
"delete": {
"description": "Deletes an entity or a child from a version of the application.",
"operationId": "Model_DeleteEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity extractor or the child entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully deleted entity.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Entity Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets information about an entity model in a version of the application.",
"operationId": "Model_GetEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An entity model info.",
"schema": {
"$ref": "#/definitions/NDepthEntityExtractor"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Entity Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"children": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"instanceOf": "datetimeV2",
"name": "Day",
"readableType": "Child Entity Extractor",
"typeId": 1
}
],
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "DayOfWeek",
"readableType": "Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 1
},
"headers": {}
}
}
}
}
},
"patch": {
"consumes": [
"application/json"
],
"description": "Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.",
"operationId": "Model_UpdateEntityChild",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity extractor or the child entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "A model object containing the name new entity extractor or the name and instance of model of a child entity extractor ",
"in": "body",
"name": "entityModelUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityModelUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Update Entity Extractor request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"entityModelUpdateObject": {
"instanceOf": "number",
"name": "New Name"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/entities/{entityId}/children": {
"post": {
"consumes": [
"application/json"
],
"description": "Creates a single child in an existing entity model hierarchy in a version of the application.",
"operationId": "Model_AddEntityChild",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "A model object containing the name of the new child model and its children.",
"in": "body",
"name": "childEntityModelCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ChildEntityModelCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created model.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Create Entity Child Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"childEntityModelCreateObject": {
"children": [],
"instanceOf": "number",
"name": "Day"
},
"entityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"versionId": "0.1"
},
"responses": {
"201": {
"body": "891c235f-4f42-4320-bc36-b6256b6c3f2b",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/entities/{entityId}/features": {
"delete": {
"description": "Deletes a relation from the feature relations used by the entity in a version of the application.",
"operationId": "Model_DeleteEntityFeature",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/EntityIdInPath"
},
{
"description": "A feature information object containing the feature relation to delete.",
"in": "body",
"name": "featureRelationDeleteObject",
"required": true,
"schema": {
"$ref": "#/definitions/ModelFeatureInformation"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete feature relation request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"featureRelationDeleteObject": {
"featureName": "Phraselist1"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets the information of the features used by the entity in a version of the application.",
"operationId": "Model_GetEntityFeatures",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/EntityIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of feature information objects for the entity.",
"schema": {
"$ref": "#/definitions/FeaturesPerModelResponseObject"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Features information request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"featureName": "Phraselist1"
},
{
"modelName": "None"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a new feature relation to be used by the entity in a version of the application.",
"operationId": "Features_AddEntityFeature",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/EntityIdInPath"
},
{
"description": "A Feature relation information object.",
"in": "body",
"name": "featureRelationCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ModelFeatureInformation"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Feature Relation request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"featureRelationCreateObject": {
"featureName": "Phraselist1"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the information of the features used by the entity in a version of the application.",
"operationId": "Model_ReplaceEntityFeatures",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/EntityIdInPath"
},
{
"description": "A list of feature information objects containing the new feature relations.",
"in": "body",
"name": "featureRelationsUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/FeaturesPerModelResponseObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Replace Features request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"featureRelationsUpdateObject": [
{
"featureName": "Phraselist1"
},
{
"modelName": "None"
}
],
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/entities/{entityId}/roles": {
"get": {
"operationId": "Model_ListEntityRoles",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity Id",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the entity roles",
"schema": {
"$ref": "#/definitions/EntityRoleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get all roles for an entity in a version of the application",
"x-ms-examples": {
"Successful Get Entity Roles request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_CreateEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity model ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "An entity role object containing the name of role.",
"in": "body",
"name": "entityRoleCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created entity role",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Create an entity role in a version of the application.",
"x-ms-examples": {
"Successful Create Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d",
"entityRoleCreateObject": {
"name": "sample role"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/entities/{entityId}/roles/{roleId}": {
"delete": {
"operationId": "Model_DeleteEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role Id.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Delete an entity role in a version of the application.",
"x-ms-examples": {
"Successful Delete Entity Extractor Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An entity role",
"schema": {
"$ref": "#/definitions/EntityRole"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get one role for a given entity in a version of the application",
"x-ms-examples": {
"Successful Get Entity Extractor Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"name": "role 1"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdateEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
},
{
"description": "The new entity role.",
"in": "body",
"name": "entityRoleUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the entity role.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Update a role for a given entity in a version of the application.",
"x-ms-examples": {
"Successful Update Entity Extractor Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"entityRoleUpdateObject": {
"name": "New Name"
},
"roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/entities/{entityId}/suggest": {
"get": {
"description": "Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.",
"operationId": "Model_ListEntitySuggestions",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The target entity extractor model to enhance.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "If there's no trained entity model, nothing is returned in the response. If there's a trained model and active learning finds any relevant queries, they are returned with the entity model predictions. If there's a trained model but active learning didn't find any relevant queries, an empty list is returned in the response.",
"schema": {
"$ref": "#/definitions/EntitiesSuggestionExamples"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Entity Suggestion Examples": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.65
},
{
"name": "FindAirportByCode",
"score": 0.02
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "hey",
"tokenizedText": [
"hey"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 4,
"entityName": "datetime",
"phrase": "2-2-2017",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 0.88
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "2-2-2017",
"tokenizedText": [
"2",
"-",
"2",
"-",
"2017"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 0.99
},
{
"name": "FindHotels",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "maybe find me an airport first",
"tokenizedText": [
"maybe",
"find",
"me",
"an",
"airport",
"first"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.98
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "as",
"tokenizedText": [
"as"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 3,
"entityName": "Renamed Entity",
"phrase": "barcelona",
"startTokenIndex": 3
},
{
"endTokenIndex": 3,
"entityName": "geography",
"phrase": "barcelona",
"startTokenIndex": 3
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find hotel in barcelona",
"tokenizedText": [
"find",
"hotel",
"in",
"barcelona"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 4,
"entityName": "Code",
"phrase": "atl",
"startTokenIndex": 4
}
],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find airport with code atl",
"tokenizedText": [
"find",
"airport",
"with",
"code",
"atl"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 4,
"entityName": "Renamed Entity",
"phrase": "madrid",
"startTokenIndex": 4
}
],
"intentPredictions": [
{
"name": "FindHotels-ChangeLocation",
"score": 1
},
{
"name": "FindHotels",
"score": 0.24
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "change hotel location to madrid",
"tokenizedText": [
"change",
"hotel",
"location",
"to",
"madrid"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 1
},
{
"name": "FindHotels",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "ok, find me an airport",
"tokenizedText": [
"ok",
",",
"find",
"me",
"an",
"airport"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 0,
"entityName": "Code",
"phrase": "eze",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 0.68
},
{
"name": "None",
"score": 0.29
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "eze",
"tokenizedText": [
"eze"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 0,
"entityName": "datetime",
"phrase": "today",
"startTokenIndex": 0
},
{
"endTokenIndex": 0,
"entityName": "datetime",
"phrase": "today",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 0.64
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "today",
"tokenizedText": [
"today"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.16
},
{
"name": "WeatherInPlace",
"score": 0.07
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "buenos aires",
"tokenizedText": [
"buenos",
"aires"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.37
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "hi there",
"tokenizedText": [
"hi",
"there"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 4,
"entityName": "datetime",
"phrase": "05-28-2017",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 0.85
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "05-28-2017",
"tokenizedText": [
"05",
"-",
"28",
"-",
"2017"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 0,
"entityName": "datetime",
"phrase": "tomorrow",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 0.6
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "tomorrow",
"tokenizedText": [
"tomorrow"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 6,
"entityName": "Renamed Entity",
"phrase": "san francisco",
"startTokenIndex": 5
},
{
"endTokenIndex": 6,
"entityName": "geography",
"phrase": "san francisco",
"startTokenIndex": 5
}
],
"intentPredictions": [
{
"name": "WeatherInPlace",
"score": 0.99
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "tell me the weather in san francisco",
"tokenizedText": [
"tell",
"me",
"the",
"weather",
"in",
"san",
"francisco"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 5,
"entityName": "Renamed Entity",
"phrase": "barcelona",
"startTokenIndex": 5
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find me a hotel in barcelona",
"tokenizedText": [
"find",
"me",
"a",
"hotel",
"in",
"barcelona"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.62
},
{
"name": "FindAirportByCode",
"score": 0.09
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "dme",
"tokenizedText": [
"dme"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.65
},
{
"name": "FindAirportByCode",
"score": 0.02
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "dude",
"tokenizedText": [
"dude"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 5,
"entityName": "Code",
"phrase": "juj",
"startTokenIndex": 5
}
],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 1
},
{
"name": "FindHotels",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "sorry, find me airport juj",
"tokenizedText": [
"sorry",
",",
"find",
"me",
"airport",
"juj"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.52
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "madrid",
"tokenizedText": [
"madrid"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "search for airport",
"tokenizedText": [
"search",
"for",
"airport"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 6,
"entityName": "Renamed Entity",
"phrase": "miami",
"startTokenIndex": 6
},
{
"endTokenIndex": 6,
"entityName": "geography",
"phrase": "miami",
"startTokenIndex": 6
}
],
"intentPredictions": [
{
"name": "TimeInPlace",
"score": 1
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "what's the time in miami?",
"tokenizedText": [
"what",
"'",
"s",
"the",
"time",
"in",
"miami",
"?"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 1,
"entityName": "datetime",
"phrase": "next monday",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 0.3
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "next monday",
"tokenizedText": [
"next",
"monday"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 3,
"entityName": "geography",
"phrase": "seattle",
"startTokenIndex": 3
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "None",
"score": 0.02
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "search hotels, seattle",
"tokenizedText": [
"search",
"hotels",
",",
"seattle"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 3,
"entityName": "Renamed Entity",
"phrase": "madrid",
"startTokenIndex": 3
}
],
"intentPredictions": [
{
"name": "FindHotels-ChangeLocation",
"score": 1
},
{
"name": "None",
"score": 0.03
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "change location to madrid",
"tokenizedText": [
"change",
"location",
"to",
"madrid"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "FindHotels",
"score": 0.99
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "search hotels, \"next day\"",
"tokenizedText": [
"search",
"hotels",
",",
"\"",
"next",
"day",
"\""
]
},
{
"entityPredictions": [
{
"endTokenIndex": 2,
"entityName": "RoomType",
"phrase": "deluxe",
"startTokenIndex": 2
},
{
"endTokenIndex": 7,
"entityName": "Category",
"phrase": "3 stars",
"startTokenIndex": 6
},
{
"endTokenIndex": 10,
"entityName": "Renamed Entity",
"phrase": "barcelona",
"startTokenIndex": 10
},
{
"endTokenIndex": 10,
"entityName": "geography",
"phrase": "barcelona",
"startTokenIndex": 10
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find a deluxe room in a 3 stars hotel in barcelona please",
"tokenizedText": [
"find",
"a",
"deluxe",
"room",
"in",
"a",
"3",
"stars",
"hotel",
"in",
"barcelona",
"please"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "TimeInPlace",
"score": 1
},
{
"name": "None",
"score": 0.14
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "time miami",
"tokenizedText": [
"time",
"miami"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 3,
"entityName": "Renamed Entity",
"phrase": "barcelona",
"startTokenIndex": 3
},
{
"endTokenIndex": 5,
"entityName": "Checkin",
"phrase": "today",
"startTokenIndex": 5
},
{
"endTokenIndex": 5,
"entityName": "datetime",
"phrase": "today",
"startTokenIndex": 5
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find hotel in barcelona from today",
"tokenizedText": [
"find",
"hotel",
"in",
"barcelona",
"from",
"today"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 2,
"entityName": "datetime",
"phrase": "5",
"startTokenIndex": 2
},
{
"endTokenIndex": 3,
"entityName": "Category",
"phrase": "5 start",
"startTokenIndex": 2
},
{
"endTokenIndex": 6,
"entityName": "Renamed Entity",
"phrase": "jujuy",
"startTokenIndex": 6
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "search for 5 start hotels in jujuy",
"tokenizedText": [
"search",
"for",
"5",
"start",
"hotels",
"in",
"jujuy"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 4,
"entityName": "datetime",
"phrase": "tomorrow",
"startTokenIndex": 4
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "None",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "search hotels, past tomorrow",
"tokenizedText": [
"search",
"hotels",
",",
"past",
"tomorrow"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 0,
"entityName": "Code",
"phrase": "loz",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 1
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "loz",
"tokenizedText": [
"loz"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "WeatherInPlace",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "show me the weather",
"tokenizedText": [
"show",
"me",
"the",
"weather"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 0,
"entityName": "Code",
"phrase": "dme",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 0.99
},
{
"name": "None",
"score": 0.04
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "dme airport",
"tokenizedText": [
"dme",
"airport"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 1,
"entityName": "Code",
"phrase": "zzz",
"startTokenIndex": 1
}
],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 1
},
{
"name": "None",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find zzz airport",
"tokenizedText": [
"find",
"zzz",
"airport"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 3,
"entityName": "Renamed Entity",
"phrase": "miami",
"startTokenIndex": 3
},
{
"endTokenIndex": 3,
"entityName": "geography",
"phrase": "miami",
"startTokenIndex": 3
}
],
"intentPredictions": [
{
"name": "FindHotels-ChangeLocation",
"score": 1
},
{
"name": "None",
"score": 0.08
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "change location to miami",
"tokenizedText": [
"change",
"location",
"to",
"miami"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 3,
"entityName": "Checkin",
"phrase": "today",
"startTokenIndex": 3
},
{
"endTokenIndex": 3,
"entityName": "datetime",
"phrase": "today",
"startTokenIndex": 3
},
{
"endTokenIndex": 6,
"entityName": "Checkout",
"phrase": "next monday",
"startTokenIndex": 5
},
{
"endTokenIndex": 6,
"entityName": "datetime",
"phrase": "next monday",
"startTokenIndex": 5
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find hotel from today till next monday",
"tokenizedText": [
"find",
"hotel",
"from",
"today",
"till",
"next",
"monday"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 7,
"entityName": "Code",
"phrase": "bcn",
"startTokenIndex": 7
}
],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 1
},
{
"name": "FindHotels",
"score": 0.02
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "sorry, find me airport with code bcn",
"tokenizedText": [
"sorry",
",",
"find",
"me",
"airport",
"with",
"code",
"bcn"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 5,
"entityName": "Renamed Entity",
"phrase": "aisjj3o9f2",
"startTokenIndex": 5
}
],
"intentPredictions": [
{
"name": "WeatherInPlace",
"score": 0.82
},
{
"name": "FindHotels",
"score": 0.02
},
{
"name": "None",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
}
],
"text": "actionresult = \"weather in aisjj3o9f2\"",
"tokenizedText": [
"actionresult",
"=",
"\"",
"weather",
"in",
"aisjj3o9f2",
"\""
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.06
},
{
"name": "FindHotels",
"score": 0.05
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
}
],
"text": "[object object]",
"tokenizedText": [
"[",
"object",
"object",
"]"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 4,
"entityName": "datetime",
"phrase": "05-27-2017",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 0.84
},
{
"name": "FindHotels",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "05-27-2017",
"tokenizedText": [
"05",
"-",
"27",
"-",
"2017"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "FindHotels-ChangeLocation",
"score": 1
},
{
"name": "FindHotels",
"score": 0.03
},
{
"name": "None",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "change hotel location",
"tokenizedText": [
"change",
"hotel",
"location"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 1
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "asdttt",
"tokenizedText": [
"asdttt"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 4,
"entityName": "Renamed Entity",
"phrase": "miami",
"startTokenIndex": 4
},
{
"endTokenIndex": 4,
"entityName": "geography",
"phrase": "miami",
"startTokenIndex": 4
}
],
"intentPredictions": [
{
"name": "TimeInPlace",
"score": 1
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "whats the time in miami",
"tokenizedText": [
"whats",
"the",
"time",
"in",
"miami"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 2,
"entityName": "Renamed Entity",
"phrase": "brasil",
"startTokenIndex": 2
}
],
"intentPredictions": [
{
"name": "TimeInPlace",
"score": 1
},
{
"name": "None",
"score": 0.01
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "time in brasil",
"tokenizedText": [
"time",
"in",
"brasil"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.65
},
{
"name": "FindAirportByCode",
"score": 0.02
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "mia",
"tokenizedText": [
"mia"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 4,
"entityName": "datetime",
"phrase": "3-3-2017",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 0.87
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "3-3-2017",
"tokenizedText": [
"3",
"-",
"3",
"-",
"2017"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 6,
"entityName": "Renamed Entity",
"phrase": "buenos aires",
"startTokenIndex": 5
},
{
"endTokenIndex": 6,
"entityName": "geography",
"phrase": "buenos aires",
"startTokenIndex": 5
},
{
"endTokenIndex": 6,
"entityName": "geography",
"phrase": "buenos aires",
"startTokenIndex": 5
},
{
"endTokenIndex": 6,
"entityName": "geography",
"phrase": "buenos aires",
"startTokenIndex": 5
}
],
"intentPredictions": [
{
"name": "WeatherInPlace",
"score": 0.97
},
{
"name": "FindHotels",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
}
],
"text": "how is the weather in buenos aires?",
"tokenizedText": [
"how",
"is",
"the",
"weather",
"in",
"buenos",
"aires",
"?"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.98
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "n",
"tokenizedText": [
"n"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 1,
"entityName": "Code",
"phrase": "aaa",
"startTokenIndex": 1
}
],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find aaa airport",
"tokenizedText": [
"find",
"aaa",
"airport"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 2,
"entityName": "Code",
"phrase": "lhr",
"startTokenIndex": 2
}
],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 0.99
},
{
"name": "None",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find airport lhr",
"tokenizedText": [
"find",
"airport",
"lhr"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 0,
"entityName": "Code",
"phrase": "juj",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 1
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "juj",
"tokenizedText": [
"juj"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 1
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "adweqwe",
"tokenizedText": [
"adweqwe"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 3,
"entityName": "Renamed Entity",
"phrase": "madrid",
"startTokenIndex": 3
},
{
"endTokenIndex": 3,
"entityName": "geography",
"phrase": "madrid",
"startTokenIndex": 3
},
{
"endTokenIndex": 5,
"entityName": "Checkin",
"phrase": "today",
"startTokenIndex": 5
},
{
"endTokenIndex": 5,
"entityName": "datetime",
"phrase": "today",
"startTokenIndex": 5
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find hotel in madrid for today",
"tokenizedText": [
"find",
"hotel",
"in",
"madrid",
"for",
"today"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 2,
"entityName": "Code",
"phrase": "zzz",
"startTokenIndex": 2
}
],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 1
},
{
"name": "None",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find airport zzz",
"tokenizedText": [
"find",
"airport",
"zzz"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 5,
"entityName": "datetime",
"phrase": "tomorrow",
"startTokenIndex": 5
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "search hotels, \"past tomorrow\"",
"tokenizedText": [
"search",
"hotels",
",",
"\"",
"past",
"tomorrow",
"\""
]
},
{
"entityPredictions": [
{
"endTokenIndex": 3,
"entityName": "Category",
"phrase": "5 stars",
"startTokenIndex": 2
},
{
"endTokenIndex": 6,
"entityName": "Renamed Entity",
"phrase": "barcelo",
"startTokenIndex": 6
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "search for 5 stars hotels in barcelo",
"tokenizedText": [
"search",
"for",
"5",
"stars",
"hotels",
"in",
"barcelo"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 1
},
{
"name": "None",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "airport",
"tokenizedText": [
"airport"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "FindHotels-ChangeLocation",
"score": 1
},
{
"name": "None",
"score": 0.19
},
{
"name": "FindAirportByCode",
"score": 0.02
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "change location",
"tokenizedText": [
"change",
"location"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 4,
"entityName": "datetime",
"phrase": "11/11/2017",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 0.9
},
{
"name": "FindHotels",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "11/11/2017",
"tokenizedText": [
"11",
"/",
"11",
"/",
"2017"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 6,
"entityName": "Renamed Entity",
"phrase": "new york",
"startTokenIndex": 5
},
{
"endTokenIndex": 6,
"entityName": "geography",
"phrase": "new york",
"startTokenIndex": 5
},
{
"endTokenIndex": 6,
"entityName": "Retrieve Sample List",
"phrase": "new york",
"startTokenIndex": 5
}
],
"intentPredictions": [
{
"name": "WeatherInPlace",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "tell me the weather in new york",
"tokenizedText": [
"tell",
"me",
"the",
"weather",
"in",
"new",
"york"
]
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/example": {
"post": {
"consumes": [
"application/json"
],
"description": "Adds a labeled example utterance in a version of the application.",
"operationId": "Examples_Add",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A labeled example utterance with the expected intent and entities.",
"in": "body",
"name": "exampleLabelObject",
"required": true,
"schema": {
"$ref": "#/definitions/ExampleLabelObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created example utterance.",
"schema": {
"$ref": "#/definitions/LabelExampleResponse"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Label request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"exampleLabelObject": {
"entityLabels": [
{
"endCharIndex": 34,
"entityName": "Place",
"startCharIndex": 21
}
],
"intentName": "WeatherInPlace",
"text": "whats the weather in buenos aires?"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": {
"ExampleId": -11,
"UtteranceText": "whats the weather in buenos aires?"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/examples": {
"get": {
"description": "Returns example utterances to be reviewed from a version of the application.",
"operationId": "Examples_List",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of predictions and label pairs for every example utterance in the application.",
"schema": {
"$ref": "#/definitions/LabeledUtterances"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Review Labeled Examples request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"entityLabels": [
{
"endTokenIndex": 7,
"entityName": "Location",
"startTokenIndex": 7
}
],
"entityPredictions": [
{
"endTokenIndex": 7,
"entityName": "Location",
"phrase": "seattle",
"startTokenIndex": 7
}
],
"id": -12,
"intentLabel": "GetWeather",
"intentPredictions": [
{
"name": "GetWeather",
"score": 1
},
{
"name": "None",
"score": 0.21
},
{
"name": "BookFlight",
"score": 0
}
],
"text": "what's the weather like in seattle?",
"tokenizedText": [
"what",
"'",
"s",
"the",
"weather",
"like",
"in",
"seattle",
"?"
]
},
{
"entityLabels": [
{
"endTokenIndex": 7,
"entityName": "Location",
"role": "To",
"startTokenIndex": 7
},
{
"endTokenIndex": 5,
"entityName": "Location",
"role": "from",
"startTokenIndex": 5
}
],
"entityPredictions": [
{
"endTokenIndex": 9,
"entityName": "datetime",
"phrase": "next thursday",
"startTokenIndex": 8
}
],
"id": -11,
"intentLabel": "BookFlight",
"intentPredictions": [
{
"name": "BookFlight",
"score": 0.93
},
{
"name": "None",
"score": 0.41
},
{
"name": "GetWeather",
"score": 0
}
],
"text": "book me a flight from cairo to redmond next thursday",
"tokenizedText": [
"book",
"me",
"a",
"flight",
"from",
"cairo",
"to",
"redmond",
"next",
"thursday"
]
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a batch of labeled example utterances to a version of the application.",
"operationId": "Examples_Batch",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "Array of example utterances.",
"in": "body",
"name": "exampleLabelObjectArray",
"required": true,
"schema": {
"$ref": "#/definitions/ExampleLabelObjectArray"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "A string array determining which labeled example utterances were added successfully.",
"schema": {
"$ref": "#/definitions/BatchLabelExampleResponse"
}
},
"207": {
"description": "Indicates that the request was partially successful. The response contains a string array indicating the status of each of the added labeled example utterances.",
"schema": {
"$ref": "#/definitions/BatchLabelExampleResponse"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Batch Add Labels request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "2370fb9d-7dbc-4898-a361-a742cf290766",
"exampleLabelObjectArray": [
{
"entityLabels": [
{
"endCharIndex": 29,
"entityName": "Place",
"startCharIndex": 21
}
],
"intentName": "WeatherInPlace",
"text": "whats the weather in seattle?"
},
{
"entityLabels": [
{
"endCharIndex": 34,
"entityName": "Place",
"startCharIndex": 21
}
],
"intentName": "WeatherInPlace",
"text": "whats the weather in buenos aires?"
}
],
"versionId": "0.1"
},
"responses": {
"201": {
"body": [
{
"hasError": false,
"value": {
"ExampleId": -728104,
"UtteranceText": "whats the weather in seattle?"
}
},
{
"hasError": false,
"value": {
"ExampleId": -5313943,
"UtteranceText": "whats the weather in buenos aires?"
}
}
],
"headers": {}
},
"207": {
"body": [
{
"error": {
"code": "FAILED",
"message": "whats the weather in seattle?. Error: The intent classifier InvalidIntent does not exist in the selected application"
},
"hasError": true
},
{
"hasError": false,
"value": {
"ExampleId": -5313943,
"UtteranceText": "whats the weather in buenos aires?"
}
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/examples/{exampleId}": {
"delete": {
"description": "Deletes the labeled example utterances with the specified ID from a version of the application.",
"operationId": "Examples_Delete",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The example ID.",
"in": "path",
"name": "exampleId",
"required": true,
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully deleted example utterance.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Example Label request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"exampleId": -5313926,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/export": {
"get": {
"description": "Exports a LUIS application to JSON format.",
"operationId": "Versions_Export",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The LUIS application structure in JSON format.",
"schema": {
"$ref": "#/definitions/LuisApp"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Export Application Version": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a",
"versionId": "0.2"
},
"responses": {
"200": {
"body": {
"closedLists": [],
"composites": [],
"culture": "en-us",
"desc": "",
"entities": [
{
"name": "AirportCode",
"roles": [
"destination"
]
},
{
"name": "Hotel",
"roles": []
}
],
"intents": [
{
"inherits": {
"domain_name": "HomeAutomation",
"model_name": "TurnOff"
},
"name": "HomeAutomation.TurnOff"
},
{
"name": "dateintent"
},
{
"name": "Help"
},
{
"name": "None"
},
{
"name": "SearchHotels"
},
{
"name": "ShowHotelsReviews"
}
],
"luis_schema_version": "3.0.0",
"model_features": [
{
"activated": true,
"mode": true,
"name": "Near",
"words": "near,around,close,nearby"
},
{
"activated": true,
"mode": true,
"name": "Show",
"words": "show,find,look,search"
}
],
"name": "LuisBot",
"patternAnyEntities": [
{
"explicitList": [],
"name": "patternAny1",
"roles": [
"role1",
"role2"
]
}
],
"patterns": [
{
"intent": "Help",
"pattern": "this is [a test] {patternAny1:role1}"
}
],
"prebuiltEntities": [
{
"name": "datetimeV2",
"roles": [
"datetime role"
]
}
],
"regex_entities": [
{
"name": "regex1",
"regexPattern": "[^a]+",
"roles": [
"regex role"
]
}
],
"regex_features": [
{
"activated": true,
"name": "AirportCodeRegex",
"pattern": "[a-z]{3}"
}
],
"utterances": [
{
"entities": [],
"intent": "Help",
"text": "i need help"
},
{
"entities": [],
"intent": "Help",
"text": "help me"
},
{
"entities": [],
"intent": "dateintent",
"text": "tomorrow"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "search for hotels in seattle"
},
{
"entities": [],
"intent": "Help",
"text": "what can i do?"
},
{
"entities": [],
"intent": "dateintent",
"text": "next monday"
},
{
"entities": [],
"intent": "dateintent",
"text": "next year"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "look for hotels in miami"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "show me hotels in california"
},
{
"entities": [
{
"endPos": 44,
"entity": "Hotel",
"startPos": 23
}
],
"intent": "ShowHotelsReviews",
"text": "show me the reviews of the amazing bot resort"
},
{
"entities": [
{
"endPos": 42,
"entity": "Hotel",
"startPos": 25
}
],
"intent": "ShowHotelsReviews",
"text": "can i see the reviews of extended bot hotel?"
},
{
"entities": [
{
"endPos": 23,
"entity": "Hotel",
"startPos": 16
}
],
"intent": "ShowHotelsReviews",
"text": "find reviews of hotelxya"
},
{
"entities": [
{
"endPos": 35,
"entity": "Hotel",
"startPos": 19
}
],
"intent": "ShowHotelsReviews",
"text": "show me reviews of the amazing hotel"
},
{
"entities": [],
"intent": "Help",
"text": "what are the available options?"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "best hotels in seattle"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "hotels in los angeles"
},
{
"entities": [],
"intent": "SearchHotels",
"text": "can you show me hotels from los angeles?"
},
{
"entities": [
{
"endPos": 56,
"entity": "Hotel",
"startPos": 31
}
],
"intent": "ShowHotelsReviews",
"text": "can you show me the reviews of the amazing resort & hotel"
},
{
"entities": [
{
"endPos": 46,
"entity": "Hotel",
"startPos": 24
}
],
"intent": "ShowHotelsReviews",
"text": "what are the reviews of the hotel bot framework?"
},
{
"entities": [
{
"endPos": 19,
"entity": "AirportCode",
"startPos": 17
}
],
"intent": "SearchHotels",
"text": "find hotels near eze"
},
{
"entities": [
{
"endPos": 24,
"entity": "AirportCode",
"startPos": 22
}
],
"intent": "SearchHotels",
"text": "where can i stay near nnn?"
},
{
"entities": [
{
"endPos": 19,
"entity": "AirportCode",
"startPos": 17
}
],
"intent": "SearchHotels",
"text": "show hotels near att airport"
},
{
"entities": [
{
"endPos": 19,
"entity": "AirportCode",
"startPos": 17
}
],
"intent": "SearchHotels",
"text": "find hotels near agl"
},
{
"entities": [
{
"endPos": 21,
"entity": "AirportCode",
"startPos": 19
}
],
"intent": "SearchHotels",
"text": "find hotels around eze airport"
},
{
"entities": [],
"intent": "dateintent",
"text": "01/7"
}
],
"versionId": "0.1"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/features": {
"get": {
"description": "Gets all the extraction phraselist and pattern features in a version of the application.",
"operationId": "Features_List",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of all phraselist features and a list of all pattern features.",
"schema": {
"$ref": "#/definitions/FeaturesResponseObject"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Features request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"skipIn": 0,
"takeIn": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"patternFeatures": [
{
"enabledForAllModels": true,
"id": 81231,
"isActive": true,
"name": "EmailPattern",
"pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b"
}
],
"phraselistFeatures": [
{
"enabledForAllModels": true,
"id": 5341,
"isActive": true,
"isExchangeable": true,
"name": "Cities",
"phrases": "Seattle,New York,Paris,Moscow,Beijin"
},
{
"enabledForAllModels": true,
"id": 74598,
"isActive": true,
"isExchangeable": true,
"name": "DaysOfWeek",
"phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday"
}
]
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/hierarchicalentities": {
"get": {
"description": "Gets information about all the hierarchical entity models in a version of the application.",
"operationId": "Model_ListHierarchicalEntities",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of hierarchical entity model infos.",
"schema": {
"$ref": "#/definitions/HierarchicalEntityExtractorsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Hierarchical Entity Infos request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"appId": "{appId}",
"skip": 0,
"take": 100,
"versionId": "{versionId}"
},
"responses": {
"200": {
"body": [
{
"children": [
{
"id": "ec076676-d8d9-42fa-a44e-87989c0a2f82",
"name": "From"
},
{
"id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
"name": "To"
}
],
"id": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"name": "Location",
"readableType": "Hierarchical Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 3
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": {
"delete": {
"description": "Deletes a hierarchical entity from a version of the application.",
"operationId": "Model_DeleteHierarchicalEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully deleted entity.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Hierarchical Entity Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{apiKey}",
"appId": "{appId}",
"hEntityId": "{hEntityId}",
"versionId": "{versionId}"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets information about a hierarchical entity in a version of the application.",
"operationId": "Model_GetHierarchicalEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A hierarchical entity model info.",
"schema": {
"$ref": "#/definitions/HierarchicalEntityExtractor"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Hierarchical Entity Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"appId": "{appId}",
"hEntityId": "{hEntityId}",
"versionId": "{versionId}"
},
"responses": {
"200": {
"body": {
"children": [
{
"id": "ec076676-d8d9-42fa-a44e-87989c0a2f82",
"name": "From"
},
{
"id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
"name": "To"
}
],
"id": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"name": "Location",
"readableType": "Hierarchical Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 3
},
"headers": {}
}
}
}
}
},
"patch": {
"consumes": [
"application/json"
],
"description": "Updates the name of a hierarchical entity model in a version of the application.",
"operationId": "Model_UpdateHierarchicalEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
},
{
"description": "Model containing names of the hierarchical entity.",
"in": "body",
"name": "modelUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ModelUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Hierarchical Entity Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"modelUpdateObject": {
"name": "Reservation"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": {
"delete": {
"description": "Deletes a hierarchical entity extractor child in a version of the application.",
"operationId": "Model_DeleteHierarchicalEntityChild",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
},
{
"description": "The hierarchical entity extractor child ID.",
"format": "uuid",
"in": "path",
"name": "hChildId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully deleted entity.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Hierarchical Entity Child Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"hChildId": "fe559c31-9778-42ea-ed45-94e0bd7cf767",
"hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets information about the child's model contained in an hierarchical entity child model in a version of the application.",
"operationId": "Model_GetHierarchicalEntityChild",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
},
{
"description": "The hierarchical entity extractor child ID.",
"format": "uuid",
"in": "path",
"name": "hChildId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The hierarchical entity child model info.",
"schema": {
"$ref": "#/definitions/HierarchicalChildEntity"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Hierarchical Entity Child Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"appId": "{appId}",
"hChildId": "{hChildId}",
"hEntityId": "{hEntityId}",
"versionId": "{versionId}"
},
"responses": {
"200": {
"body": {
"id": "ef278a6c-d94f-4d20-a602-cf53d0acf0f5",
"name": "From",
"readableType": "Hierarchical Child Entity Extractor",
"typeId": 6
},
"headers": {}
}
}
}
}
},
"patch": {
"consumes": [
"application/json"
],
"description": "Renames a single child in an existing hierarchical entity model in a version of the application.",
"operationId": "Model_UpdateHierarchicalEntityChild",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
},
{
"description": "The hierarchical entity extractor child ID.",
"format": "uuid",
"in": "path",
"name": "hChildId",
"required": true,
"type": "string"
},
{
"description": "Model object containing new name of the hierarchical entity child.",
"in": "body",
"name": "hierarchicalChildModelUpdateObject",
"required": true,
"schema": {
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated entity child.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Update Hierarchical Entity Child Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"hChildId": "fe559c31-9778-42ea-ed45-94e0bd7cf767",
"hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"hierarchicalChildModelUpdateObject": {
"name": "Location::To"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles": {
"get": {
"operationId": "Model_ListHierarchicalEntityRoles",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the entity roles",
"schema": {
"$ref": "#/definitions/EntityRoleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get all roles for a hierarchical entity in a version of the application",
"x-ms-examples": {
"Successful Get Hierarchical Entity Roles request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"hEntityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_CreateHierarchicalEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
},
{
"description": "An entity role object containing the name of role.",
"in": "body",
"name": "entityRoleCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created entity role",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Create a role for an hierarchical entity in a version of the application.",
"x-ms-examples": {
"Successful Create Hierarchical Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityRoleCreateObject": {
"name": "sample role"
},
"hEntityId": "fc821c4e-a2f8-4074-9410-7271b38a692d",
"versionId": "0.1"
},
"responses": {
"201": {
"body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/hierarchicalentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles/{roleId}": {
"delete": {
"operationId": "Model_DeleteHierarchicalEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
},
{
"description": "The entity role Id.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Delete a role for a given hierarchical role in a version of the application.",
"x-ms-examples": {
"Successful Delete Hierarchical Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetHierarchicalEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
},
{
"description": "entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An entity role",
"schema": {
"$ref": "#/definitions/EntityRole"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get one role for a given hierarchical entity in a version of the application.",
"x-ms-examples": {
"Successful Get Hierarchical Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"name": "role 1"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdateHierarchicalEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
},
{
"description": "The entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
},
{
"description": "The new entity role.",
"in": "body",
"name": "entityRoleUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the entity role.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Update a role for a given hierarchical entity in a version of the application.",
"x-ms-examples": {
"Successful Update Hierarchical Entity Extractor Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityRoleUpdateObject": {
"name": "New Name"
},
"hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/intents": {
"get": {
"description": "Gets information about the intent models in a version of the application.",
"operationId": "Model_ListIntents",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of intent model infos.",
"schema": {
"$ref": "#/definitions/IntentClassifiersList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Intent Infos request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"skip": 0,
"take": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8",
"name": "BookFlight",
"readableType": "Intent Classifier",
"typeId": 0
},
{
"id": "8285a9ee-6bc0-4409-87f4-82d539f70529",
"name": "None",
"readableType": "Intent Classifier",
"typeId": 0
},
{
"customPrebuiltDomainName": "Camera",
"customPrebuiltModelName": "CapturePhoto",
"id": "9500536f-ffec-4fab-93ad-6268abb0f73c",
"name": "$Camera.CapturePhoto",
"readableType": "Intent Classifier",
"typeId": 0
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds an intent to a version of the application.",
"operationId": "Model_AddIntent",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model object containing the name of the new intent.",
"in": "body",
"name": "intentCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ModelCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created intent model.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Create Intent Classifier request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"intentCreateObject": {
"name": "BookFlight"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/intents/{intentId}": {
"delete": {
"description": "Deletes an intent from a version of the application.",
"operationId": "Model_DeleteIntent",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
},
{
"default": false,
"description": "If true, deletes the intent's example utterances. If false, moves the example utterances to the None intent. The default value is false.",
"in": "query",
"name": "deleteUtterances",
"type": "boolean"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Intent Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets information about the intent model in a version of the application.",
"operationId": "Model_GetIntent",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An intent model info.",
"schema": {
"$ref": "#/definitions/IntentClassifier"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Intent Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "8285a9ee-6bc0-4409-87f4-82d539f70529",
"name": "TestIntent",
"readableType": "Intent Classifier",
"typeId": 0
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the name of an intent in a version of the application.",
"operationId": "Model_UpdateIntent",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
},
{
"description": "A model object containing the new intent name.",
"in": "body",
"name": "modelUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ModelUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Rename Intent Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"modelUpdateObject": {
"name": "newTest"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/intents/{intentId}/features": {
"delete": {
"description": "Deletes a relation from the feature relations used by the intent in a version of the application.",
"operationId": "Model_DeleteIntentFeature",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
},
{
"description": "A feature information object containing the feature relation to delete.",
"in": "body",
"name": "featureRelationDeleteObject",
"required": true,
"schema": {
"$ref": "#/definitions/ModelFeatureInformation"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete feature relation request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"featureRelationDeleteObject": {
"featureName": "Phraselist1"
},
"intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets the information of the features used by the intent in a version of the application.",
"operationId": "Model_GetIntentFeatures",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of feature information objects for the intent.",
"schema": {
"$ref": "#/definitions/FeaturesPerModelResponseObject"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Features information request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"featureName": "Phraselist1"
},
{
"modelName": "None"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a new feature relation to be used by the intent in a version of the application.",
"operationId": "Features_AddIntentFeature",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
},
{
"description": "A Feature relation information object.",
"in": "body",
"name": "featureRelationCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ModelFeatureInformation"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Feature Relation request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"featureRelationCreateObject": {
"featureName": "Phraselist1"
},
"intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the information of the features used by the intent in a version of the application.",
"operationId": "Model_ReplaceIntentFeatures",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
},
{
"description": "A list of feature information objects containing the new feature relations.",
"in": "body",
"name": "featureRelationsUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/FeaturesPerModelResponseObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Replace Features request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"featureRelationsUpdateObject": [
{
"featureName": "Phraselist1"
},
{
"modelName": "None"
}
],
"intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/intents/{intentId}/patternrules": {
"get": {
"operationId": "Pattern_ListIntentPatterns",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The retrieved patterns",
"schema": {
"$ref": "#/definitions/PatternRuleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Returns patterns for the specific intent in a version of the application.",
"x-ms-examples": {
"Successful Get Intent Patterns request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"intentId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d",
"skip": 0,
"take": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"intent": "report to",
"pattern": "who's {Name} reporting to?"
},
{
"id": "58077d3a-4bbb-47ba-8aa9-31c0ead0bf08",
"intent": "report to",
"pattern": "who's reporting to {Name}?"
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/intents/{intentId}/suggest": {
"get": {
"description": "Suggests example utterances that would improve the accuracy of the intent model in a version of the application.",
"operationId": "Model_ListIntentSuggestions",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "If there's no trained intent model, nothing is returned in the response. If there's a trained model and active learning finds any relevant queries, they are returned with the intent model predictions. If there's a trained model but active learning didn't find any relevant queries, an empty list is returned in the response.",
"schema": {
"$ref": "#/definitions/IntentsSuggestionExamples"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Intents Suggestion Examples": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"intentId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.65
},
{
"name": "FindAirportByCode",
"score": 0.02
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "hey",
"tokenizedText": [
"hey"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 4,
"entityName": "datetime",
"phrase": "2-2-2017",
"startTokenIndex": 0
}
],
"intentPredictions": [
{
"name": "None",
"score": 0.88
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "2-2-2017",
"tokenizedText": [
"2",
"-",
"2",
"-",
"2017"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "FindAirportByCode",
"score": 0.99
},
{
"name": "FindHotels",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "maybe find me an airport first",
"tokenizedText": [
"maybe",
"find",
"me",
"an",
"airport",
"first"
]
},
{
"entityPredictions": [],
"intentPredictions": [
{
"name": "None",
"score": 0.98
},
{
"name": "FindAirportByCode",
"score": 0.01
},
{
"name": "WeatherInPlace",
"score": 0.01
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "FindHotels",
"score": 0
}
],
"text": "as",
"tokenizedText": [
"as"
]
},
{
"entityPredictions": [
{
"endTokenIndex": 3,
"entityName": "Renamed Entity",
"phrase": "barcelona",
"startTokenIndex": 3
},
{
"endTokenIndex": 3,
"entityName": "geography",
"phrase": "barcelona",
"startTokenIndex": 3
}
],
"intentPredictions": [
{
"name": "FindHotels",
"score": 1
},
{
"name": "TimeInPlace",
"score": 0
},
{
"name": "None",
"score": 0
},
{
"name": "FindAirportByCode",
"score": 0
},
{
"name": "FindHotels-ChangeLocation",
"score": 0
},
{
"name": "WeatherInPlace",
"score": 0
}
],
"text": "find hotel in barcelona",
"tokenizedText": [
"find",
"hotel",
"in",
"barcelona"
]
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/listprebuilts": {
"get": {
"description": "Gets all the available prebuilt entities in a version of the application.",
"operationId": "Model_ListPrebuiltEntities",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the possible prebuilt entity extractors.",
"schema": {
"$ref": "#/definitions/AvailablePrebuiltEntityModels"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Available Prebuilt Entity Extractors request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"skip": 0,
"take": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"description": "Continents, Countries, Cities, Post codes, and other points of interest",
"examples": "Antarctica, Portugal, Dubai, Sanjiang County, Lake Pontchartrain, CB3 0DS",
"name": "geography"
},
{
"description": "Dates and times, resolved to a canonical form",
"examples": "June 23, 1976, Jul 11 2012, 7 AM, 6:49 PM, tomorrow at 7 AM",
"name": "datetime"
},
{
"description": "Email Addresses",
"examples": "user@site.net, user_name@mysite.com.eg",
"name": "email"
},
{
"description": "Websites URLs",
"examples": "www.website.com, http://website.net?name=my_name&age=10, https://www.mywebsite.net.eg/page",
"name": "url"
},
{
"description": "US phone numbers",
"examples": "123-456-7890, +1 123 456 789, (123)456-789",
"name": "phoneNumber"
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/models": {
"get": {
"description": "Gets information about all the intent and entity models in a version of the application.",
"operationId": "Model_ListModels",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of application model infos.",
"schema": {
"$ref": "#/definitions/ModelsInfoResponseObject"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Model Infos request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"skip": 0,
"take": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8",
"name": "BookFlight",
"readableType": "Intent Classifier",
"typeId": 0
},
{
"id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e",
"name": "datetime",
"readableType": "Prebuilt Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 2
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "DayOfWeek",
"readableType": "Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 1
},
{
"children": [
{
"id": "ec076676-d8d9-42fa-a44e-87989c0a2f82",
"name": "From"
},
{
"id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
"name": "To"
}
],
"id": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"name": "Location",
"readableType": "Hierarchical Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 3
},
{
"id": "8285a9ee-6bc0-4409-87f4-82d539f70529",
"name": "None",
"readableType": "Intent Classifier",
"typeId": 0
},
{
"children": [
{
"id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
"name": "Location::To"
},
{
"id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e",
"name": "datetime"
}
],
"id": "bc1bae43-7904-48ad-a165-88b1910174f9",
"name": "Reservation",
"readableType": "Composite Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 4
},
{
"id": "8713b104-78ec-4c4f-9f96-f2e53562cc16",
"name": "States",
"readableType": "Closed List Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"subLists": [
{
"canonicalForm": "new york",
"id": 1,
"list": [
"ny",
"new york"
]
},
{
"canonicalForm": "washington",
"id": 2,
"list": [
"washington",
"wa"
]
},
{
"canonicalForm": "california",
"id": 3,
"list": [
"california",
"ca",
"calif.",
"cal."
]
}
],
"typeId": 5
},
{
"customPrebuiltDomainName": "Camera",
"customPrebuiltModelName": "AppName",
"id": "b8e31be4-300f-455e-894b-6f079abca0a2",
"name": "$Camera.AppName",
"readableType": "Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 1
},
{
"customPrebuiltDomainName": "Camera",
"customPrebuiltModelName": "CapturePhoto",
"id": "9500536f-ffec-4fab-93ad-6268abb0f73c",
"name": "$Camera.CapturePhoto",
"readableType": "Intent Classifier",
"typeId": 0
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/models/{modelId}/examples": {
"get": {
"description": "Gets the example utterances for the given intent or entity model in a version of the application.",
"operationId": "Model_Examples",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The ID (GUID) of the model.",
"in": "path",
"name": "modelId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of example utterances for the model.",
"schema": {
"$ref": "#/definitions/ExamplesPerModelResponseObject"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Examples Per Model Request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"modelId": "e4770e43-233a-48ad-a1fa-54f4f97eff9f",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": 10002,
"text": "Lorem ipsum dolor sit amet"
},
{
"id": 10003,
"text": "consectetur adipiscing elit"
},
{
"id": 10004,
"text": "sed do eiusmod tempor incididunt"
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/patternanyentities": {
"get": {
"operationId": "Model_ListPatternAnyEntityInfos",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of Pattern.Any entity model infos.",
"schema": {
"$ref": "#/definitions/PatternAnyEntityExtractorList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get information about the Pattern.Any entity models in a version of the application.",
"x-ms-examples": {
"Successful Create Regex Entity Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"skip": 0,
"take": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"explicitList": [
{
"explicitListItem": "item 1",
"id": 456
},
{
"explicitListItem": "item 2",
"id": 457
}
],
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "any 1",
"readableType": "Pattern.Any Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 7
},
{
"explicitList": [],
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "any 2",
"readableType": "Pattern.Any Entity Extractor",
"roles": [],
"typeId": 7
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_CreatePatternAnyEntityModel",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model object containing the name and explicit list for the new Pattern.Any entity extractor.",
"in": "body",
"name": "extractorCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/PatternAnyModelCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created Pattern.Any entity model.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Adds a pattern.any entity extractor to a version of the application.",
"x-ms-examples": {
"Successful Create Regex Entity Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"extractorCreateObject": {
"explicitList": [
"item 1",
"item 2"
],
"name": "AirportCodeRegex"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "bc1bae43-7904-48ad-a165-88b1910174f9",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}": {
"delete": {
"operationId": "Model_DeletePatternAnyEntityModel",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The Pattern.Any entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Deletes a Pattern.Any entity extractor from a version of the application.",
"x-ms-examples": {
"Successful Delete Pattern.Any Entity request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetPatternAnyEntityInfo",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A regular expression entity model info.",
"schema": {
"$ref": "#/definitions/PatternAnyEntityExtractor"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Gets information about the Pattern.Any model in a version of the application.",
"x-ms-examples": {
"Successful Get Pattern.Any Entity request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"explicitList": [
{
"explicitListItem": "item 1",
"id": 456
},
{
"explicitListItem": "item 2",
"id": 457
}
],
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "any",
"readableType": "Pattern.Any Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 7
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdatePatternAnyEntityModel",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The Pattern.Any entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "An object containing the explicit list of the Pattern.Any entity.",
"in": "body",
"name": "patternAnyUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/PatternAnyModelUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the Pattern.Any entity extractor.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application.",
"x-ms-examples": {
"Successful Update Pattern.Any Entity request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"patternAnyUpdateObject": {
"explicitList": [
"item1",
"item2"
],
"name": "New Name"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist": {
"get": {
"operationId": "Model_GetExplicitList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The Pattern.Any entity id.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the explicit list items",
"schema": {
"$ref": "#/definitions/ExplicitListItemList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get the explicit (exception) list of the pattern.any entity in a version of the application.",
"x-ms-examples": {
"Successful Get Explicit List request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"explicitListItem": "item 1",
"id": 48674
},
{
"explicitListItem": "item 2",
"id": 76451
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_AddExplicitListItem",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The Pattern.Any entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The new explicit list item.",
"in": "body",
"name": "item",
"required": true,
"schema": {
"$ref": "#/definitions/ExplicitListItemCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created explicit list item.",
"schema": {
"$ref": "#/definitions/ExplicitListItemIDResponse"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.",
"x-ms-examples": {
"Successful Create Custom Prebuilt Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d",
"item": {
"explicitListItem": "item 1"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": 8645,
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/patternanyentities/fc821c4e-a2f8-4074-9410-7271b38a692d/explicitlist/8645"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist/{itemId}": {
"delete": {
"operationId": "Model_DeleteExplicitListItem",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The pattern.any entity id.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The explicit list item which will be deleted.",
"format": "int64",
"in": "path",
"name": "itemId",
"required": true,
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application.",
"x-ms-examples": {
"Successful Delete Pattern.Any Explicit List Item request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"itemId": 543211,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetExplicitListItem",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The Pattern.Any entity Id.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The explicit list item Id.",
"format": "int64",
"in": "path",
"name": "itemId",
"required": true,
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An explicit list item info.",
"schema": {
"$ref": "#/definitions/ExplicitListItem"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get the explicit (exception) list of the pattern.any entity in a version of the application.",
"x-ms-examples": {
"Successful Get Pattern.Any Explicit List Item request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a",
"itemId": 76451,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"explicitListItem": "item 2",
"id": 76451
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdateExplicitListItem",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The Pattern.Any entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The explicit list item ID.",
"format": "int64",
"in": "path",
"name": "itemId",
"required": true,
"type": "integer"
},
{
"description": "The new explicit list item.",
"in": "body",
"name": "item",
"required": true,
"schema": {
"$ref": "#/definitions/ExplicitListItemUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the explicit list item.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.",
"x-ms-examples": {
"Successful Update Pattern.Any Entity Explicit List Item request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"item": {
"explicitListItem": "new item"
},
"itemId": 53435,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles": {
"get": {
"operationId": "Model_ListPatternAnyEntityRoles",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity Id",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the entity roles",
"schema": {
"$ref": "#/definitions/EntityRoleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get all roles for a Pattern.any entity in a version of the application",
"x-ms-examples": {
"Successful Get Pattern.Any Entity Roles request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_CreatePatternAnyEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity model ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "An entity role object containing the name of role.",
"in": "body",
"name": "entityRoleCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created entity role",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Create a role for an Pattern.any entity in a version of the application.",
"x-ms-examples": {
"Successful Create Pattern.Any Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d",
"entityRoleCreateObject": {
"name": "sample role"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/patternanyentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles/{roleId}": {
"delete": {
"operationId": "Model_DeletePatternAnyEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role Id.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Delete a role for a given Pattern.any entity in a version of the application.",
"x-ms-examples": {
"Successful Delete Pattern.Any Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetPatternAnyEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An entity role",
"schema": {
"$ref": "#/definitions/EntityRole"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get one role for a given Pattern.any entity in a version of the application.",
"x-ms-examples": {
"Successful Get Pattern.Any Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"name": "role 1"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdatePatternAnyEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
},
{
"description": "The new entity role.",
"in": "body",
"name": "entityRoleUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the entity role.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Update a role for a given Pattern.any entity in a version of the application.",
"x-ms-examples": {
"Successful Update Pattern.Any Entity Extractor Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"entityRoleUpdateObject": {
"name": "New Name"
},
"roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/patternrule": {
"post": {
"consumes": [
"application/json"
],
"operationId": "Pattern_AddPattern",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The input pattern.",
"in": "body",
"name": "pattern",
"required": true,
"schema": {
"$ref": "#/definitions/PatternRuleCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The created pattern",
"schema": {
"$ref": "#/definitions/PatternRuleInfo"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Adds a pattern to a version of the application.",
"x-ms-examples": {
"Successful Add Pattern request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"pattern": {
"intent": "report to",
"pattern": "Who's {Name} reporting to?"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": {
"id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"intent": "report to",
"pattern": "who's {Name} reporting to?"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/patternrules": {
"delete": {
"consumes": [
"application/json"
],
"operationId": "Pattern_DeletePatterns",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The patterns IDs.",
"in": "body",
"name": "patternIds",
"required": true,
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Deletes a list of patterns in a version of the application.",
"x-ms-examples": {
"Successful Batch Delete Patterns request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"patternIds": [
"cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"2126479d-2a98-4d06-a65e-b8799df2dd53"
],
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Pattern_ListPatterns",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The retrieved patterns",
"schema": {
"$ref": "#/definitions/PatternRuleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Gets patterns in a version of the application.",
"x-ms-examples": {
"Successful Get Application Version Patterns request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"skip": 0,
"take": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"intent": "report to",
"pattern": "who's {Name} reporting to?"
},
{
"id": "58077d3a-4bbb-47ba-8aa9-31c0ead0bf08",
"intent": "report to",
"pattern": "who's reporting to {Name}?"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Pattern_BatchAddPatterns",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A JSON array containing patterns.",
"in": "body",
"name": "patterns",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/PatternRuleCreateObject"
},
"type": "array"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The created patterns",
"schema": {
"$ref": "#/definitions/PatternRuleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Adds a batch of patterns in a version of the application.",
"x-ms-examples": {
"Successful Batch Add Patterns request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "2370fb9d-7dbc-4898-a361-a742cf290766",
"patterns": [
{
"intent": "report to",
"pattern": "Who's {Name} reporting to?"
},
{
"intent": "report to",
"pattern": "Who's {Name} reporting to?"
}
],
"versionId": "0.1"
},
"responses": {
"201": {
"body": [
{
"id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"intent": "report to",
"pattern": "who's {Name} reporting to?"
},
{
"id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"intent": "report to",
"pattern": "who's {Name} reporting to?"
}
],
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Pattern_UpdatePatterns",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "An array represents the patterns.",
"in": "body",
"name": "patterns",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/PatternRuleUpdateObject"
},
"type": "array"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The updated patterns",
"schema": {
"$ref": "#/definitions/PatternRuleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Updates patterns in a version of the application.",
"x-ms-examples": {
"Successful Batch Update Patterns request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"patterns": [
{
"id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"intent": "report to",
"pattern": "Who's {Name} reporting to?"
},
{
"id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"intent": "report to",
"pattern": "Who's {Name} reporting to?"
}
],
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"intent": "report to",
"pattern": "who's {Name} reporting to?"
},
{
"id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"intent": "report to",
"pattern": "who's {Name} reporting to?"
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/patternrules/{patternId}": {
"delete": {
"operationId": "Pattern_DeletePattern",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The pattern ID.",
"format": "uuid",
"in": "path",
"name": "patternId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Deletes the pattern with the specified ID from a version of the application..",
"x-ms-examples": {
"Successful Delete Pattern request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"patternId": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Pattern_UpdatePattern",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The pattern ID.",
"format": "uuid",
"in": "path",
"name": "patternId",
"required": true,
"type": "string"
},
{
"description": "An object representing a pattern.",
"in": "body",
"name": "pattern",
"required": true,
"schema": {
"$ref": "#/definitions/PatternRuleUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The updated pattern",
"schema": {
"$ref": "#/definitions/PatternRuleInfo"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Updates a pattern in a version of the application.",
"x-ms-examples": {
"Successful Update Pattern request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"pattern": {
"intent": "report to",
"pattern": "Who's {Name} reporting to?"
},
"patternId": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
"intent": "report to",
"pattern": "who's {Name} reporting to?"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/phraselists": {
"get": {
"description": "Gets all the phraselist features in a version of the application.",
"operationId": "Features_ListPhraseLists",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of all phraselist features.",
"schema": {
"$ref": "#/definitions/PhraseListFeatureInfoList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Phraselist Features request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"enabledForAllModels": true,
"id": 321421,
"isActive": true,
"isExchangeable": true,
"name": "Cities",
"phrases": "Seattle,New York,Paris,Moscow,Beijin"
},
{
"enabledForAllModels": true,
"id": 97832,
"isActive": true,
"isExchangeable": true,
"name": "DaysOfWeek",
"phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Creates a new phraselist feature in a version of the application.",
"operationId": "Features_AddPhraseList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A Phraselist object containing Name, comma-separated Phrases and the isExchangeable boolean. Default value for isExchangeable is true.",
"in": "body",
"name": "phraselistCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/PhraselistCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created feature.",
"schema": {
"$ref": "#/definitions/FeatureIDResponse"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Create Phraselist Feature request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"phraselistCreateObject": {
"isExchangeable": true,
"name": "DaysOfWeek",
"phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": 1823,
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}": {
"delete": {
"description": "Deletes a phraselist feature from a version of the application.",
"operationId": "Features_DeletePhraseList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The ID of the feature to be deleted.",
"in": "path",
"name": "phraselistId",
"required": true,
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully deleted phraselist.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Phraselist Feature Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"phraselistId": 178384,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets phraselist feature info in a version of the application.",
"operationId": "Features_GetPhraseList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The ID of the feature to be retrieved.",
"in": "path",
"name": "phraselistId",
"required": true,
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A phraselist feature info.",
"schema": {
"$ref": "#/definitions/PhraseListFeatureInfo"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Phraselist Feature Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"phraselistId": 178384,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"enabledForAllModels": true,
"id": 178384,
"isActive": true,
"isExchangeable": true,
"name": "DaysOfWeek",
"phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the phrases, the state and the name of the phraselist feature in a version of the application.",
"operationId": "Features_UpdatePhraseList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The ID of the feature to be updated.",
"in": "path",
"name": "phraselistId",
"required": true,
"type": "integer"
},
{
"description": "The new values for: - Just a boolean called IsActive, in which case the status of the feature will be changed. - Name, Pattern, Mode, and a boolean called IsActive to update the feature.",
"in": "body",
"name": "phraselistUpdateObject",
"schema": {
"$ref": "#/definitions/PhraselistUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated phraselist.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Update Phraselist Feature Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"phraselistId": 178384,
"phraselistUpdateObject": {
"enabledForAllModels": false,
"isActive": false,
"isExchangeable": true,
"name": "DaysOfWeek",
"phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/prebuilts": {
"get": {
"description": "Gets information about all the prebuilt entities in a version of the application.",
"operationId": "Model_ListPrebuilts",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of prebuilt entity models infos.",
"schema": {
"$ref": "#/definitions/PrebuiltEntityExtractorsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Prebuilt Infos request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"skip": 0,
"take": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e",
"name": "datetime",
"readableType": "Prebuilt Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 2
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a list of prebuilt entities to a version of the application.",
"operationId": "Model_AddPrebuilt",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "An array of prebuilt entity extractor names.",
"in": "body",
"name": "prebuiltExtractorNames",
"required": true,
"schema": {
"$ref": "#/definitions/PrebuiltExtractorNames"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "An array of the created prebuilt extractor infos.",
"schema": {
"$ref": "#/definitions/PrebuiltEntityExtractorsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Application Version Prebuilt Infos request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"prebuiltExtractorNames": [
"datetimeV2"
],
"versionId": "0.1"
},
"responses": {
"201": {
"body": [
{
"id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e",
"name": "datetime",
"readableType": "Prebuilt Entity Extractor",
"typeId": 2
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles": {
"get": {
"operationId": "Model_ListPrebuiltEntityRoles",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity Id",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the entity roles",
"schema": {
"$ref": "#/definitions/EntityRoleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get a prebuilt entity's roles in a version of the application.",
"x-ms-examples": {
"Successful Get Prebuilt Entity Roles request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_CreatePrebuiltEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity model ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "An entity role object containing the name of role.",
"in": "body",
"name": "entityRoleCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created entity role",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Create a role for a prebuilt entity in a version of the application.",
"x-ms-examples": {
"Successful Create Prebuilt Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d",
"entityRoleCreateObject": {
"name": "sample role"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/prebuilts/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles/{roleId}": {
"delete": {
"operationId": "Model_DeletePrebuiltEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role Id.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Delete a role in a prebuilt entity in a version of the application.",
"x-ms-examples": {
"Successful Delete Prebuilt Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetPrebuiltEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An entity role",
"schema": {
"$ref": "#/definitions/EntityRole"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get one role for a given prebuilt entity in a version of the application",
"x-ms-examples": {
"Successful Get Prebuilt Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"name": "role 1"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdatePrebuiltEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
},
{
"description": "The new entity role.",
"in": "body",
"name": "entityRoleUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the entity role.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Update a role for a given prebuilt entity in a version of the application",
"x-ms-examples": {
"Successful Update Prebuilt Entity Extractor Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"entityRoleUpdateObject": {
"name": "New Name"
},
"roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": {
"delete": {
"description": "Deletes a prebuilt entity extractor from a version of the application.",
"operationId": "Model_DeletePrebuilt",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The prebuilt entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "prebuiltId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Prebuilt Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"prebuiltId": "a065c863-918e-4c56-a267-9aaae3c7dced",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"description": "Gets information about a prebuilt entity model in a version of the application.",
"operationId": "Model_GetPrebuilt",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The prebuilt entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "prebuiltId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A prebuilt entity models info.",
"schema": {
"$ref": "#/definitions/PrebuiltEntityExtractor"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Prebuilt Info request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"prebuiltId": "a065c863-918e-4c56-a267-9aaae3c7dced",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "a065c863-918e-4c56-a267-9aaae3c7dced",
"name": "datetimeV2",
"readableType": "Prebuilt Entity Extractor",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 2
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/regexentities": {
"get": {
"operationId": "Model_ListRegexEntityInfos",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of regular expression entity model infos.",
"schema": {
"$ref": "#/definitions/RegexEntityExtractorList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Gets information about the regular expression entity models in a version of the application.",
"x-ms-examples": {
"Successful Get Regex Entity Models request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"skip": 0,
"take": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "AirportCodeRegex",
"readableType": "Regex Entity Extractor",
"regexPattern": "[a-z]{3}",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 8
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "Guid regex",
"readableType": "Regex Entity Extractor",
"regexPattern": "[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{3}-[0-9A-F]{12}",
"roles": [],
"typeId": 8
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_CreateRegexEntityModel",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model object containing the name and regex pattern for the new regular expression entity extractor.",
"in": "body",
"name": "regexEntityExtractorCreateObj",
"required": true,
"schema": {
"$ref": "#/definitions/RegexModelCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created model.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Adds a regular expression entity model to a version of the application.",
"x-ms-examples": {
"Successful Create Regex Entity Model request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "{API key}",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"regexEntityExtractorCreateObj": {
"name": "AirportCodeRegex",
"regexPattern": "[a-z]{3}"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "bc1bae43-7904-48ad-a165-88b1910174f9",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles": {
"get": {
"operationId": "Model_ListRegexEntityRoles",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity Id",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the entity roles",
"schema": {
"$ref": "#/definitions/EntityRoleList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get all roles for a regular expression entity in a version of the application.",
"x-ms-examples": {
"Successful Get Regex Entity Roles request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"operationId": "Model_CreateRegexEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity model ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "An entity role object containing the name of role.",
"in": "body",
"name": "entityRoleCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created entity role",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Create a role for an regular expression entity in a version of the application.",
"x-ms-examples": {
"Successful Create Regex Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d",
"entityRoleCreateObject": {
"name": "sample role"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/regexentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73"
}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles/{roleId}": {
"delete": {
"operationId": "Model_DeleteRegexEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role Id.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Delete a role for a given regular expression in a version of the application.",
"x-ms-examples": {
"Successful Delete Regex Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetRegexEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "An entity role",
"schema": {
"$ref": "#/definitions/EntityRole"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Get one role for a given regular expression entity in a version of the application.",
"x-ms-examples": {
"Successful Get Regex Entity Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "a682a962-1f92-4ae7-b8b8-398414e30c12",
"name": "role 1"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdateRegexEntityRole",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The entity ID.",
"format": "uuid",
"in": "path",
"name": "entityId",
"required": true,
"type": "string"
},
{
"description": "The entity role ID.",
"format": "uuid",
"in": "path",
"name": "roleId",
"required": true,
"type": "string"
},
{
"description": "The new entity role.",
"in": "body",
"name": "entityRoleUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/EntityRoleUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the entity role.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Update a role for a given regular expression entity in a version of the application",
"x-ms-examples": {
"Successful Update Regex Entity Extractor Role request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"entityRoleUpdateObject": {
"name": "New Name"
},
"roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/regexentities/{regexEntityId}": {
"delete": {
"operationId": "Model_DeleteRegexEntityModel",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The regular expression entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "regexEntityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Deletes a regular expression entity from a version of the application.",
"x-ms-examples": {
"Successful Delete Regex Entity request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"regexEntityId": "a065c863-918e-4c56-a267-9aaae3c7dced",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"operationId": "Model_GetRegexEntityEntityInfo",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The regular expression entity model ID.",
"format": "uuid",
"in": "path",
"name": "regexEntityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A regular expression entity model info.",
"schema": {
"$ref": "#/definitions/RegexEntityExtractor"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Gets information about a regular expression entity in a version of the application.",
"x-ms-examples": {
"Successful Get Regex Entity request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"regexEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "AirportCodeRegex",
"readableType": "Regex Entity Extractor",
"regexPattern": "[a-z]{3}",
"roles": [
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 1"
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "role 2"
}
],
"typeId": 8
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"operationId": "Model_UpdateRegexEntityModel",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The regular expression entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "regexEntityId",
"required": true,
"type": "string"
},
{
"description": "An object containing the new entity name and regex pattern.",
"in": "body",
"name": "regexEntityUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/RegexModelUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated the regular expression entity extractor.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "Updates the regular expression entity in a version of the application.",
"x-ms-examples": {
"Successful Update Regex Entity request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"regexEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"regexEntityUpdateObject": {
"name": "New Name",
"regexPattern": "[a-z]{3}"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/settings": {
"get": {
"description": "Gets the settings in a version of the application.",
"operationId": "Settings_List",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of the application version settings.",
"schema": {
"items": {
"$ref": "#/definitions/AppVersionSettingObject"
},
"type": "array"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version settings request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"name": "UseAllTrainingData",
"value": "false"
}
],
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the settings in a version of the application.",
"operationId": "Settings_Update",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A list of the updated application version settings.",
"in": "body",
"name": "listOfAppVersionSettingObject",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/AppVersionSettingObject"
},
"type": "array"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Update Application Version settings request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"listOfAppVersionSettingObject": [
{
"name": "UseAllTrainingData",
"value": "false"
}
],
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/suggest": {
"delete": {
"consumes": [
"application/json"
],
"description": "Deleted an unlabelled utterance in a version of the application.",
"operationId": "Versions_DeleteUnlabelledUtterance",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The utterance text to delete.",
"in": "body",
"name": "utterance",
"required": true,
"schema": {
"type": "string"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful operation.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Unlabelled Utterance": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"utterance": "dummy text",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/train": {
"get": {
"description": "Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status. \"appID\" specifies the LUIS app ID. \"versionId\" specifies the version number of the LUIS app. For example, \"0.1\".",
"operationId": "Train_GetStatus",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json",
"JSON"
],
"responses": {
"200": {
"description": "A successful response provides an array of training status details for a LUIS app that you submitted for training. Each element in the response array provides training status for a model (intent or entity) in the LUIS app. Note: Training status is not provided for prebuilt entities because they are pretrained. The \"modelId\" property identifies which intent or entity the training status corresponds to. To get the name and type of each model, use the models API which has a request URL in this format: https://westus.api.cognitive.microsoft.com/luis/api/v3.0-preview/apps/{appId}/versions/{versionId}/models The details property for each model can contain the following fields: \"statusId\": An integer from 0 to 3 that corresponds to the value of the status field. \"status\": A string with one of the following values: \"Success\", \"UpToDate\", \"InProgress\", \"Fail\". If the status is \"Fail\", the \"failureReason\" property provides the reason for failure. \"exampleCount\": The number of examples used for training. In the case of the None intent or prebuilt domain intents and entities, this number includes example provided internally by the system as well as examples you added to your LUIS app. \"failureReason\": A string that indicates the reason training failed. The value \"FewLabels\" means that no labeled example utterances were provided for training. \"trainingDateTime\": A string indicating the time the model was last trained. The value uses the ISO 8601 format for representing times in UTC (Coordinated Universal Time) with a UTC designator (\"Z\"), for example: \"2017-08-10T01:08:34Z\".",
"schema": {
"$ref": "#/definitions/ModelTrainingInfoList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Training Status request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"details": {
"exampleCount": 0,
"status": "InProgress",
"statusId": 3
},
"modelId": "f9b00d5b-1f2d-421e-bc99-5ff192d0b998"
},
{
"details": {
"exampleCount": 12,
"status": "UpToDate",
"statusId": 2,
"trainingDateTime": "2017-01-31T21:42:02Z"
},
"modelId": "51403af3-5342-4926-abaa-91172a42e075"
},
{
"details": {
"exampleCount": 12,
"failureReason": "FewLabels",
"status": "Fail",
"statusId": 1
},
"modelId": "b4cf6402-dc79-4ca3-8666-b0007337e92b"
},
{
"details": {
"exampleCount": 0,
"status": "InProgress",
"statusId": 3
},
"modelId": "e8e3135a-acd9-4164-a65c-e2fedbe78cfa"
},
{
"details": {
"exampleCount": 12,
"status": "Success",
"statusId": 0,
"trainingDateTime": "2017-01-31T21:42:02Z"
},
"modelId": "3291fac9-6368-4c87-9562-e78cae0fa7c6"
},
{
"details": {
"exampleCount": 0,
"status": "InProgress",
"statusId": 3
},
"modelId": "a193efac-ab02-49d7-b005-ee717d45c4f1"
}
],
"headers": {}
}
}
}
}
},
"post": {
"description": "Sends a training request for a version of a specified LUIS app. This POST request initiates a request asynchronously. To determine whether the training request is successful, submit a GET request to get training status. Note: The application version is not fully trained unless all the models (intents and entities) are trained successfully or are up to date. To verify training success, get the training status at least once after training is complete.",
"operationId": "Train_TrainVersion",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"202": {
"description": "This response indicates the initial training status.",
"schema": {
"$ref": "#/definitions/EnqueueTrainingResponse"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Train Application Version request": {
"parameters": {
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"versionId": "0.1"
},
"responses": {
"202": {
"body": {
"status": "Queued",
"statusId": 9
},
"headers": {}
}
}
}
}
}
},
"/azureaccounts": {
"get": {
"description": "Gets the LUIS Azure accounts for the user using his ARM token.",
"operationId": "AzureAccounts_ListUserLUISAccounts",
"parameters": [
{
"$ref": "#/parameters/BearerAuthPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of Azure account information objects.",
"schema": {
"$ref": "#/definitions/AzureAccountInfoList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "user - Get LUIS Azure accounts",
"x-ms-examples": {
"Successful Get azure accounts request": {
"parameters": {
"Authorization": "Bearer {ARM Token}",
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000"
},
"responses": {
"200": {
"body": [
{
"accountName": "{account_name}",
"azureSubscriptionId": "{azure_subscription_id}",
"resourceGroup": "{resource_group_name}"
}
],
"headers": {}
}
}
}
}
}
},
"/package/{appId}/slot/{slotName}/gzip": {
"get": {
"description": "Packages a published LUIS application as a GZip file to be used in the LUIS container.",
"operationId": "Apps_PackagePublishedApplicationAsGzip",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/SlotNameInPath"
}
],
"produces": [
"application/octet-stream",
"application/json"
],
"responses": {
"200": {
"description": "The GZip binary stream of the published application package.",
"schema": {
"type": "file"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "package - Gets published LUIS application package in binary stream GZip format",
"x-ms-examples": {
"Successful Get published application package request": {
"parameters": {
"Content-Type": "application/octet-stream",
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"slotName": "PRODUCTION",
"versionId": "0.1"
},
"responses": {
"200": {
"body": "{binary}",
"headers": {}
}
}
}
}
}
},
"/package/{appId}/versions/{versionId}/gzip": {
"get": {
"description": "Packages trained LUIS application as GZip file to be used in the LUIS container.",
"operationId": "Apps_PackageTrainedApplicationAsGzip",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/octet-stream",
"application/json"
],
"responses": {
"200": {
"description": "The GZip binary stream of the trained application package.",
"schema": {
"type": "file"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"summary": "package - Gets trained LUIS application package in binary stream GZip format",
"x-ms-examples": {
"Successful Get published application package request": {
"parameters": {
"Content-Type": "application/octet-stream",
"Endpoint": "{Endpoint}",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"slotName": "PRODUCTION",
"versionId": "0.1"
},
"responses": {
"200": {
"body": "{binary}",
"headers": {}
}
}
}
}
}
}
},
"definitions": {
"AppVersionSettingObject": {
"description": "Object model of an application version setting.",
"properties": {
"name": {
"description": "The application version setting name.",
"type": "string"
},
"value": {
"description": "The application version setting value.",
"type": "string"
}
},
"type": "object"
},
"ApplicationCreateObject": {
"description": "Properties for creating a new LUIS Application",
"properties": {
"culture": {
"description": "The culture for the new application. It is the language that your app understands and speaks. E.g.: \"en-us\". Note: the culture cannot be changed after the app is created.",
"type": "string"
},
"description": {
"description": "Description of the new application. Optional.",
"type": "string"
},
"domain": {
"description": "The domain for the new application. Optional. E.g.: Comics.",
"type": "string"
},
"initialVersionId": {
"description": "The initial version ID. Optional. Default value is: \"0.1\"",
"type": "string"
},
"name": {
"description": "The name for the new application.",
"type": "string"
},
"usageScenario": {
"description": "Defines the scenario for the new application. Optional. E.g.: IoT.",
"type": "string"
}
},
"required": [
"culture",
"name"
],
"type": "object"
},
"ApplicationInfoResponse": {
"description": "Response containing the Application Info.",
"properties": {
"activeVersion": {
"description": "The version ID currently marked as active.",
"type": "string"
},
"createdDateTime": {
"description": "The version's creation timestamp.",
"type": "string"
},
"culture": {
"description": "The culture of the application. For example, \"en-us\".",
"type": "string"
},
"description": {
"description": "The description of the application.",
"type": "string"
},
"domain": {
"description": "The domain for the new application. Optional. For example, Comics.",
"type": "string"
},
"endpointHitsCount": {
"description": "Number of calls made to this endpoint.",
"type": "integer"
},
"endpoints": {
"description": "The Runtime endpoint URL for this model version.",
"type": "object"
},
"id": {
"description": "The ID (GUID) of the application.",
"format": "uuid",
"type": "string"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"usageScenario": {
"description": "Defines the scenario for the new application. Optional. For example, IoT.",
"type": "string"
},
"versionsCount": {
"description": "Amount of model versions within the application.",
"type": "integer"
}
},
"type": "object"
},
"ApplicationPublishObject": {
"description": "Object model for publishing a specific application version.",
"properties": {
"isStaging": {
"default": false,
"description": "Indicates if the staging slot should be used, instead of the Production one.",
"type": "boolean"
},
"versionId": {
"description": "The version ID to publish.",
"type": "string"
}
},
"type": "object"
},
"ApplicationSettingUpdateObject": {
"description": "Object model for updating an application's settings.",
"properties": {
"public": {
"description": "Setting your application as public allows other people to use your application's endpoint using their own keys.",
"type": "boolean",
"x-ms-client-name": "isPublic",
"x-nullable": false
}
},
"type": "object"
},
"ApplicationSettings": {
"description": "The application settings.",
"properties": {
"id": {
"description": "The application ID.",
"format": "uuid",
"type": "string"
},
"public": {
"description": "Setting your application as public allows other people to use your application's endpoint using their own keys for billing purposes.",
"type": "boolean",
"x-ms-client-name": "isPublic",
"x-nullable": false
}
},
"required": [
"id",
"public"
],
"type": "object"
},
"ApplicationUpdateObject": {
"description": "Object model for updating the name or description of an application.",
"properties": {
"description": {
"description": "The application's new description.",
"type": "string"
},
"name": {
"description": "The application's new name.",
"type": "string"
}
},
"type": "object"
},
"ApplicationUsageScenarios": {
"description": "A list of possible application usage scenarios.",
"items": {
"type": "string"
},
"type": "array"
},
"ApplicationsInfoList": {
"description": "List of Application Infos.",
"items": {
"$ref": "#/definitions/ApplicationInfoResponse"
},
"type": "array"
},
"AvailableCulture": {
"description": "Available culture for using in a new application.",
"properties": {
"code": {
"description": "The ISO value for the language.",
"type": "string"
},
"name": {
"description": "The language name.",
"type": "string"
}
},
"type": "object"
},
"AvailableCultures": {
"description": "A list of available application cultures.",
"items": {
"$ref": "#/definitions/AvailableCulture"
},
"type": "array"
},
"AvailableDomains": {
"description": "A list of available application domains.",
"items": {
"type": "string"
},
"type": "array"
},
"AvailableEndpoints": {
"additionalProperties": {
"type": "string"
},
"description": "Collection of endpoint URLs where the selected application is deployed to.",
"type": "object"
},
"AvailablePrebuiltEntityModel": {
"description": "Available Prebuilt entity model for using in an application.",
"properties": {
"description": {
"description": "The entity description and usage information.",
"type": "string"
},
"examples": {
"description": "Usage examples.",
"type": "string"
},
"name": {
"description": "The entity name.",
"type": "string"
}
},
"type": "object"
},
"AvailablePrebuiltEntityModels": {
"description": "List of Available Prebuilt entity models.",
"items": {
"$ref": "#/definitions/AvailablePrebuiltEntityModel"
},
"type": "array"
},
"AzureAccountInfoList": {
"description": "List of Azure account info objects.",
"items": {
"$ref": "#/definitions/AzureAccountInfoObject"
},
"type": "array"
},
"AzureAccountInfoObject": {
"description": "Defines the Azure account information object.",
"properties": {
"accountName": {
"description": "The Azure account name.",
"type": "string"
},
"azureSubscriptionId": {
"description": "The id for the Azure subscription.",
"type": "string"
},
"resourceGroup": {
"description": "The Azure resource group name.",
"type": "string"
}
},
"required": [
"azureSubscriptionId",
"resourceGroup",
"accountName"
],
"type": "object"
},
"BatchLabelExample": {
"description": "Response when adding a batch of labeled example utterances.",
"properties": {
"error": {
"$ref": "#/definitions/OperationStatus"
},
"hasError": {
"type": "boolean"
},
"value": {
"$ref": "#/definitions/LabelExampleResponse"
}
},
"type": "object"
},
"BatchLabelExampleResponse": {
"description": "Response when adding a batch of labeled example utterances.",
"items": {
"$ref": "#/definitions/BatchLabelExample"
},
"type": "array"
},
"ChildEntity": {
"description": "The base child entity type.",
"properties": {
"children": {
"description": "List of children",
"items": {
"$ref": "#/definitions/ChildEntity"
},
"type": "array"
},
"id": {
"description": "The ID (GUID) belonging to a child entity.",
"format": "uuid",
"type": "string"
},
"instanceOf": {
"description": "Instance of Model.",
"type": "string"
},
"name": {
"description": "The name of a child entity.",
"type": "string"
},
"readableType": {
"$ref": "#/definitions/ReadableType"
},
"typeId": {
"description": "The type ID of the Entity Model.",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"ChildEntityModelCreateObject": {
"description": "A child entity extractor create object.",
"properties": {
"children": {
"description": "Child entities.",
"items": {
"$ref": "#/definitions/ChildEntityModelCreateObject",
"type": "object"
},
"type": "array"
},
"instanceOf": {
"description": "The instance of model name",
"type": "string"
},
"name": {
"description": "Entity name.",
"type": "string"
}
},
"type": "object"
},
"ClosedList": {
"description": "Exported Model - A list entity.",
"properties": {
"name": {
"description": "Name of the list entity.",
"type": "string"
},
"roles": {
"items": {
"type": "string"
},
"type": "array"
},
"subLists": {
"description": "Sublists for the list entity.",
"items": {
"$ref": "#/definitions/SubClosedList",
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ClosedListEntityExtractor": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
},
{
"$ref": "#/definitions/EntityModelInfo"
}
],
"description": "List Entity Extractor.",
"properties": {
"subLists": {
"description": "List of sublists.",
"items": {
"$ref": "#/definitions/SubClosedListResponse"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "List Entity Extractor"
},
"ClosedListEntityExtractorsList": {
"description": "List of List Entity Extractors.",
"items": {
"$ref": "#/definitions/ClosedListEntityExtractor"
},
"type": "array"
},
"ClosedListModelCreateObject": {
"description": "Object model for creating a list entity.",
"properties": {
"name": {
"description": "Name of the list entity.",
"type": "string"
},
"subLists": {
"description": "Sublists for the feature.",
"items": {
"$ref": "#/definitions/WordListObject",
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ClosedListModelPatchObject": {
"description": "Object model for adding a batch of sublists to an existing list entity.",
"properties": {
"subLists": {
"description": "Sublists to add.",
"items": {
"$ref": "#/definitions/WordListObject",
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ClosedListModelUpdateObject": {
"description": "Object model for updating a list entity.",
"properties": {
"name": {
"description": "The new name of the list entity.",
"type": "string"
},
"subLists": {
"description": "The new sublists for the feature.",
"items": {
"$ref": "#/definitions/WordListObject",
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"CollaboratorsArray": {
"properties": {
"emails": {
"description": "The email address of the users.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CompositeEntityExtractor": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
},
{
"$ref": "#/definitions/EntityModelInfo"
}
],
"description": "A Composite Entity Extractor.",
"properties": {
"children": {
"description": "List of child entities.",
"items": {
"$ref": "#/definitions/ChildEntity"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "Composite Entity Extractor"
},
"CompositeEntityExtractorsList": {
"description": "List of Composite Entity Extractors.",
"items": {
"$ref": "#/definitions/CompositeEntityExtractor"
},
"type": "array"
},
"CompositeEntityModel": {
"description": "A composite entity extractor.",
"properties": {
"children": {
"description": "Child entities.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Entity name.",
"type": "string"
}
},
"type": "object"
},
"CustomPrebuiltModel": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
},
{
"$ref": "#/definitions/IntentClassifier"
},
{
"$ref": "#/definitions/EntityExtractor"
}
],
"description": "A Custom Prebuilt model."
},
"CustomPrebuiltModelList": {
"description": "A List of Custom Prebuilt models.",
"items": {
"$ref": "#/definitions/CustomPrebuiltModel"
},
"type": "array"
},
"EndpointInfo": {
"description": "The base class \"ProductionOrStagingEndpointInfo\" inherits from.",
"properties": {
"assignedEndpointKey": {
"description": "The endpoint key.",
"type": "string"
},
"endpointRegion": {
"description": "The endpoint's region.",
"type": "string"
},
"endpointUrl": {
"description": "The Runtime endpoint URL for this model version.",
"type": "string"
},
"failedRegions": {
"description": "Regions where publishing failed.",
"type": "string"
},
"isStaging": {
"description": "Indicates if the staging slot should be used, instead of the Production one.",
"type": "boolean"
},
"publishedDateTime": {
"description": "Timestamp when was last published.",
"type": "string"
},
"region": {
"description": "The target region that the application is published to.",
"type": "string"
},
"versionId": {
"description": "The version ID to publish.",
"type": "string"
}
},
"type": "object"
},
"EndpointKeys": {
"description": "An a array of GUIDs, comprised of Azure Endpoint Keys and the Authoring API key.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"EnqueueTrainingResponse": {
"description": "Response model when requesting to train the model.",
"properties": {
"status": {
"$ref": "#/definitions/TrainingStatus"
},
"statusId": {
"description": "The train request status ID.",
"type": "integer"
}
},
"type": "object"
},
"EntitiesSuggestionExample": {
"description": "Predicted/suggested entity.",
"properties": {
"entityPredictions": {
"description": "Predicted/suggested entities.",
"items": {
"$ref": "#/definitions/EntityPrediction"
},
"type": "array"
},
"intentPredictions": {
"description": "Predicted/suggested intents.",
"items": {
"$ref": "#/definitions/IntentPrediction"
},
"type": "array"
},
"text": {
"description": "The utterance. For example, \"What's the weather like in seattle?\"",
"type": "string"
},
"tokenizedText": {
"description": "The utterance tokenized.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EntitiesSuggestionExamples": {
"description": "List of predicted/suggested entities.",
"items": {
"$ref": "#/definitions/EntitiesSuggestionExample"
},
"type": "array"
},
"EntityExtractor": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
},
{
"$ref": "#/definitions/EntityModelInfo"
}
],
"description": "Entity Extractor.",
"properties": {
"customPrebuiltDomainName": {
"description": "The domain name.",
"type": "string"
},
"customPrebuiltModelName": {
"description": "The intent name or entity name.",
"type": "string"
}
},
"type": "object",
"x-ms-discriminator-value": "Entity Extractor"
},
"EntityExtractorsList": {
"description": "List of Entity Extractors.",
"items": {
"$ref": "#/definitions/EntityExtractor"
},
"type": "array"
},
"EntityLabel": {
"description": "Defines the entity type and position of the extracted entity within the example.",
"properties": {
"endTokenIndex": {
"description": "The index within the utterance where the extracted entity ends.",
"type": "integer"
},
"entityName": {
"description": "The entity type.",
"type": "string"
},
"role": {
"description": "The role of the predicted entity.",
"type": "string"
},
"roleId": {
"description": "The role id for the predicted entity.",
"format": "uuid",
"type": "string"
},
"startTokenIndex": {
"description": "The index within the utterance where the extracted entity starts.",
"type": "integer"
}
},
"required": [
"entityName",
"startTokenIndex",
"endTokenIndex"
],
"type": "object"
},
"EntityLabelObject": {
"description": "Defines the entity type and position of the extracted entity within the example.",
"properties": {
"endCharIndex": {
"description": "The index within the utterance where the extracted entity ends.",
"type": "integer"
},
"entityName": {
"description": "The entity type.",
"type": "string"
},
"role": {
"description": "The role the entity plays in the utterance.",
"type": "string"
},
"startCharIndex": {
"description": "The index within the utterance where the extracted entity starts.",
"type": "integer"
}
},
"required": [
"entityName",
"startCharIndex",
"endCharIndex"
],
"type": "object"
},
"EntityModelCreateObject": {
"description": "An entity extractor create object.",
"properties": {
"children": {
"description": "Child entities.",
"items": {
"$ref": "#/definitions/ChildEntityModelCreateObject",
"type": "object"
},
"type": "array"
},
"name": {
"description": "Entity name.",
"type": "string"
}
},
"type": "object"
},
"EntityModelInfo": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
}
],
"description": "An Entity Extractor model info.",
"properties": {
"roles": {
"$ref": "#/definitions/EntityRoleList"
}
},
"type": "object"
},
"EntityModelUpdateObject": {
"description": "An entity extractor update object.",
"properties": {
"instanceOf": {
"description": "The instance of model name",
"type": "string"
},
"name": {
"description": "Entity name.",
"type": "string"
}
},
"type": "object"
},
"EntityPrediction": {
"description": "A suggested entity.",
"properties": {
"endTokenIndex": {
"description": "The index within the utterance where the extracted entity ends.",
"type": "integer"
},
"entityName": {
"description": "The entity's name",
"type": "string"
},
"phrase": {
"description": "The actual token(s) that comprise the entity.",
"type": "string"
},
"startTokenIndex": {
"description": "The index within the utterance where the extracted entity starts.",
"type": "integer"
}
},
"required": [
"entityName",
"startTokenIndex",
"endTokenIndex",
"phrase"
],
"type": "object"
},
"EntityRole": {
"description": "Entity extractor role",
"properties": {
"id": {
"description": "The entity role ID.",
"format": "uuid",
"type": "string"
},
"name": {
"description": "The entity role name.",
"type": "string"
}
},
"type": "object"
},
"EntityRoleCreateObject": {
"description": "Object model for creating an entity role.",
"properties": {
"name": {
"description": "The entity role name.",
"type": "string"
}
},
"type": "object"
},
"EntityRoleList": {
"description": "List of Pattern.Any Entity Extractors.",
"items": {
"$ref": "#/definitions/EntityRole"
},
"type": "array"
},
"EntityRoleUpdateObject": {
"description": "Object model for updating an entity role.",
"properties": {
"name": {
"description": "The entity role name.",
"type": "string"
}
},
"type": "object"
},
"ErrorResponse": {
"additionalProperties": {
"type": "object"
},
"description": "Error response when invoking an operation on the API.",
"properties": {
"errorType": {
"type": "string"
}
},
"type": "object"
},
"ExampleLabelObject": {
"description": "A labeled example utterance.",
"properties": {
"entityLabels": {
"description": "The identified entities within the example utterance.",
"items": {
"$ref": "#/definitions/EntityLabelObject",
"type": "object"
},
"type": "array"
},
"intentName": {
"description": "The identified intent representing the example utterance.",
"type": "string"
},
"text": {
"description": "The example utterance.",
"type": "string"
}
},
"type": "object"
},
"ExampleLabelObjectArray": {
"description": "Object model for adding a batch of labeled examples.",
"items": {
"$ref": "#/definitions/ExampleLabelObject",
"type": "object"
},
"type": "array"
},
"ExamplesPerModelResponseObject": {
"description": "A list of example utterances per model.",
"items": {
"$ref": "#/definitions/LabelTextObject"
},
"type": "array"
},
"ExplicitListItem": {
"description": "Explicit (exception) list item",
"properties": {
"explicitListItem": {
"description": "The explicit list item value.",
"type": "string"
},
"id": {
"description": "The explicit list item ID.",
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"ExplicitListItemCreateObject": {
"description": "Object model for creating an explicit (exception) list item.",
"properties": {
"explicitListItem": {
"description": "The explicit list item.",
"type": "string"
}
},
"type": "object"
},
"ExplicitListItemIDResponse": {
"description": "The ID of the created explicit list item.",
"type": "integer",
"x-nullable": false
},
"ExplicitListItemList": {
"description": "List of explicit (exception) list items",
"items": {
"$ref": "#/definitions/ExplicitListItem"
},
"type": "array"
},
"ExplicitListItemUpdateObject": {
"description": "Model object for updating an explicit (exception) list item.",
"properties": {
"explicitListItem": {
"description": "The explicit list item.",
"type": "string"
}
},
"type": "object"
},
"FeatureIDResponse": {
"description": "The ID of the created feature.",
"type": "integer",
"x-nullable": false
},
"FeatureInfoObject": {
"description": "The base class Features-related response objects inherit from.",
"properties": {
"enabledForAllModels": {
"description": "Indicates if the feature is enabled for all models in the application.",
"type": "boolean"
},
"id": {
"description": "A six-digit ID used for Features.",
"type": "integer"
},
"isActive": {
"description": "Indicates if the feature is enabled.",
"type": "boolean"
},
"name": {
"description": "The name of the Feature.",
"type": "string"
}
},
"type": "object"
},
"FeaturesPerModelResponseObject": {
"description": "A list of feature information objects per model.",
"items": {
"$ref": "#/definitions/ModelFeatureInformation"
},
"type": "array"
},
"FeaturesResponseObject": {
"description": "Model Features, including Patterns and Phraselists.",
"properties": {
"patternFeatures": {
"$ref": "#/definitions/PatternFeatureInfoList"
},
"phraselistFeatures": {
"$ref": "#/definitions/PhraseListFeatureInfoList"
}
},
"type": "object"
},
"GuidList": {
"description": "List of IDs (GUID)",
"items": {
"$ref": "#/definitions/GuidResponse"
},
"type": "array"
},
"GuidResponse": {
"description": "The ID (GUID) returned by an operation.",
"format": "uuid",
"type": "string"
},
"HierarchicalChildEntity": {
"allOf": [
{
"$ref": "#/definitions/ChildEntity"
}
],
"description": "A Hierarchical Child Entity.",
"properties": {
"readableType": {
"$ref": "#/definitions/ReadableType"
},
"typeId": {
"description": "The type ID of the Entity Model.",
"type": "integer"
}
},
"type": "object"
},
"HierarchicalEntityExtractor": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
},
{
"$ref": "#/definitions/EntityModelInfo"
}
],
"description": "Hierarchical Entity Extractor.",
"properties": {
"children": {
"description": "List of child entities.",
"items": {
"$ref": "#/definitions/ChildEntity"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "Hierarchical Entity Extractor"
},
"HierarchicalEntityExtractorsList": {
"description": "List of Hierarchical Entity Extractors.",
"items": {
"$ref": "#/definitions/HierarchicalEntityExtractor"
},
"type": "array"
},
"HierarchicalModel": {
"properties": {
"children": {
"items": {
"$ref": "#/definitions/JsonChild",
"type": "object"
},
"type": "array"
},
"features": {
"items": {
"$ref": "#/definitions/JsonModelFeatureInformation",
"type": "object"
},
"type": "array"
},
"inherits": {
"$ref": "#/definitions/PrebuiltDomainObject",
"type": "object"
},
"name": {
"type": "string"
},
"roles": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"IntentClassifier": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
}
],
"description": "Intent Classifier.",
"properties": {
"customPrebuiltDomainName": {
"description": "The domain name.",
"type": "string"
},
"customPrebuiltModelName": {
"description": "The intent name or entity name.",
"type": "string"
}
},
"type": "object",
"x-ms-discriminator-value": "Intent Classifier"
},
"IntentClassifiersList": {
"description": "List of Intent Classifiers.",
"items": {
"$ref": "#/definitions/IntentClassifier"
},
"type": "array"
},
"IntentPrediction": {
"description": "A suggested intent.",
"properties": {
"name": {
"description": "The intent's name",
"type": "string"
},
"score": {
"description": "The intent's score, based on the prediction model.",
"type": "number"
}
},
"type": "object"
},
"IntentsSuggestionExample": {
"description": "Predicted/suggested intent.",
"properties": {
"entityPredictions": {
"description": "Predicted/suggested entities.",
"items": {
"$ref": "#/definitions/EntityPrediction"
},
"type": "array"
},
"intentPredictions": {
"description": "Predicted/suggested intents.",
"items": {
"$ref": "#/definitions/IntentPrediction"
},
"type": "array"
},
"text": {
"description": "The utterance. For example, \"What's the weather like in seattle?\"",
"type": "string"
},
"tokenizedText": {
"description": "The tokenized utterance.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"IntentsSuggestionExamples": {
"description": "List of predicted/suggested intents.",
"items": {
"$ref": "#/definitions/IntentsSuggestionExample"
},
"type": "array"
},
"JSONEntity": {
"description": "Exported Model - Extracted Entity from utterance.",
"properties": {
"endPos": {
"description": "The index within the utterance where the extracted entity ends.",
"type": "integer"
},
"entity": {
"description": "The entity name.",
"type": "string"
},
"role": {
"description": "The role the entity plays in the utterance.",
"type": "string"
},
"startPos": {
"description": "The index within the utterance where the extracted entity starts.",
"type": "integer"
}
},
"required": [
"startPos",
"endPos",
"entity"
],
"type": "object"
},
"JSONModelFeature": {
"description": "Exported Model - Phraselist Model Feature.",
"properties": {
"activated": {
"description": "Indicates if the feature is enabled.",
"type": "boolean"
},
"enabledForAllModels": {
"default": true,
"description": "Indicates if the Phraselist is enabled for all models in the application.",
"type": "boolean"
},
"mode": {
"description": "An interchangeable phrase list feature serves as a list of synonyms for training. A non-exchangeable phrase list serves as separate features for training. So, if your non-interchangeable phrase list contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-interchangeable phrase list as an additional bag of words to add to LUIS existing vocabulary features. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Default value is true.",
"type": "boolean"
},
"name": {
"description": "The Phraselist name.",
"type": "string"
},
"words": {
"description": "List of comma-separated phrases that represent the Phraselist.",
"type": "string"
}
},
"type": "object"
},
"JSONRegexFeature": {
"description": "Exported Model - A Pattern feature.",
"properties": {
"activated": {
"description": "Indicates if the Pattern feature is enabled.",
"type": "boolean"
},
"name": {
"description": "Name of the feature.",
"type": "string"
},
"pattern": {
"description": "The Regular Expression to match.",
"type": "string"
}
},
"type": "object"
},
"JSONUtterance": {
"description": "Exported Model - Utterance that was used to train the model.",
"properties": {
"entities": {
"description": "The matched entities.",
"items": {
"$ref": "#/definitions/JSONEntity",
"type": "object"
},
"type": "array"
},
"intent": {
"description": "The matched intent.",
"type": "string"
},
"text": {
"description": "The utterance.",
"type": "string"
}
},
"type": "object"
},
"JsonChild": {
"properties": {
"children": {
"items": {
"$ref": "#/definitions/JsonChild",
"type": "object"
},
"type": "array"
},
"features": {
"items": {
"$ref": "#/definitions/JsonModelFeatureInformation",
"type": "object"
},
"type": "array"
},
"instanceOf": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"JsonModelFeatureInformation": {
"description": "An object containing the model feature information either the model name or feature name.",
"properties": {
"featureName": {
"description": "The name of the feature used.",
"type": "string"
},
"modelName": {
"description": "The name of the model used.",
"type": "string"
}
},
"type": "object"
},
"LabelExampleResponse": {
"description": "Response when adding a labeled example utterance.",
"properties": {
"ExampleId": {
"description": "The newly created sample ID.",
"type": "integer"
},
"UtteranceText": {
"description": "The example utterance.",
"type": "string"
}
},
"type": "object"
},
"LabelTextObject": {
"description": "An object containing the example utterance's text.",
"properties": {
"id": {
"description": "The ID of the Label.",
"type": "integer"
},
"text": {
"description": "The text of the label.",
"type": "string"
}
},
"type": "object"
},
"LabeledUtterance": {
"description": "A prediction and label pair of an example.",
"properties": {
"entityLabels": {
"description": "The entities matching the example.",
"items": {
"$ref": "#/definitions/EntityLabel"
},
"type": "array"
},
"entityPredictions": {
"description": "List of suggested entities.",
"items": {
"$ref": "#/definitions/EntityPrediction"
},
"type": "array"
},
"id": {
"description": "ID of Labeled Utterance.",
"type": "integer"
},
"intentLabel": {
"description": "The intent matching the example.",
"type": "string"
},
"intentPredictions": {
"description": "List of suggested intents.",
"items": {
"$ref": "#/definitions/IntentPrediction"
},
"type": "array"
},
"text": {
"description": "The utterance. For example, \"What's the weather like in seattle?\"",
"type": "string"
},
"tokenizedText": {
"description": "The utterance tokenized.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"LabeledUtterances": {
"description": "A list of predictions and label pairs for every example in the application.",
"items": {
"$ref": "#/definitions/LabeledUtterance"
},
"type": "array"
},
"LuisApp": {
"additionalProperties": true,
"description": "Exported Model - An exported LUIS Application.",
"properties": {
"closedLists": {
"description": "List of list entities.",
"items": {
"$ref": "#/definitions/ClosedList",
"type": "object"
},
"type": "array"
},
"composites": {
"description": "List of composite entities.",
"items": {
"$ref": "#/definitions/HierarchicalModel",
"type": "object"
},
"type": "array"
},
"culture": {
"description": "The culture of the application. E.g.: en-us.",
"type": "string"
},
"desc": {
"description": "The description of the application.",
"type": "string"
},
"entities": {
"description": "List of entities.",
"items": {
"$ref": "#/definitions/HierarchicalModel",
"type": "object"
},
"type": "array"
},
"hierarchicals": {
"description": "List of hierarchical entities.",
"items": {
"$ref": "#/definitions/HierarchicalModel",
"type": "object"
},
"type": "array"
},
"intents": {
"description": "List of intents.",
"items": {
"$ref": "#/definitions/HierarchicalModel",
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"patternAnyEntities": {
"description": "List of Pattern.Any entities.",
"items": {
"$ref": "#/definitions/PatternAny",
"type": "object"
},
"type": "array"
},
"patterns": {
"description": "List of patterns.",
"items": {
"$ref": "#/definitions/PatternRule",
"type": "object"
},
"type": "array"
},
"phraselists": {
"description": "List of model features.",
"items": {
"$ref": "#/definitions/JSONModelFeature",
"type": "object"
},
"type": "array"
},
"prebuiltEntities": {
"description": "List of prebuilt entities.",
"items": {
"$ref": "#/definitions/PrebuiltEntity",
"type": "object"
},
"type": "array"
},
"regex_entities": {
"description": "List of regular expression entities.",
"items": {
"$ref": "#/definitions/RegexEntity",
"type": "object"
},
"type": "array"
},
"regex_features": {
"description": "List of pattern features.",
"items": {
"$ref": "#/definitions/JSONRegexFeature",
"type": "object"
},
"type": "array"
},
"utterances": {
"description": "List of example utterances.",
"items": {
"$ref": "#/definitions/JSONUtterance",
"type": "object"
},
"type": "array"
},
"versionId": {
"description": "The version ID of the application that was exported.",
"type": "string"
}
},
"type": "object"
},
"ModelCreateObject": {
"description": "Object model for creating a new entity extractor.",
"properties": {
"name": {
"description": "Name of the new entity extractor.",
"type": "string"
}
},
"type": "object"
},
"ModelFeatureInformation": {
"description": "An object containing the model feature information either the model name or feature name.",
"properties": {
"featureName": {
"description": "The name of the feature used.",
"type": "string"
},
"modelName": {
"description": "The name of the model used.",
"type": "string"
}
},
"type": "object"
},
"ModelInfo": {
"description": "Base type used in entity types.",
"properties": {
"id": {
"description": "The ID of the Entity Model.",
"format": "uuid",
"type": "string"
},
"name": {
"description": "Name of the Entity Model.",
"type": "string"
},
"readableType": {
"$ref": "#/definitions/ReadableType"
},
"typeId": {
"description": "The type ID of the Entity Model.",
"type": "integer"
}
},
"required": [
"id",
"readableType"
],
"type": "object"
},
"ModelInfoResponse": {
"allOf": [
{
"$ref": "#/definitions/HierarchicalEntityExtractor"
},
{
"$ref": "#/definitions/CompositeEntityExtractor"
},
{
"$ref": "#/definitions/ClosedListEntityExtractor"
},
{
"$ref": "#/definitions/IntentClassifier"
},
{
"$ref": "#/definitions/EntityExtractor"
},
{
"$ref": "#/definitions/RegexEntityExtractor"
},
{
"$ref": "#/definitions/PatternAnyEntityExtractor"
},
{
"$ref": "#/definitions/NDepthEntityExtractor"
}
],
"description": "An application model info.",
"properties": {
"id": {
"description": "The ID of the Entity Model.",
"format": "uuid",
"type": "string"
},
"name": {
"description": "Name of the Entity Model.",
"type": "string"
},
"readableType": {
"$ref": "#/definitions/ReadableType"
},
"typeId": {
"description": "The type ID of the Entity Model.",
"type": "integer"
}
},
"required": [
"id",
"readableType"
],
"type": "object"
},
"ModelTrainingDetails": {
"description": "Model Training Details.",
"properties": {
"exampleCount": {
"description": "The count of examples used to train the model.",
"type": "integer"
},
"failureReason": {
"description": "Reason for the training failure.",
"type": "string"
},
"status": {
"$ref": "#/definitions/TrainingStatus"
},
"statusId": {
"description": "The train request status ID.",
"type": "integer"
},
"trainingDateTime": {
"description": "When the model was trained.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"ModelTrainingInfo": {
"description": "Model Training Info.",
"properties": {
"details": {
"$ref": "#/definitions/ModelTrainingDetails"
},
"modelId": {
"description": "The ID (GUID) of the model.",
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"ModelTrainingInfoList": {
"description": "List of Model Training Infos.",
"items": {
"$ref": "#/definitions/ModelTrainingInfo"
},
"type": "array"
},
"ModelUpdateObject": {
"description": "Object model for updating an intent classifier.",
"properties": {
"name": {
"description": "The entity's new name.",
"type": "string"
}
},
"type": "object"
},
"ModelsInfoResponseObject": {
"description": "A list of application model infos.",
"items": {
"$ref": "#/definitions/ModelInfoResponse"
},
"type": "array"
},
"NDepthEntityExtractor": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
},
{
"$ref": "#/definitions/EntityModelInfo"
}
],
"description": "N-Depth Entity Extractor.",
"properties": {
"children": {
"items": {
"$ref": "#/definitions/ChildEntity"
},
"type": "array"
},
"customPrebuiltDomainName": {
"description": "The domain name.",
"type": "string"
},
"customPrebuiltModelName": {
"description": "The intent name or entity name.",
"type": "string"
}
},
"type": "object",
"x-ms-discriminator-value": "N-Depth Entity Extractor"
},
"NDepthEntityExtractorsList": {
"description": "List of N-Depth Entity Extractors.",
"items": {
"$ref": "#/definitions/NDepthEntityExtractor"
},
"type": "array"
},
"OperationError": {
"description": "Operation error details when invoking an operation on the API.",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"OperationStatus": {
"description": "Response of an Operation status.",
"properties": {
"code": {
"description": "Status Code.",
"enum": [
"Failed",
"FAILED",
"Success"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "OperationStatusType"
}
},
"message": {
"description": "Status details.",
"type": "string"
}
},
"type": "object"
},
"PatternAny": {
"description": "Pattern.Any Entity Extractor.",
"properties": {
"explicitList": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"roles": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PatternAnyEntityExtractor": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
},
{
"$ref": "#/definitions/EntityModelInfo"
}
],
"description": "Pattern.Any Entity Extractor.",
"properties": {
"explicitList": {
"$ref": "#/definitions/ExplicitListItemList"
}
},
"type": "object",
"x-ms-discriminator-value": "Pattern.Any Entity Extractor"
},
"PatternAnyEntityExtractorList": {
"description": "List of Pattern.Any Entity Extractors.",
"items": {
"$ref": "#/definitions/PatternAnyEntityExtractor"
},
"type": "array"
},
"PatternAnyModelCreateObject": {
"description": "Model object for creating a Pattern.Any entity model.",
"properties": {
"explicitList": {
"description": "The Pattern.Any explicit list.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The model name.",
"type": "string"
}
},
"type": "object"
},
"PatternAnyModelUpdateObject": {
"description": "Model object for updating a Pattern.Any entity model.",
"properties": {
"explicitList": {
"description": "The Pattern.Any explicit list.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The model name.",
"type": "string"
}
},
"type": "object"
},
"PatternFeatureInfo": {
"allOf": [
{
"$ref": "#/definitions/FeatureInfoObject"
}
],
"description": "Pattern feature.",
"properties": {
"pattern": {
"description": "The Regular Expression to match.",
"type": "string"
}
},
"type": "object"
},
"PatternFeatureInfoList": {
"description": "List of Pattern features.",
"items": {
"$ref": "#/definitions/PatternFeatureInfo"
},
"type": "array"
},
"PatternRule": {
"description": "Pattern",
"properties": {
"intent": {
"description": "The intent's name where the pattern belongs to.",
"type": "string"
},
"pattern": {
"description": "The pattern text.",
"type": "string"
}
},
"type": "object"
},
"PatternRuleCreateObject": {
"description": "Object model for creating a pattern",
"properties": {
"intent": {
"description": "The intent's name which the pattern belongs to.",
"type": "string"
},
"pattern": {
"description": "The pattern text.",
"type": "string"
}
},
"type": "object"
},
"PatternRuleInfo": {
"description": "Pattern rule",
"properties": {
"id": {
"description": "The pattern ID.",
"format": "uuid",
"type": "string"
},
"intent": {
"description": "The intent's name where the pattern belongs to.",
"type": "string"
},
"pattern": {
"description": "The pattern text.",
"type": "string"
}
},
"type": "object"
},
"PatternRuleList": {
"description": "List of patterns",
"items": {
"$ref": "#/definitions/PatternRuleInfo"
},
"type": "array"
},
"PatternRuleUpdateObject": {
"description": "Object model for updating a pattern.",
"properties": {
"id": {
"description": "The pattern ID.",
"format": "uuid",
"type": "string"
},
"intent": {
"description": "The intent's name which the pattern belongs to.",
"type": "string"
},
"pattern": {
"description": "The pattern text.",
"type": "string"
}
},
"type": "object"
},
"PersonalAssistantUrls": {
"additionalProperties": {
"type": "string"
},
"description": "Endpoint URLs for prebuilt Cortana applications.",
"type": "object"
},
"PersonalAssistantsResponse": {
"description": "Response containing user's endpoint keys and the endpoint URLs of the prebuilt Cortana applications.",
"properties": {
"endpointKeys": {
"$ref": "#/definitions/EndpointKeys"
},
"endpointUrls": {
"$ref": "#/definitions/PersonalAssistantUrls"
}
},
"type": "object"
},
"PhraseListFeatureInfo": {
"allOf": [
{
"$ref": "#/definitions/FeatureInfoObject"
}
],
"description": "Phraselist Feature.",
"properties": {
"isExchangeable": {
"description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.",
"type": "boolean"
},
"phrases": {
"description": "A list of comma-separated values.",
"type": "string"
}
},
"type": "object"
},
"PhraseListFeatureInfoList": {
"description": "List of Phraselist Features.",
"items": {
"$ref": "#/definitions/PhraseListFeatureInfo"
},
"type": "array"
},
"PhraselistCreateObject": {
"description": "Object model for creating a phraselist model.",
"properties": {
"enabledForAllModels": {
"default": true,
"description": "Indicates if the Phraselist is enabled for all models in the application.",
"type": "boolean"
},
"isExchangeable": {
"default": true,
"description": "An interchangeable phrase list feature serves as a list of synonyms for training. A non-exchangeable phrase list serves as separate features for training. So, if your non-interchangeable phrase list contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-interchangeable phrase list as an additional bag of words to add to LUIS existing vocabulary features. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Default value is true.",
"type": "boolean"
},
"name": {
"description": "The Phraselist name.",
"type": "string"
},
"phrases": {
"description": "List of comma-separated phrases that represent the Phraselist.",
"type": "string"
}
},
"type": "object"
},
"PhraselistUpdateObject": {
"description": "Object model for updating a Phraselist.",
"properties": {
"enabledForAllModels": {
"default": true,
"description": "Indicates if the Phraselist is enabled for all models in the application.",
"type": "boolean"
},
"isActive": {
"default": true,
"description": "Indicates if the Phraselist is enabled.",
"type": "boolean"
},
"isExchangeable": {
"default": true,
"description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.",
"type": "boolean"
},
"name": {
"description": "The Phraselist name.",
"type": "string"
},
"phrases": {
"description": "List of comma-separated phrases that represent the Phraselist.",
"type": "string"
}
},
"type": "object"
},
"PrebuiltDomain": {
"description": "Prebuilt Domain.",
"properties": {
"culture": {
"type": "string"
},
"description": {
"type": "string"
},
"entities": {
"items": {
"$ref": "#/definitions/PrebuiltDomainItem"
},
"type": "array"
},
"examples": {
"type": "string"
},
"intents": {
"items": {
"$ref": "#/definitions/PrebuiltDomainItem"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"PrebuiltDomainCreateBaseObject": {
"description": "A model object containing the name of the custom prebuilt entity and the name of the domain to which this model belongs.",
"properties": {
"domainName": {
"description": "The domain name.",
"type": "string"
}
},
"type": "object"
},
"PrebuiltDomainCreateObject": {
"description": "A prebuilt domain create object containing the name and culture of the domain.",
"properties": {
"culture": {
"description": "The culture of the new domain.",
"type": "string"
},
"domainName": {
"description": "The domain name.",
"type": "string"
}
},
"type": "object"
},
"PrebuiltDomainItem": {
"properties": {
"description": {
"type": "string"
},
"examples": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"PrebuiltDomainModelCreateObject": {
"description": "A model object containing the name of the custom prebuilt intent or entity and the name of the domain to which this model belongs.",
"properties": {
"domainName": {
"description": "The domain name.",
"type": "string"
},
"modelName": {
"description": "The intent name or entity name.",
"type": "string"
}
},
"type": "object"
},
"PrebuiltDomainObject": {
"properties": {
"domain_name": {
"type": "string"
},
"model_name": {
"type": "string"
}
},
"type": "object"
},
"PrebuiltDomainsList": {
"description": "List of Prebuilt Domains.",
"items": {
"$ref": "#/definitions/PrebuiltDomain"
},
"type": "array"
},
"PrebuiltEntity": {
"description": "Prebuilt Entity Extractor.",
"properties": {
"name": {
"type": "string"
},
"roles": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PrebuiltEntityExtractor": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
},
{
"$ref": "#/definitions/EntityModelInfo"
}
],
"description": "Prebuilt Entity Extractor.",
"type": "object",
"x-ms-discriminator-value": "Prebuilt Entity Extractor"
},
"PrebuiltEntityExtractorsList": {
"description": "List of Prebuilt Entity Extractors.",
"items": {
"$ref": "#/definitions/PrebuiltEntityExtractor"
},
"type": "array"
},
"PrebuiltExtractorNames": {
"description": "Object model for adding a prebuilt entity to the application.",
"items": {
"type": "string"
},
"type": "array"
},
"ProductionOrStagingEndpointInfo": {
"allOf": [
{
"$ref": "#/definitions/EndpointInfo"
}
],
"type": "object"
},
"PublishSettingUpdateObject": {
"description": "Object model for updating an application's publish settings.",
"properties": {
"sentimentAnalysis": {
"description": "Setting sentiment analysis as true returns the Sentiment of the input utterance along with the response",
"type": "boolean",
"x-nullable": false
},
"speech": {
"description": "Setting speech as public enables speech priming in your app",
"type": "boolean",
"x-nullable": false
},
"spellChecker": {
"description": "Setting spell checker as public enables spell checking the input utterance.",
"type": "boolean",
"x-nullable": false
}
},
"type": "object"
},
"PublishSettings": {
"description": "The application publish settings.",
"properties": {
"id": {
"description": "The application ID.",
"format": "uuid",
"type": "string"
},
"sentimentAnalysis": {
"description": "Setting sentiment analysis as true returns the sentiment of the input utterance along with the response",
"type": "boolean",
"x-ms-client-name": "IsSentimentAnalysisEnabled",
"x-nullable": false
},
"speech": {
"description": "Enables speech priming in your app",
"type": "boolean",
"x-ms-client-name": "IsSpeechEnabled",
"x-nullable": false
},
"spellChecker": {
"description": "Enables spell checking of the utterance.",
"type": "boolean",
"x-ms-client-name": "IsSpellCheckerEnabled",
"x-nullable": false
}
},
"required": [
"id",
"sentimentAnalysis",
"speech",
"spellChecker"
],
"type": "object"
},
"ReadableType": {
"description": "Full name of the entity type.",
"enum": [
"Entity Extractor",
"Child Entity Extractor",
"Hierarchical Entity Extractor",
"Hierarchical Child Entity Extractor",
"Composite Entity Extractor",
"List Entity Extractor",
"Prebuilt Entity Extractor",
"Intent Classifier",
"Pattern.Any Entity Extractor",
"Closed List Entity Extractor",
"Regex Entity Extractor"
],
"type": "string"
},
"RegexEntity": {
"description": "Regular Expression Entity Extractor.",
"properties": {
"name": {
"type": "string"
},
"regexPattern": {
"type": "string"
},
"roles": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegexEntityExtractor": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
},
{
"$ref": "#/definitions/EntityModelInfo"
}
],
"description": "Regular Expression Entity Extractor.",
"properties": {
"regexPattern": {
"description": "The Regular Expression entity pattern.",
"type": "string"
}
},
"type": "object",
"x-ms-discriminator-value": "Regex Entity Extractor"
},
"RegexEntityExtractorList": {
"description": "List of Regular Expression Entity Extractors.",
"items": {
"$ref": "#/definitions/RegexEntityExtractor"
},
"type": "array"
},
"RegexModelCreateObject": {
"description": "Model object for creating a regular expression entity model.",
"properties": {
"name": {
"description": "The model name.",
"type": "string"
},
"regexPattern": {
"description": "The regular expression entity pattern.",
"type": "string"
}
},
"type": "object"
},
"RegexModelUpdateObject": {
"description": "Model object for updating a regular expression entity model.",
"properties": {
"name": {
"description": "The model name.",
"type": "string"
},
"regexPattern": {
"description": "The regular expression entity pattern.",
"type": "string"
}
},
"type": "object"
},
"SubClosedList": {
"description": "Sublist of items for a list entity.",
"properties": {
"canonicalForm": {
"description": "The standard form that the list represents.",
"type": "string"
},
"list": {
"description": "List of synonym words.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SubClosedListResponse": {
"allOf": [
{
"$ref": "#/definitions/SubClosedList"
}
],
"description": "Sublist of items for a list entity.",
"properties": {
"id": {
"description": "The sublist ID",
"type": "integer",
"x-nullable": false
}
},
"type": "object"
},
"TaskUpdateObject": {
"description": "Object model for cloning an application's version.",
"properties": {
"version": {
"description": "The new version for the cloned model.",
"type": "string"
}
},
"type": "object"
},
"TrainingStatus": {
"description": "The Training status.",
"enum": [
"Queued",
"InProgress",
"UpToDate",
"Fail",
"Success"
],
"type": "string"
},
"UserAccessList": {
"description": "List of user permissions.",
"properties": {
"emails": {
"items": {
"type": "string"
},
"type": "array"
},
"owner": {
"description": "The email address of owner of the application.",
"type": "string"
}
},
"type": "object"
},
"UserCollaborator": {
"properties": {
"email": {
"description": "The email address of the user.",
"type": "string"
}
},
"type": "object"
},
"VersionInfo": {
"description": "Object model of an application version.",
"properties": {
"assignedEndpointKey": {
"additionalProperties": {
"type": "string"
},
"description": "The endpoint key.",
"type": "object"
},
"createdDateTime": {
"description": "The version's creation timestamp.",
"format": "date-time",
"type": "string"
},
"endpointHitsCount": {
"description": "Number of calls made to this endpoint.",
"type": "integer"
},
"endpointUrl": {
"description": "The Runtime endpoint URL for this model version.",
"type": "string"
},
"entitiesCount": {
"description": "Number of entities in this model.",
"type": "integer"
},
"externalApiKeys": {
"description": "External keys.",
"type": "object"
},
"intentsCount": {
"description": "Number of intents in this model.",
"type": "integer"
},
"lastModifiedDateTime": {
"description": "Timestamp of the last update.",
"format": "date-time",
"type": "string"
},
"lastPublishedDateTime": {
"description": "Timestamp when was last published.",
"format": "date-time",
"type": "string"
},
"lastTrainedDateTime": {
"description": "Timestamp of the last time the model was trained.",
"format": "date-time",
"type": "string"
},
"trainingStatus": {
"description": "The current training status.",
"enum": [
"NeedsTraining",
"InProgress",
"Trained"
],
"type": "string",
"x-ms-enum": {
"name": "TrainingStatus"
}
},
"version": {
"description": "The version ID. E.g.: \"0.1\"",
"type": "string"
}
},
"required": [
"version",
"trainingStatus"
],
"type": "object"
},
"VersionResponse": {
"description": "The new version ID returned by when importing a model version.",
"type": "string"
},
"WordListBaseUpdateObject": {
"description": "Object model for updating one of the list entity's sublists.",
"properties": {
"canonicalForm": {
"description": "The standard form that the list represents.",
"type": "string"
},
"list": {
"description": "List of synonym words.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"WordListObject": {
"description": "Sublist of items for a list entity.",
"properties": {
"canonicalForm": {
"description": "The standard form that the list represents.",
"type": "string"
},
"list": {
"description": "List of synonym words.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"x-ms-parameterized-host": {
"hostTemplate": "{Endpoint}/luis/authoring/v3.0-preview",
"parameters": [
{
"$ref": "#/parameters/Endpoint"
}
],
"useSchemePrefix": false
}
}