Document Models - Authorize Model Copy

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-07-31-preview

Generiert autorisierung zum Kopieren eines Dokumentmodells an diesen Speicherort mit der angegebenen modelId und optionaler Beschreibung.

POST {endpoint}/documentintelligence/documentModels:authorizeCopy?api-version=2024-07-31-preview

URI-Parameter

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

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
modelId	True	string	Eindeutiger Dokumentmodellname.
description		string	Dokumentmodellbeschreibung.
tags		object	Liste der Schlüsselwerttagattribute, die dem Dokumentmodell zugeordnet sind.

Antworten

Name	Typ	Beschreibung
200 OK	CopyAuthorization	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	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 Model

Beispielanforderung

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:authorizeCopy?api-version=2024-07-31-preview

{
  "modelId": "targetModel",
  "description": "Target model description"
}

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
AuthorizeCopyRequest	Anforderungstext zum Autorisieren der Dokumentmodellkopie.
CopyAuthorization	Autorisierung zum Kopieren eines Dokumentmodells in die angegebene Zielressource und modelId.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.

AuthorizeCopyRequest

Anforderungstext zum Autorisieren der Dokumentmodellkopie.

Name	Typ	Beschreibung
description	string	Dokumentmodellbeschreibung.
modelId	string	Eindeutiger Dokumentmodellname.
tags	object	Liste der Schlüsselwerttagattribute, die dem Dokumentmodell zugeordnet sind.

CopyAuthorization

Autorisierung zum Kopieren eines Dokumentmodells in die angegebene Zielressource und modelId.

Name	Typ	Beschreibung
accessToken	string	Token, das zum Autorisieren der Anforderung verwendet wird.
expirationDateTime	string	Datum/Uhrzeit, zu dem das Zugriffstoken abläuft.
targetModelId	string	Bezeichner des Zieldokumentmodells.
targetModelLocation	string	DIE URL des kopierten Dokumentmodells im Zielkonto.
targetResourceId	string	ID der Azure-Zielressource, in die das Dokumentmodell kopiert werden soll.
targetResourceRegion	string	Speicherort der Azure-Zielressource, in die das Dokumentmodell kopiert werden soll.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	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.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

InnerError

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

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

Freigeben über