LUIS Programmatic
Connect to LUIS Programmatic with 1 MCP tools for AI-powered API automation.
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "azure.local",
"basePath": "/luis/api/v2.0",
"info": {
"title": "LUIS Programmatic",
"version": "v2.0",
"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/Programmatic/stable/v2.0/LUIS-Programmatic.json",
"version": "2.0"
}
],
"x-providerName": "azure.com",
"x-serviceName": "cognitiveservices-LUIS-Programmatic",
"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"
},
"CEntityIdInPath": {
"description": "The composite entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "cEntityId",
"required": true,
"type": "string",
"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"
},
"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 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": {
"AzureRegion": "westus",
"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": "A model 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": {
"AzureRegion": "westus",
"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://api.luis.ai/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": {
"AzureRegion": "westus",
"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 the supported application cultures.",
"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": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"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 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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"prebuiltDomainCreateObject": {
"culture": "en-US",
"domainName": "Web"
}
},
"responses": {
"201": {
"body": "00000000-0000-0000-0000-000000000000",
"headers": {
"location": "https://api.luis.ai/api/v2.0/apps/customprebuiltdomains/00000000-0000-0000-0000-000000000000"
}
}
}
}
}
}
},
"/apps/customprebuiltdomains/{culture}": {
"get": {
"description": "Gets all the available custom 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/entities representation for a specific culture.",
"schema": {
"$ref": "#/definitions/PrebuiltDomainsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get AvailableCustomPrebuiltDomainsForCulture request": {
"parameters": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"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 should be included in 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.",
"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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appName": "Test LUIS App",
"luisApp": {
"bing_entities": [
"datetimeV2",
"geography"
],
"closedLists": [],
"composites": [],
"culture": "en-us",
"desc": "",
"entities": [
{
"name": "AirportCode"
},
{
"name": "Hotel"
}
],
"intents": [
{
"name": "dateintent"
},
{
"name": "Help"
},
{
"name": "None"
},
{
"name": "SearchHotels"
},
{
"name": "ShowHotelsReviews"
}
],
"luis_schema_version": "2.1.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",
"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://api.luis.ai/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": {
"AzureRegion": "westus",
"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"
}
],
"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": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"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}/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": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"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 users access list with the one 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's 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": {
"AzureRegion": "westus",
"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 and its assigned endpoint key.",
"schema": {
"$ref": "#/definitions/ProductionOrStagingEndpointInfo"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Publish Application request": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "11be6373fca44ded80fbe2afa8597c18",
"applicationPublishObject": {
"isStaging": false,
"region": "westus",
"versionId": "0.1"
}
},
"responses": {
"201": {
"body": {
"assignedEndpointKey": "11be6373fca44ded80fbe2afa8597c18",
"endpointRegion": "westus",
"endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/11be6373fca44ded80fbe2afa8597c18",
"isStaging": false,
"publishedDateTime": "2017-11-28T19:20:28Z"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/querylogs": {
"get": {
"description": "Gets the query logs of the past month 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": {
"AzureRegion": "westus",
"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.",
"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": {
"AzureRegion": "westus",
"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.",
"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": {
"AzureRegion": "westus",
"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 the application versions info.",
"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": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a",
"luisApp": {
"bing_entities": [
"datetimeV2",
"geography"
],
"closedLists": [],
"composites": [],
"culture": "en-us",
"desc": "",
"entities": [
{
"name": "AirportCode"
},
{
"name": "Hotel"
}
],
"intents": [
{
"name": "dateintent"
},
{
"name": "Help"
},
{
"name": "None"
},
{
"name": "SearchHotels"
},
{
"name": "ShowHotelsReviews"
}
],
"luis_schema_version": "2.1.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",
"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://api.luis.ai/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": {
"AzureRegion": "westus",
"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 info.",
"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": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"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 using the current snapshot of the selected application version.",
"operationId": "Versions_Clone",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model containing the new version ID.",
"in": "body",
"name": "versionCloneObject",
"schema": {
"$ref": "#/definitions/TaskUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The version ID of the created task.",
"schema": {
"example": "0.2",
"type": "string"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Clone Application Version request": {
"parameters": {
"AzureRegion": "westus",
"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 the closedlist models.",
"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 closedlist 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": {
"AzureRegion": "westus",
"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",
"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 closed list model to the application.",
"operationId": "Model_AddClosedList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model containing the name and words for the new closed 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": {
"AzureRegion": "westus",
"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 closed list model from the application.",
"operationId": "Model_DeleteClosedList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The closed list model ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully delete Closed List from application.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Closed List Entity Info request": {
"parameters": {
"AzureRegion": "westus",
"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 of a closed list model.",
"operationId": "Model_GetClosedList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The closed list model ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The closed 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": {
"AzureRegion": "westus",
"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",
"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 closedlist.",
"operationId": "Model_PatchClosedList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The closed list 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 Closed List.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add SubLists to Closed List Entity request": {
"parameters": {
"AzureRegion": "westus",
"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 closed list model.",
"operationId": "Model_UpdateClosedList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The closed list model ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
},
{
"description": "The new entity name and words list.",
"in": "body",
"name": "closedListModelUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ClosedListModelUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated Closed List 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": {
"AzureRegion": "westus",
"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 list to an existing closed list.",
"operationId": "Model_AddSubList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The closed 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 list.",
"schema": {
"example": 90440,
"type": "integer"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Sublist request": {
"parameters": {
"AzureRegion": "westus",
"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://api.luis.ai/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 closed list model.",
"operationId": "Model_DeleteSubList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The closed list entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
},
{
"description": "The sublist ID.",
"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": {
"AzureRegion": "westus",
"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 closed list's sublists.",
"operationId": "Model_UpdateSubList",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The closed list entity extractor ID.",
"format": "uuid",
"in": "path",
"name": "clEntityId",
"required": true,
"type": "string"
},
{
"description": "The sublist ID.",
"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": {
"AzureRegion": "westus",
"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}/compositeentities": {
"get": {
"description": "Gets information about the composite entity models.",
"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": {
"AzureRegion": "westus",
"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",
"typeId": 4
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a composite entity extractor to the application.",
"operationId": "Model_AddCompositeEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model containing the name and children of the new entity extractor.",
"in": "body",
"name": "compositeModelCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/CompositeEntityModel"
}
}
],
"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 Extractor": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "{apiKey}",
"appId": "{appId}",
"compositeModelCreateObject": {
"children": [
"Location::To",
"datetime"
],
"name": "Reservation"
},
"versionId": "{versionId}"
},
"responses": {
"201": {
"body": "bc1bae43-7904-48ad-a165-88b1910174f9",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": {
"delete": {
"description": "Deletes a composite entity extractor from 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": {
"AzureRegion": "westus",
"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 the composite entity model.",
"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": {
"AzureRegion": "westus",
"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",
"typeId": 4
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the composite entity extractor.",
"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": {
"AzureRegion": "westus",
"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.",
"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": {
"AzureRegion": "westus",
"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 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": {
"AzureRegion": "westus",
"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}/customprebuiltdomains": {
"post": {
"consumes": [
"application/json"
],
"description": "Adds a customizable prebuilt domain along with all of its models to this 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 custom prebuilt domain 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": {
"AzureRegion": "westus",
"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 from 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": {
"AzureRegion": "westus",
"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 custom prebuilt entities information of this application.",
"operationId": "Model_ListCustomPrebuiltEntities",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns a list of all custom 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": {
"AzureRegion": "westus",
"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",
"typeId": 1
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a custom prebuilt entity model to the application.",
"operationId": "Model_AddCustomPrebuiltEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model object containing the name of the custom 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 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": {
"AzureRegion": "westus",
"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}/customprebuiltintents": {
"get": {
"description": "Gets custom prebuilt intents information of this application.",
"operationId": "Model_ListCustomPrebuiltIntents",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns a list of all custom prebuilt intents and their representations.",
"schema": {
"$ref": "#/definitions/IntentClassifiersList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Custom Prebuilt Intent request": {
"parameters": {
"AzureRegion": "westus",
"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 custom prebuilt intent model to the application.",
"operationId": "Model_AddCustomPrebuiltIntent",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model object containing the name of the custom 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 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": {
"AzureRegion": "westus",
"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 custom prebuilt models information of this application.",
"operationId": "Model_ListCustomPrebuiltModels",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns a list of all custom 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": {
"AzureRegion": "westus",
"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",
"typeId": 1
}
],
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/entities": {
"get": {
"description": "Gets information about the entity models.",
"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/EntityExtractorsList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Entity Infos request": {
"parameters": {
"AzureRegion": "westus",
"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",
"typeId": 1
},
{
"customPrebuiltDomainName": "Camera",
"customPrebuiltModelName": "AppName",
"id": "b8e31be4-300f-455e-894b-6f079abca0a2",
"name": "$Camera.AppName",
"readableType": "Entity Extractor",
"typeId": 1
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds an entity extractor to the application.",
"operationId": "Model_AddEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model object containing the name for the new entity extractor.",
"in": "body",
"name": "modelCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ModelCreateObject"
}
}
],
"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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"modelCreateObject": {
"name": "DayOfWeek"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"headers": {
"Location": "https://api.luis.ai/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 extractor from the application.",
"operationId": "Model_DeleteEntity",
"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": "Successfully deleted entity.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Entity Info request": {
"parameters": {
"AzureRegion": "westus",
"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 the entity model.",
"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/EntityExtractor"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Entity Info request": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "DayOfWeek",
"readableType": "Entity Extractor",
"typeId": 1
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the name of an entity extractor.",
"operationId": "Model_UpdateEntity",
"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 new entity extractor name.",
"in": "body",
"name": "modelUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ModelUpdateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successfully updated entity extractor name.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Rename Entity Info request": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"modelUpdateObject": {
"name": "New Name"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/entities/{entityId}/suggest": {
"get": {
"description": "Get suggestion examples that would improve the accuracy of the entity model.",
"operationId": "Model_GetEntitySuggestions",
"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 model, nothing is returned in the response. If there's a trained model and the active learning algorithm finds any relevant queries, they are returned with the model predictions. If there's a trained model but the active learning algorithm 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": {
"AzureRegion": "westus",
"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 to the application.",
"operationId": "Examples_Add",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "An example label 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.",
"schema": {
"$ref": "#/definitions/LabelExampleResponse"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Add Label request": {
"parameters": {
"AzureRegion": "westus",
"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 examples to be reviewed.",
"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 in the application.",
"schema": {
"$ref": "#/definitions/LabeledUtterances"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Review Labeled Examples request": {
"parameters": {
"AzureRegion": "westus",
"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::To",
"startTokenIndex": 7
},
{
"endTokenIndex": 5,
"entityName": "Location::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 examples to the application.",
"operationId": "Examples_Batch",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "Array of examples.",
"in": "body",
"name": "exampleLabelObjectArray",
"required": true,
"schema": {
"$ref": "#/definitions/ExampleLabelObjectArray"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "A string array determining which labels 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 labels.",
"schema": {
"$ref": "#/definitions/BatchLabelExampleResponse"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Batch Add Labels request": {
"parameters": {
"AzureRegion": "westus",
"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 with the specified ID.",
"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 label.",
"schema": {
"$ref": "#/definitions/OperationStatus"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Delete Example Label request": {
"parameters": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a",
"versionId": "0.2"
},
"responses": {
"200": {
"body": {
"bing_entities": [
"datetimeV2",
"geography"
],
"closedLists": [],
"composites": [],
"culture": "en-us",
"desc": "",
"entities": [
{
"name": "AirportCode"
},
{
"name": "Hotel"
}
],
"intents": [
{
"name": "dateintent"
},
{
"name": "Help"
},
{
"name": "None"
},
{
"name": "SearchHotels"
},
{
"name": "ShowHotelsReviews"
}
],
"luis_schema_version": "2.1.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",
"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 features for the specified application version.",
"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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"skipIn": 0,
"takeIn": 100,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"patternFeatures": [
{
"id": 81231,
"isActive": true,
"name": "EmailPattern",
"pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b"
}
],
"phraselistFeatures": [
{
"id": 5341,
"isActive": true,
"isExchangeable": true,
"name": "Cities",
"phrases": "Seattle,New York,Paris,Moscow,Beijin"
},
{
"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 the hierarchical entity models.",
"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": {
"AzureRegion": "westus",
"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",
"typeId": 3
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a hierarchical entity extractor to the application version.",
"operationId": "Model_AddHierarchicalEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model containing the name and children of the new entity extractor.",
"in": "body",
"name": "hierarchicalModelCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/HierarchicalEntityModel"
}
}
],
"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 Hierarchical Entity Extractor request": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "{apiKey}",
"appId": "{appId}",
"hierarchicalModelCreateObject": {
"children": [
"From",
"To"
],
"name": "Location"
},
"versionId": "{versionId}"
},
"responses": {
"201": {
"body": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": {
"delete": {
"description": "Deletes a hierarchical entity extractor from the application version.",
"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": {
"AzureRegion": "westus",
"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 the hierarchical entity model.",
"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": {
"AzureRegion": "westus",
"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",
"typeId": 3
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Updates the name and children of a hierarchical entity model.",
"operationId": "Model_UpdateHierarchicalEntity",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
},
{
"description": "Model containing names of the children of the hierarchical entity.",
"in": "body",
"name": "hierarchicalModelUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/HierarchicalEntityModel"
}
}
],
"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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"hierarchicalModelUpdateObject": {
"children": [
"Location::To"
],
"name": "Reservation"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children": {
"post": {
"consumes": [
"application/json"
],
"description": "Creates a single child in an existing hierarchical entity model.",
"operationId": "Model_AddHierarchicalEntityChild",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/HEntityIdInPath"
},
{
"description": "A model object containing the name of the new hierarchical child model.",
"in": "body",
"name": "hierarchicalChildModelCreateObject",
"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 Hierarchical Entity Child Model request": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
"hierarchicalChildModelCreateObject": {
"name": "To"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": "891c235f-4f42-4320-bc36-b6256b6c3f2b",
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": {
"delete": {
"description": "Deletes a hierarchical entity extractor child from 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": {
"AzureRegion": "westus",
"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 hierarchical entity child model.",
"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": {
"AzureRegion": "westus",
"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": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Renames a single child in an existing hierarchical entity model.",
"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": {
"AzureRegion": "westus",
"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}/intents": {
"get": {
"description": "Gets information about the intent models.",
"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": {
"AzureRegion": "westus",
"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 classifier to the application.",
"operationId": "Model_AddIntent",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "A model object containing the name of the new intent classifier.",
"in": "body",
"name": "intentCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/ModelCreateObject"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "The ID of the created model.",
"schema": {
"$ref": "#/definitions/GuidResponse"
},
"x-nullable": false
}
},
"x-ms-examples": {
"Successful Create Intent Classifier request": {
"parameters": {
"AzureRegion": "westus",
"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 classifier from the application.",
"operationId": "Model_DeleteIntent",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
},
{
"default": false,
"description": "Also delete the intent's utterances (true). Or move the utterances to the None intent (false - the default value).",
"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": {
"AzureRegion": "westus",
"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.",
"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": {
"AzureRegion": "westus",
"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 classifier.",
"operationId": "Model_UpdateIntent",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
},
{
"description": "A model object containing the new intent classifier 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": {
"AzureRegion": "westus",
"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}/suggest": {
"get": {
"description": "Suggests examples that would improve the accuracy of the intent model.",
"operationId": "Model_GetIntentSuggestions",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/IntentIdInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "If there's no trained model, nothing is returned in the response. If there's a trained model and the active learning algorithm finds any relevant queries, they are returned with the model predictions. If there's a trained model but the active learning algorithm 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": {
"AzureRegion": "westus",
"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 entity extractors for 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": {
"AzureRegion": "westus",
"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 the application version models.",
"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": {
"AzureRegion": "westus",
"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",
"typeId": 2
},
{
"id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
"name": "DayOfWeek",
"readableType": "Entity Extractor",
"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",
"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",
"typeId": 4
},
{
"id": "8713b104-78ec-4c4f-9f96-f2e53562cc16",
"name": "States",
"readableType": "Closed List Entity Extractor",
"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",
"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}/patterns": {
"get": {
"deprecated": true,
"description": "[DEPRECATED NOTICE: This operation will soon be removed] Gets all the pattern features.",
"operationId": "Features_GetApplicationVersionPatternFeatures",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/SkipInPath"
},
{
"$ref": "#/parameters/TakeInPath"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of pattern features.",
"schema": {
"$ref": "#/definitions/PatternFeatureInfoList"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Application Version Pattern Features request": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": 601765,
"isActive": true,
"name": "PatternIP",
"pattern": "\\b\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\b"
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"deprecated": true,
"description": "[DEPRECATED NOTICE: This operation will soon be removed] Creates a new pattern feature.",
"operationId": "Features_CreatePatternFeature",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The Name and Pattern of the feature.",
"in": "body",
"name": "patternCreateObject",
"required": true,
"schema": {
"$ref": "#/definitions/PatternCreateObject"
}
}
],
"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 Pattern Feature request": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"patternCreateObject": {
"name": "EmailPattern",
"pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b"
},
"versionId": "0.1"
},
"responses": {
"201": {
"body": 83147,
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/patterns/{patternId}": {
"delete": {
"deprecated": true,
"description": "[DEPRECATED NOTICE: This operation will soon be removed] Deletes a pattern feature.",
"operationId": "Features_DeletePatternFeature",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The pattern feature ID.",
"in": "path",
"name": "patternId",
"required": true,
"type": "integer"
}
],
"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 Pattern Feature Info request": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"patternId": 8342,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
},
"get": {
"deprecated": true,
"description": "[DEPRECATED NOTICE: This operation will soon be removed] Gets the specified pattern feature's info.",
"operationId": "Features_GetPatternFeatureInfo",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The pattern feature ID.",
"in": "path",
"name": "patternId",
"required": true,
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The pattern feature info.",
"schema": {
"$ref": "#/definitions/PatternFeatureInfo"
}
},
"default": {
"description": "Error Response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Successful Get Pattern Feature Info request": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"patternId": 7892,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"id": 7892,
"isActive": true,
"name": "EmailPattern",
"pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b"
},
"headers": {}
}
}
}
}
},
"put": {
"consumes": [
"application/json"
],
"deprecated": true,
"description": "[DEPRECATED NOTICE: This operation will soon be removed] Updates the pattern, the name and the state of the pattern feature.",
"operationId": "Features_UpdatePatternFeature",
"parameters": [
{
"$ref": "#/parameters/AppIdInPath"
},
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"description": "The pattern feature ID.",
"in": "path",
"name": "patternId",
"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 and a boolean called IsActive to update the feature.",
"in": "body",
"name": "patternUpdateObject",
"required": true,
"schema": {
"$ref": "#/definitions/PatternUpdateObject"
}
}
],
"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 Pattern Feature Info request": {
"parameters": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"patternId": 8342,
"patternUpdateObject": {
"name": "ModifiedEmailPattern",
"pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b"
},
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"code": "Success",
"message": "Operation Successful"
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/phraselists": {
"get": {
"description": "Gets all the phraselist features.",
"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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"versionId": "0.1"
},
"responses": {
"200": {
"body": [
{
"id": 321421,
"isActive": true,
"isExchangeable": true,
"name": "Cities",
"phrases": "Seattle,New York,Paris,Moscow,Beijin"
},
{
"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.",
"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": {
"AzureRegion": "westus",
"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.",
"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": {
"AzureRegion": "westus",
"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.",
"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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"phraselistId": 178384,
"versionId": "0.1"
},
"responses": {
"200": {
"body": {
"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.",
"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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"phraselistId": 178384,
"phraselistUpdateObject": {
"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 the prebuilt entity models.",
"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": {
"AzureRegion": "westus",
"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",
"typeId": 2
}
],
"headers": {}
}
}
}
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Adds a list of prebuilt entity extractors to 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": {
"AzureRegion": "westus",
"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/{prebuiltId}": {
"delete": {
"description": "Deletes a prebuilt entity extractor from 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": {
"AzureRegion": "westus",
"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 the prebuilt entity model.",
"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": {
"AzureRegion": "westus",
"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",
"typeId": 2
},
"headers": {}
}
}
}
}
}
},
"/apps/{appId}/versions/{versionId}/suggest": {
"delete": {
"consumes": [
"application/json"
],
"description": "Deleted an unlabelled utterance.",
"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": {
"AzureRegion": "westus",
"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/v2.0/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 examples 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": {
"AzureRegion": "westus",
"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": {
"AzureRegion": "westus",
"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
"appId": "86226c53-b7a6-416f-876b-226b2b5ab07b",
"versionId": "0.1"
},
"responses": {
"202": {
"body": {
"status": "Queued",
"statusId": 9
},
"headers": {}
}
}
}
}
}
}
},
"definitions": {
"ApplicationCreateObject": {
"description": "Properties for creating a new LUIS Application",
"example": {
"culture": "en-us",
"description": "This is my first dummy application.",
"domain": "Comics",
"initialVersionId": "1.0",
"name": "MyFirstDummyApp",
"usageScenario": "IoT"
},
"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. E.g.: en-us.",
"type": "string"
},
"description": {
"description": "The description of the application.",
"type": "string"
},
"domain": {
"description": "The domain for the new application. Optional. E.g.: 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. E.g.: 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.",
"example": {
"isStaging": false,
"region": "westus",
"versionId": "0.1"
},
"properties": {
"isStaging": {
"default": false,
"description": "Indicates if the staging slot should be used, instead of the Production one.",
"type": "boolean"
},
"region": {
"description": "The target region that the application is published to.",
"type": "string"
},
"versionId": {
"description": "The version ID to publish.",
"type": "string"
}
},
"type": "object"
},
"ApplicationSettingUpdateObject": {
"description": "Object model for updating an application's settings.",
"example": {
"public": true
},
"properties": {
"public": {
"description": "Setting your application as public allows other people to use your application's endpoint using their own keys.",
"type": "boolean",
"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.",
"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.",
"example": {
"description": "This is my first modified dummy description.",
"name": "MyFirstRenamedDummyAp"
},
"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"
},
"BatchLabelExample": {
"description": "Response when adding a batch of labeled examples.",
"properties": {
"error": {
"$ref": "#/definitions/OperationStatus"
},
"hasError": {
"type": "boolean"
},
"value": {
"$ref": "#/definitions/LabelExampleResponse"
}
},
"type": "object"
},
"BatchLabelExampleResponse": {
"description": "Response when adding a batch of labeled examples.",
"items": {
"$ref": "#/definitions/BatchLabelExample"
},
"type": "array"
},
"ChildEntity": {
"description": "The base child entity type.",
"properties": {
"id": {
"description": "The ID (GUID) belonging to a child entity.",
"format": "uuid",
"type": "string"
},
"name": {
"description": "The name of a child entity.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ClosedList": {
"description": "Exported Model - A Closed List.",
"properties": {
"name": {
"description": "Name of the closed list feature.",
"type": "string"
},
"subLists": {
"description": "Sublists for the feature.",
"items": {
"$ref": "#/definitions/SubClosedList",
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ClosedListEntityExtractor": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
}
],
"description": "Closed List Entity Extractor.",
"properties": {
"subLists": {
"description": "List of sub-lists.",
"items": {
"$ref": "#/definitions/SubClosedListResponse"
},
"type": "array"
}
},
"type": "object",
"x-ms-discriminator-value": "Closed List Entity Extractor"
},
"ClosedListEntityExtractorsList": {
"description": "List of Closed List Entity Extractors.",
"items": {
"$ref": "#/definitions/ClosedListEntityExtractor"
},
"type": "array"
},
"ClosedListModelCreateObject": {
"description": "Object model for creating a closed list.",
"example": {
"name": "States",
"subLists": [
{
"canonicalForm": "New York",
"list": [
"NY",
"New York"
]
},
{
"canonicalForm": "Washington",
"list": [
"Washington",
"WA"
]
},
{
"canonicalForm": "California",
"list": [
"California",
"CA",
"Calif.",
"Cal."
]
}
]
},
"properties": {
"name": {
"description": "Name of the closed list feature.",
"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 closedlist.",
"example": {
"subLists": [
{
"canonicalForm": "Ohio",
"list": [
"Ohio",
"OH"
]
}
]
},
"properties": {
"subLists": {
"description": "Sublists to add.",
"items": {
"$ref": "#/definitions/WordListObject",
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ClosedListModelUpdateObject": {
"description": "Object model for updating a closed list.",
"example": {
"name": "States",
"subLists": [
{
"canonicalForm": "new york",
"list": [
"ny",
"new york"
]
},
{
"canonicalForm": "washington",
"list": [
"washington",
"wa"
]
},
{
"canonicalForm": "california",
"list": [
"california",
"ca",
"calif.",
"cal."
]
},
{
"canonicalForm": "Texas",
"list": [
"Texas",
"TX"
]
}
]
},
"properties": {
"name": {
"description": "The new name of the closed list feature.",
"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"
}
],
"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.",
"example": {
"children": [
"Class",
"Location"
],
"name": "Reservation"
},
"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"
},
"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 Programmatic 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. E.g.: 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"
}
],
"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"
},
"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"
},
"startCharIndex": {
"description": "The index within the utterance where the extracted entity starts.",
"type": "integer"
}
},
"required": [
"entityName",
"startCharIndex",
"endCharIndex"
],
"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"
},
"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.",
"example": {
"entityLabels": [
{
"endCharIndex": 34,
"entityName": "Place",
"startCharIndex": 21
}
],
"intentName": "WeatherInPlace",
"text": "whats the weather in buenos aires?"
},
"properties": {
"entityLabels": {
"description": "The idenfied entities within the utterance.",
"items": {
"$ref": "#/definitions/EntityLabelObject",
"type": "object"
},
"type": "array"
},
"intentName": {
"description": "The idenfitied intent representing the utterance.",
"type": "string"
},
"text": {
"description": "The sample's utterance.",
"type": "string"
}
},
"type": "object"
},
"ExampleLabelObjectArray": {
"description": "Object model for adding a batch of labeled examples.",
"example": [
{
"entityLabels": [
{
"endCharIndex": 26,
"entityName": "Location::From",
"startCharIndex": 22
},
{
"endCharIndex": 37,
"entityName": "Location::To",
"startCharIndex": 31
}
],
"intentName": "BookFlight",
"text": "Book me a flight from Cairo to Redmond next Thursday"
},
{
"entityLabels": [
{
"endCharIndex": 33,
"entityName": "Location",
"startCharIndex": 27
}
],
"intentName": "GetWeather",
"text": "What's the weather like in Seattle?"
}
],
"items": {
"$ref": "#/definitions/ExampleLabelObject",
"type": "object"
},
"type": "array"
},
"FeatureIDResponse": {
"description": "The ID of the created feature.",
"example": 398102,
"type": "integer",
"x-nullable": false
},
"FeatureInfoObject": {
"description": "The base class Features-related response objects inherit from.",
"properties": {
"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"
},
"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)",
"example": [
"2639049a-e41d-4285-a3c6-8a17ed299473",
"200d6173-ecfa-4967-bf95-3c319902dc52",
"f80aa9ba-64c8-4a36-8cc5-92010d0aadf1"
],
"items": {
"$ref": "#/definitions/GuidResponse"
},
"type": "array"
},
"GuidResponse": {
"description": "The ID (GUID) returned by an operation.",
"example": "363187f1-c573-46b3-bc4c-ae01d686e68e",
"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"
}
],
"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"
},
"HierarchicalEntityModel": {
"description": "A Hierarchical Entity Extractor.",
"example": {
"children": [
"Location::To"
],
"name": "Reservation"
},
"properties": {
"children": {
"description": "Child entities.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Entity name.",
"type": "string"
}
},
"type": "object"
},
"HierarchicalModel": {
"properties": {
"children": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"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. E.g.: what's the weather like in seattle?",
"type": "string"
},
"tokenizedText": {
"description": "The utterance tokenized.",
"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"
},
"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"
},
"mode": {
"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"
},
"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"
},
"LabelExampleResponse": {
"description": "Response when adding a labeled example.",
"properties": {
"ExampleId": {
"description": "The newly created sample ID.",
"example": -6830368,
"type": "integer"
},
"UtteranceText": {
"description": "The sample's utterance.",
"example": "book me a flight from cairo to redmond next thursday",
"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. E.g.: 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.",
"example": {
"bing_entities": [
"datetimeV2",
"geography"
],
"closedLists": [],
"composites": [],
"culture": "en-us",
"desc": "",
"entities": [
{
"name": "AirportCode"
},
{
"name": "Hotel"
}
],
"intents": [
{
"name": "dateintent"
},
{
"name": "Help"
},
{
"name": "None"
},
{
"name": "SearchHotels"
},
{
"name": "ShowHotelsReviews"
}
],
"luis_schema_version": "2.1.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",
"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"
},
"properties": {
"bing_entities": {
"description": "List of prebuilt intents.",
"items": {
"type": "string"
},
"type": "array"
},
"closedLists": {
"description": "List of closed lists.",
"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"
},
"intents": {
"description": "List of intents.",
"items": {
"$ref": "#/definitions/HierarchicalModel",
"type": "object"
},
"type": "array"
},
"model_features": {
"description": "List of model features.",
"items": {
"$ref": "#/definitions/JSONModelFeature",
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of the application.",
"type": "string"
},
"regex_features": {
"description": "List of pattern features.",
"items": {
"$ref": "#/definitions/JSONRegexFeature",
"type": "object"
},
"type": "array"
},
"utterances": {
"description": "List of sample 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.",
"example": {
"name": "DayOfWeek"
},
"properties": {
"name": {
"description": "Name of the new entity extractor.",
"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"
}
],
"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.",
"example": {
"name": "New Name"
},
"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"
},
"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"
},
"PatternCreateObject": {
"description": "Object model for creating a Pattern feature.",
"example": {
"name": "EmailPattern",
"pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b"
},
"properties": {
"name": {
"description": "Name of the feature.",
"type": "string"
},
"pattern": {
"description": "The Regular Expression to match.",
"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"
},
"PatternUpdateObject": {
"description": "Object model for updating an existing Pattern feature.",
"example": {
"name": "ModifiedEmailPattern",
"pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b"
},
"properties": {
"isActive": {
"default": true,
"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"
},
"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.",
"example": {
"isExchangeable": false,
"name": "DaysOfWeek",
"phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday"
},
"properties": {
"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"
},
"PhraselistUpdateObject": {
"description": "Object model for updating a Phraselist.",
"example": {
"name": "DaysOfWeek",
"phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday"
},
"properties": {
"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.",
"example": {
"domainName": "Camera"
},
"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.",
"example": {
"culture": "en-US",
"domainName": "Web"
},
"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.",
"example": {
"domainName": "Camera",
"modelName": "AppName"
},
"properties": {
"domainName": {
"description": "The domain name.",
"type": "string"
},
"modelName": {
"description": "The intent name or entity name.",
"type": "string"
}
},
"type": "object"
},
"PrebuiltDomainsList": {
"description": "List of Prebuilt Domains.",
"items": {
"$ref": "#/definitions/PrebuiltDomain"
},
"type": "array"
},
"PrebuiltEntityExtractor": {
"allOf": [
{
"$ref": "#/definitions/ModelInfo"
}
],
"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": "Objet model for adding a prebuilt entity to the application.",
"example": [
"number",
"ordinal"
],
"items": {
"type": "string"
},
"type": "array"
},
"ProductionOrStagingEndpointInfo": {
"allOf": [
{
"$ref": "#/definitions/EndpointInfo"
}
],
"type": "object"
},
"ReadableType": {
"description": "Full name of the entity type.",
"enum": [
"Entity Extractor",
"Hierarchical Entity Extractor",
"Hierarchical Child Entity Extractor",
"Composite Entity Extractor",
"Closed List Entity Extractor",
"Prebuilt Entity Extractor",
"Intent Classifier"
],
"type": "string"
},
"SubClosedList": {
"description": "Sublist of items for a Closed list.",
"example": {
"canonicalForm": "BankName",
"list": [
"HSBC",
"CitiBank"
]
},
"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 Closed list.",
"properties": {
"id": {
"description": "The sublist ID",
"example": "123456",
"type": "integer",
"x-nullable": false
}
},
"type": "object"
},
"TaskUpdateObject": {
"description": "Object model for cloning an application's version.",
"example": {
"version": "1.0"
},
"properties": {
"version": {
"description": "The new version for the cloned model.",
"type": "string"
}
},
"type": "object"
},
"TrainingStatus": {
"description": "The Trainning 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.",
"example": "0.1",
"type": "string"
},
"WordListBaseUpdateObject": {
"description": "Object model for updating one of the closed list's sublists.",
"example": {
"canonicalForm": "California",
"list": [
"California",
"CA",
"Calif.",
"Cal."
]
},
"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 Closed list.",
"example": {
"canonicalForm": "California",
"list": [
"California",
"CA",
"Calif.",
"Cal."
]
},
"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": "{AzureRegion}.api.cognitive.microsoft.com",
"parameters": [
{
"description": "Supported Azure regions for Cognitive Services endpoints",
"enum": [
"westus",
"westeurope",
"southeastasia",
"eastus2",
"westcentralus",
"westus2",
"eastus",
"southcentralus",
"northeurope",
"eastasia",
"australiaeast",
"brazilsouth"
],
"in": "path",
"name": "AzureRegion",
"required": true,
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "AzureRegions"
},
"x-ms-parameter-location": "client",
"x-ms-skip-url-encoding": true
}
]
}
}