Model - List Composite Entities

服务:

Azure AI Services

API 版本:

2.0

获取有关应用程序版本中所有复合实体模型的信息。

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

具有可选参数:

GET {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/compositeentities?skip={skip}&take={take}

URI 参数

名称	在	必需	类型	说明
appId	path	True	string (uuid)	应用程序 ID。
Endpoint	path	True	string	支持的认知服务终结点（协议和主机名，例如：https://westus.api.cognitive.microsoft.com）。
versionId	path	True	string	版本 ID。
skip	query		integer minimum: 0	要跳过的条目数。 默认值为 0。
take	query		integer minimum: 0 maximum: 500	要返回的条目数。 最大页面大小为 500。 默认值为 100。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string

响应

名称	类型	说明
200 OK	CompositeEntityExtractor[]	复合实体模型信息的列表。
Other Status Codes	ErrorResponse	错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

Successful Get Application Version Composite Entity Infos request

示例请求

HTTP

GET {Endpoint}/luis/api/v2.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e/versions/{versionId}/compositeentities?skip=0&take=100

示例响应

状态代码:

200

[
  {
    "id": "bc1bae43-7904-48ad-a165-88b1910174f9",
    "name": "Reservation",
    "typeId": 4,
    "readableType": "Composite Entity Extractor",
    "children": [
      {
        "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
        "name": "Location::To"
      },
      {
        "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e",
        "name": "datetime"
      }
    ],
    "roles": [
      {
        "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
        "name": "role 1"
      },
      {
        "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
        "name": "role 2"
      }
    ]
  }
]

定义

名称	说明
ChildEntity	基子实体类型。
CompositeEntityExtractor	复合实体提取器。
EntityRole	实体提取程序角色
ErrorResponse	调用 API 上的作时出现错误响应。
ReadableType	实体类型的全名。

ChildEntity

Object

基子实体类型。

名称	类型	说明
id	string (uuid)	属于子实体的 ID （GUID）。
name	string	子实体的名称。

CompositeEntityExtractor

Object

复合实体提取器。

名称	类型	说明
children	ChildEntity[]	子实体的列表。
id	string (uuid)	实体模型的 ID。
name	string	实体模型的名称。
readableType	ReadableType	实体类型的全名。
roles	EntityRole[]	Pattern.Any 实体提取程序的列表。
typeId	integer	实体模型的类型 ID。

EntityRole

Object

实体提取程序角色

名称	类型	说明
id	string (uuid)	实体角色 ID。
name	string	实体角色名称。

ErrorResponse

Object

调用 API 上的作时出现错误响应。

名称	类型	说明
errorType	string

ReadableType

枚举

实体类型的全名。

值	说明
Closed List Entity Extractor
Composite Entity Extractor
Entity Extractor
Hierarchical Child Entity Extractor
Hierarchical Entity Extractor
Intent Classifier
List Entity Extractor
Pattern.Any Entity Extractor
Prebuilt Entity Extractor
Regex Entity Extractor