Conversational Analysis Authoring - Import
Aciona uma tarefa para importar um projeto. Se já existir um projeto com o mesmo nome, os dados desse projeto serão substituídos.
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2023-04-01
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2023-04-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
O nome do projeto a utilizar. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
format
|
query |
O formato do ficheiro de projeto exportado a utilizar. |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
metadata | True |
Representa os metadados do projeto. |
|
projectFileVersion | True |
string |
A versão do ficheiro exportado. |
stringIndexType | True |
Especifica o método utilizado para interpretar desvios de cadeias. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets. |
|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Representa os recursos do projeto. |
Respostas
Name | Tipo | Description |
---|---|---|
202 Accepted |
Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa. Headers operation-location: string |
|
Other Status Codes |
Resposta de erro. |
Segurança
AADToken
Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.
Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.
Notas
- Esta definição de segurança requer a utilização do
x-ms-client-id
cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.
O Authorization URL
é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory.
* O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
- Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta Trabalho, Escola e Convidados, mas não suporta contas pessoais.
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
Uma chave de subscrição para um recurso do Serviço de idiomas.
Type:
apiKey
In:
header
Exemplos
Successful Import Project
Sample Request
POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2023-04-01
{
"projectFileVersion": "2022-05-01",
"stringIndexType": "Utf16CodeUnit",
"metadata": {
"projectKind": "Conversation",
"settings": {
"confidenceThreshold": 0.7
},
"projectName": "EmailApp",
"multilingual": true,
"description": "Trying out CLU",
"language": "en-us"
},
"assets": {
"projectKind": "Conversation",
"intents": [
{
"category": "Read"
},
{
"category": "Delete"
}
],
"entities": [
{
"category": "Sender"
},
{
"category": "Number",
"regex": {
"expressions": [
{
"regexKey": "UK Phone numbers",
"language": "en-us",
"regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/"
}
]
}
}
],
"utterances": [
{
"text": "Open Blake's email",
"dataset": "Train",
"intent": "Read",
"entities": [
{
"category": "Sender",
"offset": 5,
"length": 5
}
]
},
{
"text": "Delete last email",
"language": "en-gb",
"dataset": "Test",
"intent": "Delete",
"entities": []
}
]
}
}
Sample Response
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Definições
Name | Description |
---|---|
Composition |
O comportamento a seguir quando os componentes da entidade se sobrepõem uns aos outros. |
Conversational |
Representa uma entidade com os respetivos componentes. |
Conversational |
Representa uma intenção exportada de um projeto de conversação. |
Conversational |
Representa os recursos exportados de um projeto de conversação. |
Conversational |
Representa uma expressão exportada para um projeto de conversação. |
Conversational |
Representa as opções utilizadas para criar ou atualizar um projeto. |
Conversational |
Define os detalhes da orquestração para um destino de projeto conversacional. |
Conversational |
Representa as opções de orquestração para um destino de projeto conversacional. |
Conversational |
Representa um componente de lista de uma entidade. |
Conversational |
Representa uma lista de sinónimos dentro de um componente de lista |
Conversational |
Representa um componente regex de uma entidade. |
Conversational |
Representa uma expressão regex dentro de um componente regex. Esta expressão segue a sintaxe regex .NET. Para referência, veja aqui: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
Conversational |
Representa uma sub-lista dentro de um componente de lista. |
Conversational |
Define os detalhes de orquestração para um destino de aplicação LUIS. |
Conversational |
Representa as opções de orquestração para um destino de aplicação LUIS. |
Conversational |
Representa um componente de entidade pré-criado exportado |
Conversational |
Representa um projeto exportado. |
Conversational |
Define os detalhes da orquestração para um destino de projeto de Resposta a Perguntas. |
Conversational |
Representa as opções de orquestração para um destino de projeto de Resposta a Perguntas. |
Conversational |
Representa uma etiqueta de entidade para uma expressão. |
Conversational |
Representa uma intenção exportada para um projeto de orquestração. |
Conversational |
Representa os recursos de um projeto de orquestração. |
Conversational |
Representa uma expressão de um projeto de orquestração. |
Conversational |
Representa as definições utilizadas para definir o comportamento do projeto. |
Error |
O objeto de erro. |
Error |
Código de erro legível por humanos. |
Error |
Resposta de erro. |
Exported |
O formato do ficheiro de projeto exportado a utilizar. |
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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Project |
Representa o tipo de projeto. |
String |
Especifica o método utilizado para interpretar desvios de cadeias. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets. |
CompositionSetting
O comportamento a seguir quando os componentes da entidade se sobrepõem uns aos outros.
Name | Tipo | Description |
---|---|---|
combineComponents |
string |
Quando dois ou mais componentes são encontrados no texto e se sobrepõem, os intervalos dos componentes são intercalados num só intervalo, combinando todos eles. |
requireExactOverlap |
string |
Todos os componentes têm de se sobrepor exatamente aos mesmos carateres no texto para a entidade devolver. Se um dos componentes definidos não for correspondido ou previsto, a entidade não devolverá. |
returnLongestOverlap |
string |
Quando dois ou mais componentes são encontrados no texto e se sobrepõem, é devolvido o componente com o conjunto de carateres mais longo. |
separateComponents |
string |
A correspondência ou predição de cada componente é devolvida como uma instância separada da entidade. |
ConversationalAnalysisAuthoringConversationExportedEntity
Representa uma entidade com os respetivos componentes.
Name | Tipo | Description |
---|---|---|
category |
string |
A categoria da entidade. |
compositionSetting |
O comportamento a seguir quando os componentes da entidade se sobrepõem uns aos outros. |
|
list |
O componente de lista da entidade. |
|
prebuilts |
Os componentes de entidades pré-criadas. |
|
regex |
O componente regex da entidade. |
|
requiredComponents |
string[] |
Os componentes necessários. Os valores permitidos são "aprendidos", "list", "pré-criados" e "regex". |
ConversationalAnalysisAuthoringConversationExportedIntent
Representa uma intenção exportada de um projeto de conversação.
Name | Tipo | Description |
---|---|---|
category |
string |
A categoria de intenção. |
ConversationalAnalysisAuthoringConversationExportedProjectAssets
Representa os recursos exportados de um projeto de conversação.
Name | Tipo | Description |
---|---|---|
entities |
As entidades definidas no projeto. |
|
intents |
As intenções definidas no projeto. |
|
projectKind |
string:
Conversation |
O tipo de projeto que contém os recursos. |
utterances |
Conversational |
As expressões definidas no projeto. |
ConversationalAnalysisAuthoringConversationExportedUtterance
Representa uma expressão exportada para um projeto de conversação.
Name | Tipo | Description |
---|---|---|
dataset |
string |
O conjunto de dados para esta expressão. Os valores permitidos são "Train" e "Test". |
entities |
Conversational |
Representa as etiquetas de entidade da expressão. |
intent |
string |
A intenção da expressão. |
language |
string |
Representa o idioma da expressão. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc. |
text |
string |
O texto da expressão. |
ConversationalAnalysisAuthoringCreateProjectOptions
Representa as opções utilizadas para criar ou atualizar um projeto.
Name | Tipo | Description |
---|---|---|
description |
string |
A descrição do projeto. |
language |
string |
O idioma do projeto. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc. |
multilingual |
boolean |
Se o projeto seria ou não utilizado para vários idiomas. |
projectKind |
Representa o tipo de projeto. |
|
projectName |
string |
O novo nome do projeto. |
settings |
As definições do projeto. |
ConversationalAnalysisAuthoringExportedConversationOrchestration
Define os detalhes da orquestração para um destino de projeto conversacional.
Name | Tipo | Description |
---|---|---|
deploymentName |
string |
O nome da implementação direcionada. |
projectName |
string |
O nome do projeto de destino. |
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions
Representa as opções de orquestração para um destino de projeto conversacional.
Name | Tipo | Description |
---|---|---|
conversationOrchestration |
Conversational |
Os detalhes de destino do projeto conversacional. |
targetProjectKind |
string:
Conversation |
O tipo de destino utilizado no fluxo de orquestração. |
ConversationalAnalysisAuthoringExportedEntityList
Representa um componente de lista de uma entidade.
Name | Tipo | Description |
---|---|---|
sublists |
As sub-listas do componente de lista. |
ConversationalAnalysisAuthoringExportedEntityListSynonym
Representa uma lista de sinónimos dentro de um componente de lista
Name | Tipo | Description |
---|---|---|
language |
string |
Representa o idioma dos sinónimos. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc. |
values |
string[] |
A lista de sinónimos. |
ConversationalAnalysisAuthoringExportedEntityRegex
Representa um componente regex de uma entidade.
Name | Tipo | Description |
---|---|---|
expressions |
Conversational |
As expressões regex do componente regex. Estas expressões seguem a sintaxe regex .NET. Para referência, veja aqui: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions |
ConversationalAnalysisAuthoringExportedEntityRegexExpression
Representa uma expressão regex dentro de um componente regex. Esta expressão segue a sintaxe regex .NET. Para referência, veja aqui: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions
Name | Tipo | Description |
---|---|---|
language |
string |
Representa a linguagem da expressão regex. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc. |
regexKey |
string |
A chave da expressão regex. |
regexPattern |
string |
O padrão regex. |
ConversationalAnalysisAuthoringExportedEntitySublist
Representa uma sub-lista dentro de um componente de lista.
Name | Tipo | Description |
---|---|---|
listKey |
string |
A chave da sub-lista. |
synonyms |
As expressões dessas expressões correspondem à sub-lista. |
ConversationalAnalysisAuthoringExportedLuisOrchestration
Define os detalhes de orquestração para um destino de aplicação LUIS.
Name | Tipo | Description |
---|---|---|
appId |
string |
O ID da aplicação LUIS. |
appVersion |
string |
O ID da versão de destino. |
slotName |
string |
O nome do bloco de destino. |
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions
Representa as opções de orquestração para um destino de aplicação LUIS.
Name | Tipo | Description |
---|---|---|
luisOrchestration |
Os detalhes de destino da aplicação LUIS. |
|
targetProjectKind |
string:
Luis |
O tipo de destino utilizado no fluxo de orquestração. |
ConversationalAnalysisAuthoringExportedPrebuiltEntity
Representa um componente de entidade pré-criado exportado
Name | Tipo | Description |
---|---|---|
category |
string |
A categoria de entidade pré-criada. |
ConversationalAnalysisAuthoringExportedProject
Representa um projeto exportado.
Name | Tipo | Description |
---|---|---|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Representa os recursos do projeto. |
metadata |
Representa os metadados do projeto. |
|
projectFileVersion |
string |
A versão do ficheiro exportado. |
stringIndexType |
Especifica o método utilizado para interpretar desvios de cadeias. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets. |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration
Define os detalhes da orquestração para um destino de projeto de Resposta a Perguntas.
Name | Tipo | Description |
---|---|---|
projectName |
string |
O nome do projeto de destino. |
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions
Representa as opções de orquestração para um destino de projeto de Resposta a Perguntas.
Name | Tipo | Description |
---|---|---|
questionAnsweringOrchestration |
Conversational |
Os detalhes do projeto de Resposta a Perguntas. |
targetProjectKind |
string:
Question |
O tipo de destino utilizado no fluxo de orquestração. |
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel
Representa uma etiqueta de entidade para uma expressão.
Name | Tipo | Description |
---|---|---|
category |
string |
A categoria da etiqueta de entidade. |
length |
integer |
Comprimento do texto da entidade. |
offset |
integer |
Posição de início para o texto da entidade. |
ConversationalAnalysisAuthoringOrchestrationExportedIntent
Representa uma intenção exportada para um projeto de orquestração.
Name | Tipo | Description |
---|---|---|
category |
string |
A categoria de intenção. |
orchestration | ConversationalAnalysisAuthoringExportedOrchestrationOptions: |
Especifica o comportamento desta intenção no fluxo de orquestração. |
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets
Representa os recursos de um projeto de orquestração.
Name | Tipo | Description |
---|---|---|
intents |
Conversational |
Representa as intenções do projeto. |
projectKind |
string:
Orchestration |
O tipo de projeto que contém os recursos. |
utterances |
Conversational |
Representa as expressões do projeto. |
ConversationalAnalysisAuthoringOrchestrationExportedUtterance
Representa uma expressão de um projeto de orquestração.
Name | Tipo | Description |
---|---|---|
dataset |
string |
O conjunto de dados para esta expressão. Os valores permitidos são "Train" e "Test". |
intent |
string |
A intenção da expressão. |
language |
string |
Representa o idioma da expressão. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc. |
text |
string |
O texto da expressão. |
ConversationalAnalysisAuthoringProjectSettings
Representa as definições utilizadas para definir o comportamento do projeto.
Name | Tipo | Description |
---|---|---|
confidenceThreshold |
number |
O limiar da intenção com maior confiança, no qual a predição será automaticamente alterada para "Nenhum". O valor do limiar deve estar entre 0 e 1 inclusive. |
Error
O objeto de erro.
Name | Tipo | Description |
---|---|---|
code |
Um dos conjuntos de códigos de erro definidos pelo servidor. |
|
details |
Error[] |
Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado. |
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 por humanos do erro. |
target |
string |
O destino do erro. |
ErrorCode
Código de erro legível por humanos.
Name | 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.
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
ExportedProjectFormat
O formato do ficheiro de projeto exportado a utilizar.
Name | Tipo | Description |
---|---|---|
Conversation |
string |
Especifica o formato de um projeto de conversação. |
Luis |
string |
Especifica o formato de uma aplicação que foi exportada do LUIS. |
InnerErrorCode
Código de erro legível por humanos.
Name | 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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Tipo | Description |
---|---|---|
code |
Um dos conjuntos de códigos de erro definidos pelo servidor. |
|
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. |
ProjectKind
Representa o tipo de projeto.
Name | Tipo | Description |
---|---|---|
Conversation |
string |
Um projeto para criar linguagem natural em aplicações, bots e dispositivos IoT. |
Orchestration |
string |
Um projeto para ligar e orquestrar conversações, respostas a perguntas personalizadas e projetos LUIS em conjunto num único projeto. |
StringIndexType
Especifica o método utilizado para interpretar desvios de cadeias. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
Name | Tipo | Description |
---|---|---|
Utf16CodeUnit |
string |
Os valores de desvio e comprimento corresponderão às unidades de código UTF-16. Utilize esta opção se a sua aplicação estiver escrita num idioma que suporte Unicode, por exemplo Java, JavaScript. |