Question Answering Projects - Update Sources

Reference

Služba:: Cognitive Services - Language

Verze rozhraní API:: 2023-04-01

Aktualizace zdroje projektu.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?api-version=2023-04-01

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.

Text požadavku

Name	Typ	Description
body	UpdateSourceRecord[]	Aktualizujte parametry zdrojů 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

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/sources?api-version=2023-04-01

[
  {
    "op": "add",
    "value": {
      "displayName": "source3",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context",
      "sourceKind": "url",
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context"
    }
  },
  {
    "op": "replace",
    "value": {
      "displayName": "source1",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
      "sourceKind": "url",
      "refresh": true,
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
    }
  },
  {
    "op": "delete",
    "value": {
      "displayName": "source2",
      "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
      "sourceKind": "file",
      "source": "surface-guide.pdf"
    }
  }
]

Ukázková odpověď

Stavový kód:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2023-04-01

Definice

Name	Description
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Chybová odpověď.
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.
sourceContentStructureKind	Typ struktury obsahu pro zdroje
sourceKind	Podporované typy zdrojů.
updateOperationKind	Typ operace aktualizace pro prostředky
UpdateQnaSourceRecord	Aktualizace zdrojového záznamu
UpdateSourceRecord	Zdroj, který se má aktualizovat.

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.

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.

sourceContentStructureKind

Typ struktury obsahu pro zdroje

Name	Typ	Description
unstructured	string

sourceKind

Podporované typy zdrojů.

Name	Typ	Description
file	string
url	string

updateOperationKind

Typ operace aktualizace pro prostředky

Name	Typ	Description
add	string
delete	string
replace	string

UpdateQnaSourceRecord

Aktualizace zdrojového záznamu

Name	Typ	Default value	Description
contentStructureKind	sourceContentStructureKind	Unstructured	Typ struktury obsahu pro zdroje
displayName	string		Popisný název zdroje
refresh	boolean		Příznak logické hodnoty používaný k aktualizaci dat ze zdroje.
source	string		Jedinečný identifikátor zdroje. Název souboru, pokud se jedná o "soubor" zdroj; v opačném případě úplnou adresu URL, pokud se jedná o zdroj adresy URL.
sourceKind	sourceKind	url	Podporované typy zdrojů.
sourceUri	string		Umístění identifikátoru URI pro soubor nebo adresu URL.

UpdateSourceRecord

Zdroj, který se má aktualizovat.

Name	Typ	Description
op	updateOperationKind	Typ operace aktualizace pro prostředky
value	UpdateQnaSourceRecord	Aktualizace zdrojového záznamu

Sdílet prostřednictvím

Question Answering Projects - Update Sources

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

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

sourceContentStructureKind

sourceKind

updateOperationKind

UpdateQnaSourceRecord

UpdateSourceRecord

Další materiály