Models - Copy

Reference

Service:: Azure AI Services

API Version:: 3.2

Copies a model from one subscription to another.
This method can be used to copy a model from this speech resource to a target one. The authorization is obtained on the target speech resource. Only custom models can be copied to another speech resource.

POST {endpoint}/speechtotext/v3.2/models/{id}:copy

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	The identifier of the model that will be copied.

Request Body

Name	Required	Type	Description
expirationDateTime	True	string	The expiration date of this copy authorization.
id	True	string	The ID of this copy authorization.
sourceResourceId	True	string	The Azure Resource ID of the source speech resource.
targetResourceEndpoint	True	string	The endpoint (base url) of the target resource (with custom domain name when it is used).
targetResourceId	True	string	The Azure Resource ID of the target speech resource.
targetResourceRegion	True	string	The region (aka location) of the target speech resource (e.g., westus2).

Responses

Name	Type	Description
202 Accepted	Operation	The response contains information about the entity as payload and its location as header. Headers Retry-After: integer Operation-Location: string
Other Status Codes	Error	An error occurred.

Name

Type

Description

202 Accepted

Operation

The response contains information about the entity as payload and its location as header.

Headers

Retry-After: integer
Operation-Location: string

Other Status Codes

Error

An error occurred.

Security

Ocp-Apim-Subscription-Key

Provide your cognitive services account key here.

Type: apiKey
In: header

Authorization

Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Examples

Copy a model from source resource to target resource

Sample request

HTTP

POST {endpoint}/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy

{
  "targetResourceRegion": "westus2",
  "targetResourceId": "/subscriptions/targetSubscriptionId/resourceGroups/targetResourceGroupName/providers/Microsoft.CognitiveServices/accounts/targetSpeechResourceName",
  "targetResourceEndpoint": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models",
  "sourceResourceId": "/subscriptions/sourceSubscriptionId/resourceGroups/sourceResourceGroupName/providers/Microsoft.CognitiveServices/accounts/sourceSpeechResourceName",
  "expirationDateTime": "2019-01-07T11:34:12Z",
  "id": "d61573c6-788b-4eff-b3f5-38a1c7a9585b"
}

Sample response

Status code:: 202

Operation-Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/operations/models/copy/E30F6A27-82BE-4CCA-9258-0399C70489FF",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "lastActionDateTime": "2019-01-07T11:34:12Z",
  "status": "NotStarted",
  "id": "e30f6a27-82be-4cca-9258-0399c70489ff"
}

Definitions

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Error
ErrorCode	ErrorCode
InnerError	InnerError
ModelCopyAuthorization	ModelCopyAuthorization
Operation	Operation
OperationResult	OperationResult
Status	Status

DetailedErrorCode

Name	Type	Description
DataImportFailed	string	Data import failed.
DeleteNotAllowed	string	Delete not allowed.
DeployNotAllowed	string	Deploy not allowed.
DeployingFailedModel	string	Deploying failed model.
EmptyRequest	string	Empty Request.
EndpointCannotBeDefault	string	Endpoint cannot be default.
EndpointNotUpdatable	string	Endpoint not updatable.
EndpointWithoutLogging	string	Endpoint without logging.
ExceededNumberOfRecordingsUris	string	Exceeded number of recordings uris.
FailedDataset	string	Failed dataset.
Forbidden	string	Forbidden.
InUseViolation	string	In use violation.
InaccessibleCustomerStorage	string	Inaccessible customer storage.
InvalidAdaptationMapping	string	Invalid adaptation mapping.
InvalidBaseModel	string	Invalid base model.
InvalidCallbackUri	string	Invalid callback uri.
InvalidChannels	string	Invalid channels.
InvalidCollection	string	Invalid collection.
InvalidDataset	string	Invalid dataset.
InvalidDocument	string	Invalid Document.
InvalidDocumentBatch	string	Invalid Document Batch.
InvalidLocale	string	Invalid locale.
InvalidLogDate	string	Invalid log date.
InvalidLogEndTime	string	Invalid log end time.
InvalidLogId	string	Invalid log id.
InvalidLogStartTime	string	Invalid log start time.
InvalidModel	string	Invalid model.
InvalidModelUri	string	Invalid model uri.
InvalidParameter	string	Invalid parameter.
InvalidParameterValue	string	Invalid parameter value.
InvalidPayload	string	Invalid payload.
InvalidPermissions	string	Invalid permissions.
InvalidPrerequisite	string	Invalid prerequisite.
InvalidProductId	string	Invalid product id.
InvalidProject	string	Invalid project.
InvalidProjectKind	string	Invalid project kind.
InvalidRecordingsUri	string	Invalid recordings uri.
InvalidRequestBodyFormat	string	Invalid request body format.
InvalidSasValidityDuration	string	Invalid sas validity duration.
InvalidSkipTokenForLogs	string	Invalid skip token for logs.
InvalidSourceAzureResourceId	string	Invalid source Azure resource ID.
InvalidSubscription	string	Invalid subscription.
InvalidTest	string	Invalid test.
InvalidTimeToLive	string	Invalid time to live.
InvalidTopForLogs	string	Invalid top for logs.
InvalidTranscription	string	Invalid transcription.
InvalidWebHookEventKind	string	Invalid web hook event kind.
MissingInputRecords	string	Missing Input Records.
ModelCopyAuthorizationExpired	string	Expired ModelCopyAuthorization.
ModelDeploymentNotCompleteState	string	Model deployment not complete state.
ModelDeprecated	string	Model deprecated.
ModelExists	string	Model exists.
ModelMismatch	string	Model mismatch.
ModelNotDeployable	string	Model not deployable.
ModelVersionIncorrect	string	Model Version Incorrect.
NoUtf8WithBom	string	No utf8 with bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Only one of urls or container or dataset.
ProjectGenderMismatch	string	Project gender mismatch.
QuotaViolation	string	Quota violation.
SingleDefaultEndpoint	string	Single default endpoint.
SkuLimitsExist	string	Sku limits exist.
SubscriptionNotFound	string	Subscription not found.
UnexpectedError	string	Unexpected error.
UnsupportedClassBasedAdaptation	string	Unsupported class based adaptation.
UnsupportedDelta	string	Unsupported delta.
UnsupportedDynamicConfiguration	string	Unsupported dynamic configuration.
UnsupportedFilter	string	Unsupported filter.
UnsupportedLanguageCode	string	Unsupported language code.
UnsupportedOrderBy	string	Unsupported order by.
UnsupportedPagination	string	Unsupported pagination.
UnsupportedTimeRange	string	Unsupported time range.

EntityError

Name	Type	Description
code	string	The code of this error.
message	string	The message for this error.

Error

Name	Type	Description
code	ErrorCode	ErrorCode High level error codes.
details	Error[]	Additional supportive details regarding the error and/or expected policies.
innerError	InnerError	InnerError New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message	string	High level error message.
target	string	The source of the error. For example it would be "documents" or "document id" in case of invalid document.

ErrorCode

Name	Type	Description
Conflict	string	Representing the conflict error code.
Forbidden	string	Representing the forbidden error code.
InternalCommunicationFailed	string	Representing the internal communication failed error code.
InternalServerError	string	Representing the internal server error error code.
InvalidArgument	string	Representing the invalid argument error code.
InvalidRequest	string	Representing the invalid request error code.
NotAllowed	string	Representing the not allowed error code.
NotFound	string	Representing the not found error code.
PipelineError	string	Representing the pipeline error error code.
ServiceUnavailable	string	Representing the service unavailable error code.
TooManyRequests	string	Representing the too many requests error code.
Unauthorized	string	Representing the unauthorized error code.
UnprocessableEntity	string	Representing the unprocessable entity error code.
UnsupportedMediaType	string	Representing the unsupported media type error code.

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Detailed error code enum.
details	object	Additional supportive details regarding the error and/or expected policies.
innerError	InnerError	InnerError New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message	string	High level error message.
target	string	The source of the error. For example it would be "documents" or "document id" in case of invalid document.

ModelCopyAuthorization

Name	Type	Description
expirationDateTime	string	The expiration date of this copy authorization.
id	string	The ID of this copy authorization.
sourceResourceId	string	The Azure Resource ID of the source speech resource.
targetResourceEndpoint	string	The endpoint (base url) of the target resource (with custom domain name when it is used).
targetResourceId	string	The Azure Resource ID of the target speech resource.
targetResourceRegion	string	The region (aka location) of the target speech resource (e.g., westus2).

Operation

Name	Type	Description
createdDateTime	string	The time-stamp when the object was created. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
error	EntityError	EntityError
id	string	The identifier of this Operation.
lastActionDateTime	string	The time-stamp when the current status was entered. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
result	OperationResult	OperationResult
self	string	The location of this entity.
status	Status	Status Describe the current state of the API.

OperationResult

Name	Type	Description
link	string	The link to the result of the operation.

Status

Name	Type	Description
Failed	string	The long running operation has failed.
NotStarted	string	The long running operation has not yet started.
Running	string	The long running operation is currently processing.
Succeeded	string	The long running operation has successfully completed.

Share via

Models - Copy

URI Parameters

Request Body

Responses

Security

Ocp-Apim-Subscription-Key

Authorization

Examples

Copy a model from source resource to target resource

Sample request

Sample response

Definitions

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

ModelCopyAuthorization

Operation

OperationResult

Status

Additional resources