Question Answering Projects - Import

Reference

Služba:: Cognitive Services - Language

Verze rozhraní API:: 2023-04-01

Importuje prostředky projektu.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01

S volitelnými parametry:

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-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 rozhraní API klienta.
assetKind	query		string	Druh aktiva projektu.
format	query		format	Formát importu nebo exportu znalostní báze

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 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í

AADToken

Toto jsou toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady AZURE MAPS Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Azure Active Directory verze 1.0 nebo 2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Klíč předplatného pro prostředek služby jazyka.

Typ: apiKey
V: header

Příklady

Successful query

Ukázkový požadavek

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:import?api-version=2023-04-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": 2,
              "displayText": "prompt 1.1"
            }
          ]
        }
      },
      {
        "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: https:///language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2023-04-01

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	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ý 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 o navrhovaných otázkách v active learningu
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í nastaveno, jako výchozí použijte "en" pro angličtinu.
multilingualResource	boolean	Nastavte na hodnotu true, pokud chcete pro stejný prostředek povolit vytváření znalostních databází v různých jazycích.
settings	ProjectSettings	Konfigurovatelná nastavení projektu.

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jeden ze serverem definovaných chybových kódů.
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
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Chybová odpověď.

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	Export nebo import prostředků QnA ve formátu JSON
tsv	string	Export nebo import repliky 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 otázky a otázky
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 se indexovala QnA, například 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
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	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ých chybových kódů.
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ěď, 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í jenom u předchozí otázky, nebo ne. Pokud je true, nezahrnujte tuto 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

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 ve 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 otázky a otázky
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 se indexovala QnA, například 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 explicitně navrhl otázku.

SuggestedQuestionsCluster

Podrobnosti o navrhovaných otázkách v active learningu

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 otázky a odpovědi

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

Text požadavku

Odpovědi

Zabezpečení

AADToken

Poznámky

Rozsahy

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