Conversational Analysis Authoring - Get Supported Prebuilt Entities

Odwołanie

Usługa:: Cognitive Services - Language

Wersja interfejsu API:: 2022-05-01

Listy obsługiwane wstępnie utworzone jednostki, których można używać podczas tworzenia jednostek złożonych.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Wersja interfejsu API klienta.
language	query		string	Język umożliwiający uzyskanie obsługiwanych wstępnie utworzonych jednostek. Wymagane, jeśli wielojęzyczność jest fałszywa. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp.
maxpagesize	query		integer int32	Maksymalna liczba zasobów do uwzględnienia w jednej odpowiedzi.
multilingual	query		string	Czy uzyskać wstępnie utworzone jednostki pomocy technicznej dla projektów wielojęzycznych lub monolingualnych. Jeśli jest to prawda, parametr języka jest ignorowany.
skip	query		integer int32	Przesunięcie do kolekcji pierwszego zasobu, który ma zostać zwrócony.
top	query		integer int32	Maksymalna liczba zasobów do zwrócenia z kolekcji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Klucz subskrypcji zasobu usługi językowej.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ConversationalAnalysisAuthoringPrebuiltEntities	Lista wstępnie utworzonych jednostek.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz subskrypcji zasobu usługi językowej.

Typ: apiKey
W: header

Przykłady

Successful Get Supported Prebuilt Entities

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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
}

Definicje

Nazwa	Opis
ConversationalAnalysisAuthoringPrebuiltEntities	Reprezentuje listę pobranych wstępnie utworzonych jednostek.
ConversationalAnalysisAuthoringPrebuiltEntity	Reprezentuje obsługiwaną wstępnie utworzoną jednostkę.
Error	Obiekt błędu.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringPrebuiltEntities

Reprezentuje listę pobranych wstępnie utworzonych jednostek.

Nazwa	Typ	Opis
nextLink	string	Link następnej strony.
value	ConversationalAnalysisAuthoringPrebuiltEntity[]	Obsługiwane wstępnie utworzone jednostki.

ConversationalAnalysisAuthoringPrebuiltEntity

Reprezentuje obsługiwaną wstępnie utworzoną jednostkę.

Nazwa	Typ	Opis
category	string	Wstępnie utworzona kategoria jednostki.
description	string	Opis.
examples	string	Przykłady języka angielskiego dla jednostki.

Error

Obiekt błędu.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
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

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InnerErrorCode