Document Classifiers - Copy Classifier To
Copies document classifier to the target resource, region, and classifierId.
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:copyTo?api-version=2024-07-31-previewURI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
classifier
|
path | True |
string |
Unique document classifier name. Regex pattern: |
|
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 |
|---|---|---|---|
| accessToken | True |
string |
Token used to authorize the request. |
| expirationDateTime | True |
string |
Date/time when the access token expires. |
| targetClassifierId | True |
string |
Identifier of the target document classifier. |
| targetClassifierLocation | True |
string |
URL of the copied document classifier in the target account. |
| targetResourceId | True |
string |
ID of the target Azure resource where the document classifier should be copied to. |
| targetResourceRegion | True |
string |
Location of the target Azure resource where the document classifier should be copied to. |
Responses
| Name | Type | Description |
|---|---|---|
| 202 Accepted |
The request has been accepted for processing, but processing has not yet completed. Headers
|
|
| Other Status Codes |
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
Copy Document Classifier To
Sample request
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/sourceClassifier:copyTo?api-version=2024-07-31-preview
{
"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"
}
Sample response
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-previewDefinitions
| Name | Description |
|---|---|
|
Classifier |
Authorization to copy a document classifier to the specified target resource and classifierId. |
| Error |
The error object. |
|
Error |
Error response object. |
|
Inner |
An object containing more specific information about the error. |
ClassifierCopyAuthorization
Authorization to copy a document classifier to the specified target resource and classifierId.
| Name | Type | Description |
|---|---|---|
| accessToken |
string |
Token used to authorize the request. |
| expirationDateTime |
string |
Date/time when the access token expires. |
| targetClassifierId |
string |
Identifier of the target document classifier. |
| targetClassifierLocation |
string |
URL of the copied document classifier in the target account. |
| targetResourceId |
string |
ID of the target Azure resource where the document classifier should be copied to. |
| targetResourceRegion |
string |
Location of the target Azure resource where the document classifier 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 |
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 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 |
Inner error. |
|
| message |
string |
A human-readable representation of the error. |