Document Models - Authorize Model Copy

Reference

Service:: Azure AI Services

API Version:: 2024-07-31-preview

Generates authorization to copy a document model to this location with specified modelId and optional description.

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string uri	The Document Intelligence service endpoint.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
modelId	True	string	Unique document model name.
description		string	Document model description.
tags		object	List of key-value tag attributes associated with the document model.

Responses

Name	Type	Description
200 OK	CopyAuthorization	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Examples

Authorize Copy of Document Model

Sample request

HTTP

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

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

Sample response

Status code:: 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"
}

Definitions

Name	Description
AuthorizeCopyRequest	Request body to authorize document model copy.
CopyAuthorization	Authorization to copy a document model to the specified target resource and modelId.
Error	The error object.
ErrorResponse	Error response object.
InnerError	An object containing more specific information about the error.

AuthorizeCopyRequest

Request body to authorize document model copy.

Name	Type	Description
description	string	Document model description.
modelId	string	Unique document model name.
tags	object	List of key-value tag attributes associated with the document model.

CopyAuthorization

Authorization to copy a document model to the specified target resource and modelId.

Name	Type	Description
accessToken	string	Token used to authorize the request.
expirationDateTime	string	Date/time when the access token expires.
targetModelId	string	Identifier of the target document model.
targetModelLocation	string	URL of the copied document model in the target account.
targetResourceId	string	ID of the target Azure resource where the document model should be copied to.
targetResourceRegion	string	Location of the target Azure resource where the document model should be copied to.

Error

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorResponse

Error response object.

Name	Type	Description
error	Error	Error info.

InnerError

An object containing more specific information about the error.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	InnerError	Inner error.
message	string	A human-readable representation of the error.

Share via