Knowledgebase - Replace

Referenz

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Ersetzen Sie Den Inhalt der Wissensdatenbank.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (z. B. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Wissensdatenbank-ID.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
qnAList	True	QnADTO[]	Liste der Q-A (QnADTO), die der Wissensdatenbank hinzugefügt werden sollen. Q-A-Ids werden vom Dienst zugewiesen und sollten weggelassen werden.

Antworten

Name	Typ	Beschreibung
204 No Content		HTTP 204 Kein Inhalt.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
Context	Kontext, der Qna zugeordnet ist, um aktualisiert zu werden.
Error	Das Fehlerobjekt. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Einer der vom Server definierten Fehlercodes.
ErrorResponse	Fehlerantwort. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	Name: Wertpaar von Metadaten.
PromptDTO	Fordern Sie eine Antwort an.
Qna	QnADTO: Entweder QnaId oder QnADTO muss in einem PromptDTO-Objekt vorhanden sein.
QnADTO	Q-A-Objekt.
ReplaceKbDTO	Post body schema for Replace KB operation.

Context

Kontext, der Qna zugeordnet ist, um aktualisiert zu werden.

Name	Typ	Beschreibung
isContextOnly	boolean	So markieren Sie, ob eine Eingabeaufforderung nur mit einer vorherigen Frage relevant ist oder nicht. true: Schließen Sie diese QnA nicht als Suchergebnis für Abfragen ohne Kontext false ein . Ignoriert den Kontext und schließt diese QnA in das Suchergebnis ein.
promptsToAdd	PromptDTO[]	Liste der Eingabeaufforderungen, die dem qna hinzugefügt werden sollen.
promptsToDelete	integer[]	Liste der zu löschenden Eingabeaufforderungen, die qna zugeordnet sind

Error

Das Fehlerobjekt. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	ErrorCodeType	Einer der vom Server definierten Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innerError	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCodeType

Einer der vom Server definierten Fehlercodes.

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

Fehlerantwort. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorModel

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innerError	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

MetadataDTO

Name: Wertpaar von Metadaten.

Name	Typ	Beschreibung
name	string	Metadatenname
value	string	Metadatenwert

PromptDTO

Fordern Sie eine Antwort an.

Name	Typ	Beschreibung
displayOrder	integer	Index der Eingabeaufforderung – wird für die Reihenfolge der Eingabeaufforderungen verwendet
displayText	string	Text, der angezeigt wird, um eine Nachfrageaufforderung darzustellen
qna	Qna	QnADTO: Entweder QnaId oder QnADTO muss in einem PromptDTO-Objekt vorhanden sein.
qnaId	integer	Qna-ID entspricht der Eingabeaufforderung: Wenn QnaId vorhanden ist, wird das QnADTO-Objekt ignoriert.

Qna

QnADTO: Entweder QnaId oder QnADTO muss in einem PromptDTO-Objekt vorhanden sein.

Name	Typ	Beschreibung
answer	string	Antworttext
context	Context	Kontext einer QnA
id	integer	Eindeutige ID für die Q-A.
lastUpdatedTimestamp	string	Zeitstempel, wann die QnA zuletzt aktualisiert wurde.
metadata	MetadataDTO[]	Liste der Metadaten, die der Antwort zugeordnet sind.
questions	string[]	Liste der Fragen, die der Antwort zugeordnet sind.
source	string	Quelle, aus der Q-A indiziert wurde. Zb. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Q-A-Objekt.

Name	Typ	Beschreibung
answer	string	Antworttext
context	Context	Kontext einer QnA
id	integer	Eindeutige ID für die Q-A.
lastUpdatedTimestamp	string	Zeitstempel, wann die QnA zuletzt aktualisiert wurde.
metadata	MetadataDTO[]	Liste der Metadaten, die der Antwort zugeordnet sind.
questions	string[]	Liste der Fragen, die der Antwort zugeordnet sind.
source	string	Quelle, aus der Q-A indiziert wurde. Zb. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

Post body schema for Replace KB operation.

Name	Typ	Beschreibung
qnAList	QnADTO[]	Liste der Q-A (QnADTO), die der Wissensdatenbank hinzugefügt werden sollen. Q-A-Ids werden vom Dienst zugewiesen und sollten weggelassen werden.

Share via