Knowledgebase - Replace

Service:

Cognitive Services - QnA Maker

API Version:

v5.0-preview.2

Ersätt innehåll i kunskapsbasen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Kunskapsbas-ID.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

Name	Obligatorisk	Typ	Description
qnAList	True	QnADTO[]	Lista över Q-A (QnADTO) som ska läggas till i kunskapsbasen. Q-A-ID:n tilldelas av tjänsten och bör utelämnas.

Svar

Name	Typ	Description
204 No Content		HTTP 204 Inget innehåll.
Other Status Codes	ErrorResponse	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
Context	Kontext som är associerad med Qna som ska uppdateras.
Error	Felobjektet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	En av en serverdefinierad uppsättning felkoder.
ErrorResponse	Felsvar. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	Namn – värdepar med metadata.
PromptDTO	Fråga efter ett svar.
Qna	QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt
QnADTO	Q-A-objekt.
ReplaceKbDTO	Publicera brödtextschema för åtgärden Ersätt KB.

Context

Kontext som är associerad med Qna som ska uppdateras.

Name	Typ	Description
isContextOnly	boolean	Markera om en fråga endast är relevant med en tidigare fråga eller inte. true – Inkludera inte denna QnA som sökresultat för frågor utan kontext falskt – ignorerar kontexten och inkluderar denna QnA i sökresultatet
promptsToAdd	PromptDTO[]	Lista över uppmaningar som ska läggas till i qna.
promptsToDelete	integer[]	Lista över frågor som är associerade med qna som ska tas bort

Error

Felobjektet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	ErrorCodeType	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innerError	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En läsbar återgivning av felet.
target	string	Målet för felet.

ErrorCodeType

En av en serverdefinierad uppsättning felkoder.

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

Felsvar. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorModel

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	En mer specifik felkod än vad som angavs av det innehållande felet.
innerError	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

MetadataDTO

Namn – värdepar med metadata.

Name	Typ	Description
name	string	Metadatanamn.
value	string	Metadatavärde.

PromptDTO

Fråga efter ett svar.

Name	Typ	Description
displayOrder	integer	Index för prompten – används i ordning för prompterna
displayText	string	Text som visas för att representera en fråga om uppföljning
qna	Qna	QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt
qnaId	integer	Qna-ID som motsvarar prompten – om QnaId finns ignoreras QnADTO-objektet.

Qna

QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt

Name	Typ	Description
answer	string	Svara på sms
context	Context	Kontext för en QnA
id	integer	Unikt ID för Q-A.
lastUpdatedTimestamp	string	Tidsstämpel när QnA senast uppdaterades.
metadata	MetadataDTO[]	Lista över metadata som är associerade med svaret.
questions	string[]	Lista över frågor som är associerade med svaret.
source	string	Källa från vilken Q-A indexerades. T.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Q-A-objekt.

Name	Typ	Description
answer	string	Svara på sms
context	Context	Kontext för en QnA
id	integer	Unikt ID för Q-A.
lastUpdatedTimestamp	string	Tidsstämpel när QnA senast uppdaterades.
metadata	MetadataDTO[]	Lista över metadata som är associerade med svaret.
questions	string[]	Lista över frågor som är associerade med svaret.
source	string	Källa från vilken Q-A indexerades. T.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

Publicera brödtextschema för åtgärden Ersätt KB.

Name	Typ	Description
qnAList	QnADTO[]	Lista över Q-A (QnADTO) som ska läggas till i kunskapsbasen. Q-A-ID:n tilldelas av tjänsten och bör utelämnas.