Knowledgebase - Download

Referencia

Servicio:: Azure AI Services

Versión de la API:: v5.0-preview.2

Descarga la base de conocimiento.

GET {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}/{environment}/qna

Con parámetros opcionales:

GET {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}/{environment}/qna?source={source}&changedSince={changedSince}

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).
environment	path	True	EnvironmentType	Especifica si el entorno es Test o Prod.
kbId	path	True	string	Id. de la base de conocimiento.
changedSince	query		string	El último filtro de propiedad de estado cambiado que se va a aplicar.
source	query		string	Filtro de propiedad de origen que se va a aplicar.

Encabezado de la solicitud

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

Respuestas

Nombre	Tipo	Description
200 OK	QnADocumentsDTO	Colección de todos los Q-A de la base de conocimiento.
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "qnaDocuments": [
    {
      "id": 1,
      "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": [],
      "context": {
        "isContextOnly": false,
        "prompts": []
      },
      "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
    },
    {
      "id": 2,
      "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"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 3,
            "displayText": "Update KB"
          }
        ]
      },
      "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
    },
    {
      "id": 3,
      "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
      "source": "Editorial",
      "questions": [
        "How do I programmatically update my KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 4,
            "displayText": "Refresh Endpoint Keys"
          }
        ]
      },
      "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
    },
    {
      "id": 4,
      "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys",
      "source": "Editorial",
      "questions": [
        "How do I programmatically refresh endpoint keys?"
      ],
      "metadata": [],
      "context": {
        "isContextOnly": false,
        "prompts": []
      },
      "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00"
    }
  ]
}

Definiciones

Nombre	Description
Context	Contexto asociado a Qna que se va a actualizar.
EnvironmentType	Especifica si el entorno es Test o Prod.
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 un conjunto definido por el servidor de códigos de error.
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	Solicitar una respuesta.
Qna	QnADTO: QnaId o QnADTO deben estar presentes en un objeto PromptDTO
QnADocumentsDTO	Lista de QnADTO
QnADTO	Q-A (objeto).

Context

Object

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 esta QnA como resultado de búsqueda para consultas sin contexto false: omite el contexto e incluye este QnA en el resultado de la búsqueda.
promptsToAdd	PromptDTO[]	Lista de mensajes que se van a agregar a qna.
promptsToDelete	integer[] (int32)	Lista de mensajes asociados a qna que se van a eliminar

EnvironmentType

Enumeración

Especifica si el entorno es Test o Prod.

Valor	Description
Prod
Test

Error

Object

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

ErrorCodeType

Enumeración

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

Valor	Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Object

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

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

Object

Nombre: par de valores de metadatos.

Nombre	Tipo	Description
name	string minLength: 1 maxLength: 100	Nombre de metadatos.
value	string minLength: 1 maxLength: 500	Valor de metadatos.

PromptDTO

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 preguntas de seguimiento
qna	Qna	QnADTO: QnaId o QnADTO deben estar presentes en un objeto PromptDTO
qnaId	integer (int32)	Qna id correspondiente al símbolo del sistema: si QnaId está presente, se omite el objeto QnADTO.

Qna

Object

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

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

QnADocumentsDTO

Object

Lista de QnADTO

Nombre	Tipo	Description
qnaDocuments	QnADTO[]	Lista de respuestas.

QnADTO

Object

Q-A (objeto).

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

Compartir a través de

Knowledgebase - Download

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Ejemplos

Successful query

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Context

EnvironmentType

Error

ErrorCodeType

ErrorResponse

InnerErrorModel

MetadataDTO

PromptDTO

Qna

QnADocumentsDTO

QnADTO

Recursos adicionales