Question Answering Projects - Import

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2021-10-01

Importujte prostředky projektu.

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

S volitelnými parametry:

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 maxLength: 100	Název projektu, který se má použít.
api-version	query	True	string	Verze rozhraní API klienta.
assetKind	query		string	Druh majetku 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	Importujte identifikátor URI datového souboru.
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 sloužící ke kontrole stavu úlohy. Hlavičky Operation-Location: string
Other Status Codes	ErrorResponse	Chybová odpověď.

Name

Typ

Description

202 Accepted

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

Hlavičky

Operation-Location: string

Other Status Codes

ErrorResponse

Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

Successful query

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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é člověkem
ErrorResponse	Chybová odpověď.
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é člověkem
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – 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ího učení
SuggestedQuestionsCluster	Podrobnosti o clusteru s navrhovanými funkcemi Active Learning
WordAlterations	Kolekce změn slov

Assets

Objekt

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

Objekt

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 použijte "en" pro angličtinu; "es" pro španělštinu atd. Pokud není nastavená, jako výchozí použijte "en" pro angličtinu.
multilingualResource	boolean	Nastavte na hodnotu true, aby bylo možné vytvářet znalostní báze v různých jazycích pro stejný prostředek.
settings	ProjectSettings	Konfigurovatelná nastavení projektu.

Error

Objekt

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných 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, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

format

Výčet

Formát importu nebo exportu znalostní báze

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

ImportJobOptions

Objekt

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

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

ImportQnaRecord

Objekt

Import záznamu QnA

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

InnerErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jedna ze serverově definovaných kódů chyb.
details	object	Podrobnosti o chybě
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Zpráva o chybě.
target	string	Cíl chyby

ProjectSettings

Objekt

Konfigurovatelná nastavení projektu.

Name	Typ	Description
defaultAnswer	string	Výchozí odpověď odpovědi, pokud se ve znalostní bázi nenajde žádná dobrá shoda.

QnaDialog

Objekt

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

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

QnaPrompt

Objekt

Výzva k zadání odpovědi

Name	Typ	Description
displayOrder	integer (int32)	Index výzvy Slouží k řazení výzev.
displayText	string maxLength: 200	Text zobrazený tak, aby představoval výzvu k následné otázce.
qna	QnaRecord	Záznam QnA. Záznam QnAId nebo QnA musí být na příkazovém řádku.
qnaId	integer (int32)	ID QnA odpovídající výzvě.

QnaRecord

Objekt

Záznam QnA.

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

SuggestedQuestion

Objekt

Otázka navržená funkcí aktivního učení

Name	Typ	Description
autoSuggestedCount	integer (int32)	Počet, kolikrát byl dotaz navržen automaticky algoritmem active learning.
question	string	Otázka navržená funkcí aktivního učení
userSuggestedCount	integer (int32)	Počet, kolikrát uživatel výslovně navrhl otázku.

SuggestedQuestionsCluster

Objekt

Podrobnosti o clusteru s navrhovanými funkcemi Active Learning

Name	Typ	Description
clusterHead	string	Otázka zvolená jako hlava navrhovaného clusteru otázek pomocí algoritmu clusteringu Active Learning
suggestedQuestions	SuggestedQuestion[]	Seznam všech navrhovaných otázek pro QnA

WordAlterations

Objekt

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

Ukázkový požadavek

Ukázková odpověď

Definice

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations

Další materiály