Assistance Needed: Azure Form Recognizer API Query Issue

Question

I am having trouble querying additional fields using the prebuilt invoice model in the Azure Form Recognizer API. When I pass query fields to the endpoint https://{endpoint}/documentintelligence/documentModels/prebuilt-invoice:analyze?api-version=2024-02-29-preview&features=queryFields&queryFields=Terms,PaymentDate using the Python SDK, I receive a "No resource found" error.

I have checked that my Azure resource is located in one of the supported regions (East US, West US2, West Europe) for the public preview version 2024-02-29-preview. Although the prebuilt invoice model correctly extracts standard fields such as InvoiceId, InvoiceDate, and Total, I need to extract additional fields like VendorTRN and TelephoneNumber.

Can someone please provide guidance on how to resolve this issue and successfully query these additional fields using the Azure Form Recognizer API?

Answer 1

It seems like you’re trying to extend the schema of the prebuilt invoice model to extract specific fields you need, which is supported by Azure’s Document Intelligence. Here are a few things you might want to check:

1. API Version: Make sure you’re using the correct API version. As per your query, you’re using 2024-02-29-preview, which should be fine.

Query Fields: You’re passing Terms and PaymentDate as query fields. If you want to extract VendorTRN and TelephoneNumber, you should include these in your query fields.

1. Endpoint URL: Ensure that the endpoint URL is correct. The URL you provided seems to be in the correct format.
2. Authentication: Make sure your API key is correctly set. The API key should be wrapped in the AzureKeyCredential class.

If you’ve checked all of these and the issue persists, it might be a service-related issue.

Answer 2

Hi @Dhairya Maradiya,

Thank you for reaching out to Microsoft Q&A forum!

Thank you for reaching out. I understand that you're having trouble querying additional fields using the prebuilt invoice model in the Azure Form Recognizer API. The 'No resource found' error you're receiving may be due to incorrect query parameters or missing permissions.

I tried to repro your issue using REST API endpoint to extract additional fields as per our requirements.

To query additional fields using the Azure Form Recognizer API, you can use the following endpoint:

POST: {endpoint}/documentintelligence/documentModels/prebuilt-invoice:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&features=queryFields&queryFields=phone,Terms

Please note that you'll need to replace {endpoint} with your actual endpoint and also you can give the "queryFields" as per your requirements. Also, make sure that you have the necessary permissions and access rights to query additional fields.

The below screen shot shows the extracted additional fields:

For more info, please look into the documentation.

I hope this helps! Thank you.

Answer 3

Hi @Dhairya Maradiya,

If my response helped, please mark it as an accepted answer.

Thanks in advance.