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

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	ID da base de dados de conhecimento.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo da solicitação

Nome	Tipo	Description
add	Add	Uma instância de CreateKbInputDTO para adicionar operação
defaultAnswerUsedForExtraction	string	Cadeia de caracteres de texto a ser usada como resposta em qualquer Q-A que não tenha nenhuma resposta extraída do documento, mas tenha uma hierarquia. Necessário quando o campo EnableHierarchicalExtraction é definido como True.
delete	Delete	Uma instância de DeleteKbContentsDTO para operação de exclusão
enableHierarchicalExtraction	boolean	Habilite a extração hierárquica de Q-A de arquivos e URLs. O valor definido durante a criação da KB será usado se esse campo não estiver presente.
update	Update	Uma instância de UpdateKbContentsDTO para Operação de Atualização

Respostas

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

Nome

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

Nome	Description
Add	Uma instância de CreateKbInputDTO para adicionar operação
Context	Contexto associado ao Qna a ser atualizado.
Delete	Uma instância de DeleteKbContentsDTO para operação de exclusão
Error	O objeto de erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Um de um conjunto definido pelo servidor de códigos de erro.
ErrorResponse	Resposta de erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO	DTO para armazenar detalhes dos arquivos carregados.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Metadata	Lista de metadados associados à resposta a ser atualizada
MetadataDTO	Nome – par de valores de metadados.
Operation	Registre para acompanhar a operação de execução prolongada.
OperationStateType	Estado da operação.
PromptDTO	Solicite uma resposta.
Qna	QnADTO - QnaId ou QnADTO precisa estar presente em um objeto PromptDTO
QnADTO	Objeto Q-A.
Questions	Lista de perguntas associadas à resposta.
Update	Uma instância de UpdateKbContentsDTO para Operação de Atualização
UpdateKbOperationDTO	Contém a lista de QnAs a serem atualizadas
UpdateQnaDTO	Esquema do corpo do PATCH para Atualizar Lista de Qna

Add

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

Nome	Tipo	Description
files	FileDTO[]	Lista de arquivos a serem adicionados à base de dados de conhecimento.
qnaList	QnADTO[]	Lista de QNA a ser adicionada ao índice. As IDs são geradas pelo serviço e devem ser omitidas.
urls	string[]	Lista de URLs a serem adicionadas à base de dados de conhecimento.

Context

Contexto associado ao Qna a ser atualizado.

Nome	Tipo	Description
isContextOnly	boolean	Para marcar se um prompt é relevante apenas com uma pergunta anterior ou não. true – não inclua esse QnA como resultado da pesquisa para consultas sem contexto falso – ignora o contexto e inclui esse QnA no resultado da pesquisa
promptsToAdd	PromptDTO[]	Lista de prompts a serem adicionados ao qna.
promptsToDelete	integer[]	Lista de prompts associados a qna a serem excluídos

Delete

Uma instância de DeleteKbContentsDTO para operação de exclusão

Nome	Tipo	Description
ids	integer[]	Lista de IDs de Qna a serem excluídas
sources	string[]	Lista de fontes a serem excluídas da base de dados de conhecimento.

Error

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

Nome	Tipo	Description
code	ErrorCodeType	Um de um conjunto definido pelo servidor de códigos de erro.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
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 do erro.
target	string	O destino do erro.

ErrorCodeType

Um de um conjunto definido pelo servidor de códigos de erro.

Nome	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 API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Description
error	Error	O objeto de erro.

FileDTO

DTO para armazenar detalhes dos arquivos carregados.

Nome	Tipo	Description
fileName	string	Nome do arquivo. Os tipos de arquivo com suporte são ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri	string	URI público do arquivo.
isUnstructured	boolean	Sinalizador opcional para especificar se o arquivo 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 API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Description
code	string	Um código de erro mais específico do que foi fornecido pelo erro que o 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 ser atualizada

Nome	Tipo	Description
add	MetadataDTO[]	Lista de metadados associados à resposta a ser adicionada
delete	MetadataDTO[]	Lista de metadados associados à resposta a ser excluída

MetadataDTO

Nome – par de valores de metadados.

Nome	Tipo	Description
name	string	nome dos metadados.
value	string	valor dos metadados.

Operation

Registre para acompanhar a operação de execução prolongada.

Nome	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 inserido.
operationId	string	ID da Operação.
operationState	OperationStateType	Estado da operação.
resourceLocation	string	URI relativo para o local do recurso de destino para recursos concluídos.
userId	string	Id de usuário

OperationStateType

Estado da operação.

Nome	Tipo	Description
Failed	string
NotStarted	string
Running	string
Succeeded	string

PromptDTO

Solicite uma resposta.

Nome	Tipo	Description
displayOrder	integer	Índice do prompt – usado na ordenação dos prompts
displayText	string	Texto exibido para representar um prompt de pergunta de acompanhamento
qna	Qna	QnADTO - QnaId ou QnADTO precisa estar presente em um objeto PromptDTO
qnaId	integer	ID de Qna correspondente ao prompt – se QnaId estiver presente, o objeto QnADTO será ignorado.

Qna

QnADTO - QnaId ou QnADTO precisa estar presente em um objeto PromptDTO

Nome	Tipo	Description
answer	string	Texto de resposta
context	Context	Contexto de um QnA
id	integer	ID exclusiva para o Q-A.
lastUpdatedTimestamp	string	Carimbo de data/hora em que o QnA foi atualizado pela última vez.
metadata	MetadataDTO[]	Lista de metadados associados à resposta.
questions	string[]	Lista de perguntas associadas à resposta.
source	string	Fonte da qual o Q-A foi indexado. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Objeto Q-A.

Nome	Tipo	Description
answer	string	Texto de resposta
context	Context	Contexto de um QnA
id	integer	ID exclusiva para o Q-A.
lastUpdatedTimestamp	string	Carimbo de data/hora em que o QnA foi atualizado pela última vez.
metadata	MetadataDTO[]	Lista de metadados associados à resposta.
questions	string[]	Lista de perguntas associadas à resposta.
source	string	Fonte da qual o Q-A foi indexado. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Questions

Lista de perguntas associadas à resposta.

Nome	Tipo	Description
add	string[]	Lista de perguntas a serem adicionadas
delete	string[]	Lista de perguntas a serem excluídas.

Update

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

Nome	Tipo	Description
defaultAnswer	string	Resposta padrão enviada ao usuário se nenhuma correspondência boa for encontrada no KB.
name	string	Nome amigável para a base de dados de conhecimento.
qnaList	UpdateQnaDTO[]	Lista de Q-A (UpdateQnaDTO) a serem adicionados à base de dados de conhecimento.
urls	string[]	Lista de URLs existentes a serem atualizadas. O conteúdo será extraído novamente e indexado novamente.

UpdateKbOperationDTO

Contém a lista de QnAs a serem atualizadas

Nome	Tipo	Description
add	Add	Uma instância de CreateKbInputDTO para adicionar operação
defaultAnswerUsedForExtraction	string	Cadeia de caracteres de texto a ser usada como resposta em qualquer Q-A que não tenha nenhuma resposta extraída do documento, mas tenha uma hierarquia. Necessário quando o campo EnableHierarchicalExtraction é definido como True.
delete	Delete	Uma instância de DeleteKbContentsDTO para operação de exclusão
enableHierarchicalExtraction	boolean	Habilite a extração hierárquica de Q-A de arquivos e URLs. O valor definido durante a criação da KB será usado se esse campo não estiver presente.
update	Update	Uma instância de UpdateKbContentsDTO para Operação de Atualização

UpdateQnaDTO

Esquema do corpo do PATCH para Atualizar Lista de Qna

Nome	Tipo	Description
answer	string	Texto de resposta
context	Context	Contexto associado ao Qna a ser atualizado.
id	integer	ID exclusiva para o Q-A
metadata	Metadata	Lista de metadados associados à resposta a ser atualizada
questions	Questions	Lista de perguntas associadas à resposta.
source	string	Fonte da qual o Q-A foi indexado. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Knowledgebase - Update

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

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