Model - List Composite Entities

Dienst:

Azure AI Services

API-Version:

2.0

Ruft Informationen zu allen zusammengesetzten Entitätsmodellen in einer Version der Anwendung ab.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
appId	path	True	string (uuid)	Die Anwendungs-ID.
Endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://westus.api.cognitive.microsoft.com).
versionId	path	True	string	Die Versions-ID.
skip	query		integer minimum: 0	Die Anzahl der zu überspringenden Einträge. Der Standardwert ist 0.
take	query		integer minimum: 0 maximum: 500	Die Anzahl der zurückzugebenden Einträge. Die maximale Seitengröße beträgt 500. Der Standardwert ist 100.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Antworten

Name	Typ	Beschreibung
200 OK	CompositeEntityExtractor[]	Eine Liste der Infos zum zusammengesetzten Entitätsmodell.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Successful Get Application Version Composite Entity Infos request

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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"
      }
    ]
  }
]

Definitionen

Name	Beschreibung
ChildEntity	Der untergeordnete Basisentitätstyp.
CompositeEntityExtractor	Ein zusammengesetzter Entitätsextraktionsmodul.
EntityRole	Entitätsextraktionsrolle
ErrorResponse	Fehlerantwort beim Aufrufen eines Vorgangs in der API.
ReadableType	Vollständiger Name des Entitätstyps.

ChildEntity

Objekt

Der untergeordnete Basisentitätstyp.

Name	Typ	Beschreibung
id	string (uuid)	Die ID (GUID), die zu einer untergeordneten Entität gehört.
name	string	Der Name einer untergeordneten Entität.

CompositeEntityExtractor

Objekt

Ein zusammengesetzter Entitätsextraktionsmodul.

Name	Typ	Beschreibung
children	ChildEntity[]	Liste der untergeordneten Entitäten.
id	string (uuid)	Die ID des Entitätsmodells.
name	string	Name des Entitätsmodells.
readableType	ReadableType	Vollständiger Name des Entitätstyps.
roles	EntityRole[]	Liste der Pattern.Any Entity Extractors.
typeId	integer	Die Typ-ID des Entitätsmodells.

EntityRole

Objekt

Entitätsextraktionsrolle

Name	Typ	Beschreibung
id	string (uuid)	Die Entitätsrollen-ID.
name	string	Der Entitätsrollenname.

ErrorResponse

Objekt

Fehlerantwort beim Aufrufen eines Vorgangs in der API.

Name	Typ	Beschreibung
errorType	string

ReadableType

Enumeration

Vollständiger Name des Entitätstyps.

Wert	Beschreibung
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