Question Answering Projects - Import

Reference

Service:: Cognitive Services

API Version:: 2021-10-01

Importujte prostředky projektu.

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:import?api-version=2021-10-01

With optional parameters:

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:import?api-version=2021-10-01&format={format}&assetKind={assetKind}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Název projektu, který se má použít.
api-version	query	True	string	Verze klientského rozhraní API
assetKind	query		string	Druh aktiva projektu.
format	query		format	Formát importu nebo exportu 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
assets	Assets	Všechny prostředky pro tento projekt.
fileUri	string	Identifikátor URI datového souboru importu
metadata	CreateProjectOptions	Parametry potřebné k vytvoření projektu

Odpovědi

Name	Typ	Description
202 Accepted		Výsledky úspěšného volání s hlavičkou Operation-Location, která slouží ke kontrole stavu úlohy. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Odpověď na chybu.

Name

Typ

Description

202 Accepted

Výsledky úspěšného volání s hlavičkou Operation-Location, která slouží ke kontrole stavu úlohy.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

Odpověď na chybu.

Zabezpečení

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Příklady

Successful query

Sample Request

HTTP

POST {Endpoint}/language/query-knowledgebases/projects/proj1/:import?api-version=2021-10-01


{
  "assets": {
    "synonyms": [
      {
        "alterations": [
          "wa",
          "washington",
          "washington state"
        ]
      },
      {
        "alterations": [
          "U.S",
          "usa",
          "united states of america"
        ]
      }
    ],
    "qnas": [
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 1,
        "answer": "ans1",
        "source": "source1",
        "questions": [
          "question 1.1",
          "question 1.2"
        ],
        "metadata": {
          "k1": "v1",
          "k2": "v2"
        },
        "dialog": {
          "isContextOnly": false,
          "prompts": [
            {
              "displayOrder": 1,
              "qnaId": 11,
              "displayText": "prompt 1.1"
            },
            {
              "displayOrder": 2,
              "qnaId": 21,
              "displayText": "prompt 1.2"
            }
          ]
        }
      },
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 2,
        "answer": "ans2",
        "source": "source2",
        "questions": [
          "question 2.1",
          "question 2.2"
        ]
      }
    ]
  }
}

Sample Response

Status code:: 202

Operation-Location: job1

Definice

Name	Description
Assets	Všechny prostředky pro tento projekt.
CreateProjectOptions	Parametry potřebné k vytvoření projektu
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Odpověď na chybu.
format	Formát importu nebo exportu znalostní báze
ImportJobOptions	Prostředky projektu, které je potřeba importovat.
ImportQnaRecord	Import záznamu QnA.
InnerErrorCode	Kód chyby čitelný pro člověka.
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.
ProjectSettings	Konfigurovatelná nastavení projektu.
QnaDialog	Dialogové okno přidružené k záznamu QnA
QnaPrompt	Výzva k zadání odpovědi.
QnaRecord	Záznam QnA.
SuggestedQuestion	Otázka navržená funkcí Aktivní učení
SuggestedQuestionsCluster	Podrobnosti clusteru s navrhovanými otázkami pro Aktivní učení
WordAlterations	Kolekce změn slov.

Assets

Všechny prostředky pro tento projekt.

Name	Typ	Description
qnas	ImportQnaRecord[]	Seznam záznamů QnA, které se mají importovat
synonyms	WordAlterations[]	Kolekce synonym.

CreateProjectOptions

Parametry potřebné k vytvoření projektu

Name	Typ	Description
description	string	Popis projektu.
language	string	Jazyk textových záznamů. Toto je reprezentace jazyka BCP-47. Například pro angličtinu použijte "en". "es" pro španělštinu atd. Pokud není nastavená, jako výchozí použijte "en" pro angličtinu.
multilingualResource	boolean	Nastavte na hodnotu true, pokud chcete pro stejný prostředek vytvářet znalostní báze v různých jazycích.
settings	ProjectSettings	Konfigurovatelná nastavení projektu.

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	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.

ErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error	Error	Objekt chyby.

format

Formát importu nebo exportu znalostní báze

Name	Typ	Description
excel	string	Export nebo import repliky znalostní báze včetně všech prostředků a metadat ve formátu Tsv
json	string	Exportujte nebo importujte prostředky QnA ve formátu JSON.
tsv	string	Exportujte nebo importujte repliku znalostní báze včetně všech prostředků a metadat ve formátu Excelu.

ImportJobOptions

Prostředky projektu, které je potřeba importovat.

Name	Typ	Description
assets	Assets	Všechny prostředky pro tento projekt.
fileUri	string	Identifikátor URI datového souboru importu
metadata	CreateProjectOptions	Parametry potřebné k vytvoření projektu

ImportQnaRecord

Import záznamu QnA.

Name	Typ	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Seznam návrhů aktivního učení pro QnA
answer	string	Text odpovědi.
dialog	QnaDialog	Kontext QnA
id	integer	Jedinečné ID pro QnA.
lastUpdatedDateTime	string	Datum a čas poslední aktualizace QnA
metadata	object	Metadata přidružená k odpovědi, která jsou užitečná pro kategorizaci nebo filtrování odpovědí na otázky.
questions	string[]	Seznam otázek souvisejících s odpovědí
source	string	Zdroj, ze kterého byla indexována QnA, např. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .
sourceDisplayName	string	Popisný název zdroje

InnerErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

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	InnerErrorCode	Jeden ze serverem definované sady kódů chyb.
details	object	Podrobnosti o chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ProjectSettings

Konfigurovatelná nastavení projektu.

Name	Typ	Description
defaultAnswer	string	Výchozí odpověď odpovědi, pokud se v znalostní báze nenajde žádná správná shoda.

QnaDialog

Dialogové okno přidružené k záznamu QnA

Name	Typ	Description
isContextOnly	boolean	Pokud chcete označit, jestli je výzva relevantní pouze u předchozí otázky, nebo ne. Pokud ano, nezahrnujte tuto funkci QnA jako odpověď pro dotazy bez kontextu; jinak ignoruje kontext a zahrne tuto funkci QnA do odpovědí.
prompts	QnaPrompt[]	Seznam výzev přidružených k odpovědi

QnaPrompt

Výzva k zadání odpovědi.

Name	Typ	Description
displayOrder	integer	Index výzvy. Používá se k řazení výzev.
displayText	string	Zobrazený text představující výzvu k následné otázce.
qna	QnaRecord	Záznam QnA. Záznam QnAId nebo QnA musí být na výzvě.
qnaId	integer	ID QnA odpovídající výzvě.

QnaRecord

Záznam QnA.

Name	Typ	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Seznam návrhů aktivního učení pro QnA
answer	string	Text odpovědi.
dialog	QnaDialog	Kontext QnA
id	integer	Jedinečné ID pro QnA.
metadata	object	Metadata přidružená k odpovědi, která jsou užitečná pro kategorizaci nebo filtrování odpovědí na otázky.
questions	string[]	Seznam otázek souvisejících s odpovědí
source	string	Zdroj, ze kterého byla indexována QnA, např. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Otázka navržená funkcí Aktivní učení

Name	Typ	Description
autoSuggestedCount	integer	Kolikrát algoritmus aktivního učení automaticky navrhl otázku.
question	string	Otázka navržená funkcí Aktivní učení
userSuggestedCount	integer	Kolikrát uživatel otázku explicitně navrhl.

SuggestedQuestionsCluster

Podrobnosti clusteru s navrhovanými otázkami pro Aktivní učení

Name	Typ	Description
clusterHead	string	Otázka zvolená jako vedoucí clusteru navrhovaných otázek algoritmem clusteringu Active Learning.
suggestedQuestions	SuggestedQuestion[]	Seznam všech navrhovaných otázek pro QnA

WordAlterations

Kolekce změn slov.

Name	Typ	Description
alterations	string[]	Kolekce změn slov.

Sdílet prostřednictvím

Question Answering Projects - Import

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

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations

Další materiály