Knowledgebase - Replace

Referencia

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Reemplace el contenido de la base de conocimiento.

PUT {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}

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://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Id. de la base de conocimiento.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
qnAList	True	QnADTO[]	Lista de Q-A (QnADTO) que se va a agregar a la base de conocimiento. El servicio asigna los identificadores de Q-A y se debe omitir.

Respuestas

Nombre	Tipo	Description
204 No Content		HTTP 204 Sin contenido.
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Ejemplos

Successful query

Sample Request

HTTP

PUT {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff


{
  "qnAList": [
    {
      "id": 0,
      "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
      "source": "Custom Editorial",
      "questions": [
        "How can I change the default message from QnA Maker?"
      ],
      "metadata": []
    },
    {
      "id": 0,
      "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
      "source": "Custom Editorial",
      "questions": [
        "How do I programmatically create a KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ]
    }
  ]
}

Sample Response

Status code:: 204

Definiciones

Nombre	Description
Context	Contexto asociado a Qna que se va a actualizar.
Error	Objeto de 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.
ErrorCodeType	Uno de los conjuntos de códigos de error definidos por el servidor.
ErrorResponse	Respuesta de 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.
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.
MetadataDTO	Nombre: par de valores de metadatos.
PromptDTO	Solicite una respuesta.
Qna	QnADTO: QnaId o QnADTO deben estar presentes en un objeto PromptDTO.
QnADTO	Objeto Q-A.
ReplaceKbDTO	Esquema posterior al cuerpo para la operación Reemplazar KB.

Context

Contexto asociado a Qna que se va a actualizar.

Nombre	Tipo	Description
isContextOnly	boolean	Para marcar si una solicitud solo es relevante con una pregunta anterior o no. true: no incluya este QnA como resultado de búsqueda para consultas sin contexto false: omite el contexto e incluye esta QnA en el resultado de la búsqueda.
promptsToAdd	PromptDTO[]	Lista de mensajes que se van a agregar a qna.
promptsToDelete	integer[]	Lista de solicitudes asociadas a qna que se van a eliminar

Error

Objeto de 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	ErrorCodeType	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.

ErrorCodeType

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

Nombre	Tipo	Description
BadArgument	string
EndpointKeysError	string
ExtractionFailure	string
Forbidden	string
KbNotFound	string
NotFound	string
OperationNotFound	string
QnaRuntimeError	string
QuotaExceeded	string
SKULimitExceeded	string
ServiceError	string
Unauthorized	string
Unspecified	string
ValidationFailure	string

ErrorResponse

Respuesta de 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
error	Error	Objeto de error.

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	string	Código de error más específico del proporcionado por el error contenedor.
innerError	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.

MetadataDTO

Nombre: par de valores de metadatos.

Nombre	Tipo	Description
name	string	nombre de los metadatos.
value	string	valor de los metadatos.

PromptDTO

Solicite una respuesta.

Nombre	Tipo	Description
displayOrder	integer	Índice del símbolo del sistema: se usa para ordenar las solicitudes
displayText	string	Texto que se muestra para representar un mensaje de preguntas de seguimiento
qna	Qna	QnADTO: QnaId o QnADTO deben estar presentes en un objeto PromptDTO.
qnaId	integer	Identificador de Qna correspondiente al símbolo del sistema: si QnaId está presente, se omite el objeto QnADTO.

Qna

QnADTO: QnaId o QnADTO deben estar presentes en un objeto PromptDTO.

Nombre	Tipo	Description
answer	string	Texto de respuesta
context	Context	Contexto de una QnA
id	integer	Identificador único para el Q-A.
lastUpdatedTimestamp	string	Marca de tiempo en la que se actualizó por última vez la QnA.
metadata	MetadataDTO[]	Lista de metadatos asociados a la respuesta.
questions	string[]	Lista de preguntas asociadas a la respuesta.
source	string	Origen desde el que se indizó Q-A. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Objeto Q-A.

Nombre	Tipo	Description
answer	string	Texto de respuesta
context	Context	Contexto de una QnA
id	integer	Identificador único para el Q-A.
lastUpdatedTimestamp	string	Marca de tiempo en la que se actualizó por última vez la QnA.
metadata	MetadataDTO[]	Lista de metadatos asociados a la respuesta.
questions	string[]	Lista de preguntas asociadas a la respuesta.
source	string	Origen desde el que se indizó Q-A. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

Esquema posterior al cuerpo para la operación Reemplazar KB.

Nombre	Tipo	Description
qnAList	QnADTO[]	Lista de Q-A (QnADTO) que se va a agregar a la base de conocimiento. El servicio asigna los identificadores de Q-A y se debe omitir.