Knowledgebase - Create

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

Aszinkron művelet egy új tudásbázis létrehozásához.

POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create

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).

Kérelem fejléce

Name Kötelező Típus Description
Ocp-Apim-Subscription-Key True

string

Kérelem törzse

Name Kötelező Típus Description
name True

string

A tudásbázis rövid neve.
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.
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.
enableHierarchicalExtraction

boolean

A Q-A hierarchikus kinyerésének engedélyezése fájlokból és URL-címekből. Hamisnak tekintendő érték, ha ez a mező nincs jelen.
enableMultipleLanguages

boolean

Állítsa true (igaz) értékre, hogy engedélyezze a KB-k létrehozását ugyanazon erőforrás különböző nyelveiben.
files

FileDTO[]

Azoknak a fájloknak a listája, amelyekből ki szeretné nyerni a Q-A-t.
language

string

A tudásbázis nyelve. A támogatott nyelvek listáját itt találja.
qnaList

QnADTO[]

A tudásbázishoz hozzáadni kívánt QnADTO (QnADTO) listája. A Q-A-azonosítókat a szolgáltatás rendeli hozzá, és meg kell hagyni.
urls

string[]

A Q-A kinyeréséhez használandó URL-címek listája.

Válaszok

Name Típus Description
202 Accepted

Operation

Az aszinkron művelet részletei.
Other Status Codes

ErrorResponse

Hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Példák

Successful query

Sample Request

POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create


{
  "name": "QnA Maker FAQ",
  "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"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "displayText": "Update KB",
            "qna": {
              "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",
              "questions": [
                "How do I programmatically update my KB?"
              ],
              "metadata": [
                {
                  "name": "category",
                  "value": "api"
                }
              ],
              "context": {
                "isContextOnly": false,
                "prompts": [
                  {
                    "displayOrder": 1,
                    "displayText": "Refresh Endpoint Keys",
                    "qna": {
                      "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys",
                      "questions": [
                        "How do I programmatically refresh endpoint keys?"
                      ]
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "urls": [
    "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
    "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-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"
    }
  ]
}

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
Context

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

A CreateKb művelet törzsséma közzététele.
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.
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.

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

CreateKbDTO

A CreateKb művelet törzsséma közzététele.

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.
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.
enableHierarchicalExtraction

boolean

A Q-A hierarchikus kinyerésének engedélyezése fájlokból és URL-címekből. Hamisnak tekintendő érték, ha ez a mező nincs jelen.
enableMultipleLanguages

boolean

Állítsa true (igaz) értékre, hogy engedélyezze a KB-k létrehozását ugyanazon erőforrás különböző nyelveiben.
files

FileDTO[]

Azoknak a fájloknak a listája, amelyekből ki szeretné nyerni a Q-A-t.
language

string

A tudásbázis nyelve. A támogatott nyelvek listáját itt találja.
name

string

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

QnADTO[]

A tudásbázishoz hozzáadni kívánt QnADTO (QnADTO) listája. A Q-A-azonosítókat a szolgáltatás rendeli hozzá, és meg kell hagyni.
urls

string[]

A Q-A kinyeréséhez használandó URL-címek 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.

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