Skip to content

Commit 298c43c

Browse files
Merge pull request #1577 from bojunehsu/paulhsu/cu-rest-examples
Update use-rest-api.md examples.
2 parents 50c60d4 + 9a9ebd7 commit 298c43c

File tree

1 file changed

+67
-12
lines changed

1 file changed

+67
-12
lines changed

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

Lines changed: 67 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ First, create a JSON file named `request_body.json` with the following content:
4949
{
5050
"description": "Sample invoice analyzer",
5151
"scenario": "document",
52+
"config": {
53+
"returnDetails": true
54+
},
5255
"fieldSchema": {
5356
"fields": {
5457
"VendorName": {
@@ -153,9 +156,6 @@ First, create a JSON file named `request_body.json` with the following content:
153156
{
154157
"description": "Sample marketing video analyzer",
155158
"scenario": "videoShot",
156-
"config": {
157-
"returnDetails": true
158-
},
159159
"fieldSchema": {
160160
"fields": {
161161
"Description": {
@@ -278,12 +278,13 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
278278

279279
```json
280280
{
281-
"id": "f87e468b-d96b-488c-a646-33cc5823972f",
281+
"id": "bcf8c7c7-03ab-4204-b22c-2b34203ef5db",
282282
"status": "Succeeded",
283283
"result": {
284284
"analyzerId": "sample_invoice_analyzer",
285285
"apiVersion": "2024-12-01-preview",
286-
"createdAt": "2024-11-09T08:36:31Z",
286+
"createdAt": "2024-11-13T07:15:46Z",
287+
"warnings": [],
287288
"contents": [
288289
{
289290
"markdown": "CONTOSO LTD.\n\n\n# INVOICE\n\nContoso Headquarters...",
@@ -293,7 +294,7 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
293294
"valueString": "CONTOSO LTD.",
294295
"spans": [ { "offset": 0, "length": 12 } ],
295296
"confidence": 0.941,
296-
"source": "D(1,0.5729,0.6582,1.3353,0.6582,1.3353,0.8957,0.5729,0.8957)"
297+
"source": "D(1,0.5729,0.6582,2.3353,0.6582,2.3353,0.8957,0.5729,0.8957)"
297298
},
298299
"Items": {
299300
"type": "array",
@@ -306,14 +307,13 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
306307
"valueString": "Consulting Services",
307308
"spans": [ { "offset": 909, "length": 19 } ],
308309
"confidence": 0.971,
309-
"source": "D(1,1.3264,5.673,1.6413,5.673,1.6413,5.8402,1.3264,5.8402)"
310+
"source": "D(1,2.3264,5.673,3.6413,5.673,3.6413,5.8402,2.3264,5.8402)"
310311
},
311312
"Amount": {
312313
"type": "number",
313314
"valueNumber": 60,
314-
"spans": [ { "offset": 995, "length": 6 }
315-
],
316-
"confidence": 0.988,
315+
"spans": [ { "offset": 995, "length": 6 } ],
316+
"confidence": 0.989,
317317
"source": "D(1,7.4507,5.6684,7.9245,5.6684,7.9245,5.8323,7.4507,5.8323)"
318318
}
319319
}
@@ -330,8 +330,62 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
330330
"pageNumber": 1,
331331
"angle": -0.0039,
332332
"width": 8.5,
333-
"height": 11
333+
"height": 11,
334+
"spans": [ { "offset": 0, "length": 1650 } ],
335+
"words": [
336+
{
337+
"content": "CONTOSO",
338+
"span": { "offset": 0, "length": 7 },
339+
"confidence": 0.997,
340+
"source": "D(1,0.5739,0.6582,1.7446,0.6595,1.7434,0.8952,0.5729,0.8915)"
341+
}, ...
342+
],
343+
"lines": [
344+
{
345+
"content": "CONTOSO LTD.",
346+
"source": "D(1,0.5734,0.6563,2.335,0.6601,2.3345,0.8933,0.5729,0.8895)",
347+
"span": { "offset": 0, "length": 12 }
348+
}, ...
349+
]
334350
}
351+
],
352+
"paragraphs": [
353+
{
354+
"content": "CONTOSO LTD.",
355+
"source": "D(1,0.5734,0.6563,2.335,0.6601,2.3345,0.8933,0.5729,0.8895)",
356+
"span": { "offset": 0, "length": 12 }
357+
}, ...
358+
],
359+
"sections": [
360+
{
361+
"span": { "offset": 0, "length": 1649 },
362+
"elements": [ "/sections/1", "/sections/2" ]
363+
},
364+
{
365+
"span": { "offset": 0, "length": 12 },
366+
"elements": [ "/paragraphs/0" ]
367+
}, ...
368+
],
369+
"tables": [
370+
{
371+
"rowCount": 2,
372+
"columnCount": 6,
373+
"cells": [
374+
{
375+
"kind": "columnHeader",
376+
"rowIndex": 0,
377+
"columnIndex": 0,
378+
"rowSpan": 1,
379+
"columnSpan": 1,
380+
"content": "SALESPERSON",
381+
"source": "D(1,0.5389,4.5514,1.7505,4.5514,1.7505,4.8364,0.5389,4.8364)",
382+
"span": { "offset": 512, "length": 11 },
383+
"elements": [ "/paragraphs/19" ]
384+
}, ...
385+
],
386+
"source": "D(1,0.4885,4.5543,8.0163,4.5539,8.015,5.1207,0.4879,5.1209)",
387+
"span": { "offset": 495, "length": 228 }
388+
}, ...
335389
]
336390
}
337391
]
@@ -349,6 +403,7 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
349403
"analyzerId": "sample_chart_analyzer",
350404
"apiVersion": "2024-12-01-preview",
351405
"createdAt": "2024-11-09T08:41:00Z",
406+
"warnings": [],
352407
"contents": [
353408
{
354409
"markdown": "![image](image)\n",
@@ -389,6 +444,7 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
389444
"analyzerId": "sample_chart_analyzer",
390445
"apiVersion": "2024-12-01-preview",
391446
"createdAt": "2024-11-09T08:42:58Z",
447+
"warnings": [],
392448
"contents": [
393449
{
394450
"kind": "audioVisual",
@@ -449,7 +505,6 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
449505
# [Video](#tab/video)
450506

451507
```json
452-
453508
{
454509
"id": "204fb777-e961-4d6d-a6b1-6e02c773d72c",
455510
"status": "Succeeded",

0 commit comments

Comments
 (0)