Document Intelligence API returning incomplete KeyValuePairs (incorrectly detected)

Additional information: these are the commands I use to call the model:

############################################################################################
document_analysis_client = DocumentAnalysisClient(endpoint=ep, credential=AzureKeyCredential(key) )

poller = document_analysis_client.begin_analyze_document_from_url("prebuilt-document", fqfn) result = poller.result()
############################################################################################

If you want to try, fqfn is open to read and points to:
[redacted]
And the problematic string is [redacted]

Hi Sergio Ricardo de Freitas Oliveira,

We should use azure-ai-document intelligence package for using document intelligence client instead of azure-ai-form recognizer. Please use separate key field from Document intelligence user interface for strings from page 1 and page 2. and retrain the model.   Please refer the syntax mentioned here - Azure AI Document Intelligence client library for Python | Microsoft Learn -

@Anonymous Thank you for your persistence in help.
The library DocumentIntelligenceClient you suggested does not return the data structure KeyValuePair (actually it returns empty) for the model called "prebuilt-layout", which was the nearest available similar to the model "prebuilt-document" that I used with the library azure.ai.formrecognizer:

poller = document_intelligence_client.begin_analyze_document( "prebuilt-layout", AnalyzeDocumentRequest(url_source=fqfn)

I've tried to add the parameter features=[DocumentAnalysisFeature.KEY_VALUE_PAIRS], but it seems it is incompatible with the parameter AnalyzeDocumentRequest().

Well... the API call worked with the sintax below, but the key-value-pairs it brought are in much much less number than when I used the library azure.ai.formrecognizer. So, the problem persists.

document_intelligence_client = DocumentIntelligenceClient(endpoint=ep, credential=AzureKeyCredential(key)) poller = document_intelligence_client.begin_analyze_document( model_id="prebuilt-layout", features=[DocumentAnalysisFeature.KEY_VALUE_PAIRS], body=AnalyzeDocumentRequest(url_source=fqfn) ) result = poller.result()

Hi Sergio Ricardo de Freitas Oliveira,

Thank you for the clarification! can you please have a look once to these code.

from azure.core.credentials import AzureKeyCredential     
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import DocumentAnalysisFeature, AnalyzeResult
 
poller = document_intelligence_client.begin_analyze_document(
        "prebuilt-layout", analyze_request=f, features=[DocumentAnalysisFeature.KEY_VALUE_PAIRS], content_type="application/octet-stream"
)

print("----Key-value pairs found in document----")
    if result.key_value_pairs:
        for kv_pair in result.key_value_pairs:
            if kv_pair.key:
                print(f"Key '{kv_pair.key.content}' found within " f"'{kv_pair.key.bounding_regions}' bounding regions")
            if kv_pair.value:
                print(
                    f"Value '{kv_pair.value.content}' found within "
                    f"'{kv_pair.value.bounding_regions}' bounding regions\n"
                )

Can you please try this code to the user as long as their document is structured to have recognizable key-value pairs. If the prebuilt-layout model still doesn’t yield sufficient results, you can recommend switching to the prebuilt-document model.

I hope these helps you. Thank you!

Thank you @Anonymous

Your code exemple above returns only 2 key-value pairs (the same as my last one above). The PDF file has 41 key-value pairs. My original code using the library azure-ai-formrecognizer version 3.3.3 returns 40 key-value pairs, even though it extracts correctly to text all the PDF content.

Regarding your second recommendation (to switch to "prebuilt-document" model): even though the documentation does inform the possibility of using that model, the API returns an error when I call:

poller = document_intelligence_client.begin_analyze_document( "prebuilt-document", body=f)

The error is:

azure.core.exceptions.ResourceNotFoundError: (NotFound) Resource not found.

Code: NotFound

Message: Resource not found.

Inner error: {

"code": "ModelNotFound",

"message": "The requested model was not found."

-SR

Hi Sergio Ricardo de Freitas Oliveira,

You made a typo in your usage, It should be prebuilt-layout model instead of prebuilt-document as mentioned here. document_intelligence_client.begin_analyze_document(         "prebuilt-layout", analyze_request=f, features=[DocumentAnalysisFeature.KEY_VALUE_PAIRS], content_type="application/octet-stream")

Kindly refer below link: programming-language

Thank You.

@saideep anchuri In the comment I wrote on "Feb 25, 2025, 5:56 PM" I showed that I used "prebuilt-layout" but the API returned a number of key-value pairs much much less than the number I had obtained when I used the library azure.ai.formrecognizer...

Hello @Sergio Ricardo de Freitas Oliveira With the Document Intelligence 2023-10-31-preview, the general document model (prebuilt-document) is deprecated. Going forward, to extract key-value pairs from documents, use the prebuilt-layout model with the optional query string parameter features=keyValuePairs enabled.

Hello @Sergio Ricardo de Freitas Oliveira,

In addition to kothapally Snigdha's comments about enabling key-value pairs with features=[DocumentAnalysisFeature.KEY_VALUE_PAIRS] in prebuilt-layout under azure.ai.documentintelligence, this is necessary since prebuilt-document has been deprecated in the latest Document Intelligence API version (2023-10-31-preview).

To accurately extract key-value pairs, you can try the code below with prebuilt-layout , which has worked for me:

import os

from azure.core.credentials import AzureKeyCredential

from azure.ai.documentintelligence import DocumentIntelligenceClient

from azure.ai.documentintelligence.models import DocumentAnalysisFeature, AnalyzeResult

from azure.core.exceptions import HttpResponseError

from dotenv import load_dotenv, find_dotenv

load_dotenv(find_dotenv())

endpoint = "AZURE_DOCUMENT_INTELLIGENCE_ENDPOINT"

key = "AZURE_DOCUMENT_INTELLIGENCE_KEY"

if not endpoint or not key:

    raise ValueError("Missing Azure Document Intelligence API credentials in environment variables.")

document_intelligence_client = DocumentIntelligenceClient(

    endpoint=endpoint, 

    credential=AzureKeyCredential(key)

)

path_to_sample_document = os.path.abspath(

    os.path.join(os.path.dirname(__file__), "C://ipdf.pdf")

)

if not os.path.exists(path_to_sample_document):

    raise FileNotFoundError(f"Document not found at {path_to_sample_document}")

def analyze_languages():

    """Detect languages present in the document."""

    try:

        with open(path_to_sample_document, "rb") as f:

            poller = document_intelligence_client.begin_analyze_document(

                "prebuilt-layout",

                f,  # Pass the file stream as a positional argument

                features=[DocumentAnalysisFeature.LANGUAGES],

                content_type="application/octet-stream",

            )

        result: AnalyzeResult = poller.result()

        print("----Languages detected in the document----")

        if result.languages:

            print(f"Detected {len(result.languages)} languages:")

            for lang_idx, lang in enumerate(result.languages):

                print(f"- Language #{lang_idx}: locale '{lang.locale}', Confidence: {lang.confidence}")

                extracted_text = ",".join(

                    [result.content[span.offset: span.offset + span.length] for span in lang.spans]

                )

                print(f"  Extracted Text: '{extracted_text}'")

        else:

            print("No languages detected.")

    except HttpResponseError as error:

        print("Error during language detection:", error)

        raise

def analyze_key_value_pairs():

    """Extract key-value pairs from the document."""

    try:

        with open(path_to_sample_document, "rb") as f:

            poller = document_intelligence_client.begin_analyze_document(

                "prebuilt-layout",

                f,  # Pass the file stream as a positional argument

                features=[DocumentAnalysisFeature.KEY_VALUE_PAIRS],

                content_type="application/octet-stream",

            )

        result: AnalyzeResult = poller.result()

        print("----Key-Value Pairs found in document----")

        if result.key_value_pairs:

            for kv_pair in result.key_value_pairs:

                if kv_pair.key:

                    print(f"Key: '{kv_pair.key.content}' found in '{kv_pair.key.bounding_regions}'")

                if kv_pair.value:

                    print(f"Value: '{kv_pair.value.content}' found in '{kv_pair.value.bounding_regions}'\n")

        else:

            print("No key-value pairs detected. Try enabling 'Key-Value Pairs' in Document Intelligence Studio.")

    except HttpResponseError as error:

        print("Error during key-value pair extraction:", error)

        raise

if __name__ == "__main__":

    try:

        analyze_languages()

        analyze_key_value_pairs()

    except Exception as e:

        print("An unexpected error occurred:", e)

Output:

Hope this helps!

If you found this answer helpful, please click Accept Answer and kindly upvote it.

If you have any further questions, please click Comment.

Hello @Sergio Ricardo de Freitas Oliveira , Just checking in to see if the provided answer helped. If it did, please click "Accept the answer” and Yes for the answer . So it can benefit other community members reading this thread. If you have any further queries, do let us know.

Hello @Sergio Ricardo de Freitas Oliveira , We still have not heard back from you. Could you please let us know if the answer provided below was helpful? If it resolves your query, kindly click Accept Answer and Yes, as it could assist other community members reading this thread. Additionally, if you have any further questions, please let us know.

Hello. Thank you for your comment.

It's not a solution. I had already tried that with my document. If you read the problem description in the beginning of you can see why.

Thanks.

Hello @Sergio Ricardo de Freitas Oliveira, using my PDF files, I am able to get the key value pairs with the pre-built module. Kindly share your PDF file in a private message so I can reproduce it from my end. Please refer to this DOC for information on the use of private messages on Microsoft Q&A.

Hello Sampath
The PDF was already shared in one of the first messages of this thread.
Here it follows again: [redacted]

Hello @Sergio Ricardo de Freitas Oliveira, Checking the same from my end

Hello @Sergio Ricardo de Freitas Oliveira,

Thanks for your understanding and cooperation.

Can you please confirm if you are referring to the key value mentioned on the page below?

Thanks

No. The problematic string is [redacted]

Thank you. Ok, this is the response.