Share via

Apps - List Available Custom Prebuilt Domains

Service:
Azure AI Services
API Version:
2.0

Gets all the available custom prebuilt domains for all cultures.

GET {Endpoint}/luis/api/v2.0/apps/customprebuiltdomains

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Responses

Name Type Description
200 OK

PrebuiltDomain[]

Returns a list of all custom prebuilt domains and their intents/entities representation.
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Available Custom Prebuilt Domains request

Sample request

GET {Endpoint}/luis/api/v2.0/apps/customprebuiltdomains

Sample response

Status code:
200 
[
  {
    "name": "taxi",
    "culture": "en-us",
    "description": "A custom prebuilt domain for taxi booking",
    "examples": "book taxi x on friday at 6 pm, take me to Tinga's from Westin hotel with taxi lux",
    "intents": [
      {
        "name": "book_taxi",
        "description": "Requests/Books taxi",
        "examples": "book taxi x on friday at 6 pm"
      },
      {
        "name": "cancel_taxi",
        "description": "Cancels taxi request",
        "examples": "I just called an taxi SUV , please cancel, Cancel my taxi"
      }
    ],
    "entities": [
      {
        "name": "from_place_name",
        "description": "Route starting point",
        "examples": "find taxi x to take me to 9th street from space needle"
      }
    ]
  },
  {
    "name": "weather",
    "culture": "en-us",
    "description": "A custom prebuilt domain that gets weather forecast and condition",
    "examples": "Show me the weather for this weekend, What's the weather?",
    "intents": [
      {
        "name": "get_forecast",
        "description": "Gets weather forecast",
        "examples": "What's the weather like tomorrow?"
      },
      {
        "name": "get_condition",
        "description": "Gets weather condition",
        "examples": "what's the average temperature in India in September?"
      }
    ],
    "entities": [
      {
        "name": "location",
        "description": "Location of the queried weather",
        "examples": "What's the weather like in Minneapolis"
      },
      {
        "name": "unit",
        "description": "Temperature measurement unit",
        "examples": "Please change the weather from Fahrenheit to Celsius"
      }
    ]
  }
]

Definitions

Name Description
ErrorResponse

Error response when invoking an operation on the API.
PrebuiltDomain

Prebuilt Domain.
PrebuiltDomainItem

ErrorResponse

Object

Error response when invoking an operation on the API.

Name Type Description
errorType

string

PrebuiltDomain

Object

Prebuilt Domain.

Name Type Description
culture

string

description

string

entities

PrebuiltDomainItem[]

examples

string

intents

PrebuiltDomainItem[]

name

string

PrebuiltDomainItem

Object
Name Type Description
description

string

examples

string

name

string