Knowledgebase - Replace

Referência

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Substitua os conteúdos da base de dados de conhecimento.

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

Parâmetros do URI

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

Cabeçalho do Pedido

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

Corpo do Pedido

Name	Necessário	Tipo	Description
qnAList	True	QnADTO[]	Lista de Q-A (QnADTO) a adicionar à base de dados de conhecimento. Os IDs de Q-A são atribuídos pelo serviço e devem ser omitidos.

Respostas

Name	Tipo	Description
204 No Content		HTTP 204 Sem conteúdo.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemplos

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

Definições

Name	Description
Context	Contexto associado à Qna a atualizar.
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.
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.
MetadataDTO	Nome – par de valores de metadados.
PromptDTO	Pedir uma resposta.
Qna	QnADTO – QnaId ou QnADTO tem de estar presente num objeto PromptDTO
QnADTO	Objeto Q-A.
ReplaceKbDTO	Post body schema for Replace KB operation.

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 para consultas sem falso contexto - 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

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 série de detalhes sobre erros específicos que levaram a este erro comunicado.
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.

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.

MetadataDTO

Nome – par de valores de metadados.

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

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 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 da 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 a Q-A foi indexada. 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 da 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 a Q-A foi indexada. por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

Post body schema for Replace KB operation.

Name	Tipo	Description
qnAList	QnADTO[]	Lista de Q-A (QnADTO) a adicionar à base de dados de conhecimento. Os IDs de Q-A são atribuídos pelo serviço e devem ser omitidos.

Share via