Knowledgebase - Replace

Reference

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Nahraďte obsah znalostní báze.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com)
kbId	path	True	string	ID znalostní báze.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Text požadavku

Name	Vyžadováno	Typ	Description
qnAList	True	QnADTO[]	Seznam Q-A (QnADTO), které se mají přidat do znalostní báze. ID Q-A jsou přiřazována službou a měla by se vynechat.

Odpovědi

Name	Typ	Description
204 No Content		HTTP 204 Žádný obsah.
Other Status Codes	ErrorResponse	Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
Context	Kontext přidružený ke službě Qna, který se má aktualizovat.
Error	Objekt chyby. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Jeden ze serverem definovaných chybových kódů.
ErrorResponse	Chybová odpověď. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	Název – dvojice metadat hodnot.
PromptDTO	Výzva k zadání odpovědi
Qna	QnADTO – V objektu PromptDTO musí být buď QnaId, nebo QnADTO.
QnADTO	Objekt Q-A.
ReplaceKbDTO	Post body schema for Replace KB operation.

Context

Kontext přidružený ke službě Qna, který se má aktualizovat.

Name	Typ	Description
isContextOnly	boolean	Pokud chcete označit, jestli je výzva relevantní jenom u předchozí otázky, nebo ne. true – Nezahrnujte tuto QnA jako výsledek hledání pro dotazy bez kontextu false – ignoruje kontext a zahrne tuto QnA do výsledku hledání.
promptsToAdd	PromptDTO[]	Seznam výzev, které se mají přidat do QNA
promptsToDelete	integer[]	Seznam výzev přidružených ke qna k odstranění

Error

Objekt chyby. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	ErrorCodeType	Jeden ze serverem definovaných chybových kódů.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innerError	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorCodeType

Jeden ze serverem definovaných chybových kódů.

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

Chybová odpověď. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorModel

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	Konkrétnější kód chyby, než byl poskytnut v obsahující chybě.
innerError	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

MetadataDTO

Název – dvojice metadat hodnot.

Name	Typ	Description
name	string	Název metadat.
value	string	Hodnota metadat.

PromptDTO

Výzva k zadání odpovědi

Name	Typ	Description
displayOrder	integer	Index výzvy – používá se v pořadí výzev.
displayText	string	Zobrazený text představující výzvu k následné otázce
qna	Qna	QnADTO – V objektu PromptDTO musí být buď QnaId, nebo QnADTO.
qnaId	integer	ID Qna odpovídající výzvě – pokud existuje QnaId, objekt QnADTO se ignoruje.

Qna

QnADTO – V objektu PromptDTO musí být buď QnaId, nebo QnADTO.

Name	Typ	Description
answer	string	Text odpovědi
context	Context	Kontext QnA
id	integer	Jedinečné ID pro Q-A.
lastUpdatedTimestamp	string	Časové razítko poslední aktualizace QnA
metadata	MetadataDTO[]	Seznam metadat přidružených k odpovědi
questions	string[]	Seznam otázek souvisejících s odpovědí
source	string	Zdroj, ze kterého byla Q-A indexována. Např. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Objekt Q-A.

Name	Typ	Description
answer	string	Text odpovědi
context	Context	Kontext QnA
id	integer	Jedinečné ID pro Q-A.
lastUpdatedTimestamp	string	Časové razítko poslední aktualizace QnA
metadata	MetadataDTO[]	Seznam metadat přidružených k odpovědi
questions	string[]	Seznam otázek souvisejících s odpovědí
source	string	Zdroj, ze kterého byla Q-A indexována. Např. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

Post body schema for Replace KB operation.

Name	Typ	Description
qnAList	QnADTO[]	Seznam Q-A (QnADTO), které se mají přidat do znalostní báze. ID Q-A jsou přiřazována službou a měla by se vynechat.

Share via