Conversational Analysis Authoring - Import

Desencadena un trabajo para importar un proyecto. Si ya existe un proyecto con el mismo nombre, se reemplazan los datos de ese proyecto.

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 identificador URI

Nombre En Requerido Tipo Description
Endpoint
path True

string

Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).

projectName
path True

string

Nombre del proyecto que se va a usar.

api-version
query True

string

Versión de API del cliente.

format
query

ExportedProjectFormat

Formato del archivo de proyecto exportado que se va a usar.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
metadata True

ConversationalAnalysisAuthoringCreateProjectOptions

Representa los metadatos del proyecto.

projectFileVersion True

string

Versión del archivo exportado.

stringIndexType True

StringIndexType

Especifica el método utilizado para interpretar los desplazamientos de cadena. Para más información, vea https://aka.ms/text-analytics-offsets.

assets ConversationalAnalysisAuthoringExportedProjectAssets:

Representa los recursos del proyecto.

Respuestas

Nombre Tipo Description
202 Accepted

Una llamada correcta devuelve un encabezado Operation-Location que se usa para comprobar el estado del trabajo.

Headers

operation-location: string

Other Status Codes

ErrorResponse

Respuesta de error.

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory . Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

  • Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

  • Actualmente, Azure Active Directory v1.0 o v2.0 admite Work, School e Invitados, pero no admite cuentas personales.

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

Scopes

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

Ocp-Apim-Subscription-Key

Una clave de suscripción para un recurso de servicio de lenguaje.

Type: apiKey
In: header

Ejemplos

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

Definiciones

Nombre Description
CompositionSetting

El comportamiento que se debe seguir cuando los componentes de la entidad se superponen entre sí.

ConversationalAnalysisAuthoringConversationExportedEntity

Representa una entidad con sus componentes.

ConversationalAnalysisAuthoringConversationExportedIntent

Representa una intención exportada de un proyecto conversacional.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Representa los recursos exportados de un proyecto conversacional.

ConversationalAnalysisAuthoringConversationExportedUtterance

Representa una expresión exportada para un proyecto conversacional.

ConversationalAnalysisAuthoringCreateProjectOptions

Representa las opciones usadas para crear o actualizar un proyecto.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Define los detalles de orquestación de un destino de proyecto conversacional.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Representa las opciones de orquestación de un destino de proyecto conversacional.

ConversationalAnalysisAuthoringExportedEntityList

Representa un componente de lista de una entidad.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Representa una lista de sinónimos dentro de un componente de lista.

ConversationalAnalysisAuthoringExportedEntityRegex

Representa un componente regex de una entidad.

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Representa una expresión regex dentro de un componente regex. Esta expresión sigue la sintaxis regex de .NET. Por referencia, consulte aquí: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntitySublist

Representa una sub lista dentro de un componente de lista.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Define los detalles de orquestación de un destino de aplicación de LUIS.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Representa las opciones de orquestación de un destino de aplicación de LUIS.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Representa un componente de entidad precompilado exportado.

ConversationalAnalysisAuthoringExportedProject

Representa un proyecto exportado.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Define los detalles de orquestación de un destino de proyecto de respuesta a preguntas.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Representa las opciones de orquestación de un destino de proyecto de respuesta a preguntas.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Representa una etiqueta de entidad para una expresión.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Representa una intención exportada para un proyecto de orquestación.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Representa los recursos de un proyecto de orquestación.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Representa una expresión de un proyecto de orquestación.

ConversationalAnalysisAuthoringProjectSettings

Representa la configuración utilizada para definir el comportamiento del proyecto.

Error

Objeto de error.

ErrorCode

Código de error legible.

ErrorResponse

Respuesta de error.

ExportedProjectFormat

Formato del archivo de proyecto exportado que se va a usar.

InnerErrorCode

Código de error legible.

InnerErrorModel

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ProjectKind

Representa el tipo de proyecto.

StringIndexType

Especifica el método utilizado para interpretar los desplazamientos de cadena. Para más información, vea https://aka.ms/text-analytics-offsets.

CompositionSetting

El comportamiento que se debe seguir cuando los componentes de la entidad se superponen entre sí.

Nombre Tipo Description
combineComponents

string

Cuando se encuentran dos o más componentes en el texto y se superponen, los intervalos de los componentes se combinan en un intervalo que combina todos ellos.

requireExactOverlap

string

Todos los componentes deben superponerse exactamente con los mismos caracteres del texto para que se devuelva la entidad. Si uno de los componentes definidos no se encuentra ni se predice, la entidad no se devolverá.

returnLongestOverlap

string

Cuando se encuentran dos o más componentes en el texto y se superponen, se devuelve el componente con el conjunto de caracteres más largo.

separateComponents

string

La coincidencia o predicción de cada componente se devuelve como una instancia independiente de la entidad.

ConversationalAnalysisAuthoringConversationExportedEntity

Representa una entidad con sus componentes.

Nombre Tipo Description
category

string

Categoría de la entidad.

compositionSetting

CompositionSetting

El comportamiento que se debe seguir cuando los componentes de la entidad se superponen entre sí.

list

ConversationalAnalysisAuthoringExportedEntityList

Componente de lista de la entidad.

prebuilts

ConversationalAnalysisAuthoringExportedPrebuiltEntity[]

Componentes de entidades precompiladas.

regex

ConversationalAnalysisAuthoringExportedEntityRegex

Componente regex de la entidad.

requiredComponents

string[]

Componentes necesarios. Los valores permitidos son "learned", "list", "prebuilts" y "regex".

ConversationalAnalysisAuthoringConversationExportedIntent

Representa una intención exportada de un proyecto conversacional.

Nombre Tipo Description
category

string

Categoría de intención.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Representa los recursos exportados de un proyecto conversacional.

Nombre Tipo Description
entities

ConversationalAnalysisAuthoringConversationExportedEntity[]

Las entidades definidas en el proyecto.

intents

ConversationalAnalysisAuthoringConversationExportedIntent[]

Intenciones definidas en el proyecto.

projectKind string:

Conversation

Tipo de proyecto que contiene los recursos.

utterances

ConversationalAnalysisAuthoringConversationExportedUtterance[]

Expresiones definidas en el proyecto.

ConversationalAnalysisAuthoringConversationExportedUtterance

Representa una expresión exportada para un proyecto conversacional.

Nombre Tipo Description
dataset

string

Conjunto de datos de esta expresión. Los valores permitidos son "Train" y "Test".

entities

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]

Representa las etiquetas de entidad de la expresión.

intent

string

Intención de la expresión.

language

string

Representa el idioma de la expresión. Se trata de una representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc.

text

string

Texto de expresión.

ConversationalAnalysisAuthoringCreateProjectOptions

Representa las opciones usadas para crear o actualizar un proyecto.

Nombre Tipo Description
description

string

Descripción del proyecto.

language

string

Lenguaje del proyecto. Se trata de una representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc.

multilingual

boolean

Si el proyecto se usaría para varios lenguajes o no.

projectKind

ProjectKind

Representa el tipo de proyecto.

projectName

string

Nuevo nombre del proyecto.

settings

ConversationalAnalysisAuthoringProjectSettings

Configuración del proyecto.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Define los detalles de orquestación de un destino de proyecto conversacional.

Nombre Tipo Description
deploymentName

string

Nombre de la implementación de destino.

projectName

string

Nombre del proyecto de destino.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Representa las opciones de orquestación de un destino de proyecto conversacional.

Nombre Tipo Description
conversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestration

Detalles del destino del proyecto conversacional.

targetProjectKind string:

Conversation

Tipo del destino usado en el flujo de orquestación.

ConversationalAnalysisAuthoringExportedEntityList

Representa un componente de lista de una entidad.

Nombre Tipo Description
sublists

ConversationalAnalysisAuthoringExportedEntitySublist[]

Sublistas del componente de lista.

ConversationalAnalysisAuthoringExportedEntityListSynonym

Representa una lista de sinónimos dentro de un componente de lista.

Nombre Tipo Description
language

string

Representa el idioma de los sinónimos. Esta es una representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc.

values

string[]

Lista de sinónimos.

ConversationalAnalysisAuthoringExportedEntityRegex

Representa un componente regex de una entidad.

Nombre Tipo Description
expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression[]

Expresiones regex del componente regex. Estas expresiones siguen la sintaxis regex de .NET. Como referencia, consulte aquí: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Representa una expresión regex dentro de un componente regex. Esta expresión sigue la sintaxis regex de .NET. Por referencia, consulte aquí: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

Nombre Tipo Description
language

string

Representa el lenguaje de la expresión regex. Esta es una representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc.

regexKey

string

Clave de la expresión regex.

regexPattern

string

Patrón regex.

ConversationalAnalysisAuthoringExportedEntitySublist

Representa una sub lista dentro de un componente de lista.

Nombre Tipo Description
listKey

string

Clave de la lista secundaria.

synonyms

ConversationalAnalysisAuthoringExportedEntityListSynonym[]

Frases de que corresponden a la sub-lista.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Define los detalles de orquestación de un destino de aplicación de LUIS.

Nombre Tipo Description
appId

string

Identificador de la aplicación de LUIS.

appVersion

string

Identificador de versión de destino.

slotName

string

Nombre de la ranura de destino.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Representa las opciones de orquestación de un destino de aplicación de LUIS.

Nombre Tipo Description
luisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestration

Detalles del destino de la aplicación de LUIS.

targetProjectKind string:

Luis

Tipo del destino usado en el flujo de orquestación.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Representa un componente de entidad precompilado exportado.

Nombre Tipo Description
category

string

Categoría de entidad precompilada.

ConversationalAnalysisAuthoringExportedProject

Representa un proyecto exportado.

Nombre Tipo Description
assets ConversationalAnalysisAuthoringExportedProjectAssets:

Representa los recursos del proyecto.

metadata

ConversationalAnalysisAuthoringCreateProjectOptions

Representa los metadatos del proyecto.

projectFileVersion

string

Versión del archivo exportado.

stringIndexType

StringIndexType

Especifica el método utilizado para interpretar los desplazamientos de cadena. Para más información, vea https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Define los detalles de orquestación de un destino de proyecto de respuesta a preguntas.

Nombre Tipo Description
projectName

string

Nombre del proyecto de destino.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Representa las opciones de orquestación de un destino de proyecto de respuesta a preguntas.

Nombre Tipo Description
questionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Detalles del proyecto de respuesta a preguntas.

targetProjectKind string:

QuestionAnswering

Tipo del destino usado en el flujo de orquestación.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Representa una etiqueta de entidad para una expresión.

Nombre Tipo Description
category

string

Categoría de la etiqueta de entidad.

length

integer

Longitud del texto de la entidad.

offset

integer

Posición inicial del texto de la entidad.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Representa una intención exportada para un proyecto de orquestación.

Nombre Tipo Description
category

string

Categoría de intención.

orchestration ConversationalAnalysisAuthoringExportedOrchestrationOptions:

Especifica el comportamiento de esta intención en el flujo de orquestación.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Representa los recursos de un proyecto de orquestación.

Nombre Tipo Description
intents

ConversationalAnalysisAuthoringOrchestrationExportedIntent[]

Representa las intenciones del proyecto.

projectKind string:

Orchestration

Tipo de proyecto que contiene los recursos.

utterances

ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]

Representa las expresiones del proyecto.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Representa una expresión de un proyecto de orquestación.

Nombre Tipo Description
dataset

string

Conjunto de datos de esta expresión. Los valores permitidos son "Train" y "Test".

intent

string

Intención de la expresión.

language

string

Representa el idioma de la expresión. Se trata de una representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc.

text

string

Texto de expresión.

ConversationalAnalysisAuthoringProjectSettings

Representa la configuración utilizada para definir el comportamiento del proyecto.

Nombre Tipo Description
confidenceThreshold

number

Umbral de la intención con la mayor confianza, en la que la predicción se cambiará automáticamente a "None". El valor del umbral debe estar comprendido entre 0 y 1 inclusive.

Error

Objeto de error.

Nombre Tipo Description
code

ErrorCode

Uno de los conjuntos de códigos de error definidos por el servidor.

details

Error[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.

innererror

InnerErrorModel

Objeto que contiene información más específica que el objeto actual sobre el error.

message

string

Representación legible del error.

target

string

Destino del error.

ErrorCode

Código de error legible.

Nombre 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

Respuesta de error.

Nombre Tipo Description
error

Error

Objeto de error.

ExportedProjectFormat

Formato del archivo de proyecto exportado que se va a usar.

Nombre Tipo Description
Conversation

string

Especifica el formato de un proyecto conversacional.

Luis

string

Especifica el formato de una aplicación que se exportó desde LUIS.

InnerErrorCode

Código de error legible.

Nombre 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

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre Tipo Description
code

InnerErrorCode

Uno de los conjuntos de códigos de error definidos por el servidor.

details

object

Detalles del error.

innererror

InnerErrorModel

Objeto que contiene información más específica que el objeto actual sobre el error.

message

string

Mensaje de error.

target

string

Destino de error.

ProjectKind

Representa el tipo de proyecto.

Nombre Tipo Description
Conversation

string

Un proyecto para compilar lenguaje natural en aplicaciones, bots y dispositivos IoT.

Orchestration

string

Un proyecto para conectar y organizar conversaciones, respuesta a preguntas personalizadas y proyectos de LUIS juntos en un único proyecto.

StringIndexType

Especifica el método utilizado para interpretar los desplazamientos de cadena. Para más información, vea https://aka.ms/text-analytics-offsets.

Nombre Tipo Description
Utf16CodeUnit

string

Los valores de desplazamiento y longitud se corresponden con unidades de código UTF-16. Use esta opción si la aplicación está escrita en un lenguaje que admita Unicode, por ejemplo Java, JavaScript.