Sdílet prostřednictvím


Conversational Analysis Authoring - Get Supported Prebuilt Entities

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=2023-04-01
GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?language={language}&multilingual={multilingual}&top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-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.

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í

AADToken

Toto jsou toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

  • Azure Active Directory verze 1.0 nebo v2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

Příklady

Successful Get Supported Prebuilt Entities

Sample Request

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

Sample Response

{
  "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

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

Name Typ Description
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

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.

Name Typ Description
code

InnerErrorCode

Jeden ze serverem definované sady kódů chyb.

details

object

Podrobnosti o chybě.

innererror

InnerErrorModel

Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

message

string

Chybová zpráva.

target

string

Cíl chyby.