Skip to content

Commit 98cc371

Browse files
authored
add updated sample results
1 parent 2c0216f commit 98cc371

File tree

1 file changed

+128
-16
lines changed

1 file changed

+128
-16
lines changed

articles/ai-services/content-understanding/quickstart/use-rest-api.md

Lines changed: 128 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.date: 04/14/2025
1414

1515
* This quickstart shows you how to use the [Content Understanding REST API](/rest/api/contentunderstanding/operation-groups?view=rest-contentunderstanding-2025-05-01-preview&preserve-view=true) to get structured data from multimodal content in document, image, audio, and video files.
1616

17-
* Try the [Content Understanding API with no code on Azure AI Foundry](https://ai.azure.com/explore/aiservices/vision/contentunderstanding)
17+
* Try [Content Understanding with no code on Azure AI Foundry](https://ai.azure.com/explore/aiservices/vision/contentunderstanding)
1818

1919
## Prerequisites
2020

@@ -113,20 +113,20 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
113113

114114
```json
115115
{
116-
"id": "a8ccf3ea-e4ad-4302-9ac5-b40e69768053",
116+
"id": {resultId},
117117
"status": "Succeeded",
118118
"result": {
119119
"analyzerId": "prebuilt-documentAnalyzer",
120120
"apiVersion": "2025-05-01-preview",
121-
"createdAt": "2025-05-05T17:55:35Z",
121+
"createdAt": "YYYY-MM-DDTHH:MM:SSZ",
122122
"warnings": [],
123123
"contents": [
124124
{
125-
"markdown": "# WEB HOSTING AGREEMENT\n\nThis web Hosting Agreement is entered as of this 15 day of October ..." ,
125+
"markdown": "CONTOSO LTD.\n\n\n# INVOICE\n\nContoso Headquarters\n123 456th St...",
126126
"fields": {
127127
"Summary": {
128128
"type": "string",
129-
"valueString": "This document is a Web Hosting Agreement between Contoso Corporation and AdventureWorks Cycles, both based in Washington. It outlines the terms of their agreement, including payment terms for software and bandwidth usage, technical support requirements, and governing laws. The agreement nullifies any previous agreements between the parties and is signed by representatives of both companies."
129+
"valueString": "This document is an invoice issued by Contoso Ltd. to Microsoft Corporation for services rendered during the period of 10/14/2019 to 11/14/2019..."
130130
}
131131
},
132132
"kind": "document",
@@ -136,10 +136,66 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
136136
"pages": [
137137
{
138138
"pageNumber": 1,
139-
"angle": -0.0052,
140-
"width": 8.2639,
141-
"height": 11.6806
139+
"angle": -0.0039,
140+
"width": 8.5,
141+
"height": 11,
142+
"spans": [ { "offset": 0, "length": 1650 } ],
143+
"words": [
144+
{
145+
"content": "CONTOSO",
146+
"span": { "offset": 0, "length": 7 },
147+
"confidence": 0.998,
148+
"source": "D(1,0.5739,0.6582,1.7446,0.6595,1.7434,0.8952,0.5729,0.8915)"
149+
}, ...
150+
],
151+
"lines": [
152+
{
153+
"content": "CONTOSO LTD.",
154+
"source": "D(1,0.5734,0.6563,2.335,0.6601,2.3345,0.8933,0.5729,0.8895)",
155+
"span": { "offset": 0, "length": 12 }
156+
}, ...
157+
]
142158
}
159+
],
160+
"paragraphs": [
161+
{
162+
"content": "CONTOSO LTD.",
163+
"source": "D(1,0.5734,0.6563,2.335,0.6601,2.3345,0.8933,0.5729,0.8895)",
164+
"span": { "offset": 0, "length": 12 }
165+
},
166+
{
167+
"role": "title",
168+
"content": "INVOICE",
169+
"source": "D(1,7.0515,0.5614,8.0064,0.5628,8.006,0.791,7.0512,0.7897)",
170+
"span": { "offset": 15, "length": 9 }
171+
}, ...
172+
],
173+
"sections": [
174+
{
175+
"span": { "offset": 0, "length": 1649 },
176+
"elements": [ "/sections/1", "/sections/2" ]
177+
}, ...
178+
],
179+
"tables": [
180+
{
181+
"rowCount": 2,
182+
"columnCount": 6,
183+
"cells": [
184+
{
185+
"kind": "columnHeader",
186+
"rowIndex": 0,
187+
"columnIndex": 0,
188+
"rowSpan": 1,
189+
"columnSpan": 1,
190+
"content": "SALESPERSON",
191+
"source": "D(1,0.5389,4.5514,1.7505,4.5514,1.7505,4.8364,0.5389,4.8364)",
192+
"span": { "offset": 512, "length": 11 },
193+
"elements": [ "/paragraphs/19" ]
194+
}, ...
195+
],
196+
"source": "D(1,0.4885,4.5543,8.0163,4.5539,8.015,5.1207,0.4879,5.1209)",
197+
"span": { "offset": 495, "length": 228 }
198+
}, ...
143199
]
144200
}
145201
]
@@ -187,20 +243,41 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
187243

188244
```json
189245
{
190-
"id": "2e77aecc-b5f0-4652-b91c-4790b655ce01",
246+
"id": {resultId},
191247
"status": "Succeeded",
192248
"result": {
193249
"analyzerId": "prebuilt-audioAnalyzer",
194250
"apiVersion": "2025-05-01-preview",
195-
"createdAt": "2025-05-05T18:06:24Z",
251+
"createdAt": "YYYY-MM-DDTHH:MM:SSZ",
196252
"stringEncoding": "utf8",
197253
"warnings": [],
198254
"contents": [
199255
{
200-
"markdown": "# Audio: 00:00.000 => 01:54.670\n\nTranscript\n```\nWEBVTT\n\n00:00.080 --> 00:02.160\n<v Speaker 1>Thank you for calling Woodgrove Travel.\n\n00:02.960 --> 00:04.560\n<v Speaker 1>My name is Isabella Taylor ...",
256+
"markdown": "# Audio: 00:00.000 => 01:54.670\n\nTranscript\n```\nWEBVTT\n\n00:00.080 --> 00:02.160\n<v Speaker 1>Thank you for calling Woodgrove Travel...",
257+
"fields": {
258+
"Summary": {
259+
"type": "string",
260+
"valueString": "John Smith contacted Woodgrove Travel to report a negative experience with his flight from New York City to Los Angeles..."
261+
}
262+
},
201263
"kind": "audioVisual",
202264
"startTimeMs": 0,
203-
"endTimeMs": 114670
265+
"endTimeMs": 114670,
266+
"transcriptPhrases": [
267+
{
268+
"speaker": "Speaker 1",
269+
"startTimeMs": 80,
270+
"endTimeMs": 2160,
271+
"text": "Thank you for calling Woodgrove Travel.",
272+
"words": [
273+
{
274+
"startTimeMs": 80,
275+
"endTimeMs": 280,
276+
"text": "Thank"
277+
}, ...
278+
]
279+
}, ...
280+
]
204281
}
205282
]
206283
}
@@ -211,21 +288,56 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
211288

212289
```json
213290
{
214-
"id": "3fb3cca1-4cf1-4f2f-9155-8d1db4ef9541",
291+
"id": {resultId},
215292
"status": "Succeeded",
216293
"result": {
217294
"analyzerId": "prebuilt-videoAnalyzer",
218295
"apiVersion": "2025-05-01-preview",
219-
"createdAt": "2025-05-05T18:24:03Z",
296+
"createdAt": "YYYY-MM-DDTHH:MM:SSZ",
220297
"warnings": [],
221298
"contents": [
222299
{
223-
"markdown": "# Video: 00:00.000 => 00:43.866\nWidth: 1080\nHeight: 608\n\nTranscript\n```\nWEBVTT\n\n00:01.400 --> 00:06.560\n<Speaker 1 Speaker>When it comes to the neural TTS, in order to get a good voice, it's better to have good data ..."
300+
"markdown": "# Video: 00:00.000 => 00:43.866\nWidth: 1080\nHeight: 608\n\n## Segment 1: 00:00.000 => 00:07.367\nThe video begins with a scenic aerial view featuring the Flight Simulator and Microsoft Azure AI logos...\n\nTranscript\n```\nWEBVTT\n\n00:01.400 --> 00:06.560\n<Speaker 1 Speaker>When it comes to the neural TTS, in order to get a good voice, it's better to have good data.\n```\n\nKey Frames\n- 00:00.726 ![](keyFrame.726.jpg)...",
301+
"fields": {
302+
"Segments": {
303+
"type": "array",
304+
"valueArray": [
305+
{
306+
"type": "object",
307+
"valueObject": {
308+
"SegmentId": {
309+
"type": "string",
310+
"valueString": "1"
311+
}
312+
}
313+
}, ...
314+
]
315+
}
316+
},
224317
"kind": "audioVisual",
225318
"startTimeMs": 0,
226319
"endTimeMs": 43866,
227320
"width": 1080,
228-
"height": 608
321+
"height": 608,
322+
"KeyFrameTimesMs": [ 726, 2046, ... ],
323+
"transcriptPhrases": [
324+
{
325+
"speaker": "Speaker 1",
326+
"startTimeMs": 1400,
327+
"endTimeMs": 6560,
328+
"text": "When it comes to the neural TTS, in order to get a good voice, it's better to have good data.",
329+
"words": []
330+
}, ...
331+
],
332+
"cameraShotTimesMs": [ 1467, 3233, ... ],
333+
"segments": [
334+
{
335+
"startTimeMs": 0,
336+
"endTimeMs": 7367,
337+
"description": "The video begins with a scenic aerial view featuring the Flight Simulator and Microsoft Azure AI logos...",
338+
"segmentId": "1"
339+
}, ...
340+
]
229341
}
230342
]
231343
}

0 commit comments

Comments
 (0)