Skip to content

Commit 3a10caf

Browse files
Merge pull request #6861 from laujan/patch-1
Update batch analysis API endpoint and date
2 parents 236dd6f + 60ba814 commit 3a10caf

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

articles/ai-services/document-intelligence/prebuilt/batch-analysis.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn about the Document Intelligence Batch analysis API
55
author: laujan
66
ms.service: azure-ai-document-intelligence
77
ms.topic: conceptual
8-
ms.date: 02/25/2025
8+
ms.date: 08/28/2025
99
ms.author: lajanuar
1010
monikerRange: '>=doc-intel-4.0.0'
1111
---
@@ -53,7 +53,7 @@ Review [Managed identities for Document Intelligence](../authentication/managed-
5353

5454
Review [**Create SAS tokens**](../authentication/create-sas-tokens.md) to learn more about generating SAS tokens and how they work.
5555

56-
## Calling the batch analysis API
56+
## Call the batch analysis API
5757

5858
### 1. Specify the input files
5959

@@ -62,16 +62,19 @@ The batch API supports two options for specifying the files to be processed.
6262
* If you want to process all the files in a container or a folder, and the number of files is less than the 10000 limit, use the ```azureBlobSource``` object in your request.
6363

6464
```bash
65-
POST /documentModels/{modelId}:analyzeBatch
65+
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-11-30
6666

6767
{
6868
"azureBlobSource": {
69-
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
70-
...
71-
},
72-
...
69+
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken"
70+
71+
},
72+
{
73+
"resultContainerUrl": "https://myStorageAccount.blob.core.windows.net/myOutputContainer?mySasToken",
74+
"resultPrefix": "trainingDocsResult/"
7375
}
7476

77+
7578
```
7679
7780
* If you don't want to process all the files in a container or folder, but rather specific files in that container or folder, use the ```azureBlobFileListSource``` object. This operation requires a File List JSONL file which lists the files to be processed. Store the JSONL file in the root folder of the container. Here's an example JSONL file with two files listed:
@@ -88,7 +91,7 @@ Use a file list `JSONL` file with the following conditions:
8891
* When you want more control over which files get processed in each batch request;
8992
9093
```bash
91-
POST /documentModels/{modelId}:analyzeBatch
94+
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-11-30
9295

9396
{
9497
"azureBlobFileListSource": {
@@ -119,13 +122,14 @@ Remember to replace the following sample container URL values with real values f
119122
120123
This example shows a POST request with `azureBlobSource` input
121124
```bash
122-
POST /documentModels/{modelId}:analyzeBatch
125+
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-11-30
123126
124127
{
125128
"azureBlobSource": {
126129
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
127130
"prefix": "inputDocs/"
128131
},
132+
{
129133
"resultContainerUrl": "https://myStorageAccount.blob.core.windows.net/myOutputContainer?mySasToken",
130134
"resultPrefix": "batchResults/",
131135
"overwriteExisting": true
@@ -137,13 +141,14 @@ This example shows a POST request with `azureBlobFileListSource` and a file list
137141
138142
139143
```bash
140-
POST /documentModels/{modelId}:analyzeBatch
144+
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyzeBatch?api-version=2024-11-30
141145
142146
{
143147
"azureBlobFileListSource": {
144148
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
145149
"fileList": "myFileList.jsonl"
146150
},
151+
{
147152
"resultContainerUrl": "https://myStorageAccount.blob.core.windows.net/myOutputContainer?mySasToken",
148153
"resultPrefix": "batchResults/",
149154
"overwriteExisting": true
@@ -155,7 +160,7 @@ Here's an example **successful** response
155160
156161
```bash
157162
202 Accepted
158-
Operation-Location: /documentModels/{modelId}/analyzeBatchResults/{resultId}
163+
Operation-Location: /documentintelligence/documentModels/{modelId}/analyzeBatchResults/{resultId}?api-version=2024-11-30
159164
```
160165
161166
### 4. Retrieve API results
@@ -164,7 +169,7 @@ Use the `GET` operation to retrieve batch analysis results after the POST operat
164169
165170
166171
```bash
167-
GET /documentModels/{modelId}/analyzeBatchResults/{resultId}
172+
GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeBatchResults/{resultId}?api-version=2024-11-30
168173
200 OK
169174
170175
{

0 commit comments

Comments
 (0)