Knowledgebase - Replace

Referencia

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Cserélje le a tudásbázis tartalmát.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string	Támogatott Cognitive Services-végpont (például https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Tudásbázis-azonosító.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string

Kérelem törzse

Name	Kötelező	Típus	Description
qnAList	True	QnADTO[]	A tudásbázishoz hozzáadni kívánt QnADTO (QnADTO) listája. A Q-A-azonosítókat a szolgáltatás rendeli hozzá, és meg kell hagyni.

Válaszok

Name	Típus	Description
204 No Content		HTTP 204 Nincs tartalom.
Other Status Codes	ErrorResponse	Hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Példák

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

Definíciók

Name	Description
Context	A frissítendő Qna-hoz társított környezet.
Error	A hibaobjektum. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	A kiszolgáló által definiált hibakódok egyike.
ErrorResponse	Hibaválasz. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	Név – metaadatok értékpárja.
PromptDTO	Válasz kérése.
Qna	QnADTO – A QnaId vagy a QnADTO objektumnak jelen kell lennie egy PromptDTO objektumban
QnADTO	Q-A objektum.
ReplaceKbDTO	A Tudásbázis cseréje művelet post body sémája.

Context

A frissítendő Qna-hoz társított környezet.

Name	Típus	Description
isContextOnly	boolean	Annak megjelölése, hogy egy kérdés csak egy korábbi kérdés esetén releváns-e, vagy sem. true – Ne adja meg ezt a QnA-t a keresési eredményként olyan lekérdezések esetén, amely nem tartalmaz hamis kontextust – figyelmen kívül hagyja a kontextust, és ezt a QnA-t is tartalmazza a keresési eredményben
promptsToAdd	PromptDTO[]	A qna-hoz hozzáadandó kérések listája.
promptsToDelete	integer[]	A törölni kívánt qna-hoz társított kérések listája

Error

A hibaobjektum. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	ErrorCodeType	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innerError	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorCodeType

A kiszolgáló által definiált hibakódok egyike.

Name	Típus	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

Hibaválasz. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorModel

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	string	Pontosabb hibakód, mint amit a hiba tartalmazott.
innerError	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.

MetadataDTO

Név – metaadatok értékpárja.

Name	Típus	Description
name	string	Metaadatok neve.
value	string	Metaadatok értéke.

PromptDTO

Válasz kérése.

Name	Típus	Description
displayOrder	integer	A parancssor indexe – a parancssorok sorrendjében használatos
displayText	string	A következő kérdés megválaszolására megjelenő szöveg
qna	Qna	QnADTO – A QnaId vagy a QnADTO objektumnak jelen kell lennie egy PromptDTO objektumban
qnaId	integer	A kérdésnek megfelelő Qna-azonosító – ha QnaId van jelen, a QnADTO objektum figyelmen kívül lesz hagyva.

Qna

QnADTO – A QnaId vagy a QnADTO objektumnak jelen kell lennie egy PromptDTO objektumban

Name	Típus	Description
answer	string	Válasz szöveg
context	Context	A QnA környezete
id	integer	A Q-A egyedi azonosítója.
lastUpdatedTimestamp	string	A QnA legutóbbi frissítésének időbélyege.
metadata	MetadataDTO[]	A válaszhoz társított metaadatok listája.
questions	string[]	A válaszhoz társított kérdések listája.
source	string	Forrás, amelyből a Q-A indexelve lett. Pl. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Q-A objektum.

Name	Típus	Description
answer	string	Válasz szöveg
context	Context	A QnA környezete
id	integer	A Q-A egyedi azonosítója.
lastUpdatedTimestamp	string	A QnA legutóbbi frissítésének időbélyege.
metadata	MetadataDTO[]	A válaszhoz társított metaadatok listája.
questions	string[]	A válaszhoz társított kérdések listája.
source	string	Forrás, amelyből a Q-A indexelve lett. Pl. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

A Tudásbázis cseréje művelet post body sémája.

Name	Típus	Description
qnAList	QnADTO[]	A tudásbázishoz hozzáadni kívánt QnADTO (QnADTO) listája. A Q-A-azonosítókat a szolgáltatás rendeli hozzá, és meg kell hagyni.

Share via