Bugs copying a model using REST API

Question

Bugs copying a model using REST API

Menno Laan 0

Hi there,

I'm trying to copy a model using the the REST API for Microsoft's Document Intelligence service. I'm using the 2024-07-31-preview copy and authorize api with 2AuthToAuth instead of key-based access, but I'm getting stuck at the copy-to REST API.

When I use Document Intelligence Studio portal to copy the model, everything works as intended. But when I try to copy the model via the REST API using curl with the provided parameters, I get an error 400 bad request with the following payload:

{
    "error": {
        "code": "InvalidRequest",
        "message": "Invalid request.",
        "innererror": {
            "code": "ModelNotReady",
            "message": "Model is not ready for the requested operation. Wait for training to complete or check for operation errors."
        }
    }
}

However, the copy through the portal was successful. So, the model should be ready.

Interestingly, when I run the API request https://*****.cognitiveservices.azure.com/documentintelligence/documentModels?api-version=2024-02-29-preview, it doesn't show my model that is available if I look at models in Document Intelligence Studio.

More importantly, creating authorize request with REST API version 2024-07-31-preview seems to reserve the model ID in the target source. If you issue a new authorize request with this model ID in the target source, it will fail. This is a very limiting feature. Furthermore, there is no way to cancel an authorized copy request.

Here are the things I've discovered so far:

When creating authorize request with REST API version 2024-07-31-preview, it actually reserves this model ID in the target source. You can't issue new authorize requests with this model ID in the target source. There is no way to cancel an authorized copy request: https://learn.microsoft.com/en-us/rest/api/aiservices/document-models/authorize-model-copy?view=rest-aiservices-v4.0%20(2024-07-31-preview)&tabs=HTTP

Models created in a document intelligence project with api version 2024-02-29-preview with model api version 2024-02-29-preview created on 2024-06-20T08:24:17Z cannot be copied trough REST API: https://learn.microsoft.com/en-us/rest/api/aiservices/document-models/copy-model-to?view=rest-aiservices-v4.0%20(2024-07-31-preview)&tabs=HTTP

Models created in a document intelligence project with api version 2024-02-29-preview with model api version 2024-02-29-preview created on 2024-06-20T08:24:17Z can be copied through the Document Intelligence Studio web interface, so the model should be ready for copy somehow.

Models created in a document intelligence project with api version 2024-02-29-preview with model api version 2024-02-29-preview created on 2024-06-20T08:24:17Z will not show up when invoking the API request: https://learn.microsoft.com/en-us/rest/api/aiservices/document-models/list-models?view=rest-aiservices-v4.0%20(2024-07-31-preview)&tabs=HTTP

Models created in a document intelligence project with api version 2024-07-31-preview with model api version 2024-02-29-preview will show up in List Model and will be copied to other DI instances.

Rohit Mungi 49,131 Reputation points Microsoft Employee Moderator

2024-08-21T09:06:36.59+00:00

@Menno Laan With respect to the copy error, if the studio version works and the REST API request fails. I would recommend to check the request posted during studio operation using the browser developer mode, this would give a clear idea on what the request body and parameters used by the studio. This will clear out any mistakes made by your REST API request in the request body or the parameters. Based on the error I see, it is most likely an error in one of the values in the request body that it is unable to create the target model id.

The REST API reference for 2024-07-31-preview is the one you linked and the target model location should be something like below, do not include additional path like api version in this field.

https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentModels/targetModel

More importantly, creating authorize request with REST API version 2024-07-31-preview seems to reserve the model ID in the target source. If you issue a new authorize request with this model ID in the target source, it will fail. This is a very limiting feature. Furthermore, there is no way to cancel an authorized copy request.

For the above, Yes this is the expected behavior. The request cannot be cancelled. The copy authorization request has expiration date time which should take care of limiting the copy if the date time exceeds.

For the rest of the scenarios, if you use the matching API version for project and model they should be listed correctly, otherwise use the API version of the model during list operation to list the models will list only associated API models. I hope this helps!!
Rohit Mungi 49,131 Reputation points Microsoft Employee Moderator

2024-08-22T09:30:13.79+00:00

@Menno Laan Did the above help to answer your queries? Thanks!!
Rohit Mungi 49,131 Reputation points Microsoft Employee Moderator

2024-08-23T10:15:17.81+00:00

@Menno Laan Did the above help to answer your queries? Thanks!!