Conversational Analysis Authoring - Get Supported Prebuilt Entities

Reference

Služba:: Cognitive Services - Language

Verze rozhraní API:: 2022-05-01

Seznamy podporovaných předem vytvořených entit, které je možné použít při vytváření složených entit.

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

S volitelnými parametry:

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Verze klientského rozhraní API
language	query		string	Jazyk, pro který chcete získat podporované předem připravené entity. Vyžaduje se, pokud má více jazyků hodnotu false. Toto je reprezentace jazyka BCP-47. Použijte například "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
maxpagesize	query		integer int32	Maximální počet prostředků, které se mají zahrnout do jedné odpovědi.
multilingual	query		string	Jestli chcete získat předem připravené entity podpory pro vícejazyčné nebo jednojazyčné projekty. Pokud je hodnota true, parametr jazyka se ignoruje.
skip	query		integer int32	Posun do kolekce prvního prostředku, který se má vrátit.
top	query		integer int32	Maximální počet prostředků, které se mají vrátit z kolekce.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Klíč předplatného pro prostředek služby language.

Odpovědi

Name	Typ	Description
200 OK	ConversationalAnalysisAuthoringPrebuiltEntities	Seznam podporovaných předem vytvořených entit
Other Status Codes	ErrorResponse	Odpověď na chybu.

Zabezpečení

Ocp-Apim-Subscription-Key

Klíč předplatného pro prostředek služby language.

Typ: apiKey
V: header

Příklady

Successful Get Supported Prebuilt Entities

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
}

Definice

Name	Description
ConversationalAnalysisAuthoringPrebuiltEntities	Představuje seznam načtených podporovaných předem vytvořených entit.
ConversationalAnalysisAuthoringPrebuiltEntity	Představuje podporovanou předem připravenou entitu.
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Odpověď na chybu.
InnerErrorCode	Kód chyby čitelný pro člověka.
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringPrebuiltEntities

Představuje seznam načtených podporovaných předem vytvořených entit.

Name	Typ	Description
nextLink	string	Odkaz na další stránku
value	ConversationalAnalysisAuthoringPrebuiltEntity[]	Podporované předem vytvořené entity.

ConversationalAnalysisAuthoringPrebuiltEntity

Představuje podporovanou předem připravenou entitu.

Name	Typ	Description
category	string	Předem připravená kategorie entit.
description	string	Popis.
examples	string	Příklady pro entitu v angličtině

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jeden ze serverem definované sady kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	Description
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

Odpověď na chybu.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode