Knowledgebase - Replace

Tjänst:

Azure AI Services

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

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

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"
        }
      ]
    }
  ]
}

Exempelsvar

Statuskod:

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

Objekt

Kontext som är associerad med Qna som ska uppdateras.

Name	Typ	Description
isContextOnly	boolean	Att 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 kontexten false – ignorerar kontexten och inkluderar denna QnA i sökresultatet
promptsToAdd	PromptDTO[]	Lista över uppmaningar som ska läggas till i qna.
promptsToDelete	integer[] (int32)	Lista över frågor som är associerade med qna som ska tas bort

Error

Objekt

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 mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCodeType

Uppräkning

En av en serverdefinierad uppsättning felkoder.

Värde	Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Objekt

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

Objekt

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

Objekt

Namn – värdepar med metadata.

Name	Typ	Description
name	string minLength: 1 maxLength: 100	Metadatanamn.
value	string minLength: 1 maxLength: 500	Metadatavärde.

PromptDTO

Objekt

Fråga efter ett svar.

Name	Typ	Description
displayOrder	integer (int32)	Index för prompten – används i ordning på prompterna
displayText	string maxLength: 200	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 (int32)	Qna-ID som motsvarar prompten – om QnaId finns ignoreras QnADTO-objektet.

Qna

Objekt

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

Name	Typ	Description
answer	string minLength: 1 maxLength: 25000	Svarstext
context	Context	Kontext för en QnA
id	integer (int32)	Unikt ID för Q-A.
lastUpdatedTimestamp	string maxLength: 300	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 maxLength: 300	Källa som Q-A indexerades från. T.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Objekt

Q-A-objekt.

Name	Typ	Description
answer	string minLength: 1 maxLength: 25000	Svarstext
context	Context	Kontext för en QnA
id	integer (int32)	Unikt ID för Q-A.
lastUpdatedTimestamp	string maxLength: 300	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 maxLength: 300	Källa som Q-A indexerades från. T.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

Objekt

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.