Knowledgebase - Update

Referência

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Operação assíncrona para modificar uma base de dados de conhecimento.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto final dos Serviços Cognitivos suportado (por exemplo, https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	ID do Knowledgebase.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo do Pedido

Name	Tipo	Description
add	Add	Uma instância de CreateKbInputDTO para adicionar operação
defaultAnswerUsedForExtraction	string	Cadeia de texto a utilizar como resposta em qualquer Q-A que não tenha resposta extraída do documento, mas que tenha uma hierarquia. Necessário quando o campo EnableHierarchicalExtraction está definido como Verdadeiro.
delete	Delete	Uma instância de DeleteKbContentsDTO para a Operação de eliminação
enableHierarchicalExtraction	boolean	Ative a extração hierárquica de Q-A a partir de ficheiros e urls. O conjunto de valores durante a criação da BDC será utilizado se este campo não estiver presente.
update	Update	Uma instância de UpdateKbContentsDTO para a Operação de Atualização

Respostas

Name	Tipo	Description
202 Accepted	Operation	Detalhes da operação assíncrona. Headers Location: string
Other Status Codes	ErrorResponse	Resposta de erro.

Name

Tipo

Description

202 Accepted

Operation

Detalhes da operação assíncrona.

Headers

Location: string

Other Status Codes

ErrorResponse

Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemplos

Successful query

Sample Request

HTTP

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


{
  "add": {
    "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": []
      }
    ],
    "urls": [
      "https://docs.microsoft.com/en-us/azure/cognitive-services/Emotion/FAQ"
    ],
    "files": [
      {
        "fileName": "SurfaceManual.pdf",
        "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
      }
    ]
  },
  "delete": {
    "ids": [
      13,
      35
    ]
  },
  "update": {
    "name": "QnA Maker FAQ Prompts Bot",
    "qnaList": [
      {
        "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": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "add": [],
          "delete": []
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Add Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I add prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Delete Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I delete delete prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Update Knowledgebase",
              "displayOrder": 0,
              "qna": null,
              "qnaId": 3
            }
          ],
          "promptsToDelete": [
            3
          ]
        }
      },
      {
        "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": "Custom Editorial",
        "questions": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "delete": [
            {
              "name": "category",
              "value": "api"
            }
          ],
          "add": [
            {
              "name": "category",
              "value": "programmatic"
            }
          ]
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Regenerate Endpoint keys",
              "displayOrder": 1,
              "qna": null,
              "qnaId": 4
            }
          ],
          "promptsToDelete": [
            4
          ]
        }
      }
    ]
  }
}

Sample Response

Status code:: 202

{
  "operationState": "NotStarted",
  "createdTimestamp": "2018-03-19T07:38:46Z",
  "lastActionTimestamp": "2018-03-19T07:39:29Z",
  "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
  "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
}

Definições

Name	Description
Add	Uma instância de CreateKbInputDTO para adicionar operação
Context	Contexto associado à Qna a atualizar.
Delete	Uma instância de DeleteKbContentsDTO para a Operação de eliminação
Error	O objeto de erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Um dos conjuntos de códigos de erro definidos pelo servidor.
ErrorResponse	Resposta de erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO	DTO para guardar os detalhes dos ficheiros carregados.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Metadata	Lista de metadados associados à resposta a atualizar
MetadataDTO	Nome - par de valores de metadados.
Operation	Grave para controlar a operação de execução prolongada.
OperationStateType	Estado da operação.
PromptDTO	Pedir uma resposta.
Qna	QnADTO – QnaId ou QnADTO tem de estar presente num objeto PromptDTO
QnADTO	Objeto Q-A.
Questions	Lista de perguntas associadas à resposta.
Update	Uma instância de UpdateKbContentsDTO para a Operação de Atualização
UpdateKbOperationDTO	Contém a lista de FAQ a atualizar
UpdateQnaDTO	PATCH Body schema for Update Qna List

Add

Uma instância de CreateKbInputDTO para adicionar operação

Name	Tipo	Description
files	FileDTO[]	Lista de ficheiros a adicionar à base de dados de conhecimento.
qnaList	QnADTO[]	Lista de QNA a adicionar ao índice. Os IDs são gerados pelo serviço e devem ser omitidos.
urls	string[]	Lista de URLs a adicionar à base de dados de conhecimento.

Context

Contexto associado à Qna a atualizar.

Name	Tipo	Description
isContextOnly	boolean	Para marcar se um pedido é relevante apenas com uma pergunta anterior ou não. true - Não inclua este FAQ como resultado da pesquisa de consultas sem contexto falso - ignora o contexto e inclui este FAQ no resultado da pesquisa
promptsToAdd	PromptDTO[]	Lista de pedidos a adicionar à qna.
promptsToDelete	integer[]	Lista de pedidos associados à qna a eliminar

Delete

Uma instância de DeleteKbContentsDTO para a Operação de eliminação

Name	Tipo	Description
ids	integer[]	Lista de IDs de Qna a eliminar
sources	string[]	Lista de origens a eliminar da base de dados de conhecimento.

Error

O objeto de erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	ErrorCodeType	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innerError	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O destino do erro.

ErrorCodeType

Um dos conjuntos de códigos de erro definidos pelo servidor.

Name	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

Resposta de erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
error	Error	O objeto de erro.

FileDTO

DTO para guardar os detalhes dos ficheiros carregados.

Name	Tipo	Description
fileName	string	Nome do ficheiro. Os tipos de ficheiro suportados são ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri	string	URI público do ficheiro.
isUnstructured	boolean	Sinalizador opcional para especificar se o ficheiro especificado não está estruturado.

InnerErrorModel

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	string	Um código de erro mais específico do que o fornecido pelo erro que contém.
innerError	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

Metadata

Lista de metadados associados à resposta a atualizar

Name	Tipo	Description
add	MetadataDTO[]	Lista de metadados associados à resposta a adicionar
delete	MetadataDTO[]	Lista de Metadados associados à resposta a eliminar

MetadataDTO

Nome - par de valores de metadados.

Name	Tipo	Description
name	string	Nome dos metadados.
value	string	Valor de metadados.

Operation

Grave para controlar a operação de execução prolongada.

Name	Tipo	Description
createdTimestamp	string	Carimbo de data/hora quando a operação foi criada.
errorResponse	ErrorResponse	Detalhes do erro em caso de falhas.
lastActionTimestamp	string	Carimbo de data/hora quando o estado atual foi introduzido.
operationId	string	ID da Operação.
operationState	OperationStateType	Estado da operação.
resourceLocation	string	URI relativo à localização do recurso de destino para recursos concluídos.
userId	string	ID do Utilizador

OperationStateType

Estado da operação.

Name	Tipo	Description
Failed	string
NotStarted	string
Running	string
Succeeded	string

PromptDTO

Pedir uma resposta.

Name	Tipo	Description
displayOrder	integer	Índice da linha de comandos - utilizado na ordenação dos pedidos
displayText	string	Texto apresentado para representar um pedido de perguntas de seguimento
qna	Qna	QnADTO – QnaId ou QnADTO tem de estar presente num objeto PromptDTO
qnaId	integer	ID da Qna correspondente à linha de comandos – se o QnaId estiver presente, o objeto QnADTO é ignorado.

Qna

QnADTO – QnaId ou QnADTO tem de estar presente num objeto PromptDTO

Name	Tipo	Description
answer	string	Mensagem escrita de resposta
context	Context	Contexto de um FAQ
id	integer	ID exclusivo para o Q-A.
lastUpdatedTimestamp	string	Carimbo de data/hora quando o FAQ foi atualizado pela última vez.
metadata	MetadataDTO[]	Lista de metadados associados à resposta.
questions	string[]	Lista de perguntas associadas à resposta.
source	string	Origem a partir da qual o Q-A foi indexado. por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Objeto Q-A.

Name	Tipo	Description
answer	string	Mensagem escrita de resposta
context	Context	Contexto de um FAQ
id	integer	ID exclusivo para o Q-A.
lastUpdatedTimestamp	string	Carimbo de data/hora quando o FAQ foi atualizado pela última vez.
metadata	MetadataDTO[]	Lista de metadados associados à resposta.
questions	string[]	Lista de perguntas associadas à resposta.
source	string	Origem a partir da qual o Q-A foi indexado. por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Questions

Lista de perguntas associadas à resposta.

Name	Tipo	Description
add	string[]	Lista de perguntas a adicionar
delete	string[]	Lista de perguntas a eliminar.

Update

Uma instância de UpdateKbContentsDTO para a Operação de Atualização

Name	Tipo	Description
defaultAnswer	string	Resposta predefinida enviada ao utilizador se não for encontrada uma boa correspondência na BDC.
name	string	Nome amigável para a base de dados de conhecimento.
qnaList	UpdateQnaDTO[]	Lista de Q-A (UpdateQnaDTO) a adicionar à base de dados de conhecimento.
urls	string[]	Lista de URLs existentes a atualizar. O conteúdo será novamente extraído e re-indexado.

UpdateKbOperationDTO

Contém a lista de FAQ a atualizar

Name	Tipo	Description
add	Add	Uma instância de CreateKbInputDTO para adicionar operação
defaultAnswerUsedForExtraction	string	Cadeia de texto a utilizar como resposta em qualquer Q-A que não tenha resposta extraída do documento, mas que tenha uma hierarquia. Necessário quando o campo EnableHierarchicalExtraction está definido como Verdadeiro.
delete	Delete	Uma instância de DeleteKbContentsDTO para a Operação de eliminação
enableHierarchicalExtraction	boolean	Ative a extração hierárquica de Q-A a partir de ficheiros e urls. O conjunto de valores durante a criação da BDC será utilizado se este campo não estiver presente.
update	Update	Uma instância de UpdateKbContentsDTO para a Operação de Atualização

UpdateQnaDTO

PATCH Body schema for Update Qna List

Name	Tipo	Description
answer	string	Mensagem escrita de resposta
context	Context	Contexto associado à Qna a atualizar.
id	integer	ID exclusivo para o Q-A
metadata	Metadata	Lista de metadados associados à resposta a atualizar
questions	Questions	Lista de perguntas associadas à resposta.
source	string	Origem a partir da qual o Q-A foi indexado. por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Share via

Knowledgebase - Update

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Successful query

Sample Request

Sample Response

Definições

Add

Context

Delete

Error

ErrorCodeType

ErrorResponse

FileDTO

InnerErrorModel

Metadata

MetadataDTO

Operation

OperationStateType

PromptDTO

Qna

QnADTO

Questions

Update

UpdateKbOperationDTO

UpdateQnaDTO

Recursos adicionais