cu-cli-core 0.1.0b1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,3643 @@
1
+ {
2
+ "swagger": "2.0",
3
+ "info": {
4
+ "title": "Content Understanding",
5
+ "version": "2025-11-01",
6
+ "description": "The Content Understanding service extracts content and fields from multimodal input.",
7
+ "x-typespec-generated": [
8
+ {
9
+ "emitter": "@azure-tools/typespec-autorest"
10
+ }
11
+ ]
12
+ },
13
+ "schemes": [
14
+ "https"
15
+ ],
16
+ "x-ms-parameterized-host": {
17
+ "hostTemplate": "{endpoint}/contentunderstanding",
18
+ "useSchemePrefix": false,
19
+ "parameters": [
20
+ {
21
+ "name": "endpoint",
22
+ "in": "path",
23
+ "description": "Content Understanding service endpoint.",
24
+ "required": true,
25
+ "type": "string",
26
+ "format": "uri",
27
+ "x-ms-skip-url-encoding": true
28
+ }
29
+ ]
30
+ },
31
+ "produces": [
32
+ "application/json"
33
+ ],
34
+ "consumes": [
35
+ "application/json"
36
+ ],
37
+ "security": [
38
+ {
39
+ "AzureKey": []
40
+ },
41
+ {
42
+ "EntraIdToken": [
43
+ "https://cognitiveservices.azure.com/.default"
44
+ ]
45
+ }
46
+ ],
47
+ "securityDefinitions": {
48
+ "AzureKey": {
49
+ "type": "apiKey",
50
+ "description": "Key-based authentication using the access key of the Azure resource.",
51
+ "name": "Ocp-Apim-Subscription-Key",
52
+ "in": "header"
53
+ },
54
+ "EntraIdToken": {
55
+ "type": "oauth2",
56
+ "description": "Microsoft Entra ID OAuth2 authentication using an access token.",
57
+ "flow": "accessCode",
58
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
59
+ "scopes": {
60
+ "https://cognitiveservices.azure.com/.default": ""
61
+ },
62
+ "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token"
63
+ }
64
+ },
65
+ "tags": [],
66
+ "paths": {
67
+ "/analyzerResults/{operationId}": {
68
+ "get": {
69
+ "operationId": "ContentAnalyzers_GetResult",
70
+ "description": "Get the result of an analysis operation.",
71
+ "parameters": [
72
+ {
73
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
74
+ },
75
+ {
76
+ "name": "operationId",
77
+ "in": "path",
78
+ "description": "The unique ID of the operation.",
79
+ "required": true,
80
+ "type": "string"
81
+ }
82
+ ],
83
+ "responses": {
84
+ "200": {
85
+ "description": "The request has succeeded.",
86
+ "schema": {
87
+ "$ref": "#/definitions/ContentAnalyzerAnalyzeOperationStatus"
88
+ }
89
+ },
90
+ "default": {
91
+ "description": "An unexpected error response.",
92
+ "schema": {
93
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
94
+ },
95
+ "headers": {
96
+ "x-ms-error-code": {
97
+ "type": "string",
98
+ "description": "String error code indicating what went wrong."
99
+ }
100
+ }
101
+ }
102
+ },
103
+ "x-ms-examples": {
104
+ "Get Analysis Result": {
105
+ "$ref": "./examples/ContentAnalyzers_GetResult.json"
106
+ }
107
+ }
108
+ },
109
+ "delete": {
110
+ "operationId": "ContentAnalyzers_DeleteResult",
111
+ "description": "Mark the result of an analysis operation for deletion.",
112
+ "parameters": [
113
+ {
114
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
115
+ },
116
+ {
117
+ "name": "operationId",
118
+ "in": "path",
119
+ "description": "Operation identifier.",
120
+ "required": true,
121
+ "type": "string"
122
+ }
123
+ ],
124
+ "responses": {
125
+ "204": {
126
+ "description": "There is no content to send for this request, but the headers may be useful."
127
+ },
128
+ "default": {
129
+ "description": "An unexpected error response.",
130
+ "schema": {
131
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
132
+ },
133
+ "headers": {
134
+ "x-ms-error-code": {
135
+ "type": "string",
136
+ "description": "String error code indicating what went wrong."
137
+ }
138
+ }
139
+ }
140
+ },
141
+ "x-ms-examples": {
142
+ "Delete Analyzer Result": {
143
+ "$ref": "./examples/ContentAnalyzers_DeleteResult.json"
144
+ }
145
+ }
146
+ }
147
+ },
148
+ "/analyzerResults/{operationId}/files/{path}": {
149
+ "get": {
150
+ "operationId": "ContentAnalyzers_GetResultFile",
151
+ "description": "Get a file associated with the result of an analysis operation.",
152
+ "produces": [
153
+ "*/*",
154
+ "application/json"
155
+ ],
156
+ "parameters": [
157
+ {
158
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
159
+ },
160
+ {
161
+ "name": "operationId",
162
+ "in": "path",
163
+ "description": "Operation identifier.",
164
+ "required": true,
165
+ "type": "string"
166
+ },
167
+ {
168
+ "name": "path",
169
+ "in": "path",
170
+ "description": "File path.",
171
+ "required": true,
172
+ "type": "string",
173
+ "x-ms-skip-url-encoding": true
174
+ }
175
+ ],
176
+ "responses": {
177
+ "200": {
178
+ "description": "The request has succeeded.",
179
+ "schema": {
180
+ "type": "file"
181
+ }
182
+ },
183
+ "default": {
184
+ "description": "An unexpected error response.",
185
+ "schema": {
186
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
187
+ },
188
+ "headers": {
189
+ "x-ms-error-code": {
190
+ "type": "string",
191
+ "description": "String error code indicating what went wrong."
192
+ }
193
+ }
194
+ }
195
+ },
196
+ "x-ms-examples": {
197
+ "Get Analysis Result File": {
198
+ "$ref": "./examples/ContentAnalyzers_GetResultFile.json"
199
+ }
200
+ }
201
+ }
202
+ },
203
+ "/analyzers": {
204
+ "get": {
205
+ "operationId": "ContentAnalyzers_List",
206
+ "description": "List analyzers.",
207
+ "parameters": [
208
+ {
209
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
210
+ },
211
+ {
212
+ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
213
+ }
214
+ ],
215
+ "responses": {
216
+ "200": {
217
+ "description": "The request has succeeded.",
218
+ "schema": {
219
+ "$ref": "#/definitions/PagedContentAnalyzer"
220
+ },
221
+ "headers": {
222
+ "x-ms-client-request-id": {
223
+ "type": "string",
224
+ "format": "uuid",
225
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
226
+ }
227
+ }
228
+ },
229
+ "default": {
230
+ "description": "An unexpected error response.",
231
+ "schema": {
232
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
233
+ },
234
+ "headers": {
235
+ "x-ms-error-code": {
236
+ "type": "string",
237
+ "description": "String error code indicating what went wrong."
238
+ }
239
+ }
240
+ }
241
+ },
242
+ "x-ms-examples": {
243
+ "List Analyzers": {
244
+ "$ref": "./examples/ContentAnalyzers_List.json"
245
+ }
246
+ },
247
+ "x-ms-pageable": {
248
+ "nextLinkName": "nextLink"
249
+ }
250
+ }
251
+ },
252
+ "/analyzers/{analyzerId}": {
253
+ "get": {
254
+ "operationId": "ContentAnalyzers_Get",
255
+ "description": "Get analyzer properties.",
256
+ "parameters": [
257
+ {
258
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
259
+ },
260
+ {
261
+ "name": "analyzerId",
262
+ "in": "path",
263
+ "description": "The unique identifier of the analyzer.",
264
+ "required": true,
265
+ "type": "string",
266
+ "minLength": 1,
267
+ "maxLength": 64,
268
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
269
+ },
270
+ {
271
+ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
272
+ }
273
+ ],
274
+ "responses": {
275
+ "200": {
276
+ "description": "The request has succeeded.",
277
+ "schema": {
278
+ "$ref": "#/definitions/ContentAnalyzer"
279
+ },
280
+ "headers": {
281
+ "x-ms-client-request-id": {
282
+ "type": "string",
283
+ "format": "uuid",
284
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
285
+ }
286
+ }
287
+ },
288
+ "default": {
289
+ "description": "An unexpected error response.",
290
+ "schema": {
291
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
292
+ },
293
+ "headers": {
294
+ "x-ms-error-code": {
295
+ "type": "string",
296
+ "description": "String error code indicating what went wrong."
297
+ }
298
+ }
299
+ }
300
+ },
301
+ "x-ms-examples": {
302
+ "Get Analyzer": {
303
+ "$ref": "./examples/ContentAnalyzers_GetAnalyzer.json"
304
+ }
305
+ }
306
+ },
307
+ "put": {
308
+ "operationId": "ContentAnalyzers_CreateOrReplace",
309
+ "description": "Create a new analyzer asynchronously.",
310
+ "parameters": [
311
+ {
312
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
313
+ },
314
+ {
315
+ "name": "analyzerId",
316
+ "in": "path",
317
+ "description": "The unique identifier of the analyzer.",
318
+ "required": true,
319
+ "type": "string",
320
+ "minLength": 1,
321
+ "maxLength": 64,
322
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
323
+ },
324
+ {
325
+ "name": "allowReplace",
326
+ "in": "query",
327
+ "description": "Allow the operation to replace an existing resource.",
328
+ "required": false,
329
+ "type": "boolean",
330
+ "default": false
331
+ },
332
+ {
333
+ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
334
+ },
335
+ {
336
+ "name": "resource",
337
+ "in": "body",
338
+ "description": "The resource instance.",
339
+ "required": true,
340
+ "schema": {
341
+ "$ref": "#/definitions/ContentAnalyzer"
342
+ }
343
+ }
344
+ ],
345
+ "responses": {
346
+ "200": {
347
+ "description": "The request has succeeded.",
348
+ "schema": {
349
+ "$ref": "#/definitions/ContentAnalyzer"
350
+ },
351
+ "headers": {
352
+ "Operation-Location": {
353
+ "type": "string",
354
+ "format": "uri",
355
+ "description": "The location for monitoring the operation state."
356
+ },
357
+ "x-ms-client-request-id": {
358
+ "type": "string",
359
+ "format": "uuid",
360
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
361
+ }
362
+ }
363
+ },
364
+ "201": {
365
+ "description": "The request has succeeded and a new resource has been created as a result.",
366
+ "schema": {
367
+ "$ref": "#/definitions/ContentAnalyzer"
368
+ },
369
+ "headers": {
370
+ "Operation-Location": {
371
+ "type": "string",
372
+ "format": "uri",
373
+ "description": "The location for monitoring the operation state."
374
+ },
375
+ "x-ms-client-request-id": {
376
+ "type": "string",
377
+ "format": "uuid",
378
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
379
+ }
380
+ }
381
+ },
382
+ "default": {
383
+ "description": "An unexpected error response.",
384
+ "schema": {
385
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
386
+ },
387
+ "headers": {
388
+ "x-ms-error-code": {
389
+ "type": "string",
390
+ "description": "String error code indicating what went wrong."
391
+ }
392
+ }
393
+ }
394
+ },
395
+ "x-ms-examples": {
396
+ "Create or Replace Analyzer": {
397
+ "$ref": "./examples/ContentAnalyzers_CreateOrReplace.json"
398
+ }
399
+ },
400
+ "x-ms-long-running-operation": true
401
+ },
402
+ "patch": {
403
+ "operationId": "ContentAnalyzers_Update",
404
+ "description": "Update analyzer properties.",
405
+ "consumes": [
406
+ "application/merge-patch+json"
407
+ ],
408
+ "parameters": [
409
+ {
410
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
411
+ },
412
+ {
413
+ "name": "analyzerId",
414
+ "in": "path",
415
+ "description": "The unique identifier of the analyzer.",
416
+ "required": true,
417
+ "type": "string",
418
+ "minLength": 1,
419
+ "maxLength": 64,
420
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
421
+ },
422
+ {
423
+ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
424
+ },
425
+ {
426
+ "name": "resource",
427
+ "in": "body",
428
+ "description": "The resource instance.",
429
+ "required": true,
430
+ "schema": {
431
+ "$ref": "#/definitions/ContentAnalyzerUpdate"
432
+ }
433
+ }
434
+ ],
435
+ "responses": {
436
+ "200": {
437
+ "description": "The request has succeeded.",
438
+ "schema": {
439
+ "$ref": "#/definitions/ContentAnalyzer"
440
+ },
441
+ "headers": {
442
+ "x-ms-client-request-id": {
443
+ "type": "string",
444
+ "format": "uuid",
445
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
446
+ }
447
+ }
448
+ },
449
+ "default": {
450
+ "description": "An unexpected error response.",
451
+ "schema": {
452
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
453
+ },
454
+ "headers": {
455
+ "x-ms-error-code": {
456
+ "type": "string",
457
+ "description": "String error code indicating what went wrong."
458
+ }
459
+ }
460
+ }
461
+ },
462
+ "x-ms-examples": {
463
+ "Update Analyzer": {
464
+ "$ref": "./examples/ContentAnalyzers_Update.json"
465
+ }
466
+ }
467
+ },
468
+ "delete": {
469
+ "operationId": "ContentAnalyzers_Delete",
470
+ "description": "Delete analyzer.",
471
+ "parameters": [
472
+ {
473
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
474
+ },
475
+ {
476
+ "name": "analyzerId",
477
+ "in": "path",
478
+ "description": "The unique identifier of the analyzer.",
479
+ "required": true,
480
+ "type": "string",
481
+ "minLength": 1,
482
+ "maxLength": 64,
483
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
484
+ },
485
+ {
486
+ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
487
+ }
488
+ ],
489
+ "responses": {
490
+ "204": {
491
+ "description": "There is no content to send for this request, but the headers may be useful. ",
492
+ "headers": {
493
+ "x-ms-client-request-id": {
494
+ "type": "string",
495
+ "format": "uuid",
496
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
497
+ }
498
+ }
499
+ },
500
+ "default": {
501
+ "description": "An unexpected error response.",
502
+ "schema": {
503
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
504
+ },
505
+ "headers": {
506
+ "x-ms-error-code": {
507
+ "type": "string",
508
+ "description": "String error code indicating what went wrong."
509
+ }
510
+ }
511
+ }
512
+ },
513
+ "x-ms-examples": {
514
+ "Delete Analyzer": {
515
+ "$ref": "./examples/ContentAnalyzers_DeleteAnalyzer.json"
516
+ }
517
+ }
518
+ }
519
+ },
520
+ "/analyzers/{analyzerId}:analyze": {
521
+ "post": {
522
+ "operationId": "ContentAnalyzers_Analyze",
523
+ "description": "Extract content and fields from input.",
524
+ "parameters": [
525
+ {
526
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
527
+ },
528
+ {
529
+ "name": "analyzerId",
530
+ "in": "path",
531
+ "description": "The unique identifier of the analyzer.",
532
+ "required": true,
533
+ "type": "string",
534
+ "minLength": 1,
535
+ "maxLength": 64,
536
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
537
+ },
538
+ {
539
+ "$ref": "#/parameters/AnalyzeParameters.stringEncoding"
540
+ },
541
+ {
542
+ "$ref": "#/parameters/AnalyzeParameters.processingLocation"
543
+ },
544
+ {
545
+ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
546
+ },
547
+ {
548
+ "name": "body",
549
+ "in": "body",
550
+ "required": true,
551
+ "schema": {
552
+ "$ref": "#/definitions/AnalyzeRequest"
553
+ }
554
+ }
555
+ ],
556
+ "responses": {
557
+ "202": {
558
+ "description": "The request has been accepted for processing, but processing has not yet completed.",
559
+ "schema": {
560
+ "$ref": "#/definitions/ContentAnalyzerAnalyzeOperationStatus"
561
+ },
562
+ "headers": {
563
+ "Operation-Location": {
564
+ "type": "string",
565
+ "format": "uri",
566
+ "description": "The location for monitoring the operation state."
567
+ },
568
+ "x-ms-client-request-id": {
569
+ "type": "string",
570
+ "format": "uuid",
571
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
572
+ }
573
+ }
574
+ },
575
+ "default": {
576
+ "description": "An unexpected error response.",
577
+ "schema": {
578
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
579
+ },
580
+ "headers": {
581
+ "x-ms-error-code": {
582
+ "type": "string",
583
+ "description": "String error code indicating what went wrong."
584
+ }
585
+ }
586
+ }
587
+ },
588
+ "x-ms-examples": {
589
+ "Analyze URL": {
590
+ "$ref": "./examples/ContentAnalyzers_Analyze.json"
591
+ }
592
+ },
593
+ "x-ms-long-running-operation": true
594
+ }
595
+ },
596
+ "/analyzers/{analyzerId}:analyzeBinary": {
597
+ "post": {
598
+ "operationId": "ContentAnalyzers_AnalyzeBinary",
599
+ "description": "Extract content and fields from input.",
600
+ "consumes": [
601
+ "*/*"
602
+ ],
603
+ "parameters": [
604
+ {
605
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
606
+ },
607
+ {
608
+ "name": "analyzerId",
609
+ "in": "path",
610
+ "description": "The unique identifier of the analyzer.",
611
+ "required": true,
612
+ "type": "string",
613
+ "minLength": 1,
614
+ "maxLength": 64,
615
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
616
+ },
617
+ {
618
+ "$ref": "#/parameters/AnalyzeParameters.stringEncoding"
619
+ },
620
+ {
621
+ "$ref": "#/parameters/AnalyzeParameters.processingLocation"
622
+ },
623
+ {
624
+ "$ref": "#/parameters/AnalyzeBinaryRequest.range"
625
+ },
626
+ {
627
+ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
628
+ },
629
+ {
630
+ "$ref": "#/parameters/AnalyzeBinaryRequest.input"
631
+ }
632
+ ],
633
+ "responses": {
634
+ "202": {
635
+ "description": "The request has been accepted for processing, but processing has not yet completed.",
636
+ "schema": {
637
+ "$ref": "#/definitions/ContentAnalyzerAnalyzeOperationStatus"
638
+ },
639
+ "headers": {
640
+ "Operation-Location": {
641
+ "type": "string",
642
+ "format": "uri",
643
+ "description": "The location for monitoring the operation state."
644
+ },
645
+ "x-ms-client-request-id": {
646
+ "type": "string",
647
+ "format": "uuid",
648
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
649
+ }
650
+ }
651
+ },
652
+ "default": {
653
+ "description": "An unexpected error response.",
654
+ "schema": {
655
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
656
+ },
657
+ "headers": {
658
+ "x-ms-error-code": {
659
+ "type": "string",
660
+ "description": "String error code indicating what went wrong."
661
+ }
662
+ }
663
+ }
664
+ },
665
+ "x-ms-examples": {
666
+ "Analyze File": {
667
+ "$ref": "./examples/ContentAnalyzers_AnalyzeBinary.json"
668
+ }
669
+ },
670
+ "x-ms-long-running-operation": true
671
+ }
672
+ },
673
+ "/analyzers/{analyzerId}:copy": {
674
+ "post": {
675
+ "operationId": "ContentAnalyzers_Copy",
676
+ "description": "Create a copy of the source analyzer to the current location.",
677
+ "parameters": [
678
+ {
679
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
680
+ },
681
+ {
682
+ "name": "analyzerId",
683
+ "in": "path",
684
+ "description": "The unique identifier of the analyzer.",
685
+ "required": true,
686
+ "type": "string",
687
+ "minLength": 1,
688
+ "maxLength": 64,
689
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
690
+ },
691
+ {
692
+ "name": "allowReplace",
693
+ "in": "query",
694
+ "description": "Allow the operation to replace an existing resource.",
695
+ "required": false,
696
+ "type": "boolean",
697
+ "default": false
698
+ },
699
+ {
700
+ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
701
+ },
702
+ {
703
+ "name": "body",
704
+ "in": "body",
705
+ "required": true,
706
+ "schema": {
707
+ "$ref": "#/definitions/CopyRequest"
708
+ }
709
+ }
710
+ ],
711
+ "responses": {
712
+ "200": {
713
+ "description": "The request has succeeded.",
714
+ "schema": {
715
+ "$ref": "#/definitions/ContentAnalyzer"
716
+ },
717
+ "headers": {
718
+ "Operation-Location": {
719
+ "type": "string",
720
+ "format": "uri",
721
+ "description": "The location for monitoring the operation state."
722
+ },
723
+ "x-ms-client-request-id": {
724
+ "type": "string",
725
+ "format": "uuid",
726
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
727
+ }
728
+ }
729
+ },
730
+ "201": {
731
+ "description": "The request has succeeded and a new resource has been created as a result.",
732
+ "schema": {
733
+ "$ref": "#/definitions/ContentAnalyzer"
734
+ },
735
+ "headers": {
736
+ "Operation-Location": {
737
+ "type": "string",
738
+ "format": "uri",
739
+ "description": "The location for monitoring the operation state."
740
+ },
741
+ "x-ms-client-request-id": {
742
+ "type": "string",
743
+ "format": "uuid",
744
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
745
+ }
746
+ }
747
+ },
748
+ "default": {
749
+ "description": "An unexpected error response.",
750
+ "schema": {
751
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
752
+ },
753
+ "headers": {
754
+ "x-ms-error-code": {
755
+ "type": "string",
756
+ "description": "String error code indicating what went wrong."
757
+ }
758
+ }
759
+ }
760
+ },
761
+ "x-ms-examples": {
762
+ "Copy Analyzer": {
763
+ "$ref": "./examples/ContentAnalyzers_Copy.json"
764
+ }
765
+ },
766
+ "x-ms-long-running-operation": true
767
+ }
768
+ },
769
+ "/analyzers/{analyzerId}:grantCopyAuthorization": {
770
+ "post": {
771
+ "operationId": "ContentAnalyzers_GrantCopyAuthorization",
772
+ "description": "Get authorization for copying this analyzer to another location.",
773
+ "parameters": [
774
+ {
775
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
776
+ },
777
+ {
778
+ "name": "analyzerId",
779
+ "in": "path",
780
+ "description": "The unique identifier of the analyzer.",
781
+ "required": true,
782
+ "type": "string",
783
+ "minLength": 1,
784
+ "maxLength": 64,
785
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
786
+ },
787
+ {
788
+ "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
789
+ },
790
+ {
791
+ "name": "body",
792
+ "in": "body",
793
+ "required": true,
794
+ "schema": {
795
+ "$ref": "#/definitions/GrantCopyAuthorizationRequest"
796
+ }
797
+ }
798
+ ],
799
+ "responses": {
800
+ "200": {
801
+ "description": "The request has succeeded.",
802
+ "schema": {
803
+ "$ref": "#/definitions/CopyAuthorization"
804
+ },
805
+ "headers": {
806
+ "x-ms-client-request-id": {
807
+ "type": "string",
808
+ "format": "uuid",
809
+ "description": "An opaque, globally-unique, client-generated string identifier for the request."
810
+ }
811
+ }
812
+ },
813
+ "default": {
814
+ "description": "An unexpected error response.",
815
+ "schema": {
816
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
817
+ },
818
+ "headers": {
819
+ "x-ms-error-code": {
820
+ "type": "string",
821
+ "description": "String error code indicating what went wrong."
822
+ }
823
+ }
824
+ }
825
+ },
826
+ "x-ms-examples": {
827
+ "Grant Copy Authorization": {
828
+ "$ref": "./examples/ContentAnalyzers_GrantCopyAuthorization.json"
829
+ }
830
+ }
831
+ }
832
+ },
833
+ "/analyzers/{analyzerId}/operations/{operationId}": {
834
+ "get": {
835
+ "operationId": "ContentAnalyzers_GetOperationStatus",
836
+ "description": "Get the status of an analyzer creation operation.",
837
+ "parameters": [
838
+ {
839
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
840
+ },
841
+ {
842
+ "name": "analyzerId",
843
+ "in": "path",
844
+ "description": "The unique identifier of the analyzer.",
845
+ "required": true,
846
+ "type": "string",
847
+ "minLength": 1,
848
+ "maxLength": 64,
849
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
850
+ },
851
+ {
852
+ "name": "operationId",
853
+ "in": "path",
854
+ "description": "The unique ID of the operation.",
855
+ "required": true,
856
+ "type": "string"
857
+ }
858
+ ],
859
+ "responses": {
860
+ "200": {
861
+ "description": "The request has succeeded.",
862
+ "schema": {
863
+ "$ref": "#/definitions/ContentAnalyzerOperationStatus"
864
+ }
865
+ },
866
+ "default": {
867
+ "description": "An unexpected error response.",
868
+ "schema": {
869
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
870
+ },
871
+ "headers": {
872
+ "x-ms-error-code": {
873
+ "type": "string",
874
+ "description": "String error code indicating what went wrong."
875
+ }
876
+ }
877
+ }
878
+ },
879
+ "x-ms-examples": {
880
+ "Get Analyzer Operation Status": {
881
+ "$ref": "./examples/ContentAnalyzers_GetOperationStatus.json"
882
+ }
883
+ }
884
+ }
885
+ },
886
+ "/defaults": {
887
+ "get": {
888
+ "operationId": "ContentAnalyzers_GetDefaults",
889
+ "description": "Return default settings for this Content Understanding resource.",
890
+ "parameters": [
891
+ {
892
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
893
+ }
894
+ ],
895
+ "responses": {
896
+ "200": {
897
+ "description": "The request has succeeded.",
898
+ "schema": {
899
+ "$ref": "#/definitions/ContentUnderstandingDefaults"
900
+ }
901
+ },
902
+ "default": {
903
+ "description": "An unexpected error response.",
904
+ "schema": {
905
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
906
+ },
907
+ "headers": {
908
+ "x-ms-error-code": {
909
+ "type": "string",
910
+ "description": "String error code indicating what went wrong."
911
+ }
912
+ }
913
+ }
914
+ },
915
+ "x-ms-examples": {
916
+ "Get Defaults": {
917
+ "$ref": "./examples/ContentAnalyzers_GetDefaults.json"
918
+ }
919
+ }
920
+ },
921
+ "patch": {
922
+ "operationId": "ContentAnalyzers_UpdateDefaults",
923
+ "description": "Update default settings for this Content Understanding resource.",
924
+ "consumes": [
925
+ "application/merge-patch+json"
926
+ ],
927
+ "parameters": [
928
+ {
929
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
930
+ },
931
+ {
932
+ "name": "body",
933
+ "in": "body",
934
+ "required": true,
935
+ "schema": {
936
+ "$ref": "#/definitions/ContentUnderstandingDefaultsMergePatchUpdate"
937
+ }
938
+ }
939
+ ],
940
+ "responses": {
941
+ "200": {
942
+ "description": "The request has succeeded.",
943
+ "schema": {
944
+ "$ref": "#/definitions/ContentUnderstandingDefaults"
945
+ }
946
+ },
947
+ "default": {
948
+ "description": "An unexpected error response.",
949
+ "schema": {
950
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
951
+ },
952
+ "headers": {
953
+ "x-ms-error-code": {
954
+ "type": "string",
955
+ "description": "String error code indicating what went wrong."
956
+ }
957
+ }
958
+ }
959
+ },
960
+ "x-ms-examples": {
961
+ "Update Defaults": {
962
+ "$ref": "./examples/ContentAnalyzers_UpdateDefaults.json"
963
+ }
964
+ }
965
+ }
966
+ }
967
+ },
968
+ "definitions": {
969
+ "AnalysisContent": {
970
+ "type": "object",
971
+ "description": "Media content base class.",
972
+ "properties": {
973
+ "kind": {
974
+ "$ref": "#/definitions/AnalysisContentKind",
975
+ "description": "Content kind."
976
+ },
977
+ "mimeType": {
978
+ "type": "string",
979
+ "description": "Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc."
980
+ },
981
+ "analyzerId": {
982
+ "type": "string",
983
+ "description": "The analyzer that generated this content.",
984
+ "minLength": 1,
985
+ "maxLength": 64,
986
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
987
+ },
988
+ "category": {
989
+ "type": "string",
990
+ "description": "Classified content category."
991
+ },
992
+ "path": {
993
+ "type": "string",
994
+ "description": "The path of the content in the input."
995
+ },
996
+ "markdown": {
997
+ "type": "string",
998
+ "description": "Markdown representation of the content."
999
+ },
1000
+ "fields": {
1001
+ "type": "object",
1002
+ "description": "Extracted fields from the content.",
1003
+ "additionalProperties": {
1004
+ "$ref": "#/definitions/ContentField"
1005
+ }
1006
+ }
1007
+ },
1008
+ "discriminator": "kind",
1009
+ "required": [
1010
+ "kind",
1011
+ "mimeType"
1012
+ ]
1013
+ },
1014
+ "AnalysisContentKind": {
1015
+ "type": "string",
1016
+ "description": "Kind of media content.",
1017
+ "enum": [
1018
+ "document",
1019
+ "audioVisual"
1020
+ ],
1021
+ "x-ms-enum": {
1022
+ "name": "AnalysisContentKind",
1023
+ "modelAsString": true,
1024
+ "values": [
1025
+ {
1026
+ "name": "document",
1027
+ "value": "document",
1028
+ "description": "Document content, such as pdf, image, txt, etc."
1029
+ },
1030
+ {
1031
+ "name": "audioVisual",
1032
+ "value": "audioVisual",
1033
+ "description": "Audio visual content, such as mp3, mp4, etc."
1034
+ }
1035
+ ]
1036
+ }
1037
+ },
1038
+ "AnalysisInput": {
1039
+ "type": "object",
1040
+ "description": "Additional input to analyze.",
1041
+ "properties": {
1042
+ "url": {
1043
+ "type": "string",
1044
+ "format": "uri",
1045
+ "description": "The URL of the input to analyze. Only one of url or data should be specified."
1046
+ },
1047
+ "data": {
1048
+ "type": "string",
1049
+ "format": "byte",
1050
+ "description": "Base64-encoded binary content of the input to analyze. Only one of url or data should be specified."
1051
+ },
1052
+ "name": {
1053
+ "type": "string",
1054
+ "description": "Name of the input."
1055
+ },
1056
+ "mimeType": {
1057
+ "type": "string",
1058
+ "description": "The MIME type of the input content. Ex. application/pdf, image/jpeg, etc."
1059
+ },
1060
+ "range": {
1061
+ "$ref": "#/definitions/RangeExpression",
1062
+ "description": "Range of the input to analyze (ex. `1-3,5,9-`). Document content uses 1-based page numbers, while audio visual content uses integer milliseconds."
1063
+ }
1064
+ }
1065
+ },
1066
+ "AnalysisResult": {
1067
+ "type": "object",
1068
+ "description": "Analyze operation result.",
1069
+ "properties": {
1070
+ "analyzerId": {
1071
+ "type": "string",
1072
+ "description": "The unique identifier of the analyzer.",
1073
+ "minLength": 1,
1074
+ "maxLength": 64,
1075
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
1076
+ },
1077
+ "apiVersion": {
1078
+ "type": "string",
1079
+ "description": "The version of the API used to analyze the document."
1080
+ },
1081
+ "createdAt": {
1082
+ "type": "string",
1083
+ "format": "date-time",
1084
+ "description": "The date and time when the result was created."
1085
+ },
1086
+ "warnings": {
1087
+ "type": "array",
1088
+ "description": "Warnings encountered while analyzing the document.",
1089
+ "items": {
1090
+ "$ref": "#/definitions/Azure.Core.Foundations.Error"
1091
+ }
1092
+ },
1093
+ "stringEncoding": {
1094
+ "type": "string",
1095
+ "description": " The string encoding format for content spans in the response.\n Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.\")",
1096
+ "default": "codePoint"
1097
+ },
1098
+ "contents": {
1099
+ "type": "array",
1100
+ "description": "The extracted content.",
1101
+ "items": {
1102
+ "$ref": "#/definitions/AnalysisContent"
1103
+ }
1104
+ }
1105
+ },
1106
+ "required": [
1107
+ "contents"
1108
+ ]
1109
+ },
1110
+ "AnalyzeRequest": {
1111
+ "type": "object",
1112
+ "description": "Analyze operation request.",
1113
+ "properties": {
1114
+ "inputs": {
1115
+ "type": "array",
1116
+ "description": "Inputs to analyze. Currently, only pro mode supports multiple inputs.",
1117
+ "items": {
1118
+ "$ref": "#/definitions/AnalysisInput"
1119
+ }
1120
+ },
1121
+ "modelDeployments": {
1122
+ "type": "object",
1123
+ "description": "Specify the default mapping of model names to LLM/embedding deployments in Microsoft Foundry. For details and current semantics, see https://aka.ms/cudoc-quickstart-rest.",
1124
+ "additionalProperties": {
1125
+ "type": "string"
1126
+ }
1127
+ }
1128
+ },
1129
+ "required": [
1130
+ "inputs"
1131
+ ]
1132
+ },
1133
+ "ArrayField": {
1134
+ "type": "object",
1135
+ "description": "Array field extracted from the content.",
1136
+ "properties": {
1137
+ "valueArray": {
1138
+ "type": "array",
1139
+ "description": "Array field value.",
1140
+ "items": {
1141
+ "$ref": "#/definitions/ContentField"
1142
+ }
1143
+ }
1144
+ },
1145
+ "allOf": [
1146
+ {
1147
+ "$ref": "#/definitions/ContentField"
1148
+ }
1149
+ ],
1150
+ "x-ms-discriminator-value": "array"
1151
+ },
1152
+ "AudioVisualContent": {
1153
+ "type": "object",
1154
+ "description": "Audio visual content. Ex. audio/wav, video/mp4.",
1155
+ "properties": {
1156
+ "startTimeMs": {
1157
+ "type": "integer",
1158
+ "format": "int64",
1159
+ "description": "Start time of the content in milliseconds."
1160
+ },
1161
+ "endTimeMs": {
1162
+ "type": "integer",
1163
+ "format": "int64",
1164
+ "description": "End time of the content in milliseconds."
1165
+ },
1166
+ "width": {
1167
+ "type": "integer",
1168
+ "format": "int32",
1169
+ "description": "Width of each video frame in pixels, if applicable."
1170
+ },
1171
+ "height": {
1172
+ "type": "integer",
1173
+ "format": "int32",
1174
+ "description": "Height of each video frame in pixels, if applicable."
1175
+ },
1176
+ "cameraShotTimesMs": {
1177
+ "type": "array",
1178
+ "description": "List of camera shot changes in the video, represented by its timestamp in milliseconds. Only if returnDetails is true.",
1179
+ "items": {
1180
+ "type": "integer",
1181
+ "format": "int64"
1182
+ }
1183
+ },
1184
+ "keyFrameTimesMs": {
1185
+ "type": "array",
1186
+ "description": "List of key frames in the video, represented by its timestamp in milliseconds. Only if returnDetails is true.",
1187
+ "items": {
1188
+ "type": "integer",
1189
+ "format": "int64"
1190
+ }
1191
+ },
1192
+ "transcriptPhrases": {
1193
+ "type": "array",
1194
+ "description": "List of transcript phrases. Only if returnDetails is true.",
1195
+ "items": {
1196
+ "$ref": "#/definitions/TranscriptPhrase"
1197
+ }
1198
+ },
1199
+ "segments": {
1200
+ "type": "array",
1201
+ "description": "List of detected content segments. Only if enableSegment is true.",
1202
+ "items": {
1203
+ "$ref": "#/definitions/AudioVisualContentSegment"
1204
+ }
1205
+ }
1206
+ },
1207
+ "required": [
1208
+ "startTimeMs",
1209
+ "endTimeMs"
1210
+ ],
1211
+ "allOf": [
1212
+ {
1213
+ "$ref": "#/definitions/AnalysisContent"
1214
+ }
1215
+ ],
1216
+ "x-ms-discriminator-value": "audioVisual"
1217
+ },
1218
+ "AudioVisualContentSegment": {
1219
+ "type": "object",
1220
+ "description": "Detected audio/visual content segment.",
1221
+ "properties": {
1222
+ "segmentId": {
1223
+ "type": "string",
1224
+ "description": "Segment identifier."
1225
+ },
1226
+ "category": {
1227
+ "type": "string",
1228
+ "description": "Classified content category."
1229
+ },
1230
+ "span": {
1231
+ "$ref": "#/definitions/ContentSpan",
1232
+ "description": "Span of the segment in the markdown content."
1233
+ },
1234
+ "startTimeMs": {
1235
+ "type": "integer",
1236
+ "format": "int64",
1237
+ "description": "Start time of the segment in milliseconds."
1238
+ },
1239
+ "endTimeMs": {
1240
+ "type": "integer",
1241
+ "format": "int64",
1242
+ "description": "End time of the segment in milliseconds."
1243
+ }
1244
+ },
1245
+ "required": [
1246
+ "segmentId",
1247
+ "category",
1248
+ "span",
1249
+ "startTimeMs",
1250
+ "endTimeMs"
1251
+ ]
1252
+ },
1253
+ "Azure.Core.Foundations.Error": {
1254
+ "type": "object",
1255
+ "description": "The error object.",
1256
+ "properties": {
1257
+ "code": {
1258
+ "type": "string",
1259
+ "description": "One of a server-defined set of error codes."
1260
+ },
1261
+ "message": {
1262
+ "type": "string",
1263
+ "description": "A human-readable representation of the error."
1264
+ },
1265
+ "target": {
1266
+ "type": "string",
1267
+ "description": "The target of the error."
1268
+ },
1269
+ "details": {
1270
+ "type": "array",
1271
+ "description": "An array of details about specific errors that led to this reported error.",
1272
+ "items": {
1273
+ "$ref": "#/definitions/Azure.Core.Foundations.Error"
1274
+ }
1275
+ },
1276
+ "innererror": {
1277
+ "$ref": "#/definitions/Azure.Core.Foundations.InnerError",
1278
+ "description": "An object containing more specific information than the current object about the error."
1279
+ }
1280
+ },
1281
+ "required": [
1282
+ "code",
1283
+ "message"
1284
+ ]
1285
+ },
1286
+ "Azure.Core.Foundations.ErrorResponse": {
1287
+ "type": "object",
1288
+ "description": "A response containing error details.",
1289
+ "properties": {
1290
+ "error": {
1291
+ "$ref": "#/definitions/Azure.Core.Foundations.Error",
1292
+ "description": "The error object."
1293
+ }
1294
+ },
1295
+ "required": [
1296
+ "error"
1297
+ ]
1298
+ },
1299
+ "Azure.Core.Foundations.InnerError": {
1300
+ "type": "object",
1301
+ "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.",
1302
+ "properties": {
1303
+ "code": {
1304
+ "type": "string",
1305
+ "description": "One of a server-defined set of error codes."
1306
+ },
1307
+ "innererror": {
1308
+ "$ref": "#/definitions/Azure.Core.Foundations.InnerError",
1309
+ "description": "Inner error."
1310
+ }
1311
+ }
1312
+ },
1313
+ "Azure.Core.Foundations.OperationState": {
1314
+ "type": "string",
1315
+ "description": "Enum describing allowed operation states.",
1316
+ "enum": [
1317
+ "NotStarted",
1318
+ "Running",
1319
+ "Succeeded",
1320
+ "Failed",
1321
+ "Canceled"
1322
+ ],
1323
+ "x-ms-enum": {
1324
+ "name": "OperationState",
1325
+ "modelAsString": true,
1326
+ "values": [
1327
+ {
1328
+ "name": "NotStarted",
1329
+ "value": "NotStarted",
1330
+ "description": "The operation has not started."
1331
+ },
1332
+ {
1333
+ "name": "Running",
1334
+ "value": "Running",
1335
+ "description": "The operation is in progress."
1336
+ },
1337
+ {
1338
+ "name": "Succeeded",
1339
+ "value": "Succeeded",
1340
+ "description": "The operation has completed successfully."
1341
+ },
1342
+ {
1343
+ "name": "Failed",
1344
+ "value": "Failed",
1345
+ "description": "The operation has failed."
1346
+ },
1347
+ {
1348
+ "name": "Canceled",
1349
+ "value": "Canceled",
1350
+ "description": "The operation has been canceled by the user."
1351
+ }
1352
+ ]
1353
+ }
1354
+ },
1355
+ "BooleanField": {
1356
+ "type": "object",
1357
+ "description": "Boolean field extracted from the content.",
1358
+ "properties": {
1359
+ "valueBoolean": {
1360
+ "type": "boolean",
1361
+ "description": "Boolean field value."
1362
+ }
1363
+ },
1364
+ "allOf": [
1365
+ {
1366
+ "$ref": "#/definitions/ContentField"
1367
+ }
1368
+ ],
1369
+ "x-ms-discriminator-value": "boolean"
1370
+ },
1371
+ "ContentAnalyzer": {
1372
+ "type": "object",
1373
+ "description": "Analyzer that extracts content and fields from multimodal documents.",
1374
+ "properties": {
1375
+ "analyzerId": {
1376
+ "type": "string",
1377
+ "description": "The unique identifier of the analyzer.",
1378
+ "minLength": 1,
1379
+ "maxLength": 64,
1380
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$",
1381
+ "readOnly": true
1382
+ },
1383
+ "description": {
1384
+ "type": "string",
1385
+ "description": "A description of the analyzer."
1386
+ },
1387
+ "tags": {
1388
+ "type": "object",
1389
+ "description": "Tags associated with the analyzer.",
1390
+ "additionalProperties": {
1391
+ "type": "string"
1392
+ }
1393
+ },
1394
+ "status": {
1395
+ "$ref": "#/definitions/ContentAnalyzerStatus",
1396
+ "description": "The status of the analyzer.",
1397
+ "readOnly": true
1398
+ },
1399
+ "createdAt": {
1400
+ "type": "string",
1401
+ "format": "date-time",
1402
+ "description": "The date and time when the analyzer was created.",
1403
+ "readOnly": true
1404
+ },
1405
+ "lastModifiedAt": {
1406
+ "type": "string",
1407
+ "format": "date-time",
1408
+ "description": "The date and time when the analyzer was last modified.",
1409
+ "readOnly": true
1410
+ },
1411
+ "warnings": {
1412
+ "type": "array",
1413
+ "description": "Warnings encountered while creating the analyzer.",
1414
+ "items": {
1415
+ "$ref": "#/definitions/Azure.Core.Foundations.Error"
1416
+ },
1417
+ "readOnly": true
1418
+ },
1419
+ "baseAnalyzerId": {
1420
+ "type": "string",
1421
+ "description": "The analyzer to incrementally train from.",
1422
+ "minLength": 1,
1423
+ "maxLength": 64,
1424
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$",
1425
+ "x-ms-mutability": [
1426
+ "read",
1427
+ "create"
1428
+ ]
1429
+ },
1430
+ "config": {
1431
+ "$ref": "#/definitions/ContentAnalyzerConfig",
1432
+ "description": "Analyzer configuration settings.",
1433
+ "x-ms-mutability": [
1434
+ "read",
1435
+ "create"
1436
+ ]
1437
+ },
1438
+ "fieldSchema": {
1439
+ "$ref": "#/definitions/ContentFieldSchema",
1440
+ "description": "The schema of fields to extracted.",
1441
+ "x-ms-mutability": [
1442
+ "read",
1443
+ "create"
1444
+ ]
1445
+ },
1446
+ "dynamicFieldSchema": {
1447
+ "type": "boolean",
1448
+ "description": "Indicates whether the result may contain additional fields outside of the defined schema.",
1449
+ "default": false,
1450
+ "x-ms-mutability": [
1451
+ "read",
1452
+ "create"
1453
+ ]
1454
+ },
1455
+ "processingLocation": {
1456
+ "type": "string",
1457
+ "description": "The location where the data may be processed. Defaults to global.",
1458
+ "default": "global",
1459
+ "enum": [
1460
+ "geography",
1461
+ "dataZone",
1462
+ "global"
1463
+ ],
1464
+ "x-ms-enum": {
1465
+ "name": "ProcessingLocation",
1466
+ "modelAsString": true,
1467
+ "values": [
1468
+ {
1469
+ "name": "geography",
1470
+ "value": "geography",
1471
+ "description": "Data may be processed in the same geography as the resource."
1472
+ },
1473
+ {
1474
+ "name": "dataZone",
1475
+ "value": "dataZone",
1476
+ "description": "Data may be processed in the same data zone as the resource."
1477
+ },
1478
+ {
1479
+ "name": "global",
1480
+ "value": "global",
1481
+ "description": "Data may be processed in any Azure data center globally."
1482
+ }
1483
+ ]
1484
+ },
1485
+ "x-ms-mutability": [
1486
+ "read",
1487
+ "create"
1488
+ ]
1489
+ },
1490
+ "knowledgeSources": {
1491
+ "type": "array",
1492
+ "description": "Additional knowledge sources used to enhance the analyzer.",
1493
+ "items": {
1494
+ "$ref": "#/definitions/KnowledgeSource"
1495
+ },
1496
+ "x-ms-mutability": [
1497
+ "read",
1498
+ "create"
1499
+ ]
1500
+ },
1501
+ "models": {
1502
+ "type": "object",
1503
+ "description": "Mapping of model roles to specific model names.\nEx. { \"completion\": \"gpt-4.1\", \"embedding\": \"text-embedding-3-large\" }.",
1504
+ "additionalProperties": {
1505
+ "type": "string"
1506
+ },
1507
+ "x-ms-mutability": [
1508
+ "read",
1509
+ "create"
1510
+ ]
1511
+ },
1512
+ "supportedModels": {
1513
+ "$ref": "#/definitions/SupportedModels",
1514
+ "description": "Chat completion and embedding models supported by the analyzer.",
1515
+ "readOnly": true
1516
+ }
1517
+ },
1518
+ "required": [
1519
+ "analyzerId",
1520
+ "status",
1521
+ "createdAt",
1522
+ "lastModifiedAt"
1523
+ ]
1524
+ },
1525
+ "ContentAnalyzerAnalyzeOperationStatus": {
1526
+ "type": "object",
1527
+ "description": "Provides status details for analyze operations.",
1528
+ "properties": {
1529
+ "id": {
1530
+ "type": "string",
1531
+ "description": "The unique ID of the operation."
1532
+ },
1533
+ "status": {
1534
+ "$ref": "#/definitions/Azure.Core.Foundations.OperationState",
1535
+ "description": "The status of the operation"
1536
+ },
1537
+ "error": {
1538
+ "$ref": "#/definitions/Azure.Core.Foundations.Error",
1539
+ "description": "Error object that describes the error when status is \"Failed\"."
1540
+ },
1541
+ "result": {
1542
+ "$ref": "#/definitions/AnalysisResult",
1543
+ "description": "The result of the operation."
1544
+ },
1545
+ "usage": {
1546
+ "$ref": "#/definitions/UsageDetails",
1547
+ "description": "Usage details of the analyze operation."
1548
+ }
1549
+ },
1550
+ "required": [
1551
+ "id",
1552
+ "status"
1553
+ ]
1554
+ },
1555
+ "ContentAnalyzerConfig": {
1556
+ "type": "object",
1557
+ "description": "Configuration settings for an analyzer.",
1558
+ "properties": {
1559
+ "returnDetails": {
1560
+ "type": "boolean",
1561
+ "description": "Return all content details."
1562
+ },
1563
+ "locales": {
1564
+ "type": "array",
1565
+ "description": "List of locale hints for speech transcription.",
1566
+ "items": {
1567
+ "type": "string"
1568
+ }
1569
+ },
1570
+ "enableOcr": {
1571
+ "type": "boolean",
1572
+ "description": "Enable optical character recognition (OCR)."
1573
+ },
1574
+ "enableLayout": {
1575
+ "type": "boolean",
1576
+ "description": "Enable layout analysis."
1577
+ },
1578
+ "enableFigureDescription": {
1579
+ "type": "boolean",
1580
+ "description": "Enable generation of figure description."
1581
+ },
1582
+ "enableFigureAnalysis": {
1583
+ "type": "boolean",
1584
+ "description": "Enable analysis of figures, such as charts and diagrams."
1585
+ },
1586
+ "enableFormula": {
1587
+ "type": "boolean",
1588
+ "description": "Enable mathematical formula detection."
1589
+ },
1590
+ "tableFormat": {
1591
+ "type": "string",
1592
+ "description": "Representation format of tables in analyze result markdown.",
1593
+ "default": "html",
1594
+ "enum": [
1595
+ "html",
1596
+ "markdown"
1597
+ ],
1598
+ "x-ms-enum": {
1599
+ "name": "TableFormat",
1600
+ "modelAsString": true,
1601
+ "values": [
1602
+ {
1603
+ "name": "html",
1604
+ "value": "html",
1605
+ "description": "Represent tables using HTML table elements: \\<table>, \\<th>, \\<tr>, \\<td>."
1606
+ },
1607
+ {
1608
+ "name": "markdown",
1609
+ "value": "markdown",
1610
+ "description": "Represent tables using GitHub Flavored Markdown table syntax, which does not support merged cells or rich headers."
1611
+ }
1612
+ ]
1613
+ }
1614
+ },
1615
+ "chartFormat": {
1616
+ "type": "string",
1617
+ "description": "Representation format of charts in analyze result markdown.",
1618
+ "default": "chartJs",
1619
+ "enum": [
1620
+ "chartJs",
1621
+ "markdown"
1622
+ ],
1623
+ "x-ms-enum": {
1624
+ "name": "ChartFormat",
1625
+ "modelAsString": true,
1626
+ "values": [
1627
+ {
1628
+ "name": "chartJs",
1629
+ "value": "chartJs",
1630
+ "description": "Represent charts as Chart.js code blocks."
1631
+ },
1632
+ {
1633
+ "name": "markdown",
1634
+ "value": "markdown",
1635
+ "description": "Represent charts as markdown tables."
1636
+ }
1637
+ ]
1638
+ }
1639
+ },
1640
+ "annotationFormat": {
1641
+ "type": "string",
1642
+ "description": "Representation format of annotations in analyze result markdown.",
1643
+ "default": "markdown",
1644
+ "enum": [
1645
+ "none",
1646
+ "markdown"
1647
+ ],
1648
+ "x-ms-enum": {
1649
+ "name": "AnnotationFormat",
1650
+ "modelAsString": true,
1651
+ "values": [
1652
+ {
1653
+ "name": "none",
1654
+ "value": "none",
1655
+ "description": "Do not represent annotations."
1656
+ },
1657
+ {
1658
+ "name": "markdown",
1659
+ "value": "markdown",
1660
+ "description": "Represent basic annotation information using markdown formatting."
1661
+ }
1662
+ ]
1663
+ }
1664
+ },
1665
+ "disableFaceBlurring": {
1666
+ "type": "boolean",
1667
+ "description": "Disable the default blurring of faces for privacy while processing the content."
1668
+ },
1669
+ "estimateFieldSourceAndConfidence": {
1670
+ "type": "boolean",
1671
+ "description": "Return field grounding source and confidence."
1672
+ },
1673
+ "contentCategories": {
1674
+ "type": "object",
1675
+ "description": "Map of categories to classify the input content(s) against.",
1676
+ "additionalProperties": {
1677
+ "$ref": "#/definitions/ContentCategoryDefinition"
1678
+ }
1679
+ },
1680
+ "enableSegment": {
1681
+ "type": "boolean",
1682
+ "description": "Enable segmentation of the input by contentCategories."
1683
+ },
1684
+ "segmentPerPage": {
1685
+ "type": "boolean",
1686
+ "description": "Force segmentation of document content by page."
1687
+ },
1688
+ "omitContent": {
1689
+ "type": "boolean",
1690
+ "description": "Omit the content for this analyzer from analyze result.\nOnly return content(s) from additional analyzers specified in contentCategories, if any."
1691
+ }
1692
+ }
1693
+ },
1694
+ "ContentAnalyzerOperationStatus": {
1695
+ "type": "object",
1696
+ "description": "Provides status details for analyzer creation operations.",
1697
+ "properties": {
1698
+ "id": {
1699
+ "type": "string",
1700
+ "description": "The unique ID of the operation."
1701
+ },
1702
+ "status": {
1703
+ "$ref": "#/definitions/Azure.Core.Foundations.OperationState",
1704
+ "description": "The status of the operation"
1705
+ },
1706
+ "error": {
1707
+ "$ref": "#/definitions/Azure.Core.Foundations.Error",
1708
+ "description": "Error object that describes the error when status is \"Failed\"."
1709
+ },
1710
+ "result": {
1711
+ "$ref": "#/definitions/ContentAnalyzer",
1712
+ "description": "The result of the operation."
1713
+ },
1714
+ "usage": {
1715
+ "$ref": "#/definitions/UsageDetails",
1716
+ "description": "Usage details of the analyzer creation operation."
1717
+ }
1718
+ },
1719
+ "required": [
1720
+ "id",
1721
+ "status"
1722
+ ]
1723
+ },
1724
+ "ContentAnalyzerStatus": {
1725
+ "type": "string",
1726
+ "description": "Status of a resource.",
1727
+ "enum": [
1728
+ "creating",
1729
+ "ready",
1730
+ "deleting",
1731
+ "failed"
1732
+ ],
1733
+ "x-ms-enum": {
1734
+ "name": "ContentAnalyzerStatus",
1735
+ "modelAsString": true,
1736
+ "values": [
1737
+ {
1738
+ "name": "creating",
1739
+ "value": "creating",
1740
+ "description": "The resource is being created."
1741
+ },
1742
+ {
1743
+ "name": "ready",
1744
+ "value": "ready",
1745
+ "description": "The resource is ready."
1746
+ },
1747
+ {
1748
+ "name": "deleting",
1749
+ "value": "deleting",
1750
+ "description": "The resource is being deleted."
1751
+ },
1752
+ {
1753
+ "name": "failed",
1754
+ "value": "failed",
1755
+ "description": "The resource failed during creation."
1756
+ }
1757
+ ]
1758
+ }
1759
+ },
1760
+ "ContentAnalyzerUpdate": {
1761
+ "type": "object",
1762
+ "description": "Analyzer that extracts content and fields from multimodal documents.",
1763
+ "properties": {
1764
+ "description": {
1765
+ "type": "string",
1766
+ "description": "A description of the analyzer."
1767
+ },
1768
+ "tags": {
1769
+ "type": "object",
1770
+ "description": "Tags associated with the analyzer.",
1771
+ "additionalProperties": {
1772
+ "type": "string"
1773
+ }
1774
+ }
1775
+ }
1776
+ },
1777
+ "ContentCategoryDefinition": {
1778
+ "type": "object",
1779
+ "description": "Content category definition.",
1780
+ "properties": {
1781
+ "description": {
1782
+ "type": "string",
1783
+ "description": "The description of the category."
1784
+ },
1785
+ "analyzerId": {
1786
+ "type": "string",
1787
+ "description": "Optional analyzer used to process the content."
1788
+ },
1789
+ "analyzer": {
1790
+ "$ref": "#/definitions/ContentAnalyzer",
1791
+ "description": "Optional inline definition of analyzer used to process the content."
1792
+ }
1793
+ }
1794
+ },
1795
+ "ContentField": {
1796
+ "type": "object",
1797
+ "description": "Field extracted from the content.",
1798
+ "properties": {
1799
+ "type": {
1800
+ "$ref": "#/definitions/ContentFieldType",
1801
+ "description": "Semantic data type of the field value."
1802
+ },
1803
+ "spans": {
1804
+ "type": "array",
1805
+ "description": "Span(s) associated with the field value in the markdown content.",
1806
+ "items": {
1807
+ "$ref": "#/definitions/ContentSpan"
1808
+ }
1809
+ },
1810
+ "confidence": {
1811
+ "type": "number",
1812
+ "format": "float",
1813
+ "description": "Confidence of predicting the field value.",
1814
+ "minimum": 0,
1815
+ "maximum": 1
1816
+ },
1817
+ "source": {
1818
+ "$ref": "#/definitions/SourceExpression",
1819
+ "description": "Encoded source that identifies the position of the field value in the content."
1820
+ }
1821
+ },
1822
+ "discriminator": "type",
1823
+ "required": [
1824
+ "type"
1825
+ ]
1826
+ },
1827
+ "ContentFieldDefinition": {
1828
+ "type": "object",
1829
+ "description": "Definition of the field using a JSON Schema like syntax.",
1830
+ "properties": {
1831
+ "method": {
1832
+ "$ref": "#/definitions/GenerationMethod",
1833
+ "description": "Generation method."
1834
+ },
1835
+ "type": {
1836
+ "$ref": "#/definitions/ContentFieldType",
1837
+ "description": "Semantic data type of the field value."
1838
+ },
1839
+ "description": {
1840
+ "type": "string",
1841
+ "description": "Field description."
1842
+ },
1843
+ "items": {
1844
+ "$ref": "#/definitions/ContentFieldDefinition",
1845
+ "description": "Field type schema of each array element, if type is array."
1846
+ },
1847
+ "properties": {
1848
+ "type": "object",
1849
+ "description": "Named sub-fields, if type is object.",
1850
+ "additionalProperties": {
1851
+ "$ref": "#/definitions/ContentFieldDefinition"
1852
+ }
1853
+ },
1854
+ "examples": {
1855
+ "type": "array",
1856
+ "description": "Examples of field values.",
1857
+ "items": {
1858
+ "type": "string"
1859
+ }
1860
+ },
1861
+ "enum": {
1862
+ "type": "array",
1863
+ "description": "Enumeration of possible field values.",
1864
+ "items": {
1865
+ "type": "string"
1866
+ }
1867
+ },
1868
+ "enumDescriptions": {
1869
+ "type": "object",
1870
+ "description": "Descriptions for each enumeration value.",
1871
+ "additionalProperties": {
1872
+ "type": "string"
1873
+ }
1874
+ },
1875
+ "$ref": {
1876
+ "type": "string",
1877
+ "description": "Reference to another field definition."
1878
+ },
1879
+ "estimateSourceAndConfidence": {
1880
+ "type": "boolean",
1881
+ "description": "Return grounding source and confidence."
1882
+ }
1883
+ }
1884
+ },
1885
+ "ContentFieldSchema": {
1886
+ "type": "object",
1887
+ "description": "Schema of fields to be extracted from documents.",
1888
+ "properties": {
1889
+ "name": {
1890
+ "type": "string",
1891
+ "description": "The name of the field schema.",
1892
+ "x-ms-mutability": [
1893
+ "read",
1894
+ "create"
1895
+ ]
1896
+ },
1897
+ "description": {
1898
+ "type": "string",
1899
+ "description": "A description of the field schema.",
1900
+ "x-ms-mutability": [
1901
+ "read",
1902
+ "create"
1903
+ ]
1904
+ },
1905
+ "fields": {
1906
+ "type": "object",
1907
+ "description": "The fields defined in the schema.",
1908
+ "additionalProperties": {
1909
+ "$ref": "#/definitions/ContentFieldDefinition"
1910
+ },
1911
+ "x-ms-mutability": [
1912
+ "read",
1913
+ "create"
1914
+ ]
1915
+ },
1916
+ "definitions": {
1917
+ "type": "object",
1918
+ "description": "Additional definitions referenced by the fields in the schema.",
1919
+ "additionalProperties": {
1920
+ "$ref": "#/definitions/ContentFieldDefinition"
1921
+ },
1922
+ "x-ms-mutability": [
1923
+ "read",
1924
+ "create"
1925
+ ]
1926
+ }
1927
+ },
1928
+ "required": [
1929
+ "fields"
1930
+ ]
1931
+ },
1932
+ "ContentFieldType": {
1933
+ "type": "string",
1934
+ "description": "Semantic data type of the field value.",
1935
+ "enum": [
1936
+ "string",
1937
+ "date",
1938
+ "time",
1939
+ "number",
1940
+ "integer",
1941
+ "boolean",
1942
+ "array",
1943
+ "object",
1944
+ "json"
1945
+ ],
1946
+ "x-ms-enum": {
1947
+ "name": "ContentFieldType",
1948
+ "modelAsString": true,
1949
+ "values": [
1950
+ {
1951
+ "name": "string",
1952
+ "value": "string",
1953
+ "description": "Plain text."
1954
+ },
1955
+ {
1956
+ "name": "date",
1957
+ "value": "date",
1958
+ "description": "Date, normalized to ISO 8601 (YYYY-MM-DD) format."
1959
+ },
1960
+ {
1961
+ "name": "time",
1962
+ "value": "time",
1963
+ "description": "Time, normalized to ISO 8601 (hh:mm:ss) format."
1964
+ },
1965
+ {
1966
+ "name": "number",
1967
+ "value": "number",
1968
+ "description": "Number as double precision floating point."
1969
+ },
1970
+ {
1971
+ "name": "integer",
1972
+ "value": "integer",
1973
+ "description": "Integer as 64-bit signed integer."
1974
+ },
1975
+ {
1976
+ "name": "boolean",
1977
+ "value": "boolean",
1978
+ "description": "Boolean value."
1979
+ },
1980
+ {
1981
+ "name": "array",
1982
+ "value": "array",
1983
+ "description": "List of subfields of the same type."
1984
+ },
1985
+ {
1986
+ "name": "object",
1987
+ "value": "object",
1988
+ "description": "Named list of subfields."
1989
+ },
1990
+ {
1991
+ "name": "json",
1992
+ "value": "json",
1993
+ "description": "JSON object."
1994
+ }
1995
+ ]
1996
+ }
1997
+ },
1998
+ "ContentSpan": {
1999
+ "type": "object",
2000
+ "description": "Position of the element in markdown, specified as a character offset and length.",
2001
+ "properties": {
2002
+ "offset": {
2003
+ "type": "integer",
2004
+ "format": "int32",
2005
+ "description": "Starting position (0-indexed) of the element in markdown, specified in characters."
2006
+ },
2007
+ "length": {
2008
+ "type": "integer",
2009
+ "format": "int32",
2010
+ "description": "Length of the element in markdown, specified in characters."
2011
+ }
2012
+ },
2013
+ "required": [
2014
+ "offset",
2015
+ "length"
2016
+ ]
2017
+ },
2018
+ "ContentUnderstandingDefaults": {
2019
+ "type": "object",
2020
+ "description": "Default settings for this Content Understanding resource.",
2021
+ "properties": {
2022
+ "modelDeployments": {
2023
+ "type": "object",
2024
+ "description": "Specify the default mapping of model names to LLM/embedding deployments in Microsoft Foundry. For details and current semantics, see https://aka.ms/cudoc-quickstart-rest.",
2025
+ "additionalProperties": {
2026
+ "type": "string"
2027
+ },
2028
+ "x-ms-mutability": [
2029
+ "read",
2030
+ "update",
2031
+ "create"
2032
+ ]
2033
+ }
2034
+ },
2035
+ "required": [
2036
+ "modelDeployments"
2037
+ ]
2038
+ },
2039
+ "ContentUnderstandingDefaultsMergePatchUpdate": {
2040
+ "type": "object",
2041
+ "description": "Default settings for this Content Understanding resource.",
2042
+ "properties": {
2043
+ "modelDeployments": {
2044
+ "type": "object",
2045
+ "description": "Specify the default mapping of model names to LLM/embedding deployments in Microsoft Foundry. For details and current semantics, see https://aka.ms/cudoc-quickstart-rest.",
2046
+ "additionalProperties": {
2047
+ "type": "string"
2048
+ }
2049
+ }
2050
+ }
2051
+ },
2052
+ "CopyAuthorization": {
2053
+ "type": "object",
2054
+ "description": "Copy authorization details for cross-resource copy.",
2055
+ "properties": {
2056
+ "source": {
2057
+ "type": "string",
2058
+ "description": "Full path of the source analyzer."
2059
+ },
2060
+ "targetAzureResourceId": {
2061
+ "type": "string",
2062
+ "description": "Azure resource ID of the target location to copy to."
2063
+ },
2064
+ "expiresAt": {
2065
+ "type": "string",
2066
+ "format": "date-time",
2067
+ "description": "Date/time when the copy authorization expires."
2068
+ }
2069
+ },
2070
+ "required": [
2071
+ "source",
2072
+ "targetAzureResourceId",
2073
+ "expiresAt"
2074
+ ]
2075
+ },
2076
+ "CopyRequest": {
2077
+ "type": "object",
2078
+ "description": "Copy operation request.",
2079
+ "properties": {
2080
+ "sourceAzureResourceId": {
2081
+ "type": "string",
2082
+ "description": "Azure resource ID of the source analyzer location. Defaults to the current resource."
2083
+ },
2084
+ "sourceRegion": {
2085
+ "type": "string",
2086
+ "description": "Azure region of the source analyzer location. Defaults to current region."
2087
+ },
2088
+ "sourceAnalyzerId": {
2089
+ "type": "string",
2090
+ "description": "Source analyzer ID."
2091
+ }
2092
+ },
2093
+ "required": [
2094
+ "sourceAnalyzerId"
2095
+ ]
2096
+ },
2097
+ "DateField": {
2098
+ "type": "object",
2099
+ "description": "Date field extracted from the content.",
2100
+ "properties": {
2101
+ "valueDate": {
2102
+ "type": "string",
2103
+ "format": "date",
2104
+ "description": "Date field value, in ISO 8601 (YYYY-MM-DD) format."
2105
+ }
2106
+ },
2107
+ "allOf": [
2108
+ {
2109
+ "$ref": "#/definitions/ContentField"
2110
+ }
2111
+ ],
2112
+ "x-ms-discriminator-value": "date"
2113
+ },
2114
+ "DocumentAnnotation": {
2115
+ "type": "object",
2116
+ "description": "Annotation in a document, such as a strikethrough or a comment.",
2117
+ "properties": {
2118
+ "id": {
2119
+ "type": "string",
2120
+ "description": "Annotation identifier."
2121
+ },
2122
+ "kind": {
2123
+ "$ref": "#/definitions/DocumentAnnotationKind",
2124
+ "description": "Annotation kind."
2125
+ },
2126
+ "spans": {
2127
+ "type": "array",
2128
+ "description": "Spans of the content associated with the annotation.",
2129
+ "items": {
2130
+ "$ref": "#/definitions/ContentSpan"
2131
+ }
2132
+ },
2133
+ "source": {
2134
+ "$ref": "#/definitions/SourceExpression",
2135
+ "description": "Position of the annotation."
2136
+ },
2137
+ "comments": {
2138
+ "type": "array",
2139
+ "description": "Comments associated with the annotation.",
2140
+ "items": {
2141
+ "$ref": "#/definitions/DocumentAnnotationComment"
2142
+ }
2143
+ },
2144
+ "author": {
2145
+ "type": "string",
2146
+ "description": "Annotation author."
2147
+ },
2148
+ "createdAt": {
2149
+ "type": "string",
2150
+ "format": "date-time",
2151
+ "description": "Date and time when the annotation was created."
2152
+ },
2153
+ "lastModifiedAt": {
2154
+ "type": "string",
2155
+ "format": "date-time",
2156
+ "description": "Date and time when the annotation was last modified."
2157
+ },
2158
+ "tags": {
2159
+ "type": "array",
2160
+ "description": "Tags associated with the annotation.",
2161
+ "items": {
2162
+ "type": "string"
2163
+ }
2164
+ }
2165
+ },
2166
+ "required": [
2167
+ "id",
2168
+ "kind"
2169
+ ]
2170
+ },
2171
+ "DocumentAnnotationComment": {
2172
+ "type": "object",
2173
+ "description": "Comment associated with a document annotation.",
2174
+ "properties": {
2175
+ "message": {
2176
+ "type": "string",
2177
+ "description": "Comment message in Markdown."
2178
+ },
2179
+ "author": {
2180
+ "type": "string",
2181
+ "description": "Author of the comment."
2182
+ },
2183
+ "createdAt": {
2184
+ "type": "string",
2185
+ "format": "date-time",
2186
+ "description": "Date and time when the comment was created."
2187
+ },
2188
+ "lastModifiedAt": {
2189
+ "type": "string",
2190
+ "format": "date-time",
2191
+ "description": "Date and time when the comment was last modified."
2192
+ },
2193
+ "tags": {
2194
+ "type": "array",
2195
+ "description": "Tags associated with the comment.",
2196
+ "items": {
2197
+ "type": "string"
2198
+ }
2199
+ }
2200
+ },
2201
+ "required": [
2202
+ "message"
2203
+ ]
2204
+ },
2205
+ "DocumentAnnotationKind": {
2206
+ "type": "string",
2207
+ "description": "Document annotation kind.",
2208
+ "enum": [
2209
+ "highlight",
2210
+ "strikethrough",
2211
+ "underline",
2212
+ "italic",
2213
+ "bold",
2214
+ "circle",
2215
+ "note"
2216
+ ],
2217
+ "x-ms-enum": {
2218
+ "name": "DocumentAnnotationKind",
2219
+ "modelAsString": true,
2220
+ "values": [
2221
+ {
2222
+ "name": "highlight",
2223
+ "value": "highlight",
2224
+ "description": "Highlight annotation."
2225
+ },
2226
+ {
2227
+ "name": "strikethrough",
2228
+ "value": "strikethrough",
2229
+ "description": "Strikethrough annotation."
2230
+ },
2231
+ {
2232
+ "name": "underline",
2233
+ "value": "underline",
2234
+ "description": "Underline annotation."
2235
+ },
2236
+ {
2237
+ "name": "italic",
2238
+ "value": "italic",
2239
+ "description": "Italic annotation."
2240
+ },
2241
+ {
2242
+ "name": "bold",
2243
+ "value": "bold",
2244
+ "description": "Bold annotation."
2245
+ },
2246
+ {
2247
+ "name": "circle",
2248
+ "value": "circle",
2249
+ "description": "Circle annotation."
2250
+ },
2251
+ {
2252
+ "name": "note",
2253
+ "value": "note",
2254
+ "description": "Note annotation."
2255
+ }
2256
+ ]
2257
+ }
2258
+ },
2259
+ "DocumentBarcode": {
2260
+ "type": "object",
2261
+ "description": "Barcode in a document.",
2262
+ "properties": {
2263
+ "kind": {
2264
+ "$ref": "#/definitions/DocumentBarcodeKind",
2265
+ "description": "Barcode kind."
2266
+ },
2267
+ "value": {
2268
+ "type": "string",
2269
+ "description": "Barcode value."
2270
+ },
2271
+ "source": {
2272
+ "$ref": "#/definitions/SourceExpression",
2273
+ "description": "Encoded source that identifies the position of the barcode in the content."
2274
+ },
2275
+ "span": {
2276
+ "$ref": "#/definitions/ContentSpan",
2277
+ "description": "Span of the barcode in the markdown content."
2278
+ },
2279
+ "confidence": {
2280
+ "type": "number",
2281
+ "format": "float",
2282
+ "description": "Confidence of predicting the barcode.",
2283
+ "minimum": 0,
2284
+ "maximum": 1
2285
+ }
2286
+ },
2287
+ "required": [
2288
+ "kind",
2289
+ "value"
2290
+ ]
2291
+ },
2292
+ "DocumentBarcodeKind": {
2293
+ "type": "string",
2294
+ "description": "Barcode kind.",
2295
+ "enum": [
2296
+ "QRCode",
2297
+ "PDF417",
2298
+ "UPCA",
2299
+ "UPCE",
2300
+ "Code39",
2301
+ "Code128",
2302
+ "EAN8",
2303
+ "EAN13",
2304
+ "DataBar",
2305
+ "Code93",
2306
+ "Codabar",
2307
+ "DataBarExpanded",
2308
+ "ITF",
2309
+ "MicroQRCode",
2310
+ "Aztec",
2311
+ "DataMatrix",
2312
+ "MaxiCode"
2313
+ ],
2314
+ "x-ms-enum": {
2315
+ "name": "DocumentBarcodeKind",
2316
+ "modelAsString": true,
2317
+ "values": [
2318
+ {
2319
+ "name": "QRCode",
2320
+ "value": "QRCode",
2321
+ "description": "QR code, as defined in ISO/IEC 18004:2015."
2322
+ },
2323
+ {
2324
+ "name": "PDF417",
2325
+ "value": "PDF417",
2326
+ "description": "PDF417, as defined in ISO 15438."
2327
+ },
2328
+ {
2329
+ "name": "UPCA",
2330
+ "value": "UPCA",
2331
+ "description": "GS1 12-digit Universal Product Code."
2332
+ },
2333
+ {
2334
+ "name": "UPCE",
2335
+ "value": "UPCE",
2336
+ "description": "GS1 6-digit Universal Product Code."
2337
+ },
2338
+ {
2339
+ "name": "Code39",
2340
+ "value": "Code39",
2341
+ "description": "Code 39 barcode, as defined in ISO/IEC 16388:2007."
2342
+ },
2343
+ {
2344
+ "name": "Code128",
2345
+ "value": "Code128",
2346
+ "description": "Code 128 barcode, as defined in ISO/IEC 15417:2007."
2347
+ },
2348
+ {
2349
+ "name": "EAN8",
2350
+ "value": "EAN8",
2351
+ "description": "GS1 8-digit International Article Number (European Article Number)."
2352
+ },
2353
+ {
2354
+ "name": "EAN13",
2355
+ "value": "EAN13",
2356
+ "description": "GS1 13-digit International Article Number (European Article Number)."
2357
+ },
2358
+ {
2359
+ "name": "DataBar",
2360
+ "value": "DataBar",
2361
+ "description": "GS1 DataBar barcode."
2362
+ },
2363
+ {
2364
+ "name": "Code93",
2365
+ "value": "Code93",
2366
+ "description": "Code 93 barcode, as defined in ANSI/AIM BC5-1995."
2367
+ },
2368
+ {
2369
+ "name": "Codabar",
2370
+ "value": "Codabar",
2371
+ "description": "Codabar barcode, as defined in ANSI/AIM BC3-1995."
2372
+ },
2373
+ {
2374
+ "name": "DataBarExpanded",
2375
+ "value": "DataBarExpanded",
2376
+ "description": "GS1 DataBar Expanded barcode."
2377
+ },
2378
+ {
2379
+ "name": "ITF",
2380
+ "value": "ITF",
2381
+ "description": "Interleaved 2 of 5 barcode, as defined in ANSI/AIM BC2-1995."
2382
+ },
2383
+ {
2384
+ "name": "MicroQRCode",
2385
+ "value": "MicroQRCode",
2386
+ "description": "Micro QR code, as defined in ISO/IEC 23941:2022."
2387
+ },
2388
+ {
2389
+ "name": "Aztec",
2390
+ "value": "Aztec",
2391
+ "description": "Aztec code, as defined in ISO/IEC 24778:2008."
2392
+ },
2393
+ {
2394
+ "name": "DataMatrix",
2395
+ "value": "DataMatrix",
2396
+ "description": "Data matrix code, as defined in ISO/IEC 16022:2006."
2397
+ },
2398
+ {
2399
+ "name": "MaxiCode",
2400
+ "value": "MaxiCode",
2401
+ "description": "MaxiCode, as defined in ISO/IEC 16023:2000."
2402
+ }
2403
+ ]
2404
+ }
2405
+ },
2406
+ "DocumentCaption": {
2407
+ "type": "object",
2408
+ "description": "Caption of a table or figure.",
2409
+ "properties": {
2410
+ "content": {
2411
+ "type": "string",
2412
+ "description": "Content of the caption."
2413
+ },
2414
+ "source": {
2415
+ "$ref": "#/definitions/SourceExpression",
2416
+ "description": "Encoded source that identifies the position of the caption in the content."
2417
+ },
2418
+ "span": {
2419
+ "$ref": "#/definitions/ContentSpan",
2420
+ "description": "Span of the caption in the markdown content."
2421
+ },
2422
+ "elements": {
2423
+ "type": "array",
2424
+ "description": "Child elements of the caption.",
2425
+ "items": {
2426
+ "$ref": "#/definitions/DocumentElement"
2427
+ }
2428
+ }
2429
+ },
2430
+ "required": [
2431
+ "content"
2432
+ ]
2433
+ },
2434
+ "DocumentChartFigure": {
2435
+ "type": "object",
2436
+ "description": "Figure containing a chart, such as a bar chart, line chart, or pie chart.",
2437
+ "properties": {
2438
+ "content": {
2439
+ "type": "object",
2440
+ "description": "Chart content represented using [Chart.js config](https://www.chartjs.org/docs/latest/configuration/).",
2441
+ "additionalProperties": {}
2442
+ }
2443
+ },
2444
+ "required": [
2445
+ "content"
2446
+ ],
2447
+ "allOf": [
2448
+ {
2449
+ "$ref": "#/definitions/DocumentFigure"
2450
+ }
2451
+ ],
2452
+ "x-ms-discriminator-value": "chart"
2453
+ },
2454
+ "DocumentContent": {
2455
+ "type": "object",
2456
+ "description": "Document content. Ex. text/plain, application/pdf, image/jpeg.",
2457
+ "properties": {
2458
+ "startPageNumber": {
2459
+ "type": "integer",
2460
+ "format": "int32",
2461
+ "description": "Start page number (1-indexed) of the content."
2462
+ },
2463
+ "endPageNumber": {
2464
+ "type": "integer",
2465
+ "format": "int32",
2466
+ "description": "End page number (1-indexed) of the content."
2467
+ },
2468
+ "unit": {
2469
+ "$ref": "#/definitions/LengthUnit",
2470
+ "description": "Length unit used by the width, height, and source properties.\nFor images/tiff, the default unit is pixel. For PDF, the default unit is inch."
2471
+ },
2472
+ "pages": {
2473
+ "type": "array",
2474
+ "description": "List of pages in the document.",
2475
+ "items": {
2476
+ "$ref": "#/definitions/DocumentPage"
2477
+ }
2478
+ },
2479
+ "paragraphs": {
2480
+ "type": "array",
2481
+ "description": "List of paragraphs in the document. Only if enableOcr and returnDetails are true.",
2482
+ "items": {
2483
+ "$ref": "#/definitions/DocumentParagraph"
2484
+ }
2485
+ },
2486
+ "sections": {
2487
+ "type": "array",
2488
+ "description": "List of sections in the document. Only if enableLayout and returnDetails are true.",
2489
+ "items": {
2490
+ "$ref": "#/definitions/DocumentSection"
2491
+ }
2492
+ },
2493
+ "tables": {
2494
+ "type": "array",
2495
+ "description": "List of tables in the document. Only if enableLayout and returnDetails are true.",
2496
+ "items": {
2497
+ "$ref": "#/definitions/DocumentTable"
2498
+ }
2499
+ },
2500
+ "figures": {
2501
+ "type": "array",
2502
+ "description": "List of figures in the document. Only if enableLayout and returnDetails are true.",
2503
+ "items": {
2504
+ "$ref": "#/definitions/DocumentFigure"
2505
+ }
2506
+ },
2507
+ "annotations": {
2508
+ "type": "array",
2509
+ "description": "List of annotations in the document. Only if enableAnnotations and returnDetails are true.",
2510
+ "items": {
2511
+ "$ref": "#/definitions/DocumentAnnotation"
2512
+ }
2513
+ },
2514
+ "hyperlinks": {
2515
+ "type": "array",
2516
+ "description": "List of hyperlinks in the document. Only if returnDetails are true.",
2517
+ "items": {
2518
+ "$ref": "#/definitions/DocumentHyperlink"
2519
+ }
2520
+ },
2521
+ "segments": {
2522
+ "type": "array",
2523
+ "description": "List of detected content segments. Only if enableSegment is true.",
2524
+ "items": {
2525
+ "$ref": "#/definitions/DocumentContentSegment"
2526
+ }
2527
+ }
2528
+ },
2529
+ "required": [
2530
+ "startPageNumber",
2531
+ "endPageNumber"
2532
+ ],
2533
+ "allOf": [
2534
+ {
2535
+ "$ref": "#/definitions/AnalysisContent"
2536
+ }
2537
+ ],
2538
+ "x-ms-discriminator-value": "document"
2539
+ },
2540
+ "DocumentContentSegment": {
2541
+ "type": "object",
2542
+ "description": "Detected document content segment.",
2543
+ "properties": {
2544
+ "segmentId": {
2545
+ "type": "string",
2546
+ "description": "Segment identifier."
2547
+ },
2548
+ "category": {
2549
+ "type": "string",
2550
+ "description": "Classified content category."
2551
+ },
2552
+ "span": {
2553
+ "$ref": "#/definitions/ContentSpan",
2554
+ "description": "Span of the segment in the markdown content."
2555
+ },
2556
+ "startPageNumber": {
2557
+ "type": "integer",
2558
+ "format": "int32",
2559
+ "description": "Start page number (1-indexed) of the segment."
2560
+ },
2561
+ "endPageNumber": {
2562
+ "type": "integer",
2563
+ "format": "int32",
2564
+ "description": "End page number (1-indexed) of the segment."
2565
+ }
2566
+ },
2567
+ "required": [
2568
+ "segmentId",
2569
+ "category",
2570
+ "span",
2571
+ "startPageNumber",
2572
+ "endPageNumber"
2573
+ ]
2574
+ },
2575
+ "DocumentElement": {
2576
+ "type": "string",
2577
+ "description": "JSON pointer referencing an element of the document, such as paragraph,\ntable, section, etc."
2578
+ },
2579
+ "DocumentFigure": {
2580
+ "type": "object",
2581
+ "description": "Figure in a document.",
2582
+ "properties": {
2583
+ "kind": {
2584
+ "type": "string",
2585
+ "description": "Figure kind.",
2586
+ "default": "unknown",
2587
+ "enum": [
2588
+ "unknown",
2589
+ "chart",
2590
+ "mermaid"
2591
+ ],
2592
+ "x-ms-enum": {
2593
+ "name": "DocumentFigureKind",
2594
+ "modelAsString": true,
2595
+ "values": [
2596
+ {
2597
+ "name": "unknown",
2598
+ "value": "unknown",
2599
+ "description": "Unknown figure kind."
2600
+ },
2601
+ {
2602
+ "name": "chart",
2603
+ "value": "chart",
2604
+ "description": "Figure containing a chart, such as a bar chart, line chart, or pie chart."
2605
+ },
2606
+ {
2607
+ "name": "mermaid",
2608
+ "value": "mermaid",
2609
+ "description": "Figure containing a diagram, such as a flowchart or network diagram."
2610
+ }
2611
+ ]
2612
+ }
2613
+ },
2614
+ "id": {
2615
+ "type": "string",
2616
+ "description": "Figure identifier."
2617
+ },
2618
+ "source": {
2619
+ "$ref": "#/definitions/SourceExpression",
2620
+ "description": "Encoded source that identifies the position of the figure in the content."
2621
+ },
2622
+ "span": {
2623
+ "$ref": "#/definitions/ContentSpan",
2624
+ "description": "Span of the figure in the markdown content."
2625
+ },
2626
+ "elements": {
2627
+ "type": "array",
2628
+ "description": "Child elements of the figure, excluding any caption or footnotes.",
2629
+ "items": {
2630
+ "$ref": "#/definitions/DocumentElement"
2631
+ }
2632
+ },
2633
+ "caption": {
2634
+ "$ref": "#/definitions/DocumentCaption",
2635
+ "description": "Figure caption."
2636
+ },
2637
+ "footnotes": {
2638
+ "type": "array",
2639
+ "description": "List of figure footnotes.",
2640
+ "items": {
2641
+ "$ref": "#/definitions/DocumentFootnote"
2642
+ }
2643
+ },
2644
+ "description": {
2645
+ "type": "string",
2646
+ "description": "Description of the figure."
2647
+ },
2648
+ "role": {
2649
+ "$ref": "#/definitions/SemanticRole",
2650
+ "description": "Semantic role of the figure."
2651
+ }
2652
+ },
2653
+ "discriminator": "kind",
2654
+ "required": [
2655
+ "kind",
2656
+ "id"
2657
+ ]
2658
+ },
2659
+ "DocumentFootnote": {
2660
+ "type": "object",
2661
+ "description": "Footnote of a table or figure.",
2662
+ "properties": {
2663
+ "content": {
2664
+ "type": "string",
2665
+ "description": "Content of the footnote."
2666
+ },
2667
+ "source": {
2668
+ "$ref": "#/definitions/SourceExpression",
2669
+ "description": "Encoded source that identifies the position of the footnote in the content."
2670
+ },
2671
+ "span": {
2672
+ "$ref": "#/definitions/ContentSpan",
2673
+ "description": "Span of the footnote in the markdown content."
2674
+ },
2675
+ "elements": {
2676
+ "type": "array",
2677
+ "description": "Child elements of the footnote.",
2678
+ "items": {
2679
+ "$ref": "#/definitions/DocumentElement"
2680
+ }
2681
+ }
2682
+ },
2683
+ "required": [
2684
+ "content"
2685
+ ]
2686
+ },
2687
+ "DocumentFormula": {
2688
+ "type": "object",
2689
+ "description": "Mathematical formula in a document.",
2690
+ "properties": {
2691
+ "kind": {
2692
+ "$ref": "#/definitions/DocumentFormulaKind",
2693
+ "description": "Formula kind."
2694
+ },
2695
+ "value": {
2696
+ "type": "string",
2697
+ "description": "LaTex expression describing the formula."
2698
+ },
2699
+ "source": {
2700
+ "$ref": "#/definitions/SourceExpression",
2701
+ "description": "Encoded source that identifies the position of the formula in the content."
2702
+ },
2703
+ "span": {
2704
+ "$ref": "#/definitions/ContentSpan",
2705
+ "description": "Span of the formula in the markdown content."
2706
+ },
2707
+ "confidence": {
2708
+ "type": "number",
2709
+ "format": "float",
2710
+ "description": "Confidence of predicting the formula.",
2711
+ "minimum": 0,
2712
+ "maximum": 1
2713
+ }
2714
+ },
2715
+ "required": [
2716
+ "kind",
2717
+ "value"
2718
+ ]
2719
+ },
2720
+ "DocumentFormulaKind": {
2721
+ "type": "string",
2722
+ "description": "Formula kind.",
2723
+ "enum": [
2724
+ "inline",
2725
+ "display"
2726
+ ],
2727
+ "x-ms-enum": {
2728
+ "name": "DocumentFormulaKind",
2729
+ "modelAsString": true,
2730
+ "values": [
2731
+ {
2732
+ "name": "inline",
2733
+ "value": "inline",
2734
+ "description": "A formula embedded within the content of a paragraph."
2735
+ },
2736
+ {
2737
+ "name": "display",
2738
+ "value": "display",
2739
+ "description": "A formula in display mode that takes up an entire line."
2740
+ }
2741
+ ]
2742
+ }
2743
+ },
2744
+ "DocumentHyperlink": {
2745
+ "type": "object",
2746
+ "description": "Hyperlink in a document, such as a link to a web page or an email address.",
2747
+ "properties": {
2748
+ "content": {
2749
+ "type": "string",
2750
+ "description": "Hyperlinked content."
2751
+ },
2752
+ "url": {
2753
+ "type": "string",
2754
+ "description": "URL of the hyperlink."
2755
+ },
2756
+ "span": {
2757
+ "$ref": "#/definitions/ContentSpan",
2758
+ "description": "Span of the hyperlink in the markdown content."
2759
+ },
2760
+ "source": {
2761
+ "$ref": "#/definitions/SourceExpression",
2762
+ "description": "Position of the hyperlink."
2763
+ }
2764
+ },
2765
+ "required": [
2766
+ "content",
2767
+ "url"
2768
+ ]
2769
+ },
2770
+ "DocumentLine": {
2771
+ "type": "object",
2772
+ "description": "Line in a document, consisting of an contiguous sequence of words.",
2773
+ "properties": {
2774
+ "content": {
2775
+ "type": "string",
2776
+ "description": "Line text."
2777
+ },
2778
+ "source": {
2779
+ "$ref": "#/definitions/SourceExpression",
2780
+ "description": "Encoded source that identifies the position of the line in the content."
2781
+ },
2782
+ "span": {
2783
+ "$ref": "#/definitions/ContentSpan",
2784
+ "description": "Span of the line in the markdown content."
2785
+ }
2786
+ },
2787
+ "required": [
2788
+ "content"
2789
+ ]
2790
+ },
2791
+ "DocumentMermaidFigure": {
2792
+ "type": "object",
2793
+ "description": "Figure containing a diagram, such as a flowchart or network diagram.",
2794
+ "properties": {
2795
+ "content": {
2796
+ "type": "string",
2797
+ "description": "Diagram content represented using [Mermaid syntax](https://mermaid.js.org/intro/)."
2798
+ }
2799
+ },
2800
+ "required": [
2801
+ "content"
2802
+ ],
2803
+ "allOf": [
2804
+ {
2805
+ "$ref": "#/definitions/DocumentFigure"
2806
+ }
2807
+ ],
2808
+ "x-ms-discriminator-value": "mermaid"
2809
+ },
2810
+ "DocumentPage": {
2811
+ "type": "object",
2812
+ "description": "Content from a document page.",
2813
+ "properties": {
2814
+ "pageNumber": {
2815
+ "type": "integer",
2816
+ "format": "int32",
2817
+ "description": "Page number (1-based).",
2818
+ "minimum": 1
2819
+ },
2820
+ "width": {
2821
+ "type": "number",
2822
+ "format": "float",
2823
+ "description": "Width of the page."
2824
+ },
2825
+ "height": {
2826
+ "type": "number",
2827
+ "format": "float",
2828
+ "description": "Height of the page."
2829
+ },
2830
+ "spans": {
2831
+ "type": "array",
2832
+ "description": "Span(s) associated with the page in the markdown content.",
2833
+ "items": {
2834
+ "$ref": "#/definitions/ContentSpan"
2835
+ }
2836
+ },
2837
+ "angle": {
2838
+ "type": "number",
2839
+ "format": "float",
2840
+ "description": "The general orientation of the content in clockwise direction,\nmeasured in degrees between (-180, 180].\nOnly if enableOcr is true.",
2841
+ "maximum": 180
2842
+ },
2843
+ "words": {
2844
+ "type": "array",
2845
+ "description": "List of words in the page. Only if enableOcr and returnDetails are true.",
2846
+ "items": {
2847
+ "$ref": "#/definitions/DocumentWord"
2848
+ }
2849
+ },
2850
+ "lines": {
2851
+ "type": "array",
2852
+ "description": "List of lines in the page. Only if enableOcr and returnDetails are true.",
2853
+ "items": {
2854
+ "$ref": "#/definitions/DocumentLine"
2855
+ }
2856
+ },
2857
+ "barcodes": {
2858
+ "type": "array",
2859
+ "description": "List of barcodes in the page. Only if enableBarcode and returnDetails are true.",
2860
+ "items": {
2861
+ "$ref": "#/definitions/DocumentBarcode"
2862
+ }
2863
+ },
2864
+ "formulas": {
2865
+ "type": "array",
2866
+ "description": "List of mathematical formulas in the page. Only if enableFormula and returnDetails are true.",
2867
+ "items": {
2868
+ "$ref": "#/definitions/DocumentFormula"
2869
+ }
2870
+ }
2871
+ },
2872
+ "required": [
2873
+ "pageNumber"
2874
+ ]
2875
+ },
2876
+ "DocumentParagraph": {
2877
+ "type": "object",
2878
+ "description": "Paragraph in a document, generally consisting of an contiguous sequence of lines\nwith common alignment and spacing.",
2879
+ "properties": {
2880
+ "role": {
2881
+ "$ref": "#/definitions/SemanticRole",
2882
+ "description": "Semantic role of the paragraph."
2883
+ },
2884
+ "content": {
2885
+ "type": "string",
2886
+ "description": "Paragraph text."
2887
+ },
2888
+ "source": {
2889
+ "$ref": "#/definitions/SourceExpression",
2890
+ "description": "Encoded source that identifies the position of the paragraph in the content."
2891
+ },
2892
+ "span": {
2893
+ "$ref": "#/definitions/ContentSpan",
2894
+ "description": "Span of the paragraph in the markdown content."
2895
+ }
2896
+ },
2897
+ "required": [
2898
+ "content"
2899
+ ]
2900
+ },
2901
+ "DocumentSection": {
2902
+ "type": "object",
2903
+ "description": "Section in a document.",
2904
+ "properties": {
2905
+ "span": {
2906
+ "$ref": "#/definitions/ContentSpan",
2907
+ "description": "Span of the section in the markdown content."
2908
+ },
2909
+ "elements": {
2910
+ "type": "array",
2911
+ "description": "Child elements of the section.",
2912
+ "items": {
2913
+ "$ref": "#/definitions/DocumentElement"
2914
+ }
2915
+ }
2916
+ }
2917
+ },
2918
+ "DocumentTable": {
2919
+ "type": "object",
2920
+ "description": "Table in a document, consisting table cells arranged in a rectangular layout.",
2921
+ "properties": {
2922
+ "rowCount": {
2923
+ "type": "integer",
2924
+ "format": "int32",
2925
+ "description": "Number of rows in the table.",
2926
+ "minimum": 1
2927
+ },
2928
+ "columnCount": {
2929
+ "type": "integer",
2930
+ "format": "int32",
2931
+ "description": "Number of columns in the table.",
2932
+ "minimum": 1
2933
+ },
2934
+ "cells": {
2935
+ "type": "array",
2936
+ "description": "Cells contained within the table.",
2937
+ "items": {
2938
+ "$ref": "#/definitions/DocumentTableCell"
2939
+ }
2940
+ },
2941
+ "source": {
2942
+ "$ref": "#/definitions/SourceExpression",
2943
+ "description": "Encoded source that identifies the position of the table in the content."
2944
+ },
2945
+ "span": {
2946
+ "$ref": "#/definitions/ContentSpan",
2947
+ "description": "Span of the table in the markdown content."
2948
+ },
2949
+ "caption": {
2950
+ "$ref": "#/definitions/DocumentCaption",
2951
+ "description": "Table caption."
2952
+ },
2953
+ "footnotes": {
2954
+ "type": "array",
2955
+ "description": "List of table footnotes.",
2956
+ "items": {
2957
+ "$ref": "#/definitions/DocumentFootnote"
2958
+ }
2959
+ },
2960
+ "role": {
2961
+ "$ref": "#/definitions/SemanticRole",
2962
+ "description": "Semantic role of the table."
2963
+ }
2964
+ },
2965
+ "required": [
2966
+ "rowCount",
2967
+ "columnCount",
2968
+ "cells"
2969
+ ]
2970
+ },
2971
+ "DocumentTableCell": {
2972
+ "type": "object",
2973
+ "description": "Table cell in a document table.",
2974
+ "properties": {
2975
+ "kind": {
2976
+ "type": "string",
2977
+ "description": "Table cell kind.",
2978
+ "default": "content",
2979
+ "enum": [
2980
+ "content",
2981
+ "rowHeader",
2982
+ "columnHeader",
2983
+ "stubHead",
2984
+ "description"
2985
+ ],
2986
+ "x-ms-enum": {
2987
+ "name": "DocumentTableCellKind",
2988
+ "modelAsString": true,
2989
+ "values": [
2990
+ {
2991
+ "name": "content",
2992
+ "value": "content",
2993
+ "description": "Main content/data."
2994
+ },
2995
+ {
2996
+ "name": "rowHeader",
2997
+ "value": "rowHeader",
2998
+ "description": "Description of the row content."
2999
+ },
3000
+ {
3001
+ "name": "columnHeader",
3002
+ "value": "columnHeader",
3003
+ "description": "Description the column content."
3004
+ },
3005
+ {
3006
+ "name": "stubHead",
3007
+ "value": "stubHead",
3008
+ "description": "Description of the row headers, usually located at the top left corner of a table."
3009
+ },
3010
+ {
3011
+ "name": "description",
3012
+ "value": "description",
3013
+ "description": "Description of the content in (parts of) the table."
3014
+ }
3015
+ ]
3016
+ }
3017
+ },
3018
+ "rowIndex": {
3019
+ "type": "integer",
3020
+ "format": "int32",
3021
+ "description": "Row index of the cell."
3022
+ },
3023
+ "columnIndex": {
3024
+ "type": "integer",
3025
+ "format": "int32",
3026
+ "description": "Column index of the cell."
3027
+ },
3028
+ "rowSpan": {
3029
+ "type": "integer",
3030
+ "format": "int32",
3031
+ "description": "Number of rows spanned by this cell.",
3032
+ "default": 1,
3033
+ "minimum": 1
3034
+ },
3035
+ "columnSpan": {
3036
+ "type": "integer",
3037
+ "format": "int32",
3038
+ "description": "Number of columns spanned by this cell.",
3039
+ "default": 1,
3040
+ "minimum": 1
3041
+ },
3042
+ "content": {
3043
+ "type": "string",
3044
+ "description": "Content of the table cell."
3045
+ },
3046
+ "source": {
3047
+ "$ref": "#/definitions/SourceExpression",
3048
+ "description": "Encoded source that identifies the position of the table cell in the content."
3049
+ },
3050
+ "span": {
3051
+ "$ref": "#/definitions/ContentSpan",
3052
+ "description": "Span of the table cell in the markdown content."
3053
+ },
3054
+ "elements": {
3055
+ "type": "array",
3056
+ "description": "Child elements of the table cell.",
3057
+ "items": {
3058
+ "$ref": "#/definitions/DocumentElement"
3059
+ }
3060
+ }
3061
+ },
3062
+ "required": [
3063
+ "rowIndex",
3064
+ "columnIndex",
3065
+ "content"
3066
+ ]
3067
+ },
3068
+ "DocumentWord": {
3069
+ "type": "object",
3070
+ "description": "Word in a document, consisting of a contiguous sequence of characters.\nFor non-space delimited languages, such as Chinese, Japanese, and Korean, \neach character is represented as its own word.",
3071
+ "properties": {
3072
+ "content": {
3073
+ "type": "string",
3074
+ "description": "Word text."
3075
+ },
3076
+ "source": {
3077
+ "$ref": "#/definitions/SourceExpression",
3078
+ "description": "Encoded source that identifies the position of the word in the content."
3079
+ },
3080
+ "span": {
3081
+ "$ref": "#/definitions/ContentSpan",
3082
+ "description": "Span of the word in the markdown content."
3083
+ },
3084
+ "confidence": {
3085
+ "type": "number",
3086
+ "format": "float",
3087
+ "description": "Confidence of predicting the word.",
3088
+ "minimum": 0,
3089
+ "maximum": 1
3090
+ }
3091
+ },
3092
+ "required": [
3093
+ "content"
3094
+ ]
3095
+ },
3096
+ "GenerationMethod": {
3097
+ "type": "string",
3098
+ "description": "Generation method.",
3099
+ "enum": [
3100
+ "generate",
3101
+ "extract",
3102
+ "classify"
3103
+ ],
3104
+ "x-ms-enum": {
3105
+ "name": "GenerationMethod",
3106
+ "modelAsString": true,
3107
+ "values": [
3108
+ {
3109
+ "name": "generate",
3110
+ "value": "generate",
3111
+ "description": "Values are generated freely based on the content."
3112
+ },
3113
+ {
3114
+ "name": "extract",
3115
+ "value": "extract",
3116
+ "description": "Values are extracted as they appear in the content."
3117
+ },
3118
+ {
3119
+ "name": "classify",
3120
+ "value": "classify",
3121
+ "description": "Values are classified against a predefined set of categories."
3122
+ }
3123
+ ]
3124
+ }
3125
+ },
3126
+ "GrantCopyAuthorizationRequest": {
3127
+ "type": "object",
3128
+ "description": "Grant copy authorization request.",
3129
+ "properties": {
3130
+ "targetAzureResourceId": {
3131
+ "type": "string",
3132
+ "description": "Azure resource ID of the target analyzer location."
3133
+ },
3134
+ "targetRegion": {
3135
+ "type": "string",
3136
+ "description": "Azure region of the target analyzer location. Defaults to current region."
3137
+ }
3138
+ },
3139
+ "required": [
3140
+ "targetAzureResourceId"
3141
+ ]
3142
+ },
3143
+ "IntegerField": {
3144
+ "type": "object",
3145
+ "description": "Integer field extracted from the content.",
3146
+ "properties": {
3147
+ "valueInteger": {
3148
+ "type": "integer",
3149
+ "format": "int64",
3150
+ "description": "Integer field value."
3151
+ }
3152
+ },
3153
+ "allOf": [
3154
+ {
3155
+ "$ref": "#/definitions/ContentField"
3156
+ }
3157
+ ],
3158
+ "x-ms-discriminator-value": "integer"
3159
+ },
3160
+ "JsonField": {
3161
+ "type": "object",
3162
+ "description": "JSON field extracted from the content.",
3163
+ "properties": {
3164
+ "valueJson": {
3165
+ "description": "JSON field value."
3166
+ }
3167
+ },
3168
+ "allOf": [
3169
+ {
3170
+ "$ref": "#/definitions/ContentField"
3171
+ }
3172
+ ],
3173
+ "x-ms-discriminator-value": "json"
3174
+ },
3175
+ "KnowledgeSource": {
3176
+ "type": "object",
3177
+ "description": "Knowledge source.",
3178
+ "properties": {
3179
+ "kind": {
3180
+ "$ref": "#/definitions/KnowledgeSourceKind",
3181
+ "description": "The kind of knowledge source."
3182
+ }
3183
+ },
3184
+ "discriminator": "kind",
3185
+ "required": [
3186
+ "kind"
3187
+ ]
3188
+ },
3189
+ "KnowledgeSourceKind": {
3190
+ "type": "string",
3191
+ "description": "Knowledge source kind.",
3192
+ "enum": [
3193
+ "labeledData"
3194
+ ],
3195
+ "x-ms-enum": {
3196
+ "name": "KnowledgeSourceKind",
3197
+ "modelAsString": true,
3198
+ "values": [
3199
+ {
3200
+ "name": "labeledData",
3201
+ "value": "labeledData",
3202
+ "description": "A labeled data knowledge source."
3203
+ }
3204
+ ]
3205
+ }
3206
+ },
3207
+ "LabeledDataKnowledgeSource": {
3208
+ "type": "object",
3209
+ "description": "Labeled data knowledge source.",
3210
+ "properties": {
3211
+ "containerUrl": {
3212
+ "type": "string",
3213
+ "format": "uri",
3214
+ "description": "The URL of the blob container containing labeled data."
3215
+ },
3216
+ "prefix": {
3217
+ "type": "string",
3218
+ "description": "An optional prefix to filter blobs within the container."
3219
+ },
3220
+ "fileListPath": {
3221
+ "type": "string",
3222
+ "description": "An optional path to a file listing specific blobs to include."
3223
+ }
3224
+ },
3225
+ "required": [
3226
+ "containerUrl",
3227
+ "fileListPath"
3228
+ ],
3229
+ "allOf": [
3230
+ {
3231
+ "$ref": "#/definitions/KnowledgeSource"
3232
+ }
3233
+ ],
3234
+ "x-ms-discriminator-value": "labeledData"
3235
+ },
3236
+ "LengthUnit": {
3237
+ "type": "string",
3238
+ "description": "Length unit used by the width, height, and source properties.",
3239
+ "enum": [
3240
+ "pixel",
3241
+ "inch"
3242
+ ],
3243
+ "x-ms-enum": {
3244
+ "name": "LengthUnit",
3245
+ "modelAsString": true,
3246
+ "values": [
3247
+ {
3248
+ "name": "pixel",
3249
+ "value": "pixel",
3250
+ "description": "Pixel unit."
3251
+ },
3252
+ {
3253
+ "name": "inch",
3254
+ "value": "inch",
3255
+ "description": "Inch unit."
3256
+ }
3257
+ ]
3258
+ }
3259
+ },
3260
+ "NumberField": {
3261
+ "type": "object",
3262
+ "description": "Number field extracted from the content.",
3263
+ "properties": {
3264
+ "valueNumber": {
3265
+ "type": "number",
3266
+ "format": "double",
3267
+ "description": "Number field value."
3268
+ }
3269
+ },
3270
+ "allOf": [
3271
+ {
3272
+ "$ref": "#/definitions/ContentField"
3273
+ }
3274
+ ],
3275
+ "x-ms-discriminator-value": "number"
3276
+ },
3277
+ "ObjectField": {
3278
+ "type": "object",
3279
+ "description": "Object field extracted from the content.",
3280
+ "properties": {
3281
+ "valueObject": {
3282
+ "type": "object",
3283
+ "description": "Object field value.",
3284
+ "additionalProperties": {
3285
+ "$ref": "#/definitions/ContentField"
3286
+ }
3287
+ }
3288
+ },
3289
+ "allOf": [
3290
+ {
3291
+ "$ref": "#/definitions/ContentField"
3292
+ }
3293
+ ],
3294
+ "x-ms-discriminator-value": "object"
3295
+ },
3296
+ "PagedContentAnalyzer": {
3297
+ "type": "object",
3298
+ "description": "Paged collection of ContentAnalyzer items",
3299
+ "properties": {
3300
+ "value": {
3301
+ "type": "array",
3302
+ "description": "The ContentAnalyzer items on this page",
3303
+ "items": {
3304
+ "$ref": "#/definitions/ContentAnalyzer"
3305
+ }
3306
+ },
3307
+ "nextLink": {
3308
+ "type": "string",
3309
+ "format": "uri",
3310
+ "description": "The link to the next page of items"
3311
+ }
3312
+ },
3313
+ "required": [
3314
+ "value"
3315
+ ]
3316
+ },
3317
+ "RangeExpression": {
3318
+ "type": "string",
3319
+ "description": " Range expression for specifying parts of the input to analyze (ex. `1-3,5,9-`).\n Document content uses 1-based page numbers, while audio visual content uses integer milliseconds."
3320
+ },
3321
+ "SemanticRole": {
3322
+ "type": "string",
3323
+ "description": "Semantic role of the paragraph.",
3324
+ "enum": [
3325
+ "pageHeader",
3326
+ "pageFooter",
3327
+ "pageNumber",
3328
+ "title",
3329
+ "sectionHeading",
3330
+ "footnote",
3331
+ "formulaBlock"
3332
+ ],
3333
+ "x-ms-enum": {
3334
+ "name": "SemanticRole",
3335
+ "modelAsString": true,
3336
+ "values": [
3337
+ {
3338
+ "name": "pageHeader",
3339
+ "value": "pageHeader",
3340
+ "description": "Text near the top edge of the page."
3341
+ },
3342
+ {
3343
+ "name": "pageFooter",
3344
+ "value": "pageFooter",
3345
+ "description": "Text near the bottom edge of the page."
3346
+ },
3347
+ {
3348
+ "name": "pageNumber",
3349
+ "value": "pageNumber",
3350
+ "description": "Page number."
3351
+ },
3352
+ {
3353
+ "name": "title",
3354
+ "value": "title",
3355
+ "description": "Top-level title describing the entire document."
3356
+ },
3357
+ {
3358
+ "name": "sectionHeading",
3359
+ "value": "sectionHeading",
3360
+ "description": "Sub heading describing a section of the document."
3361
+ },
3362
+ {
3363
+ "name": "footnote",
3364
+ "value": "footnote",
3365
+ "description": "Note usually placed after the main content on a page."
3366
+ },
3367
+ {
3368
+ "name": "formulaBlock",
3369
+ "value": "formulaBlock",
3370
+ "description": "Block of formulas, often with shared alignment."
3371
+ }
3372
+ ]
3373
+ }
3374
+ },
3375
+ "SourceExpression": {
3376
+ "type": "string",
3377
+ "description": "Encoded string expression that describes positions in the content."
3378
+ },
3379
+ "StringField": {
3380
+ "type": "object",
3381
+ "description": "String field extracted from the content.",
3382
+ "properties": {
3383
+ "valueString": {
3384
+ "type": "string",
3385
+ "description": "String field value."
3386
+ }
3387
+ },
3388
+ "allOf": [
3389
+ {
3390
+ "$ref": "#/definitions/ContentField"
3391
+ }
3392
+ ],
3393
+ "x-ms-discriminator-value": "string"
3394
+ },
3395
+ "SupportedModels": {
3396
+ "type": "object",
3397
+ "description": "Chat completion and embedding models supported by the analyzer.",
3398
+ "properties": {
3399
+ "completion": {
3400
+ "type": "array",
3401
+ "description": "Chat completion models supported by the analyzer.",
3402
+ "items": {
3403
+ "type": "string"
3404
+ }
3405
+ },
3406
+ "embedding": {
3407
+ "type": "array",
3408
+ "description": "Embedding models supported by the analyzer.",
3409
+ "items": {
3410
+ "type": "string"
3411
+ }
3412
+ }
3413
+ }
3414
+ },
3415
+ "TimeField": {
3416
+ "type": "object",
3417
+ "description": "Time field extracted from the content.",
3418
+ "properties": {
3419
+ "valueTime": {
3420
+ "type": "string",
3421
+ "format": "time",
3422
+ "description": "Time field value, in ISO 8601 (hh:mm:ss) format."
3423
+ }
3424
+ },
3425
+ "allOf": [
3426
+ {
3427
+ "$ref": "#/definitions/ContentField"
3428
+ }
3429
+ ],
3430
+ "x-ms-discriminator-value": "time"
3431
+ },
3432
+ "TranscriptPhrase": {
3433
+ "type": "object",
3434
+ "description": "Transcript phrase.",
3435
+ "properties": {
3436
+ "speaker": {
3437
+ "type": "string",
3438
+ "description": "Speaker index or name."
3439
+ },
3440
+ "startTimeMs": {
3441
+ "type": "integer",
3442
+ "format": "int64",
3443
+ "description": "Start time of the phrase in milliseconds."
3444
+ },
3445
+ "endTimeMs": {
3446
+ "type": "integer",
3447
+ "format": "int64",
3448
+ "description": "End time of the phrase in milliseconds."
3449
+ },
3450
+ "locale": {
3451
+ "type": "string",
3452
+ "description": "Detected locale of the phrase. Ex. en-US."
3453
+ },
3454
+ "text": {
3455
+ "type": "string",
3456
+ "description": "Transcript text."
3457
+ },
3458
+ "confidence": {
3459
+ "type": "number",
3460
+ "format": "float",
3461
+ "description": "Confidence of predicting the phrase.",
3462
+ "minimum": 0,
3463
+ "maximum": 1
3464
+ },
3465
+ "span": {
3466
+ "$ref": "#/definitions/ContentSpan",
3467
+ "description": "Span of the phrase in the markdown content."
3468
+ },
3469
+ "words": {
3470
+ "type": "array",
3471
+ "description": "List of words in the phrase.",
3472
+ "items": {
3473
+ "$ref": "#/definitions/TranscriptWord"
3474
+ }
3475
+ }
3476
+ },
3477
+ "required": [
3478
+ "startTimeMs",
3479
+ "endTimeMs",
3480
+ "text",
3481
+ "words"
3482
+ ]
3483
+ },
3484
+ "TranscriptWord": {
3485
+ "type": "object",
3486
+ "description": "Transcript word.",
3487
+ "properties": {
3488
+ "startTimeMs": {
3489
+ "type": "integer",
3490
+ "format": "int64",
3491
+ "description": "Start time of the word in milliseconds."
3492
+ },
3493
+ "endTimeMs": {
3494
+ "type": "integer",
3495
+ "format": "int64",
3496
+ "description": "End time of the word in milliseconds."
3497
+ },
3498
+ "text": {
3499
+ "type": "string",
3500
+ "description": "Transcript text."
3501
+ },
3502
+ "span": {
3503
+ "$ref": "#/definitions/ContentSpan",
3504
+ "description": "Span of the word in the markdown content."
3505
+ }
3506
+ },
3507
+ "required": [
3508
+ "startTimeMs",
3509
+ "endTimeMs",
3510
+ "text"
3511
+ ]
3512
+ },
3513
+ "UsageDetails": {
3514
+ "type": "object",
3515
+ "description": "Usage details.",
3516
+ "properties": {
3517
+ "documentPagesMinimal": {
3518
+ "type": "integer",
3519
+ "format": "int32",
3520
+ "description": "The number of document pages processed at the minimal level.\nFor documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page."
3521
+ },
3522
+ "documentPagesBasic": {
3523
+ "type": "integer",
3524
+ "format": "int32",
3525
+ "description": "The number of document pages processed at the basic level.\nFor documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page."
3526
+ },
3527
+ "documentPagesStandard": {
3528
+ "type": "integer",
3529
+ "format": "int32",
3530
+ "description": "The number of document pages processed at the standard level.\nFor documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page."
3531
+ },
3532
+ "audioHours": {
3533
+ "type": "number",
3534
+ "format": "float",
3535
+ "description": "The hours of audio processed."
3536
+ },
3537
+ "videoHours": {
3538
+ "type": "number",
3539
+ "format": "float",
3540
+ "description": "The hours of video processed."
3541
+ },
3542
+ "contextualizationTokens": {
3543
+ "type": "integer",
3544
+ "format": "int32",
3545
+ "description": "The number of contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting."
3546
+ },
3547
+ "tokens": {
3548
+ "type": "object",
3549
+ "description": "The number of LLM and embedding tokens consumed, grouped by model (ex. GTP 4.1) and type (ex. input, cached input, output).",
3550
+ "additionalProperties": {
3551
+ "format": "int32",
3552
+ "type": "integer"
3553
+ }
3554
+ }
3555
+ }
3556
+ }
3557
+ },
3558
+ "parameters": {
3559
+ "AnalyzeBinaryRequest.input": {
3560
+ "name": "input",
3561
+ "in": "body",
3562
+ "description": "The binary content of the document to analyze.",
3563
+ "required": true,
3564
+ "schema": {
3565
+ "type": "string",
3566
+ "format": "binary"
3567
+ },
3568
+ "x-ms-parameter-location": "method"
3569
+ },
3570
+ "AnalyzeBinaryRequest.range": {
3571
+ "name": "range",
3572
+ "in": "query",
3573
+ "description": "Range of the input to analyze (ex. `1-3,5,9-`). Document content uses 1-based page numbers, while audio visual content uses integer milliseconds.",
3574
+ "required": false,
3575
+ "type": "string",
3576
+ "x-ms-parameter-location": "method"
3577
+ },
3578
+ "AnalyzeParameters.processingLocation": {
3579
+ "name": "processingLocation",
3580
+ "in": "query",
3581
+ "description": "The location where the data may be processed. Defaults to global.",
3582
+ "required": false,
3583
+ "type": "string",
3584
+ "default": "global",
3585
+ "enum": [
3586
+ "geography",
3587
+ "dataZone",
3588
+ "global"
3589
+ ],
3590
+ "x-ms-enum": {
3591
+ "name": "ProcessingLocation",
3592
+ "modelAsString": true,
3593
+ "values": [
3594
+ {
3595
+ "name": "geography",
3596
+ "value": "geography",
3597
+ "description": "Data may be processed in the same geography as the resource."
3598
+ },
3599
+ {
3600
+ "name": "dataZone",
3601
+ "value": "dataZone",
3602
+ "description": "Data may be processed in the same data zone as the resource."
3603
+ },
3604
+ {
3605
+ "name": "global",
3606
+ "value": "global",
3607
+ "description": "Data may be processed in any Azure data center globally."
3608
+ }
3609
+ ]
3610
+ },
3611
+ "x-ms-parameter-location": "method"
3612
+ },
3613
+ "AnalyzeParameters.stringEncoding": {
3614
+ "name": "stringEncoding",
3615
+ "in": "query",
3616
+ "description": " The string encoding format for content spans in the response.\n Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.\")",
3617
+ "required": false,
3618
+ "type": "string",
3619
+ "default": "codePoint",
3620
+ "x-ms-parameter-location": "method"
3621
+ },
3622
+ "Azure.Core.ClientRequestIdHeader": {
3623
+ "name": "x-ms-client-request-id",
3624
+ "in": "header",
3625
+ "description": "An opaque, globally-unique, client-generated string identifier for the request.",
3626
+ "required": false,
3627
+ "type": "string",
3628
+ "format": "uuid",
3629
+ "x-ms-parameter-location": "method",
3630
+ "x-ms-client-name": "clientRequestId"
3631
+ },
3632
+ "Azure.Core.Foundations.ApiVersionParameter": {
3633
+ "name": "api-version",
3634
+ "in": "query",
3635
+ "description": "The API version to use for this operation.",
3636
+ "required": true,
3637
+ "type": "string",
3638
+ "minLength": 1,
3639
+ "x-ms-parameter-location": "method",
3640
+ "x-ms-client-name": "apiVersion"
3641
+ }
3642
+ }
3643
+ }