Conversational Analysis Authoring - Import

Referência

Serviço:: Azure AI Services

Versão da API:: 2022-05-01

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=2022-05-01

Com parâmetros opcionais:

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2022-05-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).
projectName	path	True	string	O nome do projeto a utilizar.
api-version	query	True	string	Versão da API de Cliente.
format	query		ExportedProjectFormat	O formato do ficheiro de projeto exportado a utilizar.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Uma chave de subscrição para um recurso do Serviço de idiomas.

Corpo do Pedido

Name	Necessário	Tipo	Description
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	Representa os metadados do projeto.
projectFileVersion	True	string	A versão do ficheiro exportado.
stringIndexType	True	StringIndexType	Especifica o método utilizado para interpretar desvios de cadeias. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	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. Cabeçalhos operation-location: string
Other Status Codes	ErrorResponse	Resposta de erro.

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.

Cabeçalhos

operation-location: string

Other Status Codes

ErrorResponse

Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Uma chave de subscrição para um recurso do Serviço de idiomas.

Tipo: apiKey
Em: header

Exemplos

Successful Import Project

Pedido de amostra

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2022-05-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"
      }
    ],
    "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": []
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Definições

Name	Description
CompositionSetting	O comportamento a seguir quando os componentes da entidade se sobrepõem entre si.
ConversationalAnalysisAuthoringConversationExportedEntity	Representa uma entidade com os respetivos componentes.
ConversationalAnalysisAuthoringConversationExportedIntent	Representa uma intenção exportada de um projeto de conversação.
ConversationalAnalysisAuthoringConversationExportedProjectAssets	Representa os recursos exportados de um projeto de conversação.
ConversationalAnalysisAuthoringConversationExportedUtterance	Representa uma expressão exportada para um projeto de conversação.
ConversationalAnalysisAuthoringCreateProjectOptions	Representa as opções utilizadas para criar ou atualizar um projeto.
ConversationalAnalysisAuthoringExportedConversationOrchestration	Define os detalhes da orquestração para 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
ConversationalAnalysisAuthoringExportedEntitySublist	Representa uma sub-lista dentro de um componente de lista.
ConversationalAnalysisAuthoringExportedLuisOrchestration	Define os detalhes de orquestração para um destino de aplicação LUIS.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	Representa as opções de orquestração para um destino de aplicação LUIS.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	Representa um componente de entidade pré-criado exportado
ConversationalAnalysisAuthoringExportedProject	Representa um projeto exportado.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Define os detalhes da 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 uma etiqueta de entidade para uma expressão.
ConversationalAnalysisAuthoringOrchestrationExportedIntent	Representa uma intenção exportada para um projeto de orquestração.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Representa os recursos de um projeto de orquestração.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	Representa uma expressão de um projeto de orquestração.
ConversationalAnalysisAuthoringProjectSettings	Representa as definições utilizadas 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 ficheiro de projeto exportado a utilizar.
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 Microsoft One API – 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 utilizado para interpretar desvios de cadeia. 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 entre si.

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	CompositionSetting	O comportamento a seguir quando os componentes da entidade se sobrepõem entre si.
list	ConversationalAnalysisAuthoringExportedEntityList	O componente de lista da entidade.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	Os componentes de entidades pré-criados.

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	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 recursos.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	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	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	Representa as etiquetas de entidade da expressão.
intent	string	A intenção da expressão.
language	string	Representa o idioma da expressão. Esta é a 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	A linguagem do projeto. Esta é a 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	ProjectKind	Representa o tipo de projeto.
projectName	string	O novo nome do projeto.
settings	ConversationalAnalysisAuthoringProjectSettings	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	ConversationalAnalysisAuthoringExportedConversationOrchestration	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	ConversationalAnalysisAuthoringExportedEntitySublist[]	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.

ConversationalAnalysisAuthoringExportedEntitySublist

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

Name	Tipo	Description
listKey	string	A chave da sub-lista.
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	As expressões correspondentes à 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	ConversationalAnalysisAuthoringExportedLuisOrchestration	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: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Representa os recursos do projeto.
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	Representa os metadados do projeto.
projectFileVersion	string	A versão do ficheiro exportado.
stringIndexType	StringIndexType	Especifica o método utilizado para interpretar desvios de cadeia. 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	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Os detalhes do projeto de Resposta a Perguntas.
targetProjectKind	string: QuestionAnswering	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: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	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	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	Representa as intenções do projeto.
projectKind	string: Orchestration	O tipo de projeto que contém os recursos.
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	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. Esta é a 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".

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
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 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	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	InnerErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
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.

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 cadeia. 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 a unidades de código UTF-16. Utilize esta opção se a sua aplicação estiver escrita numa linguagem que suporte Unicode, por exemplo Java, JavaScript.

Partilhar via

Conversational Analysis Authoring - Import

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Successful Import Project

Pedido de amostra

Resposta da amostra

Definições

CompositionSetting

ConversationalAnalysisAuthoringConversationExportedEntity

ConversationalAnalysisAuthoringConversationExportedIntent

ConversationalAnalysisAuthoringConversationExportedProjectAssets

ConversationalAnalysisAuthoringConversationExportedUtterance

ConversationalAnalysisAuthoringCreateProjectOptions

ConversationalAnalysisAuthoringExportedConversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

ConversationalAnalysisAuthoringExportedEntityList

ConversationalAnalysisAuthoringExportedEntityListSynonym

ConversationalAnalysisAuthoringExportedEntitySublist

ConversationalAnalysisAuthoringExportedLuisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

ConversationalAnalysisAuthoringExportedPrebuiltEntity

ConversationalAnalysisAuthoringExportedProject

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

ConversationalAnalysisAuthoringOrchestrationExportedIntent

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

ConversationalAnalysisAuthoringProjectSettings

Error

ErrorCode

ErrorResponse

ExportedProjectFormat

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

Recursos adicionais