@azure/ai-form-recognizer 4.1.0-beta.1 → 5.0.0

package/types/ai-form-recognizer.d.ts

@@ -106,24 +106,13 @@ export declare interface AnalyzeDocumentOptions<Result = AnalyzeResult<AnalyzedD
      * Examples: "1", "3-5", "1,3-5"
      */
     pages?: string;
-    /**
-     * A list of additional fields to add to the extracted documents.
-     *
-     * Additional fields are extracted dynamically and do not require any training. This capability is only available if
-     * the "queryFields.premium" feature is enabled. Pass "queryFields.premium" in the `features` parameter
-     * to enable it.
-     *
-     * NOTE: This feature incurs additional costs, so be sure to consult the service documentation to understand the added
-     * costs associated with using it. See the service documentation for more information: https://aka.ms/azsdk/formrecognizer/queryfields
-     */
-    queryFields?: string[];
     /**
      * A list of features to enable in the model. Enabling features may incur additional costs, so be sure to consult the
      * service documentation to understand the nature of the features and any added costs associated with using them.
      *
      * For more information about the features available in Form Recognizer, see the service documentation: https://aka.ms/azsdk/formrecognizer/features
      */
-    features?: string[];
+    features?: FormRecognizerFeature[];
 }
 
 /**
@@ -168,7 +157,7 @@ export declare interface AnalyzeResultCommon {
     /**
      * The service API version used to produce this result.
      */
-    apiVersion: FormRecognizerApiVersion;
+    apiVersion: string;
     /**
      * The unique ID of the model that was used to produce this result.
      */
@@ -183,22 +172,50 @@ export declare interface AnalyzeResultCommon {
 /** Defines values for AnalyzeResultOperationStatus. */
 export declare type AnalyzeResultOperationStatus = "notStarted" | "running" | "failed" | "succeeded";
 
-/** Azure Blob Storage content. */
-export declare interface AzureBlobContentSource {
-    /** Azure Blob Storage container URL. */
-    containerUrl: string;
-    /** Blob name prefix. */
-    prefix?: string;
+/**
+ * A training data source defined by an Azure Blob Container and a JSONL file list within the container.
+ */
+export declare interface AzureBlobFileListSource {
+    /**
+     * The underlying details of the Azure Blob File List Source.
+     */
+    azureBlobFileListSource: AzureBlobFileListSourceDetails;
+    /**
+     * Must be undefined for a Blob File List Source.
+     */
+    azureBlobSource?: undefined;
 }
 
 /** File list in Azure Blob Storage. */
-export declare interface AzureBlobFileListSource {
+export declare interface AzureBlobFileListSourceDetails {
     /** Azure Blob Storage container URL. */
     containerUrl: string;
     /** Path to a JSONL file within the container specifying a subset of documents for training. */
     fileList: string;
 }
 
+/**
+ * A training data source defined by an Azure Blob Container.
+ */
+export declare interface AzureBlobSource {
+    /**
+     * The underlying details of the Azure Blob Source.
+     */
+    azureBlobSource: AzureBlobSourceDetails;
+    /**
+     * Must be undefined for a Blob Source.
+     */
+    azureBlobFileListSource?: undefined;
+}
+
+/** Azure Blob Storage content. */
+export declare interface AzureBlobSourceDetails {
+    /** Azure Blob Storage container URL. */
+    containerUrl: string;
+    /** Blob name prefix. */
+    prefix?: string;
+}
+
 export { AzureKeyCredential }
 
 /**
@@ -235,12 +252,12 @@ export declare interface BoundingRegion extends HasBoundingPolygon {
     pageNumber: number;
 }
 
-/** Training data source. */
+/** Classifier document type info. */
 export declare interface ClassifierDocumentTypeDetails {
-    /** Azure Blob Storage location containing the training data. */
-    azureBlobSource?: AzureBlobContentSource;
-    /** Azure Blob Storage file list specifying the training data. */
-    azureBlobFileListSource?: AzureBlobFileListSource;
+    /** Azure Blob Storage location containing the training data for a classifier document type.  Either azureBlobSource or azureBlobFileListSource must be specified. */
+    azureBlobSource?: AzureBlobSourceDetails;
+    /** Azure Blob Storage file list specifying the training data for a classifier document type.  Either azureBlobSource or azureBlobFileListSource must be specified. */
+    azureBlobFileListSource?: AzureBlobFileListSourceDetails;
 }
 
 /**
@@ -367,7 +384,6 @@ export declare interface DocumentAddressField extends DocumentFieldCommon {
 export declare class DocumentAnalysisClient {
     private _restClient;
     private _tracing;
-    private _apiVersion;
     /**
      * Create a `DocumentAnalysisClient` instance from a resource endpoint and a an Azure Identity `TokenCredential`.
      *
@@ -728,7 +744,7 @@ export declare class DocumentAnalysisClient {
 /**
  * Configurable options for DocumentAnalysisClient.
  */
-export declare interface DocumentAnalysisClientOptions extends FormRecognizerCommonClientOptions {
+export declare interface DocumentAnalysisClientOptions extends CommonClientOptions {
     /**
      * The unit of string offset/length values that the service returns.
      *
@@ -775,26 +791,10 @@ export declare interface DocumentAnalysisPollOperationState<Result = AnalyzeResu
  * A visual annotation element in the document, such as a check mark or cross.
  */
 export declare interface DocumentAnnotation extends HasBoundingPolygon {
-    /**
-     * The kind of annotation that this element represents. One of:
-     *  - "check": A check mark (✓).
-     *  - "cross": A cross mark (X).
-     */
-    kind: DocumentAnnotationKind;
     /** Confidence of correctly extracting the annotation. */
     confidence: number;
 }
 
-/**
- * Defines values for DocumentAnnotationKind. \
- * {@link KnownDocumentAnnotationKind} can be used interchangeably with DocumentAnnotationKind,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **check**: A visual check ✓. \
- * **cross**: A visual cross X.
- */
-export declare type DocumentAnnotationKind = string;
-
 /**
  * A DocumentField that consists of an array of nested fields. All fields in the array will have the same type.
  */
@@ -902,6 +902,18 @@ export declare interface DocumentClassifierDetails {
     };
 }
 
+/**
+ * A set of sources used to create a document classifier. This is a map of
+ * document type names to sources that will be used to train the model to
+ * classify documents of the corresponding source type.
+ */
+export declare interface DocumentClassifierDocumentTypeSources {
+    /**
+     * The training data source of a given document type name.
+     */
+    [docType: string]: DocumentClassifierSource;
+}
+
 /**
  * The state of a model creation operation.
  */
@@ -914,6 +926,15 @@ export declare interface DocumentClassifierOperationState extends PollOperationS
  */
 export declare type DocumentClassifierPoller = PollerLike<DocumentClassifierOperationState, DocumentClassifierDetails>;
 
+/**
+ * A content source that may be used to build a document classifier.
+ *
+ * One of:
+ * - BlobSource
+ * - BlobFileListSource
+ */
+export declare type DocumentClassifierSource = AzureBlobSource | AzureBlobFileListSource;
+
 /**
  * A DocumentField that has a value indicating a country or region, represented as a string.
  */
@@ -1049,20 +1070,6 @@ export declare interface DocumentFormula extends HasBoundingPolygon {
  */
 export declare type DocumentFormulaKind = string;
 
-/**
- * An extracted image. Images are represented as pages, so this type contains the 1-based index of the page containing
- * this image's data as well as the layout information of the image (`span`, `boundingPolygon`) and the confidence
- * value.
- */
-export declare interface DocumentImage extends HasBoundingPolygon {
-    /** Page number of this image's data. (1-based) */
-    pageNumber: number;
-    /** Location of the image in the reading-order concatenated `content`. */
-    span: DocumentSpan;
-    /** Confidence of correctly extracting the image. */
-    confidence: number;
-}
-
 /**
  * A DocumentField that has an integer value.
  */
@@ -1087,8 +1094,6 @@ export declare interface DocumentKeyValuePair {
     key: DocumentKeyValueElement;
     /** Field value of the key-value pair. */
     value?: DocumentKeyValueElement;
-    /** Common name of the key-value pair. */
-    commonName?: string;
     /** Confidence of correctly extracting the key-value pair. */
     confidence: number;
 }
@@ -1131,7 +1136,7 @@ export declare interface DocumentModel<Result> {
     /**
      * The API version of the model.
      */
-    apiVersion?: FormRecognizerApiVersion;
+    apiVersion?: string;
     /**
      * An associated transformation that is used to conver the base (weak) Result type to the strong version.
      */
@@ -1260,6 +1265,45 @@ export declare class DocumentModelAdministrationClient {
      * @returns a long-running operation (poller) that will eventually produce the created model information or an error
      */
     beginBuildDocumentModel(modelId: string, containerUrl: string, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>;
+    /**
+     * Build a new model with a given ID from a model content source.
+     *
+     * The Model ID can consist of any text, so long as it does not begin with "prebuilt-" (as these models refer to
+     * prebuilt Form Recognizer models that are common to all resources), and so long as it does not already exist within
+     * the resource.
+     *
+     * The content source describes the mechanism the service will use to read the input training data. See the
+     * {@link DocumentModelContentSource} type for more information.
+     *
+     * ### Example
+     *
+     * ```javascript
+     * const modelId = "aNewModel";
+     *
+     * const poller = await client.beginBuildDocumentModel(modelId, { containerUrl: "<SAS-encoded blob container URL>" }, {
+     *   // Optionally, a text description may be attached to the model
+     *   description: "This is an example model!"
+     * });
+     *
+     * // Model building, like all other model creation operations, returns a poller that eventually produces a ModelDetails
+     * // object
+     * const modelDetails = await poller.pollUntilDone();
+     *
+     * const {
+     *   modelId, // identical to the modelId given when creating the model
+     *   description, // identical to the description given when creating the model
+     *   createdOn, // the Date (timestamp) that the model was created
+     *   docTypes // information about the document types in the model and their field schemas
+     * } = modelDetails;
+     * ```
+     *
+     * @param modelId - the unique ID of the model to create
+     * @param contentSource - a content source that provides the training data for this model
+     * @param buildMode - the mode to use when building the model (see `DocumentModelBuildMode`)
+     * @param options - optional settings for the model build operation
+     * @returns a long-running operation (poller) that will eventually produce the created model information or an error
+     */
+    beginBuildDocumentModel(modelId: string, contentSource: DocumentModelSource, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>;
     /**
      * Creates a single composed model from several pre-existing submodels.
      *
@@ -1418,13 +1462,12 @@ export declare class DocumentModelAdministrationClient {
      * ```
      *
      * @param classifierId - the unique ID of the classifier to create
-     * @param docTypes - the document types to include in the classifier (a map of document type names to `ClassifierDocumentTypeDetails`)
+     * @param docTypeSources - the document types to include in the classifier and their sources (a map of document type
+     *                         names to `ClassifierDocumentTypeDetails`)
      * @param options - optional settings for the classifier build operation
      * @returns a long-running operation (poller) that will eventually produce the created classifier details or an error
      */
-    beginBuildDocumentClassifier(classifierId: string, docTypes: {
-        [docType: string]: ClassifierDocumentTypeDetails;
-    }, options?: BeginBuildDocumentClassifierOptions): Promise<DocumentClassifierPoller>;
+    beginBuildDocumentClassifier(classifierId: string, docTypeSources: DocumentClassifierDocumentTypeSources, options?: BeginBuildDocumentClassifierOptions): Promise<DocumentClassifierPoller>;
     /**
      * Create an LRO poller that handles model creation operations.
      *
@@ -1718,7 +1761,7 @@ export declare class DocumentModelAdministrationClient {
 /**
  * Configurable options for DocumentModelAdministrationClient.
  */
-export declare interface DocumentModelAdministrationClientOptions extends FormRecognizerCommonClientOptions {
+export declare interface DocumentModelAdministrationClientOptions extends CommonClientOptions {
 }
 
 /**
@@ -1809,6 +1852,15 @@ export declare interface DocumentModelOperationState extends PollOperationState<
  */
 export declare type DocumentModelPoller = PollerLike<DocumentModelOperationState, DocumentModelDetails>;
 
+/**
+ * A content source that may be used to build a document model.
+ *
+ * One of:
+ * - BlobSource
+ * - BlobFileListSource
+ */
+export declare type DocumentModelSource = AzureBlobSource | AzureBlobFileListSource;
+
 /** Document model summary. */
 export declare interface DocumentModelSummary {
     /** Unique document model name. */
@@ -1851,17 +1903,6 @@ export declare interface DocumentObjectField<Properties = {
 
 /** Content and layout elements extracted from a page from the input. */
 export declare interface DocumentPage {
-    /**
-     * The type of content that this page represents. One of:
-     *
-     *   - "document": A page from a PDF or image file. All content from Office/HTML files is represented as a single page.
-     *   - "sheet": A sheet from a spreadsheet.
-     *   - "slide": A slide from a presentation.
-     *   - "image": An embedded image from an Office/HTML file.
-     *
-     * If the page type is not known, the value is "document" by default.
-     */
-    kind: DocumentPageKind;
     /** 1-based page number in the input document. */
     pageNumber: number;
     /** The general orientation of the content in clockwise direction, measured in degrees between (-180, 180]. */
@@ -1880,10 +1921,6 @@ export declare interface DocumentPage {
     selectionMarks?: DocumentSelectionMark[];
     /** Extracted lines from the page, potentially containing both textual and visual elements. */
     lines?: DocumentLine[];
-    /**
-     * Extracted annotations from the page, such as check marks or cross marks.
-     */
-    annotations?: DocumentAnnotation[];
     /**
      * Extracted barcodes from the page.
      */
@@ -1891,29 +1928,13 @@ export declare interface DocumentPage {
     /**
      * Extracted formulas from the page.
      *
-     * The `"ocr.formula"` feature must be enabled or this property will be undefined.
+     * The `"formulas"` feature must be enabled or this property will be undefined.
      *
      * See {@link AnalyzeDocumentOptions#features}.
      */
     formulas?: DocumentFormula[];
-    /**
-     * Extracted images in the page.
-     */
-    images?: DocumentImage[];
 }
 
-/**
- * Defines values for DocumentPageKind. \
- * {@link KnownDocumentPageKind} can be used interchangeably with DocumentPageKind,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **document**: A page from a PDF or image file.  All content from Office\/HTML files is represented as a single page. \
- * **sheet**: A sheet from a spreadsheet. \
- * **slide**: A slide from a presentation. \
- * **image**: An embedded image from an Office\/HTML file.
- */
-export declare type DocumentPageKind = string;
-
 /** A paragraph object consisting with contiguous lines generally with common alignment and spacing. */
 export declare interface DocumentParagraph {
     /** Semantic role of the paragraph. */
@@ -2162,52 +2183,6 @@ export declare type FontStyle = string;
  */
 export declare type FontWeight = string;
 
-/**
- * Valid values of the Form Recognizer service REST API version.
- */
-export declare type FormRecognizerApiVersion = (typeof FormRecognizerApiVersion)[keyof typeof FormRecognizerApiVersion];
-
-/**
- * Supported and common values of FormRecognizerApiVersion.
- */
-export declare const FormRecognizerApiVersion: {
-    /**
-     * The newest version of the service known to be supported by the client (default).
-     *
-     * If using a beta package version, this will be identical to the latest preview version. Otherwise, it will be
-     * identical to the latest stable version.
-     */
-    readonly Latest: "2023-02-28-preview";
-    /**
-     * The newest stable version of the service known to be supported by the package. This will be a Generally Available
-     * (GA) version, even if the package version is a beta.
-     */
-    readonly Stable: "2022-08-31";
-    /**
-     * Form Recognizer API version 2022-08-31 (GA).
-     */
-    readonly "2022-08-31": "2022-08-31";
-    /**
-     * Form Recognizer API version 2023-02-28-preview.
-     */
-    readonly "2023-02-28-preview": "2023-02-28-preview";
-};
-
-/**
- * Configurable options for the Form Recognizer service clients (DocumentAnalysisClient and
- * DocumentModelAdministrationClient).
- */
-export declare interface FormRecognizerCommonClientOptions extends CommonClientOptions {
-    /**
-     * The version of the Form Recognizer REST API to call. Service versions 2.1 and lower (non-date-based versions) are
-     * not supported by this client. To use API version 2.1, please use version 3 of the Azure Form Recognizer SDK for
-     * JavaScript (\@azure/ai-form-recognizer\@^3.2.0).
-     *
-     * Default: FormRecognizerApiVersion.Stable ("2022-08-31")
-     */
-    apiVersion?: FormRecognizerApiVersion;
-}
-
 /**
  * Add-on capabilities (features) that can be enabled for the request.
  *
@@ -2217,23 +2192,34 @@ export declare interface FormRecognizerCommonClientOptions extends CommonClientO
  */
 export declare type FormRecognizerFeature = (typeof FormRecognizerFeature)[keyof typeof FormRecognizerFeature] | (string & {});
 
+/**
+ * Known feature flags supported by the Form Recognizer clients.
+ */
 export declare const FormRecognizerFeature: {
-    /**
-     * Enables the use of Query Fields.
-     */
-    readonly QueryFieldsPremium: "queryFields.premium";
     /**
      * Enables extracting extra font information.
      */
-    readonly OcrFont: "ocr.font";
+    readonly Fonts: "styleFont";
     /**
      * Enables high-resolution processing for documents with small text.
      */
-    readonly OcrHighResolution: "ocr.highResolution";
+    readonly OcrHighResolution: "ocrHighResolution";
+    /**
+     * Enables the detection of mathematical expressions in the document..
+     */
+    readonly Formulas: "formulas";
+    /**
+     * Enables the detection of the text content language.
+     */
+    readonly Languages: "languages";
+    /**
+     *  Enables the detection of barcodes in the document.
+     */
+    readonly Barcodes: "barcodes";
     /**
-     * Enables formula extraction.
+     *  Enables the detection of general key value pairs (form fields) in the document.
      */
-    readonly OcrFormula: "ocr.formula";
+    readonly KeyValuePairs: "keyValuePairs";
 };
 
 /**
@@ -2283,14 +2269,6 @@ export declare interface InnerError {
     innererror?: InnerError;
 }
 
-/** Known values of {@link DocumentAnnotationKind} that the service accepts. */
-export declare enum KnownDocumentAnnotationKind {
-    /** A visual check ✓. */
-    Check = "check",
-    /** A visual cross X. */
-    Cross = "cross"
-}
-
 /** Known values of {@link DocumentBarcodeKind} that the service accepts. */
 export declare enum KnownDocumentBarcodeKind {
     /** QR code, as defined in ISO/IEC 18004:2015. */
@@ -2377,18 +2355,6 @@ export declare enum KnownDocumentFormulaKind {
     Display = "display"
 }
 
-/** Known values of {@link DocumentPageKind} that the service accepts. */
-export declare enum KnownDocumentPageKind {
-    /** A page from a PDF or image file.  All content from Office/HTML files is represented as a single page. */
-    Document = "document",
-    /** A sheet from a spreadsheet. */
-    Sheet = "sheet",
-    /** A slide from a presentation. */
-    Slide = "slide",
-    /** An embedded image from an Office/HTML file. */
-    Image = "image"
-}
-
 /** Known values of {@link DocumentSignatureType} that the service accepts. */
 export declare enum KnownDocumentSignatureType {
     /** A signature is detected. */
@@ -2561,6 +2527,9 @@ export declare interface OperationDetails {
     error?: ErrorModel;
 }
 
+/**
+ * Details about any of several different types of Form Recognizer management operations.
+ */
 export declare type OperationDetailsUnion = OperationDetails | DocumentModelBuildOperationDetails | DocumentModelComposeOperationDetails | DocumentModelCopyToOperationDetails | DocumentClassifierBuildOperationDetails;
 
 /**