Document Classifiers - Authorize Classifier Copy

Služba:

Azure AI Services

Verze rozhraní API:

2024-11-30

Generuje autorizaci ke zkopírování klasifikátoru dokumentu do tohoto umístění se zadaným id klasifikátoru a volitelným popisem.

POST {endpoint}/documentintelligence/documentClassifiers:authorizeCopy?api-version=2024-11-30

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Koncový bod služby Document Intelligence
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
classifierId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Jedinečný název klasifikátoru dokumentu
description		string maxLength: 4096	Popis klasifikátoru dokumentu
tags		object	Seznam atributů značky klíč-hodnota přidružených k klasifikátoru dokumentu

Odpovědi

Name	Typ	Description
200 OK	ClassifierCopyAuthorization	Požadavek byl úspěšný.
Other Status Codes	DocumentIntelligenceErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

Authorize Copy of Document Classifier

Ukázkový požadavek

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:authorizeCopy?api-version=2024-11-30

{
  "classifierId": "targetClassifier",
  "description": "Target classifier description"
}

Ukázková odpověď

Stavový kód:

200

{
  "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
  "targetResourceRegion": "targetResourceRegion",
  "targetClassifierId": "targetClassifier",
  "targetClassifierLocation": "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/targetClassifier",
  "accessToken": "accessToken",
  "expirationDateTime": "2021-09-23T09:12:54.552Z"
}

Definice

Name	Description
AuthorizeClassifierCopyRequest	Text požadavku na autorizaci kopie klasifikátoru dokumentu
ClassifierCopyAuthorization	Autorizace ke zkopírování klasifikátoru dokumentu do zadaného cílového prostředku a id klasifikátoru.
DocumentIntelligenceError	Objekt chyby.
DocumentIntelligenceErrorResponse	Objekt odpovědi na chybu
DocumentIntelligenceInnerError	Objekt obsahující konkrétnější informace o chybě.

AuthorizeClassifierCopyRequest

Objekt

Text požadavku na autorizaci kopie klasifikátoru dokumentu

Name	Typ	Description
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Jedinečný název klasifikátoru dokumentu
description	string maxLength: 4096	Popis klasifikátoru dokumentu
tags	object	Seznam atributů značky klíč-hodnota přidružených k klasifikátoru dokumentu

ClassifierCopyAuthorization

Objekt

Autorizace ke zkopírování klasifikátoru dokumentu do zadaného cílového prostředku a id klasifikátoru.

Name	Typ	Description
accessToken	string	Token použitý k autorizaci požadavku.
expirationDateTime	string (date-time)	Datum a čas vypršení platnosti přístupového tokenu
targetClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Identifikátor klasifikátoru cílového dokumentu
targetClassifierLocation	string (uri)	Adresa URL zkopírovaného klasifikátoru dokumentu v cílovém účtu
targetResourceId	string	ID cílového prostředku Azure, do kterého se má klasifikátor dokumentu zkopírovat.
targetResourceRegion	string	Umístění cílového prostředku Azure, do kterého se má klasifikátor dokumentu zkopírovat.

DocumentIntelligenceError

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	DocumentIntelligenceError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Objekt

Objekt odpovědi na chybu

Name	Typ	Description
error	DocumentIntelligenceError	Informace o chybě

DocumentIntelligenceInnerError

Objekt

Objekt obsahující konkrétnější informace o chybě.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	DocumentIntelligenceInnerError	Vnitřní chyba.
message	string	Čitelné znázornění chyby člověkem.