Share via

Knowledgebase - Update

  • Referencia
Service:
Cognitive Services - QnA Maker
API Version:
v5.0-preview.2

Aszinkron művelet egy tudásbázis módosításához.

PATCH {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 Típus Description
add

Add

A CreateKbInputDTO egy példánya a hozzáadási művelethez
defaultAnswerUsedForExtraction

string

A válaszként használandó szöveges sztring minden olyan Q-A-ben, amelynek nincs kicsomagolt válasza a dokumentumból, de hierarchiával rendelkezik. Akkor szükséges, ha az EnableHierarchicalExtraction mező Értéke Igaz.
delete

Delete

A DeleteKbContentsDTO egy példánya a törlési művelethez
enableHierarchicalExtraction

boolean

A Q-A hierarchikus kinyerésének engedélyezése fájlokból és URL-címekből. A tudásbázis létrehozásakor beállított érték akkor lesz használatban, ha ez a mező nincs jelen.
update

Update

Az UpdateKbContentsDTO egy példánya a frissítési művelethez

Válaszok

Name Típus Description
202 Accepted

Operation

Az aszinkron művelet részletei.

Headers

Location: string
Other Status Codes

ErrorResponse

Hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Példák

Successful query

Sample Request

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

Definíciók

Name Description
Add

A CreateKbInputDTO egy példánya a hozzáadási művelethez
Context

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

A DeleteKbContentsDTO egy példánya a törlési művelethez
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.
FileDTO

A feltöltött fájlok adatainak tárolására szolgáló DTO.
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.
Metadata

A frissítendő válaszhoz társított metaadatok listája
MetadataDTO

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

Rekord a hosszú ideig futó művelet nyomon követéséhez.
OperationStateType

Művelet állapota.
PromptDTO

Válasz kérése.
Qna

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

Q-A objektum.
Questions

A válaszhoz társított kérdések listája.
Update

Az UpdateKbContentsDTO egy példánya a frissítési művelethez
UpdateKbOperationDTO

A frissítendő QNA-k listáját tartalmazza
UpdateQnaDTO

PATCH Törzsséma a Qna-lista frissítéséhez

Add

A CreateKbInputDTO egy példánya a hozzáadási művelethez

Name Típus Description
files

FileDTO[]

A tudásbázishoz hozzáadni kívánt fájlok listája.
qnaList

QnADTO[]

Az indexhez hozzáadni kívánt QNA listája. Az azonosítókat a szolgáltatás hozza létre, és ki kell hagynia.
urls

string[]

A tudásbázishoz hozzáadni kívánt URL-címek listá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

Delete

A DeleteKbContentsDTO egy példánya a törlési művelethez

Name Típus Description
ids

integer[]

A törölni kívánt Qna-azonosítók listája
sources

string[]

A tudásbázisból törölni kívánt források 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.

FileDTO

A feltöltött fájlok adatainak tárolására szolgáló DTO.

Name Típus Description
fileName

string

Fájlnév. Támogatott fájltípusok: ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri

string

A fájl nyilvános URI-ja.
isUnstructured

boolean

Választható jelző annak megadásához, hogy a megadott fájl strukturálatlan-e.

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.

Metadata

A frissítendő válaszhoz társított metaadatok listája

Name Típus Description
add

MetadataDTO[]

A hozzáadni kívánt válaszhoz társított metaadatok listája
delete

MetadataDTO[]

A törölni kívánt válaszhoz társított metaadatok listája

MetadataDTO

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

Name Típus Description
name

string

Metaadatok neve.
value

string

Metaadatok értéke.

Operation

Rekord a hosszú ideig futó művelet nyomon követéséhez.

Name Típus Description
createdTimestamp

string

Időbélyeg a művelet létrehozásakor.
errorResponse

ErrorResponse

Hiba részletei hibák esetén.
lastActionTimestamp

string

Az aktuális állapot megadásának időbélyege.
operationId

string

Műveletazonosító.
operationState

OperationStateType

Művelet állapota.
resourceLocation

string

A befejezett erőforrások célerőforrás-helyének relatív URI-ja.
userId

string

Felhasználói azonosító

OperationStateType

Művelet állapota.

Name Típus Description
Failed

string

NotStarted

string

Running

string

Succeeded

string

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

Questions

A válaszhoz társított kérdések listája.

Name Típus Description
add

string[]

Hozzáadandó kérdések listája
delete

string[]

A törölni kívánt kérdések listája.

Update

Az UpdateKbContentsDTO egy példánya a frissítési művelethez

Name Típus Description
defaultAnswer

string

A felhasználónak küldött alapértelmezett válasz, ha nem található megfelelő egyezés a TUDÁSBÁZIS-ban.
name

string

A tudásbázis rövid neve.
qnaList

UpdateQnaDTO[]

A tudásbázishoz hozzáadandó Q-A-k (UpdateQnaDTO) listája.
urls

string[]

A frissítendő meglévő URL-címek listája. A rendszer ismét kinyeri és újra indexeli a tartalmat.

UpdateKbOperationDTO

A frissítendő QNA-k listáját tartalmazza

Name Típus Description
add

Add

A CreateKbInputDTO egy példánya a hozzáadási művelethez
defaultAnswerUsedForExtraction

string

A válaszként használandó szöveges sztring minden olyan Q-A-ben, amelynek nincs kicsomagolt válasza a dokumentumból, de hierarchiával rendelkezik. Akkor szükséges, ha az EnableHierarchicalExtraction mező Értéke Igaz.
delete

Delete

A DeleteKbContentsDTO egy példánya a törlési művelethez
enableHierarchicalExtraction

boolean

A Q-A hierarchikus kinyerésének engedélyezése fájlokból és URL-címekből. A tudásbázis létrehozásakor beállított érték akkor lesz használatban, ha ez a mező nincs jelen.
update

Update

Az UpdateKbContentsDTO egy példánya a frissítési művelethez

UpdateQnaDTO

PATCH Törzsséma a Qna-lista frissítéséhez

Name Típus Description
answer

string

Válasz szöveg
context

Context

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

integer

A Q-A egyedi azonosítója
metadata

Metadata

A frissítendő válaszhoz társított metaadatok listája
questions

Questions

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