Conversational Analysis Authoring - Import

Dispara um trabalho 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 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).

projectName
path True

string

O nome do projeto a ser usado.

api-version
query True

string

Versão de API do cliente.

format
query

ExportedProjectFormat

O formato do arquivo de projeto exportado a ser usado.

Corpo da solicitação

Nome Obrigatório Tipo Description
metadata True

ConversationalAnalysisAuthoringCreateProjectOptions

Representa os metadados do projeto.

projectFileVersion True

string

A versão do arquivo exportado.

stringIndexType True

StringIndexType

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter mais informações, consulte https://aka.ms/text-analytics-offsets.

assets ConversationalAnalysisAuthoringExportedProjectAssets:

Representa os ativos do projeto.

Respostas

Nome Tipo Description
202 Accepted

Uma chamada bem-sucedida resulta em um cabeçalho Operation-Location usado para verificar o status do trabalho.

Headers

operation-location: string

Other Status Codes

ErrorResponse

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.

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

Scopes

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.

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

Nome Description
CompositionSetting

O comportamento a seguir quando os componentes da entidade se sobrepõem uns aos outros.

ConversationalAnalysisAuthoringConversationExportedEntity

Representa uma entidade com seus componentes.

ConversationalAnalysisAuthoringConversationExportedIntent

Representa uma intenção exportada de um projeto de conversa.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Representa os ativos exportados de um projeto de conversa.

ConversationalAnalysisAuthoringConversationExportedUtterance

Representa um enunciado exportado para um projeto de conversa.

ConversationalAnalysisAuthoringCreateProjectOptions

Representa as opções usadas para criar ou atualizar um projeto.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Define os detalhes de orquestração de um destino de projeto conversacional.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Representa as opções de orquestração para um destino de projeto conversacional.

ConversationalAnalysisAuthoringExportedEntityList

Representa um componente de lista de uma entidade.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Representa uma lista de sinônimos dentro de um componente de lista

ConversationalAnalysisAuthoringExportedEntityRegex

Representa um componente regex de uma entidade.

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Representa uma expressão regex dentro de um componente regex. Essa expressão segue a sintaxe regex do .NET. Para referência, marcar aqui:https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntitySublist

Representa uma sub-lista dentro de um componente de lista.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Define os detalhes de orquestração de um destino de aplicativo LUIS.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Representa as opções de orquestração para um destino de aplicativo LUIS.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Representa um componente de entidade predefinido exportado

ConversationalAnalysisAuthoringExportedProject

Representa um projeto exportado.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Define os detalhes de orquestração para um destino de projeto de Resposta a Perguntas.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Representa as opções de orquestração para um destino de projeto de Resposta a Perguntas.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Representa um rótulo de entidade para um enunciado.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Representa uma intenção exportada para um projeto de orquestração.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Representa os ativos de um projeto de orquestração.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Representa um enunciado de um projeto de orquestração.

ConversationalAnalysisAuthoringProjectSettings

Representa as configurações usadas para definir o comportamento do projeto.

Error

O objeto de erro.

ErrorCode

Código de erro legível por humanos.

ErrorResponse

Resposta de erro.

ExportedProjectFormat

O formato do arquivo de projeto exportado a ser usado.

InnerErrorCode

Código de erro legível por humanos.

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.

ProjectKind

Representa o tipo de projeto.

StringIndexType

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter mais informações, consulte https://aka.ms/text-analytics-offsets.

CompositionSetting

O comportamento a seguir quando os componentes da entidade se sobrepõem uns aos outros.

Nome Tipo Description
combineComponents

string

Quando dois ou mais componentes são encontrados no texto e se sobrepõem, os intervalos dos componentes são mesclados em um intervalo combinando todos eles.

requireExactOverlap

string

Todos os componentes devem se sobrepor exatamente aos mesmos caracteres no texto para que a entidade retorne. Se um dos componentes definidos não for corresponder ou for previsto, a entidade não retornará.

returnLongestOverlap

string

Quando dois ou mais componentes são encontrados no texto e se sobrepõem, o componente com o conjunto mais longo de caracteres é retornado.

separateComponents

string

A corresponder ou a previsão de cada componente é retornada como uma instância separada da entidade.

ConversationalAnalysisAuthoringConversationExportedEntity

Representa uma entidade com seus componentes.

Nome Tipo Description
category

string

A categoria da entidade.

compositionSetting

CompositionSetting

O comportamento a seguir quando os componentes da entidade se sobrepõem uns aos outros.

list

ConversationalAnalysisAuthoringExportedEntityList

O componente de lista da entidade.

prebuilts

ConversationalAnalysisAuthoringExportedPrebuiltEntity[]

Os componentes de entidades predefinidas.

regex

ConversationalAnalysisAuthoringExportedEntityRegex

O componente regex da entidade.

requiredComponents

string[]

Os componentes necessários. Os valores permitidos são 'learned', 'list', 'prebuilts' e 'regex'.

ConversationalAnalysisAuthoringConversationExportedIntent

Representa uma intenção exportada de um projeto de conversa.

Nome Tipo Description
category

string

A categoria de intenção.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Representa os ativos exportados de um projeto de conversa.

Nome Tipo Description
entities

ConversationalAnalysisAuthoringConversationExportedEntity[]

As entidades definidas no projeto.

intents

ConversationalAnalysisAuthoringConversationExportedIntent[]

As intenções definidas no projeto.

projectKind string:

Conversation

O tipo de projeto que contém os ativos.

utterances

ConversationalAnalysisAuthoringConversationExportedUtterance[]

Os enunciados definidos no projeto.

ConversationalAnalysisAuthoringConversationExportedUtterance

Representa um enunciado exportado para um projeto de conversa.

Nome Tipo Description
dataset

string

O conjunto de dados para esse enunciado. Os valores permitidos são 'Treinar' e 'Testar'.

entities

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]

Representa os rótulos de entidade do enunciado.

intent

string

A intenção do enunciado.

language

string

Representa a linguagem do enunciado. 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.

text

string

O texto do enunciado.

ConversationalAnalysisAuthoringCreateProjectOptions

Representa as opções usadas para criar ou atualizar um projeto.

Nome Tipo Description
description

string

A descrição do projeto.

language

string

A linguagem do projeto. 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.

multilingual

boolean

Se o projeto seria usado para vários idiomas ou não.

projectKind

ProjectKind

Representa o tipo de projeto.

projectName

string

O novo nome do projeto.

settings

ConversationalAnalysisAuthoringProjectSettings

As configurações do projeto.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Define os detalhes de orquestração de um destino de projeto conversacional.

Nome Tipo Description
deploymentName

string

O nome da implantação de destino.

projectName

string

O nome do projeto de destino.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Representa as opções de orquestração para um destino de projeto conversacional.

Nome Tipo Description
conversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestration

Os detalhes de destino do projeto conversacional.

targetProjectKind string:

Conversation

O tipo do destino usado no fluxo de orquestração.

ConversationalAnalysisAuthoringExportedEntityList

Representa um componente de lista de uma entidade.

Nome Tipo Description
sublists

ConversationalAnalysisAuthoringExportedEntitySublist[]

As sub-listas do componente de lista.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Representa uma lista de sinônimos dentro de um componente de lista

Nome Tipo Description
language

string

Representa o idioma dos sinônimos. 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.

values

string[]

A lista de sinônimos.

ConversationalAnalysisAuthoringExportedEntityRegex

Representa um componente regex de uma entidade.

Nome Tipo Description
expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression[]

As expressões regex do componente regex. Essas expressões seguem a sintaxe regex do .NET. Para referência, marcar aqui:https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Representa uma expressão regex dentro de um componente regex. Essa expressão segue a sintaxe regex do .NET. Para referência, marcar aqui:https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

Nome Tipo Description
language

string

Representa o idioma da expressão regex. 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.

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.

Nome Tipo Description
listKey

string

A chave da sub-lista.

synonyms

ConversationalAnalysisAuthoringExportedEntityListSynonym[]

As frases de que correspondem à sub-lista.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Define os detalhes de orquestração de um destino de aplicativo LUIS.

Nome Tipo Description
appId

string

A ID do aplicativo LUIS.

appVersion

string

A ID da versão de destino.

slotName

string

O nome do slot de destino.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Representa as opções de orquestração para um destino de aplicativo LUIS.

Nome Tipo Description
luisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestration

Os detalhes de destino do aplicativo LUIS.

targetProjectKind string:

Luis

O tipo do destino usado no fluxo de orquestração.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Representa um componente de entidade predefinido exportado

Nome Tipo Description
category

string

A categoria de entidade predefinida.

ConversationalAnalysisAuthoringExportedProject

Representa um projeto exportado.

Nome Tipo Description
assets ConversationalAnalysisAuthoringExportedProjectAssets:

Representa os ativos do projeto.

metadata

ConversationalAnalysisAuthoringCreateProjectOptions

Representa os metadados do projeto.

projectFileVersion

string

A versão do arquivo exportado.

stringIndexType

StringIndexType

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter mais informações, consulte https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Define os detalhes de orquestração para um destino de projeto de Resposta a Perguntas.

Nome 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.

Nome Tipo Description
questionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Os detalhes do projeto de Respostas às Perguntas.

targetProjectKind string:

QuestionAnswering

O tipo do destino usado no fluxo de orquestração.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Representa um rótulo de entidade para um enunciado.

Nome Tipo Description
category

string

A categoria do rótulo de entidade.

length

integer

Comprimento do texto da entidade.

offset

integer

Posição inicial para o texto da entidade.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Representa uma intenção exportada para um projeto de orquestração.

Nome Tipo Description
category

string

A categoria de intenção.

orchestration ConversationalAnalysisAuthoringExportedOrchestrationOptions:

Especifica o comportamento dessa intenção no fluxo de orquestração.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Representa os ativos de um projeto de orquestração.

Nome Tipo Description
intents

ConversationalAnalysisAuthoringOrchestrationExportedIntent[]

Representa as intenções do projeto.

projectKind string:

Orchestration

O tipo de projeto que contém os ativos.

utterances

ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]

Representa os enunciados do projeto.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Representa um enunciado de um projeto de orquestração.

Nome Tipo Description
dataset

string

O conjunto de dados para esse enunciado. Os valores permitidos são 'Treinar' e 'Testar'.

intent

string

A intenção do enunciado.

language

string

Representa a linguagem do enunciado. 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.

text

string

O texto do enunciado.

ConversationalAnalysisAuthoringProjectSettings

Representa as configurações usadas para definir o comportamento do projeto.

Nome Tipo Description
confidenceThreshold

number

O limite da intenção com a maior confiança, na qual a previsão será automaticamente alterada para "Nenhum". O valor do limite deve estar entre 0 e 1 inclusive.

Error

O objeto de erro.

Nome Tipo Description
code

ErrorCode

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

InnerErrorModel

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

Error

O objeto de erro.

ExportedProjectFormat

O formato do arquivo de projeto exportado a ser usado.

Nome Tipo Description
Conversation

string

Especifica o formato de um projeto de conversa.

Luis

string

Especifica o formato de um aplicativo que foi exportado do LUIS.

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

InnerErrorCode

Um de um conjunto definido pelo servidor de códigos de erro.

details

object

Detalhes do erro.

innererror

InnerErrorModel

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.

Nome Tipo Description
Conversation

string

Um projeto para criar linguagem natural em aplicativos, bots e dispositivos IoT.

Orchestration

string

Um projeto para conectar e orquestrar projetos de Conversa, Respostas às Perguntas personalizadas e LUIS em um único projeto.

StringIndexType

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter mais informações, consulte https://aka.ms/text-analytics-offsets.

Nome Tipo Description
Utf16CodeUnit

string

Os valores de deslocamento e comprimento corresponderão às unidades de código UTF-16. Use essa opção se o aplicativo for escrito em um idioma que dê suporte a Unicode, por exemplo Java, JavaScript.