Freigeben über


Knowledgebase - Replace

Ersetzen Sie Knowledgebase-Inhalte.

PUT {Endpoint}/qnamaker/v4.0/knowledgebases/{kbId}

URI-Parameter

Name In Erforderlich Typ Beschreibung
Endpoint
path True

string

Unterstützter Cognitive Services-Endpunkt (z. B. https://< qnamaker-resource-name> .api.cognitiveservices.azure.com).

kbId
path True

string

Knowledgebase-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

Typ: apiKey
In: header

Beispiele

Successful query

Beispielanforderung

PUT {Endpoint}/qnamaker/v4.0/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"
        }
      ]
    }
  ]
}

Beispiel für eine Antwort

Definitionen

Name Beschreibung
Context

Der mit Qna verknüpfte Kontext, der aktualisiert werden soll.

Error

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

ErrorCodeType

Eine serverdefinierte Gruppe von 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

Zur Eingabe einer Antwort auffordern.

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

Der mit Qna verknüpfte Kontext, der aktualisiert werden soll.

Name Typ Beschreibung
isContextOnly

boolean

Um zu markieren, 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 falsch ein - ignoriert den Kontext und schließt diese QnA in das Suchergebnis ein.

promptsToAdd

PromptDTO[]

Liste der Eingabeaufforderungen, die der qna hinzugefügt werden sollen.

promptsToDelete

integer[] (int32)

Liste der mit qna verknüpften Eingabeaufforderungen, die gelöscht werden sollen

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

Eine serverdefinierte Gruppe von 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 lesbare Darstellung des Fehlers.

target

string

Das Ziel des Fehlers.

ErrorCodeType

Eine serverdefinierte Gruppe von Fehlercodes.

Wert Beschreibung
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

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

minLength: 1
maxLength: 100

Metadatenname.

value

string

minLength: 1
maxLength: 500

Metadatenwert.

PromptDTO

Zur Eingabe einer Antwort auffordern.

Name Typ Beschreibung
displayOrder

integer (int32)

Index der Eingabeaufforderung – wird in der Reihenfolge der Eingabeaufforderungen verwendet

displayText

string

maxLength: 200

Text, der angezeigt wird, um eine Nachverfolgungsfrageaufforderung darzustellen

qna

Qna

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

qnaId

integer (int32)

Qna id corresponding to the prompt - if QnaId is present, QnADTO object is ignored.

Qna

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

Name Typ Beschreibung
answer

string

minLength: 1
maxLength: 25000

Antworttext

context

Context

Kontext eines QnA

id

integer (int32)

Eindeutige ID für Q-A.

metadata

MetadataDTO[]

Liste der Metadaten, die der Antwort zugeordnet sind.

questions

string[]

Liste der Fragen, die der Antwort zugeordnet sind.

source

string

maxLength: 300

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

minLength: 1
maxLength: 25000

Antworttext

context

Context

Kontext eines QnA

id

integer (int32)

Eindeutige ID für Q-A.

metadata

MetadataDTO[]

Liste der Metadaten, die der Antwort zugeordnet sind.

questions

string[]

Liste der Fragen, die der Antwort zugeordnet sind.

source

string

maxLength: 300

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.