Conversational Analysis Authoring - Get Supported Prebuilt Entities

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-04-01

Listet die unterstützten vordefinierten Entitäten auf, die beim Erstellen zusammengesetzter Entitäten verwendet werden können.

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?api-version=2023-04-01

Mit optionalen Parametern:

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?api-version=2023-04-01&language={language}&multilingual={multilingual}&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.
language	query		string	Die Sprache, für die unterstützte vordefinierte Entitäten abgerufen werden sollen. Erforderlich, wenn mehrsprachig ist false. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw.
maxpagesize	query		integer int32	Die maximale Anzahl von Ressourcen, die in eine einzelne Antwort eingeschlossen werden sollen.
multilingual	query		string	Ob die Unterstützung für mehrsprachige oder monolinguale Projekte vorkonfiguriert werden soll. Wenn true, wird der Sprachparameter ignoriert.
skip	query		integer int32	Ein Offset in der Auflistung der ersten zurückzugebenden Ressource.
top	query		integer int32	Die maximale Anzahl von Ressourcen, die aus der Auflistung zurückgegeben werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	ConversationalAnalysisAuthoringPrebuiltEntities	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

Successful Get Supported Prebuilt Entities

Beispielanforderung

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?api-version=2023-04-01&language=en

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "category": "Person.Name",
      "description": "Name of an individual",
      "examples": "john, Sam, Lisa"
    },
    {
      "category": "General.Event",
      "description": "Important events",
      "examples": "World War two, Covid 19"
    },
    {
      "category": "General.Organization",
      "description": "Companies and corporations",
      "examples": "Microsoft, Amazon"
    },
    {
      "category": "Choice.Boolean",
      "description": "boolean choice",
      "examples": "yes, no, agreed"
    },
    {
      "category": "Quantity.Age",
      "description": "Age of a person or thing",
      "examples": "10-month-old, 19 years old, 58 year-old"
    },
    {
      "category": "Quantity.NumberRange",
      "description": "a numeric interval",
      "examples": "between 25 and 35, 25-35"
    },
    {
      "category": "Quantity.Number",
      "description": "A cardinal number in numeric or text form",
      "examples": "ten, forty two, 3.141, 10K"
    },
    {
      "category": "Quantity.Percentage",
      "description": "A percentage, using the symbol % or the word \"percent\"",
      "examples": "10%, 5.6 percent"
    },
    {
      "category": "Quantity.Ordinal",
      "description": "An ordinal number in numeric or text form",
      "examples": "first, second, tenth, 1st, 2nd, 10th"
    },
    {
      "category": "Quantity.Dimension",
      "description": "Spacial dimensions, including length, distance, area, and volume",
      "examples": "2 miles, 650 square kilometres, 9,350 feet"
    },
    {
      "category": "Quantity.Temperature",
      "description": "A temperature in celsius or fahrenheit",
      "examples": "32F, 34 degrees celsius, 2 deg C"
    },
    {
      "category": "Quantity.Currency",
      "description": "Monetary amounts, including currency",
      "examples": "1000.00 US dollars, £20.00, $ 67.5 B"
    },
    {
      "category": "DateTime",
      "description": "exact date values",
      "examples": "May 11th"
    },
    {
      "category": "Email",
      "description": "Email addresses",
      "examples": "user@example.net, user_name@example.com, user.Name12@example.net"
    },
    {
      "category": "Phone Number",
      "description": "US phone numbers",
      "examples": "123-456-7890, +1 123 456 789, (123)456-789"
    },
    {
      "category": "URL",
      "description": "Websites URLs and links",
      "examples": "www.example.com, http://example.net?name=my_name&age=10"
    }
  ],
  "nextLink": null
}

Definitionen

Name	Beschreibung
ConversationalAnalysisAuthoringPrebuiltEntities	Stellt eine Liste der abgerufenen unterstützten vordefinierten Entitäten dar.
ConversationalAnalysisAuthoringPrebuiltEntity	Stellt eine unterstützte vordefinierte Entität dar.
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringPrebuiltEntities

Stellt eine Liste der abgerufenen unterstützten vordefinierten Entitäten dar.

Name	Typ	Beschreibung
nextLink	string	Der Link zur nächsten Seite.
value	ConversationalAnalysisAuthoringPrebuiltEntity[]	Die unterstützten vordefinierten Entitäten.

ConversationalAnalysisAuthoringPrebuiltEntity

Stellt eine unterstützte vordefinierte Entität dar.

Name	Typ	Beschreibung
category	string	Die vordefinierte Entitätskategorie.
description	string	Die Beschreibung.
examples	string	Englische Beispiele für die Entität.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Lesbarer Fehlercode.

Name	Typ	Beschreibung
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode