Knowledgebase - Create

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

Asynchronní operace pro vytvoření nové znalostní báze.

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

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)

Hlavička požadavku

Name Vyžadováno Typ Description
Ocp-Apim-Subscription-Key True

string

Text požadavku

Name Vyžadováno Typ Description
name True

string

Popisný název znalostní báze
defaultAnswer

string

Výchozí odpověď odeslaná uživateli, pokud se v znalostní bázi nenajde dobrá shoda.
defaultAnswerUsedForExtraction

string

Textový řetězec, který se má použít jako odpověď v jakékoli funkci Q-A, která nemá extrahovanou odpověď z dokumentu, ale má hierarchii. Požadováno, pokud je pole EnableHierarchicalExtraction nastaveno na Hodnotu True.
enableHierarchicalExtraction

boolean

Povolte hierarchickou extrakci Q-A ze souborů a adres URL. Hodnota, která se má považovat za nepravdivý, pokud toto pole neexistuje.
enableMultipleLanguages

boolean

Pokud chcete povolit vytváření znalostních databází pro stejný prostředek v různých jazycích, nastavte na hodnotu true.
files

FileDTO[]

Seznam souborů, ze kterých chcete extrahovat funkci Q-A.
language

string

Jazyk znalostní báze. Seznam podporovaných jazyků najdete tady.
qnaList

QnADTO[]

Seznam Q-A (QnADTO), které se mají přidat do znalostní báze Id Q-A přiřazuje služba a měla by se vynechat.
urls

string[]

Seznam adres URL, které se mají použít k extrakci Q-A.

Odpovědi

Name Typ Description
202 Accepted

Operation

Podrobnosti o asynchronní operaci
Other Status Codes

ErrorResponse

Odpověď na chybu.

Zabezpečení

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Příklady

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

Definice

Name Description
Context

Kontext přidružený ke službě Qna, který se má aktualizovat.
CreateKbDTO

Schéma textu post pro operaci CreateKb
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é sady kódů chyb.
ErrorResponse

Odpověď na chybu. 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.
MetadataDTO

Název – pár hodnot metadat.
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 QnaId nebo QnADTO.
QnADTO

Objekt Q-A.

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í pouze u předchozí otázky, nebo ne. true – Nezahrnujte tuto funkci QnA jako výsledek hledání pro dotazy bez kontextu false – ignoruje kontext a zahrne tuto funkci 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 k odstranění qna

CreateKbDTO

Schéma textu post pro operaci CreateKb

Name Typ Description
defaultAnswer

string

Výchozí odpověď odeslaná uživateli, pokud se v znalostní bázi nenajde dobrá shoda.
defaultAnswerUsedForExtraction

string

Textový řetězec, který se má použít jako odpověď v jakékoli funkci Q-A, která nemá extrahovanou odpověď z dokumentu, ale má hierarchii. Požadováno, pokud je pole EnableHierarchicalExtraction nastaveno na Hodnotu True.
enableHierarchicalExtraction

boolean

Povolte hierarchickou extrakci Q-A ze souborů a adres URL. Hodnota, která se má považovat za nepravdivý, pokud toto pole neexistuje.
enableMultipleLanguages

boolean

Pokud chcete povolit vytváření znalostních databází pro stejný prostředek v různých jazycích, nastavte na hodnotu true.
files

FileDTO[]

Seznam souborů, ze kterých chcete extrahovat funkci Q-A.
language

string

Jazyk znalostní báze. Seznam podporovaných jazyků najdete tady.
name

string

Popisný název znalostní báze
qnaList

QnADTO[]

Seznam Q-A (QnADTO), které se mají přidat do znalostní báze Id Q-A přiřazuje služba a měla by se vynechat.
urls

string[]

Seznam adres URL, které se mají použít k extrakci Q-A.

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é sady kódů chyb.
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é sady kódů chyb.

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

Odpověď na chybu. 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 chybou obsahující chybu.
innerError

InnerErrorModel

Objekt obsahující konkrétnější informace o chybě než aktuální objekt.

MetadataDTO

Název – pár hodnot metadat.

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, kdy byla operace vytvořena.
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 cílového 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 při řazení 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 QnaId nebo QnADTO.
qnaId

integer

ID Qna odpovídající výzvě – pokud je K dispozici QnaId, objekt QnADTO se ignoruje.

Qna

QnADTO – V objektu PromptDTO musí být 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 indexována funkce Q-A. 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 indexována funkce Q-A. Např. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs