[Form Recognizer] 2023-07-31 swagger (Azure#26560)

### Packages impacted by this PR
`@azure/ai-form-recognizer`

### Describe the problem that is addressed by this PR
Moving in the `azure-sdk-for-js-pr`
code(https://github.com/Azure/azure-sdk-for-js-pr/tree/ai-form-recognizer/2023-07-31)
to the `azure-sdk-for-js` repo

---------

Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <will@wtemple.net>

Author: 3 people

sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Release History
 
+## 4.1.0 (Unreleased)
+
+### Features Added
+
+- `AnalyzeDocumentOptions.features` allows three new features compared to the last beta version:
+  - `barcodes`: enables the detection of barcodes in the document.
+  - `keyValuePairs`: enable the detection of general key value pairs (form fields) in the document.
+  - `languages`: enables the detection of the text content language.
+- `beginBuildDocumentModel` has a new overload that accepts a `DocumentModelContentSource` in place of a raw `containerUrl`. This allows training document models using the new Azure Blob file list source (that is already supported by document classifiers). The `DocumentModelContentSource` is an object that contains a `containerUrl` property, and if a `fileList` property is also provided it is interpreted as an Azure Blob file list source. Otherwise it is interpreted as an Azure Blob content source with an optional `prefix` property.
+
+### Breaking Changes
+
+- `DocumentAnalysisClient` and `DocumentModelAdministrationClient` now target service API version `2023-07-31` by default. Version `2023-02-28-preview` is not supported.
+- `AnalyzeDocumentOptions.features` changed the following feature names:
+  - `ocr.highResolution` renamed to `ocrHighResolution`.
+  - `ocr.formula` renamed to `formulas`.
+  - `ocr.font` renamed to `styleFont`.
+- The following fields have been removed
+  - `AnalyzeDocumentOptions.queryFields`
+  - `DocumentPage.kind` and `DocumentPage.images` (`DocumentPageKind` and `DocumentImage` types have been removed too.)
+  - `DocumentKeyValuePair.commonName`
+- Changed how content sources are provided when creating document classifiers. The type of content source (`azureBlobContentSource` or `azureBlobFileListSource`) is no longer required in the content source input, and the type is now inferred automatically. If a `fileList` property is provided, it is interpreted as a file list source, and otherwise it is interpreted as a blob content source with optional `prefix`.
+
 ## 4.1.0-beta.1 (2023-04-11)
 
 ### Features Added

sdk/formrecognizer/ai-form-recognizer/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "js",
   "TagPrefix": "js/formrecognizer/ai-form-recognizer",
-  "Tag": "js/formrecognizer/ai-form-recognizer_9bcc4e2404"
+  "Tag": "js/formrecognizer/ai-form-recognizer_8a62bba2a4"
 }

sdk/formrecognizer/ai-form-recognizer/package.json

@@ -3,7 +3,7 @@
   "sdk-type": "client",
   "author": "Microsoft Corporation",
   "description": "An isomorphic client library for the Azure Form Recognizer service.",
-  "version": "4.1.0-beta.1",
+  "version": "4.1.0",
   "keywords": [
     "node",
     "azure",

sdk/formrecognizer/ai-form-recognizer/review/ai-form-recognizer.api.md

@@ -52,7 +52,6 @@ export interface AnalyzeDocumentOptions<Result = AnalyzeResult<AnalyzedDocument>
     features?: string[];
     locale?: string;
     pages?: string;
-    queryFields?: string[];
 }
 
 // @public
@@ -83,7 +82,7 @@ export interface AzureBlobContentSource {
 }
 
 // @public
-export interface AzureBlobFileListSource {
+export interface AzureBlobFileListContentSource {
     containerUrl: string;
     fileList: string;
 }
@@ -114,7 +113,7 @@ export interface BoundingRegion extends HasBoundingPolygon {
 
 // @public
 export interface ClassifierDocumentTypeDetails {
-    azureBlobFileListSource?: AzureBlobFileListSource;
+    azureBlobFileListSource?: AzureBlobFileListContentSource;
     azureBlobSource?: AzureBlobContentSource;
 }
 
@@ -198,12 +197,8 @@ export interface DocumentAnalysisPollOperationState<Result = AnalyzeResult<Analy
 // @public
 export interface DocumentAnnotation extends HasBoundingPolygon {
     confidence: number;
-    kind: DocumentAnnotationKind;
 }
 
-// @public
-export type DocumentAnnotationKind = string;
-
 // @public
 export interface DocumentArrayField<T = DocumentField> extends DocumentFieldCommon {
     kind: "array";
@@ -242,6 +237,9 @@ export interface DocumentClassifierBuildOperationDetails extends OperationDetail
     result?: DocumentClassifierDetails;
 }
 
+// @public
+export type DocumentClassifierContentSource = AzureBlobContentSource | AzureBlobFileListContentSource;
+
 // @public
 export interface DocumentClassifierDetails {
     apiVersion: string;
@@ -321,13 +319,6 @@ export interface DocumentFormula extends HasBoundingPolygon {
 // @public
 export type DocumentFormulaKind = string;
 
-// @public
-export interface DocumentImage extends HasBoundingPolygon {
-    confidence: number;
-    pageNumber: number;
-    span: DocumentSpan;
-}
-
 // @public
 export interface DocumentIntegerField extends DocumentValueField<number> {
     kind: "integer";
@@ -342,7 +333,6 @@ export interface DocumentKeyValueElement {
 
 // @public
 export interface DocumentKeyValuePair {
-    commonName?: string;
     confidence: number;
     key: DocumentKeyValueElement;
     value?: DocumentKeyValueElement;
@@ -375,9 +365,10 @@ export class DocumentModelAdministrationClient {
     constructor(endpoint: string, credential: KeyCredential, options?: DocumentModelAdministrationClientOptions);
     constructor(endpoint: string, credential: KeyCredential | TokenCredential, options?: DocumentModelAdministrationClientOptions);
     beginBuildDocumentClassifier(classifierId: string, docTypes: {
-        [docType: string]: ClassifierDocumentTypeDetails;
+        [docType: string]: DocumentClassifierContentSource;
     }, options?: BeginBuildDocumentClassifierOptions): Promise<DocumentClassifierPoller>;
     beginBuildDocumentModel(modelId: string, containerUrl: string, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>;
+    beginBuildDocumentModel(modelId: string, contentSource: DocumentModelContentSource, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>;
     beginComposeDocumentModel(modelId: string, componentModelIds: Iterable<string>, options?: BeginComposeDocumentModelOptions): Promise<DocumentModelPoller>;
     beginCopyModelTo(sourceModelId: string, authorization: CopyAuthorization, options?: BeginCopyModelOptions): Promise<DocumentModelPoller>;
     deleteDocumentClassifier(classifierId: string, options?: OperationOptions): Promise<void>;
@@ -417,6 +408,9 @@ export interface DocumentModelComposeOperationDetails extends OperationDetails {
     result?: DocumentModelDetails;
 }
 
+// @public
+export type DocumentModelContentSource = AzureBlobContentSource | AzureBlobFileListContentSource;
+
 // @public
 export interface DocumentModelCopyToOperationDetails extends OperationDetails {
     kind: "documentModelCopyTo";
@@ -473,12 +467,9 @@ export interface DocumentObjectField<Properties = {
 // @public
 export interface DocumentPage {
     angle?: number;
-    annotations?: DocumentAnnotation[];
     barcodes?: DocumentBarcode[];
     formulas?: DocumentFormula[];
     height?: number;
-    images?: DocumentImage[];
-    kind: DocumentPageKind;
     lines?: DocumentLine[];
     pageNumber: number;
     selectionMarks?: DocumentSelectionMark[];
@@ -488,9 +479,6 @@ export interface DocumentPage {
     words?: DocumentWord[];
 }
 
-// @public
-export type DocumentPageKind = string;
-
 // @public
 export interface DocumentParagraph {
     boundingRegions?: BoundingRegion[];
@@ -624,10 +612,9 @@ export type FormRecognizerApiVersion = (typeof FormRecognizerApiVersion)[keyof t
 
 // @public
 export const FormRecognizerApiVersion: {
-    readonly Latest: "2023-02-28-preview";
-    readonly Stable: "2022-08-31";
+    readonly Latest: "2023-07-31";
+    readonly Stable: "2023-07-31";
     readonly "2022-08-31": "2022-08-31";
-    readonly "2023-02-28-preview": "2023-02-28-preview";
 };
 
 // @public
@@ -640,10 +627,12 @@ export type FormRecognizerFeature = (typeof FormRecognizerFeature)[keyof typeof
 
 // @public (undocumented)
 export const FormRecognizerFeature: {
-    readonly QueryFieldsPremium: "queryFields.premium";
-    readonly OcrFont: "ocr.font";
-    readonly OcrHighResolution: "ocr.highResolution";
-    readonly OcrFormula: "ocr.formula";
+    readonly Fonts: "styleFont";
+    readonly OcrHighResolution: "ocrHighResolution";
+    readonly Formulas: "formulas";
+    readonly Languages: "languages";
+    readonly Barcodes: "barcodes";
+    readonly KeyValuePairs: "keyValuePairs";
 };
 
 // @public
@@ -677,12 +666,6 @@ export interface InnerError {
     message?: string;
 }
 
-// @public
-export enum KnownDocumentAnnotationKind {
-    Check = "check",
-    Cross = "cross"
-}
-
 // @public
 export enum KnownDocumentBarcodeKind {
     Aztec = "Aztec",
@@ -734,14 +717,6 @@ export enum KnownDocumentFormulaKind {
     Inline = "inline"
 }
 
-// @public
-export enum KnownDocumentPageKind {
-    Document = "document",
-    Image = "image",
-    Sheet = "sheet",
-    Slide = "slide"
-}
-
 // @public
 export enum KnownDocumentSignatureType {
     Signed = "signed",

sdk/formrecognizer/ai-form-recognizer/samples-dev/buildClassifier.ts

@@ -42,14 +42,10 @@ async function main() {
       type1: {
         // `azureBlobSource` isn't the only way to provide training data to the service. For more information, see
         // the documentation of the `ClassifierDocumentTypeDetails` type.
-        azureBlobSource: {
-          containerUrl: trainingDataSasUrl1,
-        },
+        containerUrl: trainingDataSasUrl1,
       },
       type2: {
-        azureBlobSource: {
-          containerUrl: trainingDataSasUrl2,
-        },
+        containerUrl: trainingDataSasUrl2,
       },
     },
     {

sdk/formrecognizer/ai-form-recognizer/samples-dev/prebuilt/prebuilt-businessCard.ts

@@ -8,8 +8,8 @@
 
 // Model:       prebuilt-businessCard
 // Description: Extract key information from business cards.
-// API Version: 2023-02-28-preview
-// Created:     Thu Apr 06 2023
+// API Version: 2023-07-31
+// Created:     Wed Aug 02 2023
 
 import * as fr from "@azure/ai-form-recognizer";
 
@@ -139,8 +139,8 @@ function modelInfo() {
   return {
     modelId: "prebuilt-businessCard",
     description: "Extract key information from business cards.",
-    createdOn: "2023-02-28T00:00:00.000Z",
-    apiVersion: "2023-02-28-preview",
+    createdOn: "2023-07-31T00:00:00.000Z",
+    apiVersion: "2023-07-31",
     docTypes: {
       businessCard: {
         buildMode: "template",

sdk/formrecognizer/ai-form-recognizer/samples-dev/prebuilt/prebuilt-document.ts

@@ -8,7 +8,7 @@
 
 // Model:       prebuilt-document
 // Description: Extract text, layout, entities, and general key-value pairs from documents.
-// API Version: 2023-02-28-preview
+// API Version: 2023-07-31
 // Created:     Thu Apr 06 2023
 
 import * as fr from "@azure/ai-form-recognizer";
@@ -55,6 +55,6 @@ function modelInfo() {
     modelId: "prebuilt-document",
     description: "Extract text, layout, entities, and general key-value pairs from documents.",
     createdOn: "2023-02-28T00:00:00.000Z",
-    apiVersion: "2023-02-28-preview",
+    apiVersion: "2023-07-31",
   } as const;
 }