Document Intelligence 2024-11-30 GA

[bojunehsu]

Data Plane API Specification Update Pull Request

Document Intelligence 2024-11-30 GA.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

• Link to API Spec engagement record issue:

Is this review for (select one):

• a private preview
• a public preview
• GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

• Design Document: See internal PR
• Previous API Spec Doc: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/ai/data-plane/DocumentIntelligence/preview/2024-07-31-preview
• Updated paths:
  • Added new batch list/delete operations
    • GET /documentModels/{modelId}/analyzeBatchResults
    • DELETE /documentModels/{modelId}/analyzeBatchResults/{resultId}
  • DELETE /documentModels/{modelId}/analyzeResults/{resultId}

[openapi-pipeline-app]

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
JavaScript	@azure-rest/ai-document-intelligence	https://apiview.dev/Assemblies/Review/0ca4eda857b94249aa787305a387271f?revisionId=356ec4626c7648e3b4a75127554ae0de
Python	azure-ai-documentintelligence	https://apiview.dev/Assemblies/Review/e537ef4f04a343e1863478cb96d48b59?revisionId=ed01e8a5ff0e4cd58c9bcb4dcadbb52e
TypeSpec	DocumentIntelligence	https://apiview.dev/Assemblies/Review/f8a22c44fd034f7597acfffdba53dade?revisionId=4f3dc6679bea4c18842a172ec162914a

[weidongxu-microsoft]

Thanks. I think I got all the answers to my doubts.

[mikekistler]

I left some comments on aspects of the API where it is not following the Azure guidelines. We may have discussed these in prior reviews but I could not find mention of it going back through the review notes. Please respond with an explanation so we have the reasoning documented.

[mikekistler]

Tagging @allenjzhang and @mario-guerra to review the TypeSpec for best practices.

[mikekistler]

Looks good. 👍