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=2022-05-01
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2022-05-01
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Nombre del proyecto que se va a usar. |
api-version
|
query | True |
string |
Versión de API del cliente. |
format
|
query |
Formato del archivo de proyecto exportado que se va a usar. |
Nombre | Requerido | Tipo | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Una clave de suscripción para un recurso de servicio de lenguaje. |
Nombre | Requerido | Tipo | Description |
---|---|---|---|
metadata | True |
Representa los metadatos del proyecto. |
|
projectFileVersion | True |
string |
Versión del archivo exportado. |
stringIndexType | True |
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. |
Nombre | Tipo | Description |
---|---|---|
202 Accepted |
Una llamada correcta devuelve un encabezado Operation-Location que se usa para comprobar el estado del trabajo. Encabezados operation-location: string |
|
Other Status Codes |
Respuesta de error. |
Una clave de suscripción para un recurso de servicio de lenguaje.
Tipo:
apiKey
En:
header
Solicitud de ejemplo
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": []
}
]
}
}
Respuesta de muestra
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01
Nombre | Description |
---|---|
Composition |
El comportamiento que se debe seguir cuando los componentes de la entidad se superponen entre sí. |
Conversational |
Representa una entidad con sus componentes. |
Conversational |
Representa una intención exportada de un proyecto conversacional. |
Conversational |
Representa los recursos exportados de un proyecto conversacional. |
Conversational |
Representa una expresión exportada para un proyecto conversacional. |
Conversational |
Representa las opciones usadas para crear o actualizar un proyecto. |
Conversational |
Define los detalles de orquestación de un destino de proyecto conversacional. |
Conversational |
Representa las opciones de orquestación de un destino de proyecto conversacional. |
Conversational |
Representa un componente de lista de una entidad. |
Conversational |
Representa una lista de sinónimos dentro de un componente de lista. |
Conversational |
Representa una sublista dentro de un componente de lista. |
Conversational |
Define los detalles de orquestación de un destino de aplicación de LUIS. |
Conversational |
Representa las opciones de orquestación de un destino de aplicación de LUIS. |
Conversational |
Representa un componente de entidad precompilado exportado. |
Conversational |
Representa un proyecto exportado. |
Conversational |
Define los detalles de orquestación de un destino de proyecto de respuesta a preguntas. |
Conversational |
Representa las opciones de orquestación de un destino de proyecto de respuesta a preguntas. |
Conversational |
Representa una etiqueta de entidad para una expresión. |
Conversational |
Representa una intención exportada para un proyecto de orquestación. |
Conversational |
Representa los recursos de un proyecto de orquestación. |
Conversational |
Representa una expresión de un proyecto de orquestación. |
Conversational |
Representa la configuración utilizada para definir el comportamiento del proyecto. |
Error |
Objeto de error. |
Error |
Código de error legible. |
Error |
Respuesta de error. |
Exported |
Formato del archivo de proyecto exportado que se va a usar. |
Inner |
Código de error legible. |
Inner |
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. |
Project |
Representa el tipo de proyecto. |
String |
Especifica el método utilizado para interpretar los desplazamientos de cadena. Para más información, vea https://aka.ms/text-analytics-offsets. |
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. |
Representa una entidad con sus componentes.
Nombre | Tipo | Description |
---|---|---|
category |
string |
Categoría de la entidad. |
compositionSetting |
El comportamiento que se debe seguir cuando los componentes de la entidad se superponen entre sí. |
|
list |
Componente de lista de la entidad. |
|
prebuilts |
Componentes de entidades precompiladas. |
Representa una intención exportada de un proyecto conversacional.
Nombre | Tipo | Description |
---|---|---|
category |
string |
Categoría de intención. |
Representa los recursos exportados de un proyecto conversacional.
Nombre | Tipo | Description |
---|---|---|
entities |
Las entidades definidas en el proyecto. |
|
intents |
Intenciones definidas en el proyecto. |
|
projectKind |
string:
Conversation |
Tipo de proyecto que contiene los recursos. |
utterances |
Conversational |
Expresiones definidas en el proyecto. |
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 |
Conversational |
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. |
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 |
Representa el tipo de proyecto. |
|
projectName |
string |
Nuevo nombre del proyecto. |
settings |
Configuración del proyecto. |
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. |
Representa las opciones de orquestación de un destino de proyecto conversacional.
Nombre | Tipo | Description |
---|---|---|
conversationOrchestration |
Conversational |
Detalles del destino del proyecto conversacional. |
targetProjectKind |
string:
Conversation |
El tipo de destino utilizado en el flujo de orquestación. |
Representa un componente de lista de una entidad.
Nombre | Tipo | Description |
---|---|---|
sublists |
Sublistas del componente de lista. |
Representa una lista de sinónimos dentro de un componente de lista.
Nombre | Tipo | Description |
---|---|---|
language |
string |
Representa el idioma de los sinónimos. 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. |
values |
string[] |
Lista de sinónimos. |
Representa una sublista dentro de un componente de lista.
Nombre | Tipo | Description |
---|---|---|
listKey |
string |
Clave de la sublista. |
synonyms |
Frases de que corresponden a la sublista. |
Define los detalles de orquestación de un destino de aplicación de LUIS.
Nombre | Tipo | Description |
---|---|---|
appId |
string |
El identificador de la aplicación de LUIS. |
appVersion |
string |
Identificador de versión de destino. |
slotName |
string |
Nombre de la ranura de destino. |
Representa las opciones de orquestación de un destino de aplicación de LUIS.
Nombre | Tipo | Description |
---|---|---|
luisOrchestration |
Detalles del destino de la aplicación de LUIS. |
|
targetProjectKind |
string:
Luis |
El tipo de destino utilizado en el flujo de orquestación. |
Representa un componente de entidad precompilado exportado.
Nombre | Tipo | Description |
---|---|---|
category |
string |
Categoría de entidad precompilada. |
Representa un proyecto exportado.
Nombre | Tipo | Description |
---|---|---|
assets | ConversationalAnalysisAuthoringExportedProjectAssets: |
Representa los recursos del proyecto. |
metadata |
Representa los metadatos del proyecto. |
|
projectFileVersion |
string |
Versión del archivo exportado. |
stringIndexType |
Especifica el método utilizado para interpretar los desplazamientos de cadena. Para más información, vea https://aka.ms/text-analytics-offsets. |
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. |
Representa las opciones de orquestación de un destino de proyecto de respuesta a preguntas.
Nombre | Tipo | Description |
---|---|---|
questionAnsweringOrchestration |
Conversational |
Detalles del proyecto de respuesta a preguntas. |
targetProjectKind |
string:
Question |
El tipo de destino utilizado en el flujo de orquestación. |
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. |
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. |
Representa los recursos de un proyecto de orquestación.
Nombre | Tipo | Description |
---|---|---|
intents |
Conversational |
Representa las intenciones del proyecto. |
projectKind |
string:
Orchestration |
Tipo de proyecto que contiene los recursos. |
utterances |
Conversational |
Representa las expresiones del proyecto. |
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. |
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". |
Objeto de error.
Nombre | Tipo | Description |
---|---|---|
code |
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 |
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. |
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 |
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
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. |
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 |
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 |
Uno de los conjuntos de códigos de error definidos por el servidor. |
|
details |
object |
Detalles del error. |
innererror |
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. |
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. |
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. |