Model - Get Hierarchical Entity

Usługa:

Azure AI Services

Wersja interfejsu API:

3.0-preview

Pobiera informacje o jednostce hierarchicznej w wersji aplikacji.

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
appId	path	True	string (uuid)	Identyfikator aplikacji.
Endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
hEntityId	path	True	string (uuid)	Identyfikator obiektu wyodrębniającego jednostki hierarchicznej.
versionId	path	True	string	Identyfikator wersji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Odpowiedzi

Nazwa	Typ	Opis
200 OK	HierarchicalEntityExtractor	Informacje o modelu jednostki hierarchicznej.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Successful Get Hierarchical Entity Info request

Przykładowe żądanie

HTTP

GET {Endpoint}/luis/authoring/v3.0-preview/apps/363187f1-c573-46b3-bc4c-ae01d686e68e/versions/{versionId}/hierarchicalentities/fe559c31-9778-42ea-ba45-94e0bd7cf767

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767",
  "name": "Location",
  "typeId": 3,
  "readableType": "Hierarchical Entity Extractor",
  "children": [
    {
      "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82",
      "name": "From"
    },
    {
      "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519",
      "name": "To"
    }
  ],
  "roles": [
    {
      "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
      "name": "role 1"
    },
    {
      "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73",
      "name": "role 2"
    }
  ]
}

Definicje

Nazwa	Opis
ChildEntity	Podstawowy typ jednostki podrzędnej.
EntityRole	Rola wyodrębniającego jednostkę
ErrorResponse	Odpowiedź na błąd podczas wywoływania operacji w interfejsie API.
HierarchicalEntityExtractor	Hierarchiczny ekstraktor jednostek.
ReadableType	Pełna nazwa typu jednostki.

ChildEntity

Objekt

Podstawowy typ jednostki podrzędnej.

Nazwa	Typ	Opis
children	ChildEntity[]	Lista elementów podrzędnych
id	string (uuid)	Identyfikator (GUID) należący do jednostki podrzędnej.
instanceOf	string	Wystąpienie modelu.
name	string	Nazwa jednostki podrzędnej.
readableType	ReadableType	Pełna nazwa typu jednostki.
typeId	integer	Identyfikator typu modelu jednostki.

EntityRole

Objekt

Rola wyodrębniającego jednostkę

Nazwa	Typ	Opis
id	string (uuid)	Identyfikator roli jednostki.
name	string	Nazwa roli jednostki.

ErrorResponse

Objekt

Odpowiedź na błąd podczas wywoływania operacji w interfejsie API.

Nazwa	Typ	Opis
errorType	string

HierarchicalEntityExtractor

Objekt

Hierarchiczny ekstraktor jednostek.

Nazwa	Typ	Opis
children	ChildEntity[]	Lista jednostek podrzędnych.
id	string (uuid)	Identyfikator modelu jednostki.
name	string	Nazwa modelu jednostki.
readableType	ReadableType	Pełna nazwa typu jednostki.
roles	EntityRole[]	Lista wyodrębniaczy jednostek Pattern.Any.
typeId	integer	Identyfikator typu modelu jednostki.

ReadableType

Wyliczanie

Pełna nazwa typu jednostki.

Wartość	Opis
Child Entity Extractor
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