Get KeyValuePairs when using modelId="prebuilt-invoice".

Question

Hello :)

DocumentAnalysisClient client = new DocumentAnalysisClientBuilder()
	.credential(new AzureKeyCredential(apiKey))
	.endpoint(endpoint)
	.buildClient();
SyncPoller<OperationResult, AnalyzeResult> analyzeInvoicePoller = client.beginAnalyzeDocumentFromUrl("prebuilt-invoice", url);
AnalyzeResult analyzeInvoiceResult = analyzeInvoicePoller.getFinalResult();
List<DocumentKeyValuePair> kartList = analyzeInvoiceResult.getKeyValuePairs();

List of KeyValuePairs is null when the modelId provided is "prebuilt-invoice", but is the actual key value pairs I am after when modelId="prebuilt-document". Is there a way to get key value pairs AND the processed fields you get from the prebuilt invoice model.

Answer 1

Hello @Andreas Palm Sivertsen , Thanks for using Microsoft Q&A Platform.

The key-value pairs are supported for the prebuilt-invoice model. However, to get a better understanding of the features available for each model, I recommend visiting the Analysis feature table. This table provides a comprehensive overview of the features available for each model, including prebuilt and custom models.

I have reproduced, and the key-values pair are generated. Here is the sample python code snippet for the pre-built invoice model to print the key-value pairs of the analyze result: https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/quickstarts/get-started-sdks-rest-api?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-python

for kv_pair in invoices.key_value_pairs:
    if kv_pair.key:
        print(
            "Key '{}' found within '{}' bounding regions".format(kv_pair.key.content,
                    format_bounding_region(kv_pair.key.bounding_regions),
            )
        )
    if kv_pair.value:
        print(
            "Value '{}' found within '{}' bounding regions\n".format(kv_pair.value.content,
                    format_bounding_region(kv_pair.value.bounding_regions),
            )
        )

Result:

I hope this helps.

Regards,
Vasavi

-Please kindly accept the answer and vote 'yes' if you feel helpful to support the community, thanks.