Share via

Pattern - List Patterns

  • Reference
Service:
Azure AI Services
API Version:
2.0

Gets patterns in a version of the application.

GET {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/patternrules
With optional parameters: 
GET {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/patternrules?skip={skip}&take={take}

URI Parameters

Name In Required Type Description
appId
 path True

string

uuid

The application ID.
Endpoint
 path True

string

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

string

The version ID.
skip
 query

integer

The number of entries to skip. Default value is 0.
take
 query

integer

The number of entries to return. Maximum page size is 500. Default is 100.

Request Header

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

string

Responses

Name Type Description
200 OK

PatternRuleInfo[]

The retrieved patterns
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Application Version Patterns request

Sample request

GET {Endpoint}/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/patternrules?skip=0&take=100

Sample response

Status code:
200 
[
  {
    "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3",
    "pattern": "who's {Name} reporting to?",
    "intent": "report to"
  },
  {
    "id": "58077d3a-4bbb-47ba-8aa9-31c0ead0bf08",
    "pattern": "who's reporting to {Name}?",
    "intent": "report to"
  }
]

Definitions

Name Description
ErrorResponse

Error response when invoking an operation on the API.
PatternRuleInfo

Pattern rule

ErrorResponse

Error response when invoking an operation on the API.

Name Type Description
errorType

string

PatternRuleInfo

Pattern rule

Name Type Description
id

string

The pattern ID.
intent

string

The intent's name where the pattern belongs to.
pattern

string

The pattern text.