Document Text extraction model

Question

Document Text extraction model

Vusirikala, Aishwarya 0

I have created a model for "Document Text extraction" under Azure AI foundry. I would like to use the model that i have created in my python code. How do i use the model to extract the fields from the files?

1 answer

Your answer

Answer 1

Vikram Singh 2,390 Microsoft Employee

Hi Vusirikala, Aishwarya

Welcome to the Microsoft Q&A Forum! Thank you for posting your query here.

To utilize your custom "Document Text Extraction" model from Azure AI Foundry in your Python application. Here's how you can use the model to extract fields in your code:

Deploy the Model: First, ensure that your model is deployed in Azure AI Foundry. You can do this by navigating to your Azure AI Foundry project, selecting "Management center" from the left pane, and then selecting "Models + endpoints" under the Project section.
Get the REST Endpoint: Once your model is deployed, you will need the REST endpoint prediction URL. You can get this by selecting the model you want to deploy and noting the REST endpoint provided.
Use the Python SDK: You can use the Azure AI Document Intelligence SDK or the REST API to apply your custom model for inferencing.
Extract Fields: The response will contain the extracted fields from your document. You can parse this JSON response to get the specific fields you need.

For more detailed guidance, you can refer to the official Microsoft documentation: How to use Azure AI services in Azure AI Foundry portal

Additionally, the Azure AI Document Intelligence client library for Python provides detailed information on processing documents and extracting text using the SDK.

I hope this is helpful!

Thanks

Please do not forget to "Accept the answer” and “up-vote” wherever the information provided helps you, this can be beneficial to other community members.

Vikram Singh 2,390 Reputation points Microsoft Employee

2025-02-10T04:41:19.2533333+00:00

Hi Vusirikala, Aishwarya

Greetings.

Just following up to check if my suggestion helped. Please do not forget to "Accept the answer” and “up-vote” wherever the information provided helps you, this can be beneficial to other community members.

Thank you
Vusirikala, Aishwarya 0 Reputation points

2025-02-10T05:28:35.5966667+00:00

Thank you Vikram for your response. With your response, I am kinda getting some hope on how to proceed further.

below is what I see when i go to "Models + endpoints". I do not see the REST endpoint here. Can you guide me on how to get the REST endpoint?
Vusirikala, Aishwarya 0 Reputation points

2025-02-10T06:30:30.3233333+00:00
Hi Vikram,

Per Step 3 of your solution, i tried the Azure AI Document Intelligence SDK and below is what I get: Looks like the API version of the model created by AI Foundry is not being supported by the SDK. The API version created is 2024-07-31-preview. Any help on how to get around this issue?

File "C:\Users\VusirikaAi01\OneDrive - Hearst\FirstDataBank\HDA.venv\lib\site-packages\azure\ai\documentintelligence_operations_operations.py", line 819, in _analyze_document_initial

raise HttpResponseError(response=response, model=error)

azure.core.exceptions.HttpResponseError: (InvalidArgument) Invalid argument.

Code: InvalidArgument

Message: Invalid argument.

Inner error: {

"code": "InvalidParameter", "message": "The parameter CustomGenerative is invalid: Invalid build mode for this api-version."

}

PS C:\Users\VusirikaAi01\OneDrive - Hearst\FirstDataBank\HDA>
Vusirikala, Aishwarya 0 Reputation points

2025-02-10T06:35:49.5133333+00:00
Following up further:

Per Step #3, I went ahead and used the Azure AI Document Intelligence SDK and below is what i got: Looks like the API version of my model (2024-07-31-preview) is not being accepted by the SDK? How to get around with it?

File "C:\Users\VusirikaAi01\OneDrive - Hearst\FirstDataBank\HDA.venv\lib\site-packages\azure\ai\documentintelligence_operations_operations.py", line 819, in _analyze_document_initial

raise HttpResponseError(response=response, model=error)

azure.core.exceptions.HttpResponseError: (InvalidArgument) Invalid argument.

Code: InvalidArgument

Message: Invalid argument.

Inner error: {

"code": "InvalidParameter", "message": "The parameter CustomGenerative is invalid: Invalid build mode for this api-version."

}

PS C:\Users\VusirikaAi01\OneDrive - Hearst\FirstDataBank\HDA>
Vikram Singh 2,390 Reputation points Microsoft Employee

2025-02-10T07:45:23.5166667+00:00
Hello Vusirikala, Aishwarya,

Thank you for reaching out. It seems that the issue you're encountering is due to the API version 2024-07-31-preview not being supported by the Azure AI Document Intelligence SDK. Here are some steps to help you get around this issue:

Use a Supported API Version: The Azure AI Document Intelligence SDK may not yet support the 2024-07-31-preview API version. Try using a stable, generally available (GA) API version such as 2023-07-31 or 2023-10-3112. You can update your SDK client to target one of these supported API versions.

Update SDK Client Library: Ensure that you are using the latest version of the Azure AI Document Intelligence SDK. You can update the SDK client library by running the following command:
pip install --upgrade azure-ai-documentintelligence#This will ensure that you have the latest features and bug fixes

Modify API Request: Adjust your API request to use a supported API version. For example, you can modify the endpoint URL in your request to target the 2023-07-31 API version:
endpoint = "https://<your-endpoint-name>.cognitiveservices.azure.com/" api_version = "2023-07-31" url = f"{endpoint}/formrecognizer/documentModels/prebuilt-read:analyze?api-version={api_version}"

Check Parameter Validity: Ensure that all parameters in your API request are valid for the chosen API version. The error message indicates that the parameter CustomGenerative is invalid for the 2024-07-31-preview API version. Verify that you are using the correct parameters as per the API documentation3.

By following these steps, you should be able to resolve the InvalidArgument error and successfully use the Azure AI Document Intelligence SDK. If you need further assistance, feel free to ask!

For more detailed guidance, you can refer to the official Microsoft documentation:

Document Intelligence SDK target REST API 2023-07-31 (GA) latest.

Document Intelligence SDK target REST API v4.0

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

Also, i think you resolve the REST endpoint you mentioned before.

Cheers
Vikram Singh 2,390 Reputation points Microsoft Employee

2025-02-12T11:59:46.99+00:00

Hello Vusirikala, Aishwarya,

Greetings.

Just following up to check if my suggestion helped. Please do not forget to "Accept the answer” and “up-vote” wherever the information provided helps you, this can be beneficial to other community members.

Thank you
Vikram Singh 2,390 Reputation points Microsoft Employee

2025-02-17T04:29:13.84+00:00

Hi Vusirikala, Aishwarya,

Greetings.

If the response helped, please do click Accept Answer and Yes for was this answer helpful.

Doing so would help other community members with similar issue identify the solution. I highly appreciate your contribution to the community.

Thank You.
Vikram Singh 2,390 Reputation points Microsoft Employee

2025-02-19T04:38:58.16+00:00

Hi Vusirikala, Aishwarya,

Greetings.

We haven’t heard from you on the last response and was just checking back to see if you got a chance to try above suggestions.

If the response helped, please don't forget to close up the thread here by upvoting and accept it as an answer.

Thank You.

Share via

Document Text extraction model

1 answer

Your answer