Merge pull request #214 from HarshaNalluru/harshan/issue/207

[Form Recognizer] BoundingBox to BoundingPolygon
Azure · May 12, 2022 · e2165a9 · e2165a9
2 parents f3ab973 + fa375e2
commit e2165a9
Show file tree

Hide file tree

Showing 16 changed files with 546 additions and 218 deletions.
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md
@@ -10,6 +10,7 @@
 ### Breaking Changes
 
 - Renamed the `beginCopyModel` method of `DocumentModelAdministrationClient` to `beginCopyModelTo`. [#20775](https://github.com/Azure/azure-sdk-for-js/pull/20775)
+- Renamed `BoundingRegion#boundingBox` to `BoundingRegion#polygon`, as the service may now provide arbitrary, polygonal bounding areas rather than just rectangles.
 
 ### Bugs Fixed
 

diff --git a/sdk/formrecognizer/ai-form-recognizer/package.json b/sdk/formrecognizer/ai-form-recognizer/package.json
@@ -108,6 +108,7 @@
     "cross-env": "^7.0.2",
     "dotenv": "^8.2.0",
     "eslint": "^7.15.0",
+    "esm": "^3.2.18",
     "karma": "^6.2.0",
     "karma-chrome-launcher": "^3.0.0",
     "karma-coverage": "^2.0.0",

diff --git a/sdk/formrecognizer/ai-form-recognizer/review/ai-form-recognizer.api.md b/sdk/formrecognizer/ai-form-recognizer/review/ai-form-recognizer.api.md
@@ -69,9 +69,8 @@ export interface ArrayFieldSchema<Item extends Readonly<FieldSchema> = Readonly<
 export { AzureKeyCredential }
 
 // @public
-export interface BoundingRegion {
+export interface BoundingRegion extends HasBoundingPolygon {
     pageNumber: number;
-    polygon: number[];
 }
 
 // @public
@@ -338,6 +337,13 @@ export interface DocumentFieldSchema {
 // @public
 export type DocumentFieldType = string;
 
+// @public
+export interface DocumentImage extends HasBoundingPolygon {
+    confidence: number;
+    pageRef: number;
+    span: DocumentSpan;
+}
+
 // @public
 export interface DocumentIntegerField extends DocumentValueField<number> {
     kind: "integer";
@@ -365,8 +371,7 @@ export interface DocumentLanguage {
 }
 
 // @public
-export interface DocumentLine {
-    boundingBox?: number[];
+export interface DocumentLine extends HasBoundingPolygon {
     content: string;
     spans: DocumentSpan[];
     words: () => IterableIterator<DocumentWord>;
@@ -423,18 +428,22 @@ export interface DocumentObjectField<Properties = {
 
 // @public
 export interface DocumentPage {
-    angle: number;
-    height: number;
-    kind: string;
+    angle?: number;
+    height?: number;
+    images?: DocumentImage[];
+    kind: DocumentPageKind;
     lines?: DocumentLine[];
-    pageNumber: number;
+    pageNumber?: number;
     selectionMarks?: DocumentSelectionMark[];
     spans: DocumentSpan[];
-    unit: LengthUnit;
-    width: number;
+    unit?: LengthUnit;
+    width?: number;
     words: DocumentWord[];
 }
 
+// @public
+export type DocumentPageKind = string;
+
 // @public
 export interface DocumentParagraph {
     boundingRegions?: BoundingRegion[];
@@ -450,9 +459,8 @@ export interface DocumentPhoneNumberField extends DocumentFieldCommon {
 }
 
 // @public
-export interface DocumentSelectionMark {
+export interface DocumentSelectionMark extends HasBoundingPolygon {
     confidence: number;
-    polygon?: number[];
     span: DocumentSpan;
     state: SelectionMarkState;
 }
@@ -542,10 +550,9 @@ export interface DocumentValueField<T> extends DocumentFieldCommon {
 }
 
 // @public
-export interface DocumentWord {
+export interface DocumentWord extends HasBoundingPolygon {
     confidence: number;
     content: string;
-    polygon?: number[];
     span: DocumentSpan;
 }
 
@@ -598,6 +605,11 @@ export interface GetModelOptions extends OperationOptions {
 export interface GetOperationOptions extends OperationOptions {
 }
 
+// @public (undocumented)
+export interface HasBoundingPolygon {
+    polygon?: Point2D[];
+}
+
 // @public
 export type IdentityDocument = ReifyPrebuiltSchema<typeof IdentityDocumentSchema>;
 
@@ -1039,6 +1051,12 @@ export type OperationStatus = "notStarted" | "running" | "failed" | "succeeded"
 // @public
 export type ParagraphRole = string;
 
+// @public
+export interface Point2D {
+    x: number;
+    y: number;
+}
+
 // @public
 export interface PollerOptions<TState extends PollOperationState<unknown>> extends OperationOptions {
     onProgress?: (state: TState) => void;

diff --git a/sdk/formrecognizer/ai-form-recognizer/src/generated/models/index.ts b/sdk/formrecognizer/ai-form-recognizer/src/generated/models/index.ts
diff --git a/sdk/formrecognizer/ai-form-recognizer/src/index.ts b/sdk/formrecognizer/ai-form-recognizer/src/index.ts
@@ -13,26 +13,18 @@ export { DocumentAnalysisClient } from "./documentAnalysisClient";
 export { DocumentModelAdministrationClient } from "./documentModelAdministrationClient";
 export {
   // Generated types used verbatim
-  BoundingRegion,
   ContentType,
   CopyAuthorization,
   CurrencyValue,
   DocTypeInfo,
   DocumentBuildMode,
-  DocumentEntity,
   DocumentFieldSchema,
   DocumentFieldType,
-  DocumentKeyValueElement,
-  DocumentKeyValuePair,
-  DocumentSelectionMark,
   DocumentSignatureType,
   DocumentSpan,
   DocumentLanguage,
   DocumentStyle,
-  DocumentTable,
-  DocumentTableCell,
   DocumentTableCellKind,
-  DocumentWord,
   LengthUnit,
   ModelInfo,
   ModelSummary,
@@ -43,17 +35,13 @@ export {
   CustomDocumentModelsInfo,
   AnalyzeResultOperationStatus,
   SelectionMarkState,
-  DocumentTableCaption,
-  DocumentTableFootnote,
-  DocumentParagraph,
   ParagraphRole,
+  DocumentPageKind,
 } from "./generated";
 export {
   AnalysisPoller,
   AnalyzeResult,
   AnalyzeResultCommon,
-  DocumentPage,
-  DocumentLine,
   DocumentAnalysisPollOperationState,
   AnalyzedDocument,
   FormRecognizerRequestBody,
@@ -63,3 +51,4 @@ export * from "./models";
 export * from "./options";
 export * from "./prebuilt";
 export { EnglishCapitalLetter, Acronymic } from "./util";
+export { Point2D } from "./transforms/polygon";