Document Models - Copy Model To

Dienst:

Azure AI Services

API-Version:

2024-07-31-preview

Kopiert das Dokumentmodell in die Zielressource, region und modelId.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Der Document Intelligence-Dienstendpunkt.
modelId	path	True	string	Eindeutiger Dokumentmodellname. RegEx-Muster: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

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

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Header Operation-Location: string Retry-After: integer
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

Copy Document Model To

Beispielanforderung

HTTP

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

{
  "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"
}

Beispiel für eine Antwort

Statuscode:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview

Definitionen

Name	Beschreibung
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.

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.