Document Classifiers - Authorize Classifier Copy

Dienst:: Azure AI Services

API-Version:: 2024-11-30

Generiert die Autorisierung zum Kopieren eines Dokumentklassifizierers an diesen Speicherort mit der angegebenen Klassifizierer-ID und optionaler Beschreibung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Document Intelligence-Dienstendpunkt.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
classifierId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Eindeutiger Dokumentklassifizierername.
description		string maxLength: 4096	Beschreibung des Dokumentklassifizierers.
tags		object	Liste der Schlüsselwerttagattribute, die dem Dokumentklassifizierer zugeordnet sind.

Antworten

Name	Typ	Beschreibung
200 OK	ClassifierCopyAuthorization	Die Anforderung ist erfolgreich.
Other Status Codes	DocumentIntelligenceErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

Authorize Copy of Document Classifier

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
AuthorizeClassifierCopyRequest	Anforderungstext zum Autorisieren der Dokumentklassifiziererkopie.
ClassifierCopyAuthorization	Autorisierung zum Kopieren eines Dokumentklassifizierers in die angegebene Zielressource und ClassifierId.
DocumentIntelligenceError	Das Fehlerobjekt.
DocumentIntelligenceErrorResponse	Fehlerantwortobjekt.
DocumentIntelligenceInnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.

AuthorizeClassifierCopyRequest

Objekt

Anforderungstext zum Autorisieren der Dokumentklassifiziererkopie.

Name	Typ	Beschreibung
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Eindeutiger Dokumentklassifizierername.
description	string maxLength: 4096	Beschreibung des Dokumentklassifizierers.
tags	object	Liste der Schlüsselwerttagattribute, die dem Dokumentklassifizierer zugeordnet sind.

ClassifierCopyAuthorization

Objekt

Autorisierung zum Kopieren eines Dokumentklassifizierers in die angegebene Zielressource und ClassifierId.

Name	Typ	Beschreibung
accessToken	string	Token, das zum Autorisieren der Anforderung verwendet wird.
expirationDateTime	string (date-time)	Datum/Uhrzeit, zu dem das Zugriffstoken abläuft.
targetClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Bezeichner des Zieldokumentklassifizierers.
targetClassifierLocation	string (uri)	DIE URL des kopierten Dokumentklassifizierers im Zielkonto.
targetResourceId	string	ID der Azure-Zielressource, in die der Dokumentklassifizierer kopiert werden soll.
targetResourceRegion	string	Speicherort der Azure-Zielressource, in die der Dokumentklassifizierer kopiert werden soll.

DocumentIntelligenceError

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	DocumentIntelligenceError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	DocumentIntelligenceInnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

DocumentIntelligenceErrorResponse

Objekt

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	DocumentIntelligenceError	Fehlerinformationen.

DocumentIntelligenceInnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	DocumentIntelligenceInnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.