Knowledgebase - Replace

Referência

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Substitua o conteúdo da base de dados de conhecimento.

PUT {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	Obrigatório	Tipo	Description
qnAList	True	QnADTO[]	Lista de Q-A (QnADTO) a serem adicionados à base de dados de conhecimento. As IDs de Q-A são atribuídas pelo serviço e devem ser omitidas.

Respostas

Nome	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

Nome	Description
Context	Contexto associado ao Qna a ser atualizado.
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.
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.
MetadataDTO	Nome – par de valores de metadados.
PromptDTO	Solicite uma resposta.
Qna	QnADTO - QnaId ou QnADTO precisa estar presente em um objeto PromptDTO
QnADTO	Objeto Q-A.
ReplaceKbDTO	Esquema de corpo de postagem para a operação Substituir KB.

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

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.

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.

MetadataDTO

Nome – par de valores de metadados.

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

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

ReplaceKbDTO

Esquema de corpo de postagem para a operação Substituir KB.

Nome	Tipo	Description
qnAList	QnADTO[]	Lista de Q-A (QnADTO) a serem adicionados à base de dados de conhecimento. As IDs de Q-A são atribuídas pelo serviço e devem ser omitidas.

Share via