@azure/ai-form-recognizer 4.0.0-beta.6 → 4.0.0

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.
Files changed (29) hide show
  1. package/README.md +20 -22
  2. package/dist/index.js +274 -327
  3. package/dist/index.js.map +1 -1
  4. package/dist-esm/src/constants.js +1 -1
  5. package/dist-esm/src/constants.js.map +1 -1
  6. package/dist-esm/src/documentModel.js.map +1 -1
  7. package/dist-esm/src/documentModelAdministrationClient.js +32 -32
  8. package/dist-esm/src/documentModelAdministrationClient.js.map +1 -1
  9. package/dist-esm/src/generated/generatedClient.js +33 -54
  10. package/dist-esm/src/generated/generatedClient.js.map +1 -1
  11. package/dist-esm/src/generated/models/index.js +2 -14
  12. package/dist-esm/src/generated/models/index.js.map +1 -1
  13. package/dist-esm/src/generated/models/mappers.js +189 -189
  14. package/dist-esm/src/generated/models/mappers.js.map +1 -1
  15. package/dist-esm/src/generated/models/parameters.js +4 -38
  16. package/dist-esm/src/generated/models/parameters.js.map +1 -1
  17. package/dist-esm/src/index.js.map +1 -1
  18. package/dist-esm/src/lro/administration.js +3 -3
  19. package/dist-esm/src/lro/administration.js.map +1 -1
  20. package/dist-esm/src/lro/analysis.js +2 -2
  21. package/dist-esm/src/lro/analysis.js.map +1 -1
  22. package/dist-esm/src/models/documentElements.js.map +1 -1
  23. package/dist-esm/src/options/BuildModelOptions.js.map +1 -1
  24. package/dist-esm/src/options/DeleteModelOptions.js.map +1 -1
  25. package/dist-esm/src/options/FormRecognizerClientOptions.js +3 -2
  26. package/dist-esm/src/options/FormRecognizerClientOptions.js.map +1 -1
  27. package/dist-esm/src/options/index.js.map +1 -1
  28. package/package.json +1 -1
  29. package/types/ai-form-recognizer.d.ts +108 -65
@@ -128,14 +128,14 @@ export const AnalyzeResultOperation = {
128
128
  allowedValues: ["notStarted", "running", "failed", "succeeded"]
129
129
  }
130
130
  },
131
- createdDateTime: {
131
+ createdOn: {
132
132
  serializedName: "createdDateTime",
133
133
  required: true,
134
134
  type: {
135
135
  name: "DateTime"
136
136
  }
137
137
  },
138
- lastUpdatedDateTime: {
138
+ lastUpdatedOn: {
139
139
  serializedName: "lastUpdatedDateTime",
140
140
  required: true,
141
141
  type: {
@@ -288,13 +288,6 @@ export const DocumentPage = {
288
288
  name: "Composite",
289
289
  className: "DocumentPage",
290
290
  modelProperties: {
291
- kind: {
292
- serializedName: "kind",
293
- required: true,
294
- type: {
295
- name: "String"
296
- }
297
- },
298
291
  pageNumber: {
299
292
  constraints: {
300
293
  InclusiveMinimum: 1
@@ -376,18 +369,6 @@ export const DocumentPage = {
376
369
  }
377
370
  }
378
371
  },
379
- images: {
380
- serializedName: "images",
381
- type: {
382
- name: "Sequence",
383
- element: {
384
- type: {
385
- name: "Composite",
386
- className: "DocumentImage"
387
- }
388
- }
389
- }
390
- },
391
372
  lines: {
392
373
  serializedName: "lines",
393
374
  type: {
@@ -525,56 +506,6 @@ export const DocumentSelectionMark = {
525
506
  }
526
507
  }
527
508
  };
528
- export const DocumentImage = {
529
- type: {
530
- name: "Composite",
531
- className: "DocumentImage",
532
- modelProperties: {
533
- polygon: {
534
- serializedName: "polygon",
535
- type: {
536
- name: "Sequence",
537
- element: {
538
- constraints: {
539
- InclusiveMinimum: 0
540
- },
541
- type: {
542
- name: "Number"
543
- }
544
- }
545
- }
546
- },
547
- span: {
548
- serializedName: "span",
549
- type: {
550
- name: "Composite",
551
- className: "DocumentSpan"
552
- }
553
- },
554
- pageRef: {
555
- constraints: {
556
- InclusiveMinimum: 0
557
- },
558
- serializedName: "pageRef",
559
- required: true,
560
- type: {
561
- name: "Number"
562
- }
563
- },
564
- confidence: {
565
- constraints: {
566
- InclusiveMaximum: 1,
567
- InclusiveMinimum: 0
568
- },
569
- serializedName: "confidence",
570
- required: true,
571
- type: {
572
- name: "Number"
573
- }
574
- }
575
- }
576
- }
577
- };
578
509
  export const DocumentLine = {
579
510
  type: {
580
511
  name: "Composite",
@@ -734,25 +665,6 @@ export const DocumentTable = {
734
665
  }
735
666
  }
736
667
  },
737
- caption: {
738
- serializedName: "caption",
739
- type: {
740
- name: "Composite",
741
- className: "DocumentCaption"
742
- }
743
- },
744
- footnotes: {
745
- serializedName: "footnotes",
746
- type: {
747
- name: "Sequence",
748
- element: {
749
- type: {
750
- name: "Composite",
751
- className: "DocumentFootnote"
752
- }
753
- }
754
- }
755
- },
756
668
  boundingRegions: {
757
669
  serializedName: "boundingRegions",
758
670
  type: {
@@ -862,86 +774,6 @@ export const DocumentTableCell = {
862
774
  }
863
775
  }
864
776
  };
865
- export const DocumentCaption = {
866
- type: {
867
- name: "Composite",
868
- className: "DocumentCaption",
869
- modelProperties: {
870
- content: {
871
- serializedName: "content",
872
- required: true,
873
- type: {
874
- name: "String"
875
- }
876
- },
877
- boundingRegions: {
878
- serializedName: "boundingRegions",
879
- type: {
880
- name: "Sequence",
881
- element: {
882
- type: {
883
- name: "Composite",
884
- className: "BoundingRegion"
885
- }
886
- }
887
- }
888
- },
889
- spans: {
890
- serializedName: "spans",
891
- required: true,
892
- type: {
893
- name: "Sequence",
894
- element: {
895
- type: {
896
- name: "Composite",
897
- className: "DocumentSpan"
898
- }
899
- }
900
- }
901
- }
902
- }
903
- }
904
- };
905
- export const DocumentFootnote = {
906
- type: {
907
- name: "Composite",
908
- className: "DocumentFootnote",
909
- modelProperties: {
910
- content: {
911
- serializedName: "content",
912
- required: true,
913
- type: {
914
- name: "String"
915
- }
916
- },
917
- boundingRegions: {
918
- serializedName: "boundingRegions",
919
- type: {
920
- name: "Sequence",
921
- element: {
922
- type: {
923
- name: "Composite",
924
- className: "BoundingRegion"
925
- }
926
- }
927
- }
928
- },
929
- spans: {
930
- serializedName: "spans",
931
- required: true,
932
- type: {
933
- name: "Sequence",
934
- element: {
935
- type: {
936
- name: "Composite",
937
- className: "DocumentSpan"
938
- }
939
- }
940
- }
941
- }
942
- }
943
- }
944
- };
945
777
  export const DocumentKeyValuePair = {
946
778
  type: {
947
779
  name: "Composite",
@@ -1660,14 +1492,99 @@ export const OperationSummary = {
1660
1492
  name: "Number"
1661
1493
  }
1662
1494
  },
1663
- createdDateTime: {
1495
+ createdOn: {
1496
+ serializedName: "createdDateTime",
1497
+ required: true,
1498
+ type: {
1499
+ name: "DateTime"
1500
+ }
1501
+ },
1502
+ lastUpdatedOn: {
1503
+ serializedName: "lastUpdatedDateTime",
1504
+ required: true,
1505
+ type: {
1506
+ name: "DateTime"
1507
+ }
1508
+ },
1509
+ kind: {
1510
+ serializedName: "kind",
1511
+ required: true,
1512
+ type: {
1513
+ name: "String"
1514
+ }
1515
+ },
1516
+ resourceLocation: {
1517
+ serializedName: "resourceLocation",
1518
+ required: true,
1519
+ type: {
1520
+ name: "String"
1521
+ }
1522
+ },
1523
+ apiVersion: {
1524
+ serializedName: "apiVersion",
1525
+ type: {
1526
+ name: "String"
1527
+ }
1528
+ },
1529
+ tags: {
1530
+ serializedName: "tags",
1531
+ type: {
1532
+ name: "Dictionary",
1533
+ value: { type: { name: "String" } }
1534
+ }
1535
+ }
1536
+ }
1537
+ }
1538
+ };
1539
+ export const OperationDetails = {
1540
+ type: {
1541
+ name: "Composite",
1542
+ className: "OperationDetails",
1543
+ uberParent: "OperationDetails",
1544
+ polymorphicDiscriminator: {
1545
+ serializedName: "kind",
1546
+ clientName: "kind"
1547
+ },
1548
+ modelProperties: {
1549
+ operationId: {
1550
+ serializedName: "operationId",
1551
+ required: true,
1552
+ type: {
1553
+ name: "String"
1554
+ }
1555
+ },
1556
+ status: {
1557
+ serializedName: "status",
1558
+ required: true,
1559
+ type: {
1560
+ name: "Enum",
1561
+ allowedValues: [
1562
+ "notStarted",
1563
+ "running",
1564
+ "failed",
1565
+ "succeeded",
1566
+ "canceled"
1567
+ ]
1568
+ }
1569
+ },
1570
+ percentCompleted: {
1571
+ constraints: {
1572
+ InclusiveMaximum: 100,
1573
+ InclusiveMinimum: 0
1574
+ },
1575
+ serializedName: "percentCompleted",
1576
+ type: {
1577
+ name: "Number"
1578
+ }
1579
+ },
1580
+ createdOn: {
1664
1581
  serializedName: "createdDateTime",
1665
1582
  required: true,
1666
1583
  type: {
1667
1584
  name: "DateTime"
1668
1585
  }
1669
1586
  },
1670
- lastUpdatedDateTime: {
1587
+ lastUpdatedOn: {
1671
1588
  serializedName: "lastUpdatedDateTime",
1672
1589
  required: true,
1673
1590
  type: {
@@ -1700,6 +1617,13 @@ export const OperationSummary = {
1700
1617
  name: "Dictionary",
1701
1618
  value: { type: { name: "String" } }
1702
1619
  }
1620
+ },
1621
+ error: {
1622
+ serializedName: "error",
1623
+ type: {
1624
+ name: "Composite",
1625
+ className: "ErrorModel"
1626
+ }
1703
1627
  }
1704
1628
  }
1705
1629
  }
@@ -1755,7 +1679,54 @@ export const DocumentModelSummary = {
1755
1679
  name: "String"
1756
1680
  }
1757
1681
  },
1758
- createdDateTime: {
1682
+ createdOn: {
1683
+ serializedName: "createdDateTime",
1684
+ required: true,
1685
+ type: {
1686
+ name: "DateTime"
1687
+ }
1688
+ },
1689
+ apiVersion: {
1690
+ serializedName: "apiVersion",
1691
+ type: {
1692
+ name: "String"
1693
+ }
1694
+ },
1695
+ tags: {
1696
+ serializedName: "tags",
1697
+ type: {
1698
+ name: "Dictionary",
1699
+ value: { type: { name: "String" } }
1700
+ }
1701
+ }
1702
+ }
1703
+ }
1704
+ };
1705
+ export const DocumentModelDetails = {
1706
+ type: {
1707
+ name: "Composite",
1708
+ className: "DocumentModelDetails",
1709
+ modelProperties: {
1710
+ modelId: {
1711
+ constraints: {
1712
+ Pattern: new RegExp("[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}")
1713
+ },
1714
+ serializedName: "modelId",
1715
+ required: true,
1716
+ type: {
1717
+ name: "String"
1718
+ }
1719
+ },
1720
+ description: {
1721
+ constraints: {
1722
+ MaxLength: 4096
1723
+ },
1724
+ serializedName: "description",
1725
+ type: {
1726
+ name: "String"
1727
+ }
1728
+ },
1729
+ createdOn: {
1759
1730
  serializedName: "createdDateTime",
1760
1731
  required: true,
1761
1732
  type: {
@@ -1774,6 +1745,15 @@ export const DocumentModelSummary = {
1774
1745
  name: "Dictionary",
1775
1746
  value: { type: { name: "String" } }
1776
1747
  }
1748
+ },
1749
+ docTypes: {
1750
+ serializedName: "docTypes",
1751
+ type: {
1752
+ name: "Dictionary",
1753
+ value: {
1754
+ type: { name: "Composite", className: "DocumentTypeDetails" }
1755
+ }
1756
+ }
1777
1757
  }
1778
1758
  }
1779
1759
  }
@@ -1901,36 +1881,50 @@ export const CustomDocumentModelsDetails = {
1901
1881
  }
1902
1882
  }
1903
1883
  };
1904
- export const OperationDetails = {
1884
+ export const DocumentModelBuildOperationDetails = {
1885
+ serializedName: "documentModelBuild",
1905
1886
  type: {
1906
1887
  name: "Composite",
1907
- className: "OperationDetails",
1908
- modelProperties: Object.assign(Object.assign({}, OperationSummary.type.modelProperties), { error: {
1909
- serializedName: "error",
1888
+ className: "DocumentModelBuildOperationDetails",
1889
+ uberParent: "OperationDetails",
1890
+ polymorphicDiscriminator: OperationDetails.type.polymorphicDiscriminator,
1891
+ modelProperties: Object.assign(Object.assign({}, OperationDetails.type.modelProperties), { result: {
1892
+ serializedName: "result",
1910
1893
  type: {
1911
1894
  name: "Composite",
1912
- className: "ErrorModel"
1895
+ className: "DocumentModelDetails"
1913
1896
  }
1914
- }, result: {
1897
+ } })
1898
+ }
1899
+ };
1900
+ export const DocumentModelComposeOperationDetails = {
1901
+ serializedName: "documentModelCompose",
1902
+ type: {
1903
+ name: "Composite",
1904
+ className: "DocumentModelComposeOperationDetails",
1905
+ uberParent: "OperationDetails",
1906
+ polymorphicDiscriminator: OperationDetails.type.polymorphicDiscriminator,
1907
+ modelProperties: Object.assign(Object.assign({}, OperationDetails.type.modelProperties), { result: {
1915
1908
  serializedName: "result",
1916
1909
  type: {
1917
- name: "Dictionary",
1918
- value: { type: { name: "any" } }
1910
+ name: "Composite",
1911
+ className: "DocumentModelDetails"
1919
1912
  }
1920
1913
  } })
1921
1914
  }
1922
1915
  };
1923
- export const DocumentModelDetails = {
1916
+ export const DocumentModelCopyToOperationDetails = {
1917
+ serializedName: "documentModelCopyTo",
1924
1918
  type: {
1925
1919
  name: "Composite",
1926
- className: "DocumentModelDetails",
1927
- modelProperties: Object.assign(Object.assign({}, DocumentModelSummary.type.modelProperties), { docTypes: {
1928
- serializedName: "docTypes",
1920
+ className: "DocumentModelCopyToOperationDetails",
1921
+ uberParent: "OperationDetails",
1922
+ polymorphicDiscriminator: OperationDetails.type.polymorphicDiscriminator,
1923
+ modelProperties: Object.assign(Object.assign({}, OperationDetails.type.modelProperties), { result: {
1924
+ serializedName: "result",
1929
1925
  type: {
1930
- name: "Dictionary",
1931
- value: {
1932
- type: { name: "Composite", className: "DocumentTypeDetails" }
1933
- }
1926
+ name: "Composite",
1927
+ className: "DocumentModelDetails"
1934
1928
  }
1935
1929
  } })
1936
1930
  }
@@ -1991,4 +1985,10 @@ export const GeneratedClientCopyDocumentModelToHeaders = {
1991
1985
  }
1992
1986
  }
1993
1987
  };
1988
+ export let discriminators = {
1989
+ OperationDetails: OperationDetails,
1990
+ "OperationDetails.documentModelBuild": DocumentModelBuildOperationDetails,
1991
+ "OperationDetails.documentModelCompose": DocumentModelComposeOperationDetails,
1992
+ "OperationDetails.documentModelCopyTo": DocumentModelCopyToOperationDetails
1993
+ };
1994
1994
  //# sourceMappingURL=mappers.js.map