Delen via


Conversational Analysis Authoring - Get Supported Prebuilt Entities

Lijsten de ondersteunde vooraf samengestelde entiteiten die kunnen worden gebruikt tijdens het maken van samengestelde entiteiten.

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

URI-parameters

Name In Vereist Type Description
Endpoint
path True

string

Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).

api-version
query True

string

Client-API-versie.

language
query

string

De taal voor het ophalen van ondersteunde vooraf samengestelde entiteiten. Vereist als meertalig onwaar is. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels, 'en-gb' voor Engels (VK), 'es' voor Spaans, enzovoort.

maxpagesize
query

integer

int32

Het maximum aantal resources dat in één antwoord moet worden opgenomen.

multilingual
query

string

Of u de vooraf samengestelde ondersteuningsentiteiten voor meertalige of eentalige projecten wilt krijgen. Indien waar, wordt de taalparameter genegeerd.

skip
query

integer

int32

Een verschuiving in de verzameling van de eerste resource die moet worden geretourneerd.

top
query

integer

int32

Het maximum aantal resources dat uit de verzameling moet worden geretourneerd.

Antwoorden

Name Type Description
200 OK

ConversationalAnalysisAuthoringPrebuiltEntities

De lijst met ondersteunde vooraf samengestelde entiteiten.

Other Status Codes

ErrorResponse

Foutreactie.

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

  • Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

  • Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful Get Supported Prebuilt Entities

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ConversationalAnalysisAuthoringPrebuiltEntities

Vertegenwoordigt een lijst met de opgehaalde ondersteunde vooraf samengestelde entiteiten.

ConversationalAnalysisAuthoringPrebuiltEntity

Vertegenwoordigt een ondersteunde vooraf samengestelde entiteit.

Error

Het foutobject.

ErrorCode

Door mensen leesbare foutcode.

ErrorResponse

Foutreactie.

InnerErrorCode

Door mensen leesbare foutcode.

InnerErrorModel

Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ConversationalAnalysisAuthoringPrebuiltEntities

Vertegenwoordigt een lijst met de opgehaalde ondersteunde vooraf samengestelde entiteiten.

Name Type Description
nextLink

string

De koppeling naar de volgende pagina.

value

ConversationalAnalysisAuthoringPrebuiltEntity[]

De ondersteunde vooraf samengestelde entiteiten.

ConversationalAnalysisAuthoringPrebuiltEntity

Vertegenwoordigt een ondersteunde vooraf samengestelde entiteit.

Name Type Description
category

string

De vooraf gedefinieerde entiteitscategorie.

description

string

De beschrijving.

examples

string

Engelse voorbeelden voor de entiteit.

Error

Het foutobject.

Name Type Description
code

ErrorCode

Een van een door de server gedefinieerde set foutcodes.

details

Error[]

Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.

innererror

InnerErrorModel

Een object met specifiekere informatie dan het huidige object over de fout.

message

string

Een door mensen leesbare weergave van de fout.

target

string

Het doel van de fout.

ErrorCode

Door mensen leesbare foutcode.

Name Type 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

Foutreactie.

Name Type Description
error

Error

Het foutobject.

InnerErrorCode

Door mensen leesbare foutcode.

Name Type 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

Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

InnerErrorCode

Een van een door de server gedefinieerde set foutcodes.

details

object

Foutdetails.

innererror

InnerErrorModel

Een object met specifiekere informatie dan het huidige object over de fout.

message

string

Foutbericht.

target

string

Foutdoel.