Question Answering Projects - Update Qnas

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2023-04-01

Actualiza los QnAs de un proyecto.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string (uri)	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nombre del proyecto que se va a usar.
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

Nombre	Tipo	Description
body	UpdateQnaRecord[]	Actualice los parámetros de QnAs de un proyecto.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Encabezados Operation-Location: string
Other Status Codes	ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

202 Accepted

La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Encabezados

Operation-Location: string

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: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas?api-version=2023-04-01

[
  {
    "op": "add",
    "value": {
      "answer": "ans3",
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "displayText": "prompt 3.1",
            "qnaId": 11
          },
          {
            "displayOrder": 2,
            "displayText": "prompt 3.2",
            "qnaId": 21
          }
        ]
      },
      "id": 3,
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "questions": [
        "question 3.1",
        "question 3.2"
      ],
      "source": "source1"
    }
  },
  {
    "op": "replace",
    "value": {
      "answer": "ans4",
      "id": 1,
      "questions": [
        "question 4.1",
        "question 4.2"
      ],
      "source": "source1"
    }
  },
  {
    "op": "delete",
    "value": {
      "answer": "ans2",
      "id": 2,
      "questions": [
        "question 2.1",
        "question 2.2"
      ],
      "source": "source1"
    }
  }
]

Respuesta de muestra

status code:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2023-04-01

Definiciones

Nombre	Description
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
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.
QnaDialog	Cuadro de diálogo asociado con el registro de QnA.
QnaPrompt	Solicitar una respuesta.
QnaRecord	Registro QnA.
SuggestedQuestion	Pregunta sugerida por la característica De aprendizaje activo.
SuggestedQuestionsCluster	Detalles del clúster de preguntas sugeridas de Active Learning.
updateOperationKind	Tipo de operación de actualización para los recursos.
UpdateQnaRecord	Registro QnA que se va a actualizar.

Error

Object

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

Enumeración

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

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Enumeración

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

Object

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.

QnaDialog

Object

Cuadro de diálogo asociado con el registro de QnA.

Nombre	Tipo	Description
isContextOnly	boolean	Para marcar si una solicitud solo es relevante con una pregunta anterior o no. Si es true, no incluya esta QnA como respuesta para las consultas sin contexto; de lo contrario, omite el contexto e incluye esta QnA en respuestas.
prompts	QnaPrompt[]	Lista de mensajes asociados a la respuesta.

QnaPrompt

Object

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.
qna	QnaRecord	Registro QnA. El registro QnAId o QnA debe estar presente en un símbolo del sistema.
qnaId	integer (int32)	Identificador de la QnA correspondiente al símbolo del sistema.

QnaRecord

Object

Registro QnA.

Nombre	Tipo	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Lista de sugerencias de Aprendizaje activo para QnA.
answer	string minLength: 1 maxLength: 25000	Texto de respuesta.
dialog	QnaDialog	Contexto de una QnA.
id	integer (int32)	Identificador único 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 maxLength: 300	Origen desde el que QnA se indizó, por ejemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Object

Pregunta sugerida por la característica De aprendizaje activo.

Nombre	Tipo	Description
autoSuggestedCount	integer (int32)	El número de veces que el algoritmo de Aprendizaje activo sugirió automáticamente la pregunta.
question	string	Pregunta sugerida por la característica De aprendizaje activo.
userSuggestedCount	integer (int32)	El usuario sugirió explícitamente el número de veces que el usuario sugirió la pregunta.

SuggestedQuestionsCluster

Object

Detalles del clúster de preguntas sugeridas de Active Learning.

Nombre	Tipo	Description
clusterHead	string	Pregunta elegida como encabezado del clúster de preguntas sugeridas por el algoritmo de agrupación en clústeres de Active Learning.
suggestedQuestions	SuggestedQuestion[]	Lista de todas las preguntas sugeridas para el QnA.

updateOperationKind

Enumeración

Tipo de operación de actualización para los recursos.

Valor	Description
add	Agregar operación.
delete	Operación de eliminación.
replace	Operación de reemplazo.

UpdateQnaRecord

Object

Registro QnA que se va a actualizar.

Nombre	Tipo	Description
op	updateOperationKind	Tipo de operación de actualización para los recursos.
value	QnaRecord	Registro QnA.

Compartir a través de

Question Answering Projects - Update Qnas

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

OAuth2Auth

Ámbitos

Ejemplos

Successful query

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

updateOperationKind

UpdateQnaRecord