Conversational Analysis Authoring - Get Supported Prebuilt Entities
Lista as entidades predefinidas com suporte que podem ser usadas ao criar entidades compostas.
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
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
Versão de API do cliente. |
language
|
query |
string |
O idioma para o qual obter entidades predefinidas com suporte. Obrigatório se multilíngue for false. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol etc. |
|
maxpagesize
|
query |
integer int32 |
O número máximo de recursos a serem incluídos em uma única resposta. |
|
multilingual
|
query |
string |
Se deseja obter as entidades predefinidas de suporte para projetos multilíngues ou monolíngues. Se for true, o parâmetro de linguagem será ignorado. |
|
skip
|
query |
integer int32 |
Um deslocamento para a coleção do primeiro recurso a ser retornado. |
|
top
|
query |
integer int32 |
O número máximo de recursos a serem retornados da coleção. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A lista de entidades predefinidas com suporte. |
|
Other Status Codes |
Resposta de erro. |
Segurança
AADToken
Esses são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.
Observações
- Essa definição de segurança requer o uso do
x-ms-client-id
cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.
O Authorization URL
é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory.
* O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Uma chave de assinatura para um recurso de serviço de linguagem.
Tipo:
apiKey
Em:
header
Exemplos
Successful Get Supported Prebuilt Entities
Solicitação de exemplo
GET {Endpoint}/language/authoring/analyze-conversations/projects/global/prebuilt-entities?language=en&api-version=2023-04-01
Resposta de exemplo
{
"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
}
Definições
Nome | Description |
---|---|
Conversational |
Representa uma lista das entidades predefinidas com suporte recuperadas. |
Conversational |
Representa uma entidade predefinida com suporte. |
Error |
O objeto de erro. |
Error |
Código de erro legível por humanos. |
Error |
Resposta de erro. |
Inner |
Código de erro legível por humanos. |
Inner |
Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
ConversationalAnalysisAuthoringPrebuiltEntities
Representa uma lista das entidades predefinidas com suporte recuperadas.
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
O link da próxima página. |
value |
As entidades predefinidas com suporte. |
ConversationalAnalysisAuthoringPrebuiltEntity
Representa uma entidade predefinida com suporte.
Nome | Tipo | Description |
---|---|---|
category |
string |
A categoria de entidade predefinida. |
description |
string |
A descrição. |
examples |
string |
Exemplos em inglês para a entidade. |
Error
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
code |
Um de um conjunto definido pelo servidor de códigos de erro. |
|
details |
Error[] |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
message |
string |
Uma representação legível pelo homem do erro. |
target |
string |
O destino do erro. |
ErrorCode
Código de erro legível por humanos.
Nome | Tipo | 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
Resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
InnerErrorCode
Código de erro legível por humanos.
Nome | Tipo | 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
Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nome | Tipo | Description |
---|---|---|
code |
Um de um conjunto definido pelo servidor de códigos de erro. |
|
details |
object |
Detalhes do erro. |
innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
message |
string |
Mensagem de erro. |
target |
string |
Destino do erro. |