Compartir a través de


Analyze Conversations - Analyze Conversations

Analiza la expresión de conversación de entrada.

POST {Endpoint}/language/:analyze-conversations?api-version=2024-11-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).

api-version
query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

ConversationalTask

Entrada de una tarea de reconocimiento del lenguaje de conversación.

Nombre Requerido Tipo Description
analysisInput True

ConversationAnalysisOptions

ConversationItem de entrada y sus parámetros opcionales

kind True string:

Conversation

Clase base de una tarea de entrada de conversación.

parameters True

ConversationTaskParameters

Parámetros de entrada necesarios para una tarea conversation language understanding.

Respuestas

Nombre Tipo Description
200 OK AnalyzeConversationTaskResult:

ConversationalTaskResult

La solicitud se ha realizado correctamente.

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

SuccessfulAnalyzeConversations
SuccessfulAnalyzeConversationsArbitration
SuccessfulAnalyzeConversationsArbitrationDirectTarget

SuccessfulAnalyzeConversations

Solicitud de ejemplo

POST {Endpoint}/language/:analyze-conversations?api-version=2024-11-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "id": "1",
      "participantId": "1",
      "text": "play In the air tonight from Phil Collins"
    }
  },
  "parameters": {
    "projectName": "{project-name}",
    "deploymentName": "{deployment-name}",
    "stringIndexType": "TextElement_V8"
  }
}

Respuesta de muestra

{
  "kind": "ConversationResult",
  "result": {
    "query": "play In the air tonight from Phil Collins",
    "prediction": {
      "topIntent": "PlayMusic",
      "projectKind": "Conversation",
      "intents": [
        {
          "category": "PlayMusic",
          "confidenceScore": 1
        },
        {
          "category": "SearchCreativeWork",
          "confidenceScore": 0
        },
        {
          "category": "AddToPlaylist",
          "confidenceScore": 0
        }
      ],
      "entities": [
        {
          "category": "Media.Artist",
          "text": "Phil Collins",
          "offset": 29,
          "length": 12,
          "confidenceScore": 1
        }
      ]
    }
  }
}

SuccessfulAnalyzeConversationsArbitration

Solicitud de ejemplo

POST {Endpoint}/language/:analyze-conversations?api-version=2024-11-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "participantId": "1",
      "id": "1",
      "modality": "text",
      "language": "en-GB",
      "text": "How do I integrate QnA Maker and LUIS?"
    }
  },
  "parameters": {
    "projectName": "{project-name}",
    "deploymentName": "{deployment-name}",
    "verbose": true,
    "isLoggingEnabled": false,
    "stringIndexType": "TextElement_V8"
  }
}

Respuesta de muestra

{
  "kind": "ConversationResult",
  "result": {
    "query": "trains from London",
    "prediction": {
      "topIntent": "Rail",
      "projectKind": "Orchestration",
      "intents": {
        "Rail": {
          "confidenceScore": 1,
          "targetProjectKind": "Conversation",
          "result": {
            "query": "trains from London",
            "prediction": {
              "topIntent": "Timetable",
              "projectKind": "Conversation",
              "intents": [
                {
                  "category": "Timetable",
                  "confidenceScore": 0.99968535
                },
                {
                  "category": "Locomotive",
                  "confidenceScore": 0.000314623
                }
              ],
              "entities": []
            }
          }
        },
        "Tree": {
          "confidenceScore": 0.2641529,
          "targetProjectKind": "QuestionAnswering"
        },
        "None": {
          "confidenceScore": 0,
          "targetProjectKind": "NonLinked"
        }
      }
    }
  }
}

SuccessfulAnalyzeConversationsArbitrationDirectTarget

Solicitud de ejemplo

POST {Endpoint}/language/:analyze-conversations?api-version=2024-11-01

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "text": "Ports and connectors",
      "participantId": "1",
      "id": "1"
    }
  },
  "parameters": {
    "projectName": "prj1",
    "deploymentName": "dep1",
    "directTarget": "qnaProject",
    "targetProjectParameters": {
      "qnaProject": {
        "targetProjectKind": "QuestionAnswering",
        "callingOptions": {
          "context": {
            "previousUserQuery": "Meet Surface Pro 4",
            "previousQnaId": 4
          },
          "top": 1,
          "question": "App Service overview"
        }
      }
    }
  }
}

Respuesta de muestra

{
  "kind": "ConversationResult",
  "result": {
    "query": "Ports and connectors",
    "prediction": {
      "projectKind": "Orchestration",
      "topIntent": "qnaTargetApp",
      "intents": {
        "qnaTargetApp": {
          "targetProjectKind": "QuestionAnswering",
          "confidenceScore": 1,
          "result": {
            "answers": [
              {
                "questions": [
                  "App Service overview"
                ],
                "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.",
                "confidenceScore": 0.7384000000000001,
                "id": 1,
                "source": "https://docs.microsoft.com/en-us/azure/app-service/overview",
                "metadata": {},
                "dialog": {
                  "isContextOnly": false,
                  "prompts": []
                }
              }
            ]
          }
        }
      }
    }
  }
}

Definiciones

Nombre Description
AgeResolution

Representa el modelo de resolución de entidades Age.

AgeUnit

Unidad de medición de edad

AnalyzeConversationResult

Representa una respuesta de análisis de conversación.

AnalyzeConversationTaskKind

Enumeración de tareas de conversación admitidas.

AnalyzeConversationTaskResultsKind

Enumeración de los resultados de tareas conversacionales admitidos.

AnswersOptions

Parámetros para consultar una base de conocimiento.

AnswerSpan

Objeto de intervalo de respuestas de QnA.

AnswersResult

Representa la lista de respuestas a preguntas.

AreaResolution

Representa el modelo de resolución de entidades de área.

AreaUnit

Unidad de medida de área.

BooleanResolution

Resolución de expresiones booleanas

ConversationalTask

Entrada de una tarea de reconocimiento del lenguaje de conversación.

ConversationalTaskResult

Resultados de una tarea Conversación.

ConversationAnalysisOptions

ConversationItem de entrada y sus parámetros opcionales

ConversationCallingOptions

La opción que se va a establecer para llamar a un proyecto conversation.

ConversationEntity

Resultado de la extracción de entidades de un proyecto conversation.

ConversationIntent

Resultado de la clasificación de intenciones de un proyecto conversation.

ConversationParameters

Se trata de un conjunto de parámetros de solicitud para proyectos de conversación personalizados.

ConversationPrediction

Representa la sección de predicción de un proyecto conversation.

ConversationResult

Respuesta devuelta por un proyecto conversation.

ConversationTargetIntentResult

Un resumen de la respuesta del proyecto conversation.

ConversationTaskParameters

Parámetros de entrada necesarios para una tarea Conversación.

CurrencyResolution

Representa el modelo de resolución de entidades de moneda.

DateTimeResolution

Resolución de instancias de entidad datetime.

DateTimeSubKind

SubKind datetime.

EntitySubtype

Modelo de subtipo de entidad concreta de información adicional.

Error

Objeto de error.

ErrorCode

Código de error legible para personas.

ErrorResponse

Respuesta de error.

ExtraInformationKind

Tipo de objeto de información adicional.

InformationResolution

Representa el modelo de resolución de entidades de información (datos).

InformationUnit

Unidad de medición de información (datos).

InnerErrorCode

Código de error legible para personas.

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.

InputModality

Enumeración de modalidades conversacionales admitidas.

KnowledgeBaseAnswer

Representa la respuesta de la base de conocimiento.

KnowledgeBaseAnswerContext

Objeto de contexto con la información de QnA anterior.

KnowledgeBaseAnswerDialog

Cuadro de diálogo asociado a Answer.

KnowledgeBaseAnswerPrompt

Solicitar una respuesta.

LengthResolution

Representa el modelo de resolución de entidades de longitud.

LengthUnit

Unidad de medida de longitud.

ListKey

Tipo de datos adicional de clave de lista.

LogicalOperationKind

Operación usada para combinar filtros de metadatos.

LuisCallingOptions

Esto personaliza cómo el servicio llama a los proyectos disponibles con carácter general de LUIS.

LuisParameters

Se trata de un conjunto de parámetros de solicitud para proyectos disponibles con carácter general de LUIS.

LuisTargetIntentResult

Es un resumen de la respuesta disponible con carácter general de LUIS.

MetadataFilter

Busque las QnAs asociadas a la lista de metadatos especificada.

MetadataRecord

Objeto para proporcionar el par de valores de clave para cada metadato.

NoneLinkedTargetIntentResult

Un resumen de la respuesta de intención no vinculada.

NumberKind

Tipo de la entidad numérica extraída.

NumberResolution

Resolución de instancias de entidad numéricas.

NumericRangeResolution

representa la resolución de intervalos numéricos.

OrchestrationPrediction

Esto representa el resultado de predicción de un proyecto de Orquestación.

OrdinalResolution

Resolución de instancias de entidad de números ordinales.

projectKind

Tipo del proyecto.

QueryFilters

filtra sobre la base de conocimiento.

QuestionAnsweringParameters

Se trata de un conjunto de parámetros de solicitud para las bases de conocimiento de respuesta a preguntas.

QuestionAnsweringTargetIntentResult

Es un resumen de una respuesta kb de respuesta a preguntas.

RangeKind

Tipo de intervalo que representa el objeto de resolución.

RankerKind

Tipo de clasificador que se va a usar

RegexKey

Tipo de datos extra de clave regex.

RelativeTo

Punto de referencia que indica el número ordinal.

ResolutionKind

Tipo de objeto de resolución de entidades.

role

Rol del participante.

ShortAnswerOptions

Para configurar la característica de predicción de intervalo de respuestas.

SpeedResolution

Representa el modelo de resolución de entidades de velocidad.

SpeedUnit

Unidad de medida de velocidad

StringIndexType

Tipo de índice de cadena

targetProjectKind

Tipo de un servicio de destino.

TemperatureResolution

Representa el modelo de resolución de entidades de temperatura.

TemperatureUnit

Unidad de medición de temperatura.

TemporalModifier

Un modificador opcional de una instancia de fecha y hora.

TemporalSpanResolution

representa la resolución de una fecha o intervalo de tiempo.

TextConversationItem

Modalidad de texto de una conversación de entrada.

VolumeResolution

Representa el modelo de resolución de entidades de volumen.

VolumeUnit

Unidad de volumen de medida

WeightResolution

Representa el modelo de resolución de entidades de peso.

WeightUnit

Unidad de medida de peso.

AgeResolution

Representa el modelo de resolución de entidades Age.

Nombre Tipo Description
resolutionKind string:

AgeResolution

Tipo de objeto de resolución de entidades.

unit

AgeUnit

Unidad de medición de edad

value

number (double)

Valor numérico que indica el texto extraído.

AgeUnit

Unidad de medición de edad

Valor Description
Day

Unidad de edad del día

Month

Unidad de edad del mes

Unspecified

Unidad de edad no especificada

Week

Unidad de edad de la semana

Year

Unidad de edad de año

AnalyzeConversationResult

Representa una respuesta de análisis de conversación.

Nombre Tipo Description
detectedLanguage

string

El sistema detectó el idioma de la consulta en la representación del idioma BCP 47.

prediction BasePrediction:

Resultado de la predicción de un proyecto de conversación.

query

string

Expresión de conversación dada por el autor de la llamada.

AnalyzeConversationTaskKind

Enumeración de tareas de conversación admitidas.

Valor Description
Conversation

Tipo de tarea conversación

AnalyzeConversationTaskResultsKind

Enumeración de los resultados de tareas conversacionales admitidos.

Valor Description
ConversationResult

Tipo de tarea de resultado de conversación

AnswersOptions

Parámetros para consultar una base de conocimiento.

Nombre Tipo Description
answerSpanRequest

ShortAnswerOptions

Para configurar la característica de predicción de intervalo de respuestas.

confidenceScoreThreshold

number (double)

minimum: 0
maximum: 1

Puntuación mínima del umbral para las respuestas, el valor oscila entre 0 y 1.

context

KnowledgeBaseAnswerContext

Objeto de contexto con la información de QnA anterior.

filters

QueryFilters

Filtre los QnAs en función de la lista de metadatos y los orígenes de la base de conocimiento especificados.

includeUnstructuredSources

boolean

(Opcional) Marca para habilitar la consulta en orígenes no estructurados.

qnaId

integer (int32)

Identificador exacto de QnA para capturar de la base de conocimiento, este campo tiene prioridad sobre la pregunta.

question

string

Pregunta del usuario para consultar en la base de conocimiento.

rankerType

RankerKind

Tipo de clasificador que se va a usar.

top

integer (int32)

Número máximo de respuestas que se devolverán para la pregunta.

userId

string

Identificador único del usuario.

AnswerSpan

Objeto de intervalo de respuestas de QnA.

Nombre Tipo Description
confidenceScore

number (double)

minimum: 0
maximum: 1

Puntuación de predicción del intervalo de respuestas, intervalos de valor comprendidos entre 0 y 1.

length

integer (int32)

Longitud del intervalo de respuesta.

offset

integer (int32)

Desplazamiento del intervalo de respuesta desde el inicio de la respuesta.

text

string

Texto previsto del intervalo de respuestas.

AnswersResult

Representa la lista de respuestas a preguntas.

Nombre Tipo Description
answers

KnowledgeBaseAnswer[]

Representa la lista de resultados de respuesta.

AreaResolution

Representa el modelo de resolución de entidades de área.

Nombre Tipo Description
resolutionKind string:

AreaResolution

Tipo de objeto de resolución de entidades.

unit

AreaUnit

Unidad de medida del área

value

number (double)

Valor numérico que indica el texto extraído.

AreaUnit

Unidad de medida de área.

Valor Description
Acre

Unidad de área de acre

SquareCentimeter

Unidad de área de centímetros cuadrados

SquareDecameter

Unidad de área de decametros cuadrados

SquareDecimeter

Unidad de área de decimeter cuadrado

SquareFoot

Unidad de área de pies cuadrados

SquareHectometer

Unidad de área de hectómetro cuadrado

SquareInch

Unidad de área de pulgada cuadrada

SquareKilometer

Unidad de área de kilómetros cuadrados

SquareMeter

Unidad de área de medidor cuadrado

SquareMile

Unidad de área de milla cuadrada

SquareMillimeter

Unidad de área de milímetro cuadrado

SquareYard

Unidad de área del patio cuadrado

Unspecified

Unidad de área no especificada

BooleanResolution

Resolución de expresiones booleanas

Nombre Tipo Description
resolutionKind string:

BooleanResolution

Tipo de objeto de resolución de entidades.

value

boolean

Resolución de expresiones booleanas

ConversationalTask

Entrada de una tarea de reconocimiento del lenguaje de conversación.

Nombre Tipo Description
analysisInput

ConversationAnalysisOptions

ConversationItem de entrada y sus parámetros opcionales

kind string:

Conversation

Clase base de una tarea de entrada de conversación.

parameters

ConversationTaskParameters

Parámetros de entrada necesarios para una tarea conversation language understanding.

ConversationalTaskResult

Resultados de una tarea Conversación.

Nombre Tipo Description
kind string:

ConversationResult

Clase base de un resultado de tarea de entrada de conversación.

result

AnalyzeConversationResult

Representa una respuesta de análisis de conversación.

ConversationAnalysisOptions

ConversationItem de entrada y sus parámetros opcionales

Nombre Tipo Description
conversationItem

TextConversationItem

Base abstracta para una conversación con formato de entrada del usuario (por ejemplo, Texto, Transcripción).

ConversationCallingOptions

La opción que se va a establecer para llamar a un proyecto conversation.

Nombre Tipo Description
isLoggingEnabled

boolean

Si es true, la consulta se guardará para que los clientes revisen aún más en la creación, para mejorar la calidad del modelo.

language

string

El idioma de la consulta en la representación del lenguaje BCP 47.

verbose

boolean

Si es true, el servicio devolverá información más detallada.

ConversationEntity

Resultado de la extracción de entidades de un proyecto conversation.

Nombre Tipo Description
category

string

Categoría de entidad.

confidenceScore

number (float)

Puntuación de confianza de entidad.

extraInformation BaseExtraInformation[]:

Colección de objetos de información adicional de entidad.

length

integer (int32)

Longitud del texto.

offset

integer (int32)

Índice inicial de esta entidad en la consulta.

resolutions BaseResolution[]:

Colección de objetos de resolución de entidades.

text

string

Texto de la entidad predicho.

ConversationIntent

Resultado de la clasificación de intenciones de un proyecto conversation.

Nombre Tipo Description
category

string

Clase predicha.

confidenceScore

number (float)

minimum: 0
maximum: 1

Puntuación de confianza de la clase de 0,0 a 1,0.

ConversationParameters

Se trata de un conjunto de parámetros de solicitud para proyectos de conversación personalizados.

Nombre Tipo Description
apiVersion

string

La versión de LA API que se va a usar al llamar a un servicio de destino específico.

callingOptions

ConversationCallingOptions

La opción que se va a establecer para llamar a un proyecto conversation.

targetProjectKind string:

Conversation

El tipo de un servicio de destino

ConversationPrediction

Representa la sección de predicción de un proyecto conversation.

Nombre Tipo Description
entities

ConversationEntity[]

Resultados de extracción de entidades.

intents

ConversationIntent[]

Resultados de clasificación de intenciones.

projectKind string:

Conversation

Tipo del proyecto.

topIntent

string

Intención con la puntuación más alta.

ConversationResult

Respuesta devuelta por un proyecto conversation.

Nombre Tipo Description
detectedLanguage

string

El idioma detectado de la consulta en la representación del lenguaje BCP 47.

prediction

ConversationPrediction

Resultado previsto de la consulta.

query

string

La misma consulta dada en la solicitud.

ConversationTargetIntentResult

Un resumen de la respuesta del proyecto conversation.

Nombre Tipo Description
apiVersion

string

La versión de LA API que se usa para llamar a un servicio de destino.

confidenceScore

number (double)

minimum: 0
maximum: 1

La puntuación de predicción y oscila entre 0,0 y 1,0.

result

ConversationResult

Respuesta real de un proyecto conversation.

targetProjectKind string:

Conversation

Esta es la clase base de una predicción de intención.

ConversationTaskParameters

Parámetros de entrada necesarios para una tarea Conversación.

Nombre Tipo Valor predeterminado Description
deploymentName

string

Nombre de la implementación que se va a usar.

directTarget

string

Nombre de un proyecto de destino al que reenviar la solicitud.

isLoggingEnabled

boolean

Si es true, el servicio mantendrá la consulta para su posterior revisión.

projectName

string

Nombre del proyecto que se va a usar.

stringIndexType

StringIndexType

TextElements_v8

Especifica el método utilizado para interpretar los desplazamientos de cadena. El valor predeterminado es Text Elements (Graphemes) según Unicode v8.0.0. Para obtener más información, consulte https://aka.ms/text-analytics-offsets.

targetProjectParameters

object

Diccionario que representa los parámetros de cada proyecto de destino.

verbose

boolean

Si es true, el servicio devolverá información más detallada en la respuesta.

CurrencyResolution

Representa el modelo de resolución de entidades de moneda.

Nombre Tipo Description
ISO4217

string

El código alfabético basado en otro estándar ISO, ISO 3166, que enumera los códigos de los nombres de país. Las dos primeras letras del código de tres letras ISO 4217 son las mismas que el código del nombre del país y, siempre que sea posible, la tercera letra corresponde a la primera letra del nombre de moneda.

resolutionKind string:

CurrencyResolution

Tipo de objeto de resolución de entidades.

unit

string

Unidad de la cantidad capturada en la entidad extraída

value

number (double)

Cantidad de dinero capturada en la entidad extraída

DateTimeResolution

Resolución de instancias de entidad datetime.

Nombre Tipo Description
dateTimeSubKind

DateTimeSubKind

El subkind DateTime

modifier

TemporalModifier

Un modificador opcional de una instancia de fecha y hora.

resolutionKind string:

DateTimeResolution

Tipo de objeto de resolución de entidades.

timex

string

Representación extendida de fecha y hora ISO 8601 como se describe en (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)

value

string

Tiempo real que indica el texto extraído.

DateTimeSubKind

SubKind datetime.

Valor Description
Date

Subkind date

DateTime

Subkind DateTime

Duration

Duración subkind

Set

Establecer subkind

Time

Subkind time

EntitySubtype

Modelo de subtipo de entidad concreta de información adicional.

Nombre Tipo Description
extraInformationKind string:

EntitySubtype

Tipo de objeto de información adicional.

value

string

Subtipo de un tipo de entidad extraído.

Error

Objeto de error.

Nombre Tipo Description
code

ErrorCode

Uno de un conjunto definido por el servidor de códigos de error.

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 para personas.

Valor Description
AzureCognitiveSearchIndexLimitReached

Error alcanzado el límite de índices de Azure Cognitive Search

AzureCognitiveSearchIndexNotFound

Error no encontrado en el índice de Azure Cognitive Search

AzureCognitiveSearchNotFound

Error no encontrado de Azure Cognitive Search

AzureCognitiveSearchThrottling

Error de limitación de Azure Cognitive Search

Conflict

Error de conflicto

Forbidden

Error de acceso prohibido

InternalServerError

Error interno del servidor

InvalidArgument

Error de argumento no válido

InvalidRequest

Error de solicitud no válido

NotFound

Error no encontrado

OperationNotFound

Error de operación no encontrado

ProjectNotFound

Error de proyecto no encontrado

QuotaExceeded

Error de cuota superada

ServiceUnavailable

Error de servicio no disponible

Timeout

Error de tiempo de espera

TooManyRequests

Error de demasiadas solicitudes

Unauthorized

Error de acceso no autorizado

Warning

Error de advertencia

ErrorResponse

Respuesta de error.

Nombre Tipo Description
error

Error

Objeto de error.

ExtraInformationKind

Tipo de objeto de información adicional.

Valor Description
EntitySubtype

Tipo de información adicional de subtipo de entidad

ListKey

Tipo de información adicional de lista clave

RegexKey

Tipo de información adicional de clave regex

InformationResolution

Representa el modelo de resolución de entidades de información (datos).

Nombre Tipo Description
resolutionKind string:

InformationResolution

Tipo de objeto de resolución de entidades.

unit

InformationUnit

Unidad de medición de información (datos).

value

number (double)

Valor numérico que indica el texto extraído.

InformationUnit

Unidad de medición de información (datos).

Valor Description
Bit

Unidad de información de bits

Byte

Unidad de información de bytes

Gigabit

Unidad de información gigabit

Gigabyte

Unidad de información de Gigabyte

Kilobit

Unidad de información de kilobits

Kilobyte

Unidad de información kilobyte

Megabit

Unidad de información de Megabit

Megabyte

Unidad de información megabyte

Petabit

Unidad de información de Petabit

Petabyte

Unidad de información de Petabyte

Terabit

Unidad de información de Terabit

Terabyte

Unidad de información de Terabyte

Unspecified

Unidad de información no especificada

InnerErrorCode

Código de error legible para personas.

Valor Description
AzureCognitiveSearchNotFound

Error no encontrado de Azure Cognitive Search

AzureCognitiveSearchThrottling

Error de limitación de Azure Cognitive Search

EmptyRequest

Error de solicitud vacía

ExtractionFailure

Error de extracción

InvalidCountryHint

Error de sugerencia de país no válido

InvalidDocument

Error de documento no válido

InvalidDocumentBatch

Error de lote de documento no válido

InvalidParameterValue

Error de valor de parámetro no válido

InvalidRequest

Error de solicitud no válido

InvalidRequestBodyFormat

Error de formato de cuerpo de solicitud no válido

KnowledgeBaseNotFound

Error de base de conocimiento no encontrado

MissingInputDocuments

Error de documentos de entrada que faltan

ModelVersionIncorrect

Error incorrecto de la versión del modelo

UnsupportedLanguageCode

Error de código de idioma no admitido

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 un conjunto definido por el servidor de códigos de error.

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.

InputModality

Enumeración de modalidades conversacionales admitidas.

Valor Description
text

Modalidad de entrada de texto

transcript

Modalidad de entrada de transcripción

KnowledgeBaseAnswer

Representa la respuesta de la base de conocimiento.

Nombre Tipo Description
answer

string

Texto de respuesta.

answerSpan

AnswerSpan

Objeto de intervalo de respuestas de QnA con respecto a la pregunta del usuario.

confidenceScore

number (double)

minimum: 0
maximum: 1

Puntuación de confianza de respuesta, el valor oscila entre 0 y 1.

dialog

KnowledgeBaseAnswerDialog

Cuadro de diálogo asociado a Answer.

id

integer (int32)

Identificador del resultado de QnA.

metadata

object

Metadatos asociados a la respuesta, útiles para clasificar o filtrar respuestas a preguntas.

questions

string[]

Lista de preguntas asociadas a la respuesta.

source

string

Origen del resultado de QnA.

KnowledgeBaseAnswerContext

Objeto de contexto con la información de QnA anterior.

Nombre Tipo Description
previousQnaId

integer (int32)

Resultado de respuesta superior anterior QnA ID.

previousUserQuery

string

Consulta de usuario anterior.

KnowledgeBaseAnswerDialog

Cuadro de diálogo asociado a Answer.

Nombre Tipo Description
isContextOnly

boolean

Para marcar si una solicitud solo es relevante con una pregunta anterior o no. Si es true, no incluya este QnA como resultado de búsqueda para las consultas sin contexto; de lo contrario, si es false, omite el contexto e incluye este QnA en el resultado de la búsqueda.

prompts

KnowledgeBaseAnswerPrompt[]

Lista de mensajes asociados a la respuesta.

KnowledgeBaseAnswerPrompt

Solicitar una respuesta.

Nombre Tipo Description
displayOrder

integer (int32)

Índice del símbolo del sistema: se usa para ordenar las solicitudes.

displayText

string

maxLength: 200

Texto que se muestra para representar un mensaje de pregunta de seguimiento.

qnaId

integer (int32)

Id. de QnA correspondiente al símbolo del sistema.

LengthResolution

Representa el modelo de resolución de entidades de longitud.

Nombre Tipo Description
resolutionKind string:

LengthResolution

Tipo de objeto de resolución de entidades.

unit

LengthUnit

Unidad de medida de longitud

value

number (double)

Valor numérico que indica el texto extraído.

LengthUnit

Unidad de medida de longitud.

Valor Description
Centimeter

Unidad de longitud de centímetros

Decameter

Unidad de longitud de decameter

Decimeter

Unidad de longitud de decimeter

Foot

Unidad de longitud de pie

Hectometer

Unidad de longitud del hectómetro

Inch

Unidad de longitud de pulgada

Kilometer

Unidad de longitud de kilómetros

LightYear

Unidad de longitud del año ligero

Meter

Unidad de longitud de medidor

Micrometer

Unidad de longitud de micrometer

Mile

Unidad de longitud de milla

Millimeter

Unidad de longitud de milímetros

Nanometer

Unidad de longitud de nanometer

Picometer

Unidad de longitud picométrica

Pt

Unidad de longitud de punto

Unspecified

Unidad de longitud no especificada

Yard

Unidad de longitud de patio

ListKey

Tipo de datos adicional de clave de lista.

Nombre Tipo Description
extraInformationKind string:

ListKey

Tipo de objeto de información adicional.

key

string

Forma canónica de la entidad extraída.

LogicalOperationKind

Operación usada para combinar filtros de metadatos.

Valor Description
AND

AND lógico

OR

OR lógico

LuisCallingOptions

Esto personaliza cómo el servicio llama a los proyectos disponibles con carácter general de LUIS.

Nombre Tipo Description
bing-spell-check-subscription-key

string

Clave de suscripción que se va a usar al habilitar bing spell check

log

boolean

Guarde el registro para agregar expresiones de entrenamiento más adelante.

show-all-intents

boolean

Establezca true para mostrar todas las intenciones.

spellCheck

boolean

Habilite la revisión ortográfica.

timezoneOffset

integer (int32)

Desplazamiento de zona horaria para la ubicación de la solicitud.

verbose

boolean

Habilite la respuesta detallada.

LuisParameters

Se trata de un conjunto de parámetros de solicitud para proyectos disponibles con carácter general de LUIS.

Nombre Tipo Description
apiVersion

string

La versión de LA API que se va a usar al llamar a un servicio de destino específico.

callingOptions

LuisCallingOptions

Esto personaliza cómo el servicio llama a los proyectos disponibles con carácter general de LUIS.

query

string

maxLength: 500

Expresión que se va a predecir.

targetProjectKind string:

Luis

El tipo de un servicio de destino

LuisTargetIntentResult

Es un resumen de la respuesta disponible con carácter general de LUIS.

Nombre Tipo Description
apiVersion

string

La versión de LA API que se usa para llamar a un servicio de destino.

confidenceScore

number (double)

minimum: 0
maximum: 1

La puntuación de predicción y oscila entre 0,0 y 1,0.

result

LuisResult

Respuesta real de una aplicación disponible con carácter general de LUIS.

targetProjectKind string:

Luis

Esta es la clase base de una predicción de intención.

MetadataFilter

Busque las QnAs asociadas a la lista de metadatos especificada.

Nombre Tipo Valor predeterminado Description
logicalOperation

LogicalOperationKind

AND

Operación usada para combinar filtros de metadatos.

metadata

MetadataRecord[]

Lista de metadatos.

MetadataRecord

Objeto para proporcionar el par de valores de clave para cada metadato.

Nombre Tipo Description
key

string

Clave de metadatos del diccionario de metadatos usado en QnA.

value

string

Valor de metadatos del diccionario de metadatos usado en QnA.

NoneLinkedTargetIntentResult

Un resumen de la respuesta de intención no vinculada.

Nombre Tipo Description
apiVersion

string

La versión de LA API que se usa para llamar a un servicio de destino.

confidenceScore

number (double)

minimum: 0
maximum: 1

La puntuación de predicción y oscila entre 0,0 y 1,0.

result

ConversationResult

Respuesta real de un proyecto conversation.

targetProjectKind string:

NonLinked

Esta es la clase base de una predicción de intención.

NumberKind

Tipo de la entidad numérica extraída.

Valor Description
Decimal

Número decimal

Fraction

Número de fracción

Integer

Número entero

Percent

Número de porcentaje

Power

Número de energía

Unspecified

Tipo de número no especificado

NumberResolution

Resolución de instancias de entidad numéricas.

Nombre Tipo Description
numberKind

NumberKind

Tipo de la entidad numérica extraída.

resolutionKind string:

NumberResolution

Tipo de objeto de resolución de entidades.

value

number (double)

Representación numérica de lo que indica el texto extraído.

NumericRangeResolution

representa la resolución de intervalos numéricos.

Nombre Tipo Description
maximum

number (double)

Valor final del intervalo.

minimum

number (double)

Valor inicial del intervalo.

rangeKind

RangeKind

Tipo de intervalo que representa el objeto de resolución.

resolutionKind string:

NumericRangeResolution

Tipo de objeto de resolución de entidades.

OrchestrationPrediction

Esto representa el resultado de predicción de un proyecto de Orquestación.

Nombre Tipo Description
intents

object

Diccionario que contiene todas las intenciones. Una clave es un nombre de intención y un valor es su puntuación de confianza y el tipo de destino. El valor de la intención superior también contiene la respuesta real del proyecto de destino.

projectKind string:

Orchestration

Tipo del proyecto.

topIntent

string

Intención con la puntuación más alta.

OrdinalResolution

Resolución de instancias de entidad de números ordinales.

Nombre Tipo Description
offset

string

Desplazamiento con respecto a la referencia (por ejemplo, desplazamiento = -1 indica el segundo al último)

relativeTo

RelativeTo

Punto de referencia que indica el número ordinal.

resolutionKind string:

OrdinalResolution

Tipo de objeto de resolución de entidades.

value

string

Expresión aritmética simple que denota el ordinal.

projectKind

Tipo del proyecto.

Valor Description
Conversation

Tipo de conversación

Orchestration

Tipo de orquestación

QueryFilters

filtra sobre la base de conocimiento.

Nombre Tipo Valor predeterminado Description
logicalOperation

LogicalOperationKind

AND

Operación lógica que se usa para combinar el filtro de metadatos con el filtro de origen.

metadataFilter

MetadataFilter

filtra sobre la base de conocimiento.

sourceFilter

string[]

filtra sobre la base de conocimiento.

QuestionAnsweringParameters

Se trata de un conjunto de parámetros de solicitud para las bases de conocimiento de respuesta a preguntas.

Nombre Tipo Description
apiVersion

string

La versión de LA API que se va a usar al llamar a un servicio de destino específico.

callingOptions

AnswersOptions

Las opciones enviadas a un KB de respuesta a preguntas.

targetProjectKind string:

QuestionAnswering

El tipo de un servicio de destino

QuestionAnsweringTargetIntentResult

Es un resumen de una respuesta kb de respuesta a preguntas.

Nombre Tipo Description
apiVersion

string

La versión de LA API que se usa para llamar a un servicio de destino.

confidenceScore

number (double)

minimum: 0
maximum: 1

La puntuación de predicción y oscila entre 0,0 y 1,0.

result

AnswersResult

La respuesta generada por un KB de respuesta a preguntas.

targetProjectKind string:

QuestionAnswering

Esta es la clase base de una predicción de intención.

RangeKind

Tipo de intervalo que representa el objeto de resolución.

Valor Description
Age

Intervalo de edad

Area

Intervalo de áreas

Currency

Intervalo de moneda

Information

Intervalo de información

Length

Intervalo de longitud

Number

Intervalo de números

Speed

Intervalo de velocidad

Temperature

Intervalo de temperatura

Volume

Intervalo de volúmenes

Weight

Rango de peso

RankerKind

Tipo de clasificador que se va a usar

Valor Description
Default

Clasificador predeterminado.

QuestionOnly

Solo el clasificador de preguntas.

RegexKey

Tipo de datos extra de clave regex.

Nombre Tipo Description
extraInformationKind string:

RegexKey

Tipo de objeto de información adicional.

key

string

Clave del patrón regex usado para extraer la entidad.

regexPattern

string

Patrón regex de .NET que se usa para extraer la entidad. Visite https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions para obtener más información sobre las expresiones regulares de .NET.

RelativeTo

Punto de referencia que indica el número ordinal.

Valor Description
Current

Estado actual

End

Estado final

Start

Estado de inicio

ResolutionKind

Tipo de objeto de resolución de entidades.

Valor Description
AgeResolution

Resolución de una entidad de antigüedad

AreaResolution

Resolución de una entidad de área

BooleanResolution

Resolución de una entidad booleana

CurrencyResolution

Resolución de una entidad de moneda

DateTimeResolution

Resolución de una entidad de fecha y hora

InformationResolution

Resolución de una entidad de información

LengthResolution

Resolución de una entidad de longitud

NumberResolution

Resolución de una entidad numérica

NumericRangeResolution

Resolución de una entidad de intervalo numérico

OrdinalResolution

Resolución de una entidad ordinal

SpeedResolution

Resolución de una entidad de velocidad

TemperatureResolution

Resolución de una entidad de temperatura

TemporalSpanResolution

Resolución de una entidad de intervalo temporal

VolumeResolution

Resolución de una entidad de volumen

WeightResolution

Resolución de una entidad de peso

role

Rol del participante.

Valor Description
agent

El participante es un agente.

customer

El participante es un cliente.

generic

es un participante genérico.

ShortAnswerOptions

Para configurar la característica de predicción de intervalo de respuestas.

Nombre Tipo Valor predeterminado Description
confidenceScoreThreshold

number (double)

minimum: 0
maximum: 1

Puntuación mínima del umbral necesaria para incluir un intervalo de respuesta, intervalos de valor comprendidos entre 0 y 1.

enable

boolean

True

Habilite o deshabilite la predicción de intervalo de respuestas.

topAnswersWithSpan

integer (int32)

minimum: 1
maximum: 10

Número de respuestas principales que se deben tener en cuenta para la predicción de intervalos de 1 a 10.

SpeedResolution

Representa el modelo de resolución de entidades de velocidad.

Nombre Tipo Description
resolutionKind string:

SpeedResolution

Tipo de objeto de resolución de entidades.

unit

SpeedUnit

Unidad de medida de velocidad

value

number (double)

Valor numérico que indica el texto extraído.

SpeedUnit

Unidad de medida de velocidad

Valor Description
CentimetersPerMillisecond

Centímetros por unidad de velocidad de milisegundos

FootPerMinute

Unidad de velocidad de pie por minuto

FootPerSecond

Unidad de velocidad pie por segundo

KilometersPerHour

Kilómetros por unidad de velocidad por hora

KilometersPerMillisecond

Kilómetros por unidad de velocidad de milisegundos

KilometersPerMinute

Kilómetros por minuto unidad de velocidad

KilometersPerSecond

Kilómetros por segundo unidad de velocidad

Knot

Unidad de velocidad de nudo

MetersPerMillisecond

Medidores por unidad de velocidad de milisegundos

MetersPerSecond

Medidores por segundo unidad de velocidad

MilesPerHour

Millas por unidad de velocidad por hora

Unspecified

Unidad de velocidad no especificada

YardsPerMinute

Yardas por minuto unidad de velocidad

YardsPerSecond

Yardas por segundo unidad de velocidad

StringIndexType

Tipo de índice de cadena

Valor Description
TextElements_v8

Los valores de desplazamiento y longitud devueltos se corresponden con TextElements (clústeres de Graphemes y Grapheme) que confirman el estándar Unicode 8.0.0. Use esta opción si la aplicación está escrita en .Net Framework o .Net Core y usará StringInfo.

UnicodeCodePoint

Los valores de desplazamiento y longitud devueltos se corresponden con los puntos de código Unicode. Use esta opción si la aplicación está escrita en un lenguaje que admita Unicode, por ejemplo, Python.

Utf16CodeUnit

Los valores de desplazamiento y longitud devueltos corresponden a 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.

targetProjectKind

Tipo de un servicio de destino.

Valor Description
Conversation

Tipo de servicio de destino de conversación

Luis

Tipo de servicio de destino de Luis

NonLinked

Tipo de servicio de destino no vinculado

QuestionAnswering

Tipo de servicio de destino QuestionAnswering

TemperatureResolution

Representa el modelo de resolución de entidades de temperatura.

Nombre Tipo Description
resolutionKind string:

TemperatureResolution

Tipo de objeto de resolución de entidades.

unit

TemperatureUnit

Unidad de medición de temperatura.

value

number (double)

Valor numérico que indica el texto extraído.

TemperatureUnit

Unidad de medición de temperatura.

Valor Description
Celsius

Unidad de temperatura Celsius

Fahrenheit

Unidad de temperatura Fahrenheit

Kelvin

Unidad de temperatura de Kelvin

Rankine

Unidad de temperatura rankine

Unspecified

Unidad de temperatura no especificada

TemporalModifier

Un modificador opcional de una instancia de fecha y hora.

Valor Description
After

Después del modificador temporal

AfterApprox

Modificador temporal AfterApprox

AfterMid

Modificador temporal AfterMid

AfterStart

Modificador temporal AfterStart

Approx

Modificador temporal aprox

Before

Antes del modificador temporal

BeforeApprox

Modificador temporal BeforeApprox

BeforeEnd

Modificador temporal BeforeEnd

BeforeStart

Modificador temporal BeforeStart

End

Modificador temporal final

Less

Menor modificador temporal

Mid

Modificador temporal medio

More

Modificador temporal más

ReferenceUndefined

Modificador temporal ReferenceUndefined

Since

Desde el modificador temporal

SinceEnd

Modificador temporal SinceEnd

Start

Modificador temporal de inicio

Until

Hasta el modificador temporal

TemporalSpanResolution

representa la resolución de una fecha o intervalo de tiempo.

Nombre Tipo Description
begin

string

representa la resolución de una fecha o intervalo de tiempo. Representación extendida de fecha y hora ISO 8601 como se describe en (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)

duration

string

Valor de duración opcional con formato basado en iso 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)

end

string

representa la resolución de una fecha o intervalo de tiempo. Representación extendida de fecha y hora ISO 8601 como se describe en (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)

modifier

TemporalModifier

Un modificador opcional de una instancia de fecha y hora.

resolutionKind string:

TemporalSpanResolution

Tipo de objeto de resolución de entidades.

timex

string

Un triplete opcional que contiene el principio, el final y la duración indicados como cadenas con formato ISO 8601.

TextConversationItem

Modalidad de texto de una conversación de entrada.

Nombre Tipo Description
id

string

Identificador de un elemento de conversación.

language

string

Idioma de invalidación de un elemento de conversación en la representación de idioma BCP 47.

modality

InputModality

Enumeración de modalidades conversacionales admitidas.

participantId

string

Identificador de participante de un elemento de conversación.

role

role

Rol del participante.

text

string

Entrada de texto

VolumeResolution

Representa el modelo de resolución de entidades de volumen.

Nombre Tipo Description
resolutionKind string:

VolumeResolution

Tipo de objeto de resolución de entidades.

unit

VolumeUnit

Unidad de volumen de medida

value

number (double)

Valor numérico que indica el texto extraído.

VolumeUnit

Unidad de volumen de medida

Valor Description
Barrel

Unidad de volumen en barricas.

Bushel

Unidad de volumen en carretes.

Centiliter

Unidad de volumen en centilitros.

Cord

Unidad de volumen en cables.

CubicCentimeter

Unidad de volumen en centímetros cúbicos.

CubicFoot

Unidad de volumen en pies cúbicos.

CubicInch

Unidad de volumen en pulgadas cúbicas.

CubicMeter

Unidad de volumen en metros cúbicos.

CubicMile

Unidad de volumen en millas cúbicas.

CubicMillimeter

Unidad de volumen en milímetros cúbicos.

CubicYard

Unidad de volumen en patios cúbicos.

Cup

Unidad de volumen en tazas.

Decaliter

Unidad de volumen en descalificadores.

FluidDram

Unidad de volumen en drams fluidos.

FluidOunce

Unidad de volumen en onzas fluidas.

Gill

Unidad de volumen en gilles.

Hectoliter

Unidad de volumen en hectoliters.

Hogshead

Unidad de volumen en hogsheads.

Liter

Unidad de volumen en litros.

Milliliter

Unidad de volumen en mililitros.

Minim

Unidad de volumen en minim.

Peck

Unidad de volumen en cuellos.

Pinch

Unidad de volumen en pellizcos.

Pint

Unidad de volumen en pints.

Quart

Unidad de volumen en cuartos.

Tablespoon

Unidad de volumen en cucharadas.

Teaspoon

Unidad de volumen en cucharas.

Unspecified

Unidad de volumen no especificada.

WeightResolution

Representa el modelo de resolución de entidades de peso.

Nombre Tipo Description
resolutionKind string:

WeightResolution

Tipo de objeto de resolución de entidades.

unit

WeightUnit

Unidad de medida de peso.

value

number (double)

Valor numérico que indica el texto extraído.

WeightUnit

Unidad de medida de peso.

Valor Description
Dram

Unidad de peso en drams

Gallon

Unidad de volumen en galones

Grain

Unidad de peso en granos

Gram

Unidad de peso en gramos

Kilogram

Unidad de peso en kilogramos

LongTonBritish

Unidad de peso en toneladas largas (británicas)

MetricTon

Unidad de peso en toneladas métricas

Milligram

Unidad de peso en miligramos

Ounce

Unidad de peso en onzas

PennyWeight

Unidad de peso en pennyweights

Pound

Unidad de peso en libras

ShortHundredWeightUS

Unidad de peso en cien pesos cortos (EE. UU.)

ShortTonUS

Unidad de peso en toneladas cortas (EE. UU.)

Stone

Unidad de peso en piedras

Ton

Unidad de peso en toneladas

Unspecified

Unidad de peso no especificada