Knowledgebase - Update

Reference

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Asynchronní operace pro úpravu znalostní báze.

PATCH {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	Typ	Description
add	Add	Instance CreateKbInputDTO pro operaci přidání
defaultAnswerUsedForExtraction	string	Textový řetězec, který má být použit jako odpověď v jakékoli Q-A, který nemá extrahované odpovědi z dokumentu, ale má hierarchii. Vyžaduje se, pokud je pole EnableHierarchicalExtraction nastavené na hodnotu True.
delete	Delete	Instance DeleteKbContentsDTO pro operaci odstranění
enableHierarchicalExtraction	boolean	Povolte hierarchickou extrakci Q-A ze souborů a adres URL. Pokud toto pole není k dispozici, použije se hodnota nastavená při vytváření znalostní báze.
update	Update	Instance UpdateKbContentsDTO pro operaci aktualizace

Odpovědi

Name	Typ	Description
202 Accepted	Operation	Podrobnosti o asynchronní operaci. Headers Location: string
Other Status Codes	ErrorResponse	Chybová odpověď.

Name

Typ

Description

202 Accepted

Operation

Podrobnosti o asynchronní operaci.

Headers

Location: string

Other Status Codes

ErrorResponse

Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Příklady

Successful query

Sample Request

HTTP

PATCH {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff


{
  "add": {
    "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": []
      }
    ],
    "urls": [
      "https://docs.microsoft.com/en-us/azure/cognitive-services/Emotion/FAQ"
    ],
    "files": [
      {
        "fileName": "SurfaceManual.pdf",
        "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
      }
    ]
  },
  "delete": {
    "ids": [
      13,
      35
    ]
  },
  "update": {
    "name": "QnA Maker FAQ Prompts Bot",
    "qnaList": [
      {
        "id": 2,
        "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": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "add": [],
          "delete": []
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Add Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I add prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Delete Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I delete delete prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Update Knowledgebase",
              "displayOrder": 0,
              "qna": null,
              "qnaId": 3
            }
          ],
          "promptsToDelete": [
            3
          ]
        }
      },
      {
        "id": 3,
        "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
        "source": "Custom Editorial",
        "questions": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "delete": [
            {
              "name": "category",
              "value": "api"
            }
          ],
          "add": [
            {
              "name": "category",
              "value": "programmatic"
            }
          ]
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Regenerate Endpoint keys",
              "displayOrder": 1,
              "qna": null,
              "qnaId": 4
            }
          ],
          "promptsToDelete": [
            4
          ]
        }
      }
    ]
  }
}

Sample Response

Status code:: 202

{
  "operationState": "NotStarted",
  "createdTimestamp": "2018-03-19T07:38:46Z",
  "lastActionTimestamp": "2018-03-19T07:39:29Z",
  "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
  "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
}

Definice

Name	Description
Add	Instance CreateKbInputDTO pro operaci přidání
Context	Kontext přidružený ke službě Qna, který se má aktualizovat.
Delete	Instance DeleteKbContentsDTO pro operaci 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.
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.
FileDTO	DTO pro uchovávání podrobností o nahraných souborech.
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.
Metadata	Seznam metadat přidružených k odpovědi, která se má aktualizovat
MetadataDTO	Název – dvojice metadat hodnot.
Operation	Záznam pro sledování dlouhotrvajících operací
OperationStateType	Stav operace.
PromptDTO	Výzva k zadání odpovědi
Qna	QnADTO – V objektu PromptDTO musí být buď QnaId, nebo QnADTO.
QnADTO	Objekt Q-A.
Questions	Seznam otázek souvisejících s odpovědí
Update	Instance UpdateKbContentsDTO pro operaci aktualizace
UpdateKbOperationDTO	Obsahuje seznam otázek a odpovědí, které se mají aktualizovat.
UpdateQnaDTO	Základní schéma PATCH pro aktualizaci seznamu QNA

Add

Instance CreateKbInputDTO pro operaci přidání

Name	Typ	Description
files	FileDTO[]	Seznam souborů, které se mají přidat do znalostní báze.
qnaList	QnADTO[]	Seznam QNA, které se mají přidat do indexu ID generuje služba a měla by se vynechat.
urls	string[]	Seznam adres URL, které se mají přidat do znalostní báze

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í

Delete

Instance DeleteKbContentsDTO pro operaci odstranění

Name	Typ	Description
ids	integer[]	Seznam ID QNA, která se mají odstranit
sources	string[]	Seznam zdrojů, které mají být odstraněny z znalostní báze.

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.

FileDTO

DTO pro uchovávání podrobností o nahraných souborech.

Name	Typ	Description
fileName	string	Název souboru. Podporované typy souborů jsou .tsv, .pdf, .txt, .docx, .xlsx.
fileUri	string	Veřejný identifikátor URI souboru.
isUnstructured	boolean	Volitelný příznak určující, jestli je daný soubor nestrukturovaný.

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.

Metadata

Seznam metadat přidružených k odpovědi, která se má aktualizovat

Name	Typ	Description
add	MetadataDTO[]	Seznam metadat přidružených k odpovědi, která se má přidat
delete	MetadataDTO[]	Seznam metadat přidružených k odpovědi, která se má odstranit

MetadataDTO

Název – dvojice metadat hodnot.

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

Operation

Záznam pro sledování dlouhotrvajících operací

Name	Typ	Description
createdTimestamp	string	Časové razítko vytvoření operace
errorResponse	ErrorResponse	Podrobnosti o chybě v případě selhání
lastActionTimestamp	string	Časové razítko zadání aktuálního stavu
operationId	string	ID operace.
operationState	OperationStateType	Stav operace.
resourceLocation	string	Relativní identifikátor URI k cílovému umístění prostředku pro dokončené prostředky
userId	string	ID uživatele

OperationStateType

Stav operace.

Name	Typ	Description
Failed	string
NotStarted	string
Running	string
Succeeded	string

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

Questions

Seznam otázek souvisejících s odpovědí

Name	Typ	Description
add	string[]	Seznam otázek, které se mají přidat
delete	string[]	Seznam otázek, které mají být odstraněny

Update

Instance UpdateKbContentsDTO pro operaci aktualizace

Name	Typ	Description
defaultAnswer	string	Výchozí odpověď se odešle uživateli, pokud se v znalostní bázi nenajde žádná správná shoda.
name	string	Popisný název znalostní báze
qnaList	UpdateQnaDTO[]	Seznam Q-A (UpdateQnaDTO), které se mají přidat do znalostní báze.
urls	string[]	Seznam existujících adres URL, které se mají aktualizovat. Obsah se znovu extrahuje a přeindexuje.

UpdateKbOperationDTO

Obsahuje seznam otázek a odpovědí, které se mají aktualizovat.

Name	Typ	Description
add	Add	Instance CreateKbInputDTO pro operaci přidání
defaultAnswerUsedForExtraction	string	Textový řetězec, který má být použit jako odpověď v jakékoli Q-A, který nemá extrahované odpovědi z dokumentu, ale má hierarchii. Vyžaduje se, pokud je pole EnableHierarchicalExtraction nastavené na hodnotu True.
delete	Delete	Instance DeleteKbContentsDTO pro operaci odstranění
enableHierarchicalExtraction	boolean	Povolte hierarchickou extrakci Q-A ze souborů a adres URL. Pokud toto pole není k dispozici, použije se hodnota nastavená při vytváření znalostní báze.
update	Update	Instance UpdateKbContentsDTO pro operaci aktualizace

UpdateQnaDTO

Základní schéma PATCH pro aktualizaci seznamu QNA

Name	Typ	Description
answer	string	Text odpovědi
context	Context	Kontext přidružený ke službě Qna, který se má aktualizovat.
id	integer	Jedinečné ID pro Q-A
metadata	Metadata	Seznam metadat přidružených k odpovědi, která se má aktualizovat
questions	Questions	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

Sdílet prostřednictvím

Knowledgebase - Update

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Příklady

Successful query

Sample Request

Sample Response

Definice

Add

Context

Delete

Error

ErrorCodeType

ErrorResponse

FileDTO

InnerErrorModel

Metadata

MetadataDTO

Operation

OperationStateType

PromptDTO

Qna

QnADTO

Questions

Update

UpdateKbOperationDTO

UpdateQnaDTO

Další materiály