Convert JSON to AnalyzeResult

[ashp-grouptree]

Azure.AI.FormRecognizer 4.1.0

Query/Question

Will there ever be more support to mock an AnalyzeResult object from a JSON response obtained from the Document Intelligence Studio? I can use DocumentAnalysisModelFactory.AnalyzeResult to create a mock object but there is no support for populating DocumentTable etc.? For testing purposes we should have support for creating an exact replica of the endpoint response surely?

Environment

Runtime Environment:
OS Name: Windows
OS Version: 10.0.19045
OS Platform: Windows
RID: win-x64
Base Path: C:\Program Files\dotnet\sdk\9.0.101\

.NET SDK:
Version: 9.0.101
Commit: eedb237549
Workload version: 9.0.100-manifests.4a280210
MSBuild version: 17.12.12+1cce77968

Visual Studio Version 17.12.3

[jsquire]

Thank you for your feedback. Tagging and routing to the team member best able to assist.

[kinelski]

Hello @ashp-grouptree,

You can also mock DocumentTable and other models using the DocumentAnalysisModelFactory. For example, you could do:

List<DocumentTable> tables = new() {
    DocumentAnalysisModelFactory.DocumentTable(rowCount: 3, columnCount: 1);
    DocumentAnalysisModelFactory.DocumentTable(rowCount: 5, columnCount: 2);
};
AnalyzeResult result = DocumentAnalysisModelFactory.AnalyzeResult(tables: tables);

You should be able to replicate any possible result returned by the service if you use the model factory to create your models.

That said, please be aware that Azure.AI.FormRecognizer is an old package that won't receive more feature updates in the future. Going forward, Azure.AI.DocumentIntelligence is the official package to go for the Document Intelligence service.

The new package supports JSON serialization/deserialization of our models, which might make the process of mocking AnalyzeResult easier depending on your scenario:

JsonSerializerOptions options = new JsonSerializerOptions()
{
    Converters = { new JsonModelConverter() }
};

// Serializing AnalyzeResult into JSON.
AnalyzeResult model = DocumentIntelligenceModelFactory.AnalyzeResult();
string data = JsonSerializer.Serialize(model, options);

// Deserializing AnalyzeResult from JSON.
AnalyzeResult? model = JsonSerializer.Deserialize<AnalyzeResult>(data, options);

If you ever decide to migrate, consider taking a look at our README and our migration guide for a complete list of missing features.

[github-actions]

Hi @ashp-grouptree. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.

[ashp-grouptree]

Thanks for the help. This looks to be what we need will give it a try.