Why does the DocumentIntelligenceAdministrationClient GetModel method not return any information for either BlobFileListSource or BlobSource? The DocumentModelDetails contains null values for these fields in the query results.

Question

Why does the DocumentIntelligenceAdministrationClient GetModel method not return any information for either BlobFileListSource or BlobSource? The DocumentModelDetails contains null values for these fields in the query results.

Sean Leino 20

In V4 Document Intelligence API version 2024-11-30, when calling DocumentIntelligenceAdministrationClient.GetModel, the returned DocumentModelDetails object does not contain any information for either BlobFileListSource or BlobSource. This information would be extremely helpful to potentially migrate a V3 extraction model to V4. We have tried both the .NET SDK and the REST API, same result.

User's image

1 answer

Your answer

Answer 1

Sina Salam 23,931 Volunteer Moderator

Hello Sean Leino & Mohammad ASIF,

Thanks to you all, for your endurance, feedback and clarifications.

I understand that it's been a serious challenge retrieving training source metadata when using the DocumentIntelligenceAdministrationClient.GetModelAsync method in the Azure.AI.DocumentIntelligence v1.0.0 SDK.

The key clarification is that the GetModelOptions class does not exist in the GA SDK release. Those references to it are from early preview packages or outdated documentation, and so sorry for misleading. In the current SDK, GetModelAsync only accepts the modelId with an optional RequestContext, as documented here: GetModelAsync API Docs.

It is also important to distinguish between migrated and native V4 models. For migrated V3 → V4 models, training source metadata such as BlobSource and BlobFileListSource does not carry over. This is by design and results in null values even if you use include=source. The only way to recover this information is to pull it from your original training scripts, infrastructure-as-code definitions (ARM, Bicep, Terraform), or the Azure portal. If you require full metadata support, the best practice is to retrain a native V4 model using your original container URL and prefix. See the official Migration Guide.

For native V4 models, the REST API does support retrieving training source details using the include=source query parameter:

GET https://{endpoint}/documentintelligence/documentModels/{modelId}?include=source&api-version=2024-11-30

REST API Reference

However, the .NET SDK currently does not surface this feature. As a workaround, you can call the REST API directly using HttpClient in C#:

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "<your-key>");
var response = await client.GetAsync($"{endpoint}/documentintelligence/documentModels/{modelId}?include=source&api-version=2024-11-30");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);

This will return training source information if the service makes it available. If REST also returns null for a natively trained V4 model, that indicates a service-side limitation rather than an SDK gap.

Therefore, migrated models will never return training sources, native V4 models require REST API calls for now, and SDK support for include=source is not yet available. The official API reference for DocumentIntelligenceAdministrationClient.GetModelAsync shows no overload that accepts an include=source parameter or a GetModelOptions object. The most reliable path forward is to retrain in V4 for future-proofing and, in the short term, use REST API workarounds where SDK support falls short.I hope this is helpful! Do not hesitate to let me know if you have any other questions or clarifications.

Please don't forget to close up the thread here by upvoting and accept it as an answer if it is helpful.

Sina Salam 23,931 Reputation points Volunteer Moderator

2025-08-20T14:18:56.3033333+00:00
Hello Sean Leino,

Welcome to the Microsoft Q&A and thank you for posting your questions here.

I understand that you are having issue with your DocumentIntelligenceAdministrationClient GetModel method not return any information for either BlobFileListSource or BlobSource and he DocumentModelDetails contains null values for these fields in the query results.

This is a common point of confusion, and the issue is not with your code but a fundamental characteristic of the migration process.

The core of the problem is that when a V3 model is made accessible on a V4 endpoint, the V4 service inherits the model's analysis capabilities but not its administrative metadata. The original training source configuration (the container URL or file list) is simply not ported over. Consequently, the GetModel operation in V4 has no underlying data to return for these properties, which is why they remain null even when you correctly use the include=source parameter. This behavior is a defined limitation of the service's migration pathway, as the system prioritizes maintaining the model's core functionality over its creation history.

Therefore, to proceed with your migration, you must retrieve this critical information from your own development and operational records. The most reliable method is to use the original code, script, or infrastructure-as-a-code template (any of, ARM, Bicep, Terraform) you used to train the V3 model, as this is where the containerUrl and prefix were initially specified. If you still have access to the original Azure Form Recognizer resource in the portal, you may also find hints of the source path in the model's details pane. For a sustainable future-state solution, the recommended path is to use this recovered information to train a new, native V4 model. This new model will fully support all V4 management operations, including the successful retrieval of its source details using the standard method. For a native V4 model, you correctly retrieve the source as follows:

// Using the Azure.AI.DocumentIntelligence SDK var options = new GetModelOptions { Include = "source" }; Response<DocumentModelDetails> response = await adminClient.GetModelAsync(modelId, options); // Access source via response.Value.TrainingDataSources

For steps and more reading use the below links:

https://learn.microsoft.com/en-us/dotnet/api/azure.ai.documentintelligence.documentintelligenceadministrationclient.builddocumentmodelasync?view=azure-dotnet

https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/MigrationGuide.md

I hope this is helpful! Do not hesitate to let me know if you have any other questions or clarifications.

Please don't forget to close up the thread here by upvoting and accept it as an answer if it is helpful.
Sean Leino 20 Reputation points

2025-08-20T14:39:59.19+00:00

GetModelOptions - where is that documented? I cannot find that in the .NET SDK or REST API documentation? If I try to add that to my code, GetModelOptions class is not found??
Sina Salam 23,931 Reputation points Volunteer Moderator

2025-08-20T16:08:55.3666667+00:00
Hello @Sean Leino ,

Thanks for your feedback.

If you do it right, you will get right result.

For clarification:

The class GetModelOptions does exist, but it's part of the Azure.AI.DocumentIntelligence v1.0.0 SDK, which targets the v4.0 REST API.

It is used to specify options when calling GetModelAsync, such as including the training data source.

Official SDK Documentation:

https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/how-to-guides/use-sdk-rest-api?view=doc-intel-4.0.0

https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/versioning/sdk-overview-v4-0?view=doc-intel-4.0.0

The REST API endpoint GET /documentintelligence/documentModels/{modelId} supports retrieving model details. However, there is no direct equivalent to GetModelOptions in the REST APIs, instead, you use query parameters like include=source to get training data source info.

https://learn.microsoft.com/en-us/rest/api/aiservices/document-models/get-model?view=rest-aiservices-v4.0%20%282024-11-30%29

https://learn.microsoft.com/en-us/javascript/api/%40azure/digital-twins-core/getmodeloptions?view=azure-node-latest

The reason you're not find GetModelOptions in your Code:

If you're getting a "class not found" error:

Make sure you're using the correct SDK version: Azure.AI.DocumentIntelligence v1.0.0 from NuGet and add the package via NuGet. See examples in the first link.

Success.
Deleted

This comment has been deleted due to a violation of our Code of Conduct. The comment was manually reported or identified through automated detection before action was taken. Please refer to our Code of Conduct for more information.
Sean Leino 20 Reputation points

2025-08-20T17:31:00.9866667+00:00

Not sure what happened to my last comment, reposting summary just in case:

I am currently using the Azure.AI.DocumentIntelligence v1.0.0 SDK, which targets the v4.0 REST API. I confirmed this in Visual Studio.

I still cannot find an overloads for GetModelAsync that take a GetModelOptions parameter and I cannot declare variables of type GetModelOptions.

The documentation URLs have not mention of GetModelOptions nor can I find any mentions in GitHub or elsewhere.

Thanks for your help and please let me know what else I need to do for this to show up; am I missing a using reference?
Sean Leino 20 Reputation points

2025-08-20T17:32:27.47+00:00
Sean Leino 20 Reputation points

2025-08-20T18:22:24.08+00:00
Mohammad ASIF 0 Reputation points

2025-08-21T07:35:15.7066667+00:00

I am in the same boat as Sean. I have a model that was original created with V4 API (2024-11-30). When using the GetModel API, the Blob related details are always null.

The GetModel API only takes modelId and optionally the requestContext in an overload. I have the v1.0.0 Azure.AI.DocumentIntelligence SDK and the GetModelOptions is nowhere to be found. Even if it did exist, the GetModel API doesn't take anything other than what I had specified as parameters above. What are we missing here? Is it possible that what you guys are referring to did exist in one one the prereleases?

I would love to get to the bottom of this.

TIA
Sina Salam 23,931 Reputation points Volunteer Moderator

2025-08-21T11:51:47.59+00:00

Hello Sean Leino & Mohammad ASIF,

Thanks to you all, for your endurance, feedback and clarifications. I will repost the solution for your perusal.

Share via

Why does the DocumentIntelligenceAdministrationClient GetModel method not return any information for either BlobFileListSource or BlobSource? The DocumentModelDetails contains null values for these fields in the query results.

1 answer

Your answer