You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/content-understanding/quickstart/use-rest-api.md
+32-43Lines changed: 32 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,49 +50,58 @@ curl -i -X POST "{endpoint}/analyzers/{analyzerId}:analyze?api-version=2025-05-0
50
50
51
51
# [Document](#tab/document)
52
52
53
-
1. Replace `{endpoint}` and `{key}` with the corresponding values from your Azure AI Services instance in the Azure portal
53
+
1. Replace `{endpoint}` and `{key}` with the corresponding values from your Azure AI Services instance in the Azure portal.
54
54
2. Replace `{analyzerId}` with `prebuilt-documentAnalyzer`.
55
-
3. Replace `{fileUrl}` with a publicly accessible URL of the file to analyze—such as a path to an Azure Storage Blob with a shared access signature (SAS), or use the sample URL: `https://github.com/Azure-Samples/azure-ai-content-understanding-python/blob/main/data/invoice.pdf`.
55
+
3. Replace `{fileUrl}` with a publicly accessible URL of the file to analyze—such as a path to an Azure Storage Blob with a shared access signature (SAS), or use the sample URL: `https://github.com/Azure-Samples/azure-ai-content-understanding-python/raw/refs/heads/main/data/invoice.pdf`.
56
56
57
57
# [Image](#tab/image)
58
58
59
-
1. Replace `{endpoint}` and `{key}` with the corresponding values from your Azure AI Services instance in the Azure portal
60
-
2. Replace `{analyzerId}` with `prebuilt-imageAnalyzer`
61
-
3. Replace `{fileUrl}` with a publicly accessible URL of the file to analyze—such as a path to an Azure Storage Blob with a shared access signature (SAS), or use the sample URL: `https://github.com/Azure-Samples/azure-ai-content-understanding-python/blob/main/data/pieChart.jpg`
59
+
1. Replace `{endpoint}` and `{key}` with the corresponding values from your Azure AI Services instance in the Azure portal.
60
+
2. Replace `{analyzerId}` with `prebuilt-imageAnalyzer`.
61
+
3. Replace `{fileUrl}` with a publicly accessible URL of the file to analyze—such as a path to an Azure Storage Blob with a shared access signature (SAS), or use the sample URL: `https://github.com/Azure-Samples/azure-ai-content-understanding-python/raw/refs/heads/main/data/pieChart.jpg`.
62
62
63
63
# [Audio](#tab/audio)
64
64
65
-
1. Replace `{endpoint}` and `{key}` with the corresponding values from your Azure AI Services instance in the Azure portal
66
-
2. Replace `{analyzerId}` with `prebuilt-audioAnalyzer`
67
-
3. Replace `{fileUrl}` with a publicly accessible URL of the file to analyze—such as a path to an Azure Storage Blob with a shared access signature (SAS), or use the sample URL: `https://github.com/Azure-Samples/azure-ai-content-understanding-python/blob/main/data/audio.wav`
65
+
1. Replace `{endpoint}` and `{key}` with the corresponding values from your Azure AI Services instance in the Azure portal.
66
+
2. Replace `{analyzerId}` with `prebuilt-audioAnalyzer`.
67
+
3. Replace `{fileUrl}` with a publicly accessible URL of the file to analyze—such as a path to an Azure Storage Blob with a shared access signature (SAS), or use the sample URL: `https://github.com/Azure-Samples/azure-ai-content-understanding-python/raw/refs/heads/main/data/audio.wav`.
68
68
69
69
# [Video](#tab/video)
70
70
71
-
1. Replace `{endpoint}` and `{key}` with the corresponding values from your Azure AI Services instance in the Azure portal
72
-
2. Replace `{analyzerId}` with `prebuilt-videoAnalyzer`
73
-
3. Replace `{fileUrl}` with a publicly accessible URL of the file to analyze—such as a path to an Azure Storage Blob with a shared access signature (SAS), or use the sample URL: `https://github.com/Azure-Samples/azure-ai-content-understanding-python/blob/main/data/FlightSimulator.mp4`
71
+
1. Replace `{endpoint}` and `{key}` with the corresponding values from your Azure AI Services instance in the Azure portal.
72
+
2. Replace `{analyzerId}` with `prebuilt-videoAnalyzer`.
73
+
3. Replace `{fileUrl}` with a publicly accessible URL of the file to analyze—such as a path to an Azure Storage Blob with a shared access signature (SAS), or use the sample URL: `https://github.com/Azure-Samples/azure-ai-content-understanding-python/raw/refs/heads/main/data/FlightSimulator.mp4`.
74
74
---
75
75
76
76
77
77
#### POST Response
78
78
79
-
The 202 (`Accepted`) response includes an `operation-location` header containing a URL that you can use to track the status of this asynchronous analyze operation.
79
+
The response returns `resultId` that you can use to track the status of this asynchronous analyze operation.
"valueString": "The image is a pie chart that represents the distribution of hours worked per week by individuals. It is divided into four segments: 60+ hours (37.8%), 50-60 hours (36.6%), 40-50 hours (18.9%), and 1-39 hours (6.7%)."
159
-
}
160
-
},
161
-
"kind": "document",
162
-
"startPageNumber": 1,
163
-
"endPageNumber": 1,
164
-
"unit": "pixel",
165
-
"pages": [
166
-
{
167
-
"pageNumber": 1,
168
-
"angle": 0.1013839,
169
-
"width": 1283,
170
-
"height": 617
171
-
}
172
-
]
173
-
},
174
162
{
175
163
"markdown": "\n",
176
164
"fields": {
177
165
"Summary": {
178
166
"type": "string",
179
-
"valueString": "The image is a pie chart that represents the distribution of hours worked per week by individuals. It is divided into four segments: 60+ hours (37.8%), 50-60 hours (36.6%), 40-50 hours (18.9%), and 1-39 hours (6.7%)."
167
+
"valueString": "The image is a pie chart depicting the distribution of hours worked per week among a group of individuals. The chart is divided into four segments: 60+ hours (37.8%), 50-60 hours (36.6%), 40-50 hours (18.9%), and 1-39 hours (6.7%). Each segment is labeled with its corresponding percentage and color-coded for clarity."
180
168
}
181
169
},
182
170
"kind": "document",
@@ -185,7 +173,8 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
185
173
"unit": "pixel",
186
174
"pages": [
187
175
{
188
-
"pageNumber": 1
176
+
"pageNumber": 1,
177
+
"spans": []
189
178
}
190
179
]
191
180
}
@@ -247,6 +236,6 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
247
236
248
237
## Next steps
249
238
250
-
* In this quickstart, you learned how to call the [REST API](<Reference Link>) using a pre-built analyzer. See how you can [customize pre-built analyzers](<Link to customization) to better fit your use case.
239
+
* In this quickstart, you learned how to call the [REST API](REFERENCE LINK) using a pre-built analyzer. See how you can [customize pre-built analyzers](LINK TO CUSTOMIZATION) to better fit your use case.
0 commit comments