@azure/ai-form-recognizer 5.0.0 → 5.1.0

package/dist/commonjs/lro/util/poller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"poller.d.ts","sourceRoot":"","sources":["../../../../src/lro/util/poller.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAEtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAK/D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAE9B;;;OAGG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,SAAS,kBAAkB,CAAC,OAAO,CAAC;IACvE;;OAEG;IACH,IAAI,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD;;OAEG;IACH,IAAI,EAAE,CAAC,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAChE;;OAEG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CACtC;AAED;;;;GAIG;AACH,wBAAsB,GAAG,CAAC,OAAO,EAAE,MAAM,SAAS,kBAAkB,CAAC,OAAO,CAAC,EAC3E,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,EAC3B,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,eAAe,EAAE,eAAe,GAAG,SAAS,GAC3C,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CA2FtC"}

package/dist/commonjs/lro/util/poller.js

@@ -0,0 +1,87 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lro = lro;
+const delayMs_js_1 = require("./delayMs.js");
+const abort_controller_1 = require("@azure/abort-controller");
+const DEFAULT_POLLING_INTERVAL = 5000;
+/**
+ * Uniform poller implementation, creates a poller based on a PollerSpec.
+ *
+ * @internal
+ */
+async function lro(spec, pollingInterval, initAbortSignal) {
+    let serverDrivenDelay;
+    const initContext = {
+        abortSignal: initAbortSignal,
+        updateDelay: (interval) => {
+            serverDrivenDelay = interval;
+        },
+    };
+    if (initAbortSignal === null || initAbortSignal === void 0 ? void 0 : initAbortSignal.aborted) {
+        throw new abort_controller_1.AbortError("The operation was aborted.");
+    }
+    let state = await spec.init(initContext);
+    // Job handling. If `job` is defined, then there is an active `pollUntilDone` call on this poller.
+    // Call `cancelJob` to interrupt the polling loop (awaiters will throw).
+    let job;
+    let cancelJob;
+    const handlers = new Map();
+    const handleProgressEvents = async () => handlers.forEach((h) => h(state));
+    const self = {
+        onProgress: (callback) => {
+            const s = Symbol();
+            handlers.set(s, callback);
+            return () => handlers.delete(s);
+        },
+        stopPolling: () => cancelJob === null || cancelJob === void 0 ? void 0 : cancelJob(),
+        poll: async (options) => {
+            state = await spec.poll({
+                abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal,
+                updateDelay: (interval) => {
+                    serverDrivenDelay = interval;
+                },
+            }, state);
+            handleProgressEvents();
+        },
+        pollUntilDone: (options) => (job !== null && job !== void 0 ? job : (job = (async () => {
+            // Technically, the poller could complete during initialization
+            if (!self.isDone()) {
+                // Poll once to get the ball rolling, this avoids a delay if the operation completes immediately
+                await self.poll(options);
+                while (!self.isDone()) {
+                    const finalPollingInterval = Math.max(serverDrivenDelay !== null && serverDrivenDelay !== void 0 ? serverDrivenDelay : 0, pollingInterval !== null && pollingInterval !== void 0 ? pollingInterval : DEFAULT_POLLING_INTERVAL);
+                    const delay = (0, delayMs_js_1.delayMs)(finalPollingInterval, options === null || options === void 0 ? void 0 : options.abortSignal);
+                    cancelJob = delay.cancel;
+                    await delay.then(() => self.poll());
+                }
+            }
+            const result = self.getResult();
+            // The state says it's done, so we know we are in either a success case, an error case, or an _internal_ error.
+            if (result !== undefined)
+                return result;
+            else if (state.error !== undefined)
+                throw state.error;
+            // Unreachable
+            else {
+                throw new Error(`Internal Client Error: analysis poller completed without success or error: ${state}`);
+            }
+        })().finally(() => {
+            job = undefined;
+        }))),
+        // The poller is stopped if there is no job running
+        isStopped: () => !!job,
+        // The operation is complete if either a result or error is produced
+        isDone: () => !!state.result || !!state.error,
+        // In FR, all operations run to completion
+        cancelOperation() {
+            throw new Error("The Azure Form Recognizer service does not support operation cancellation.");
+        },
+        getOperationState: () => state,
+        getResult: () => state.result,
+        toString: () => spec.serialize(state),
+    };
+    return self;
+}
+//# sourceMappingURL=poller.js.map

package/dist/commonjs/lro/util/poller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"poller.js","sourceRoot":"","sources":["../../../../src/lro/util/poller.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAiDlC,kBA+FC;AA7ID,6CAAuC;AAEvC,8DAAqD;AAErD,MAAM,wBAAwB,GAAG,IAAI,CAAC;AAqCtC;;;;GAIG;AACI,KAAK,UAAU,GAAG,CACvB,IAA2B,EAC3B,eAAmC,EACnC,eAA4C;IAE5C,IAAI,iBAAqC,CAAC;IAE1C,MAAM,WAAW,GAAqB;QACpC,WAAW,EAAE,eAAe;QAC5B,WAAW,EAAE,CAAC,QAAQ,EAAE,EAAE;YACxB,iBAAiB,GAAG,QAAQ,CAAC;QAC/B,CAAC;KACF,CAAC;IAEF,IAAI,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,EAAE,CAAC;QAC7B,MAAM,IAAI,6BAAU,CAAC,4BAA4B,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAIzC,kGAAkG;IAClG,wEAAwE;IACxE,IAAI,GAAiC,CAAC;IACtC,IAAI,SAAmC,CAAC;IAIxC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAmB,CAAC;IAC5C,MAAM,oBAAoB,GAAG,KAAK,IAAmB,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAE1F,MAAM,IAAI,GAAe;QACvB,UAAU,EAAE,CAAC,QAAiC,EAAE,EAAE;YAChD,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC1B,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;QACD,WAAW,EAAE,GAAG,EAAE,CAAC,SAAS,aAAT,SAAS,uBAAT,SAAS,EAAI;QAChC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACtB,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CACrB;gBACE,WAAW,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;gBACjC,WAAW,EAAE,CAAC,QAAQ,EAAE,EAAE;oBACxB,iBAAiB,GAAG,QAAQ,CAAC;gBAC/B,CAAC;aACF,EACD,KAAK,CACN,CAAC;YACF,oBAAoB,EAAE,CAAC;QACzB,CAAC;QACD,aAAa,EAAE,CAAC,OAAO,EAAE,EAAE,CACzB,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,IAAH,GAAG,GAAK,CAAC,KAAK,IAAI,EAAE;YACnB,+DAA+D;YAC/D,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;gBACnB,gGAAgG;gBAChG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACzB,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;oBACtB,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,CACnC,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,CAAC,EACtB,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,wBAAwB,CAC5C,CAAC;oBACF,MAAM,KAAK,GAAG,IAAA,oBAAO,EAAC,oBAAoB,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,CAAC,CAAC;oBAClE,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC;oBACzB,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAEhC,+GAA+G;YAC/G,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,MAAM,CAAC;iBACnC,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;gBAAE,MAAM,KAAK,CAAC,KAAK,CAAC;YACtD,cAAc;iBACT,CAAC;gBACJ,MAAM,IAAI,KAAK,CACb,8EAA8E,KAAK,EAAE,CACtF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;YAChB,GAAG,GAAG,SAAS,CAAC;QAClB,CAAC,CAAC,EAAC;QACL,mDAAmD;QACnD,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG;QACtB,oEAAoE;QACpE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK;QAC7C,0CAA0C;QAC1C,eAAe;YACb,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAChG,CAAC;QACD,iBAAiB,EAAE,GAAG,EAAE,CAAC,KAAK;QAC9B,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM;QAC7B,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;KACtC,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PollOperationState, PollerLike } from \"@azure/core-lro\";\nimport { delayMs } from \"./delayMs.js\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport { AbortError } from \"@azure/abort-controller\";\n\nconst DEFAULT_POLLING_INTERVAL = 5000;\n\n/**\n * Information about the Long-Running Operation (LRO) that is being performed.\n */\nexport interface OperationContext {\n  /**\n   * An AbortSignal that can be used to cancel the operation.\n   */\n  abortSignal?: AbortSignalLike;\n\n  /**\n   * Sets the server's preferred polling interval in milliseconds. To clear the server's preferred polling interval,\n   * pass `undefined`.\n   */\n  updateDelay: (interval: number | undefined) => void;\n}\n\n/**\n * A specification for a long-running operation, which defines the poller flow.\n * @internal\n */\nexport interface OperationSpec<TState extends PollOperationState<unknown>> {\n  /**\n   * A function that produces the first operation state for this LRO.\n   */\n  init: (ctx: OperationContext) => Promise<TState>;\n  /**\n   * A function that consumes the existing state of the poller and produces the next state.\n   */\n  poll: (ctx: OperationContext, state: TState) => Promise<TState>;\n  /**\n   * A function that serializes the state into a string.\n   */\n  serialize: (state: TState) => string;\n}\n\n/**\n * Uniform poller implementation, creates a poller based on a PollerSpec.\n *\n * @internal\n */\nexport async function lro<TResult, TState extends PollOperationState<TResult>>(\n  spec: OperationSpec<TState>,\n  pollingInterval: number | undefined,\n  initAbortSignal: AbortSignalLike | undefined,\n): Promise<PollerLike<TState, TResult>> {\n  let serverDrivenDelay: number | undefined;\n\n  const initContext: OperationContext = {\n    abortSignal: initAbortSignal,\n    updateDelay: (interval) => {\n      serverDrivenDelay = interval;\n    },\n  };\n\n  if (initAbortSignal?.aborted) {\n    throw new AbortError(\"The operation was aborted.\");\n  }\n\n  let state = await spec.init(initContext);\n\n  type ThisPoller = PollerLike<TState, TResult>;\n\n  // Job handling. If `job` is defined, then there is an active `pollUntilDone` call on this poller.\n  // Call `cancelJob` to interrupt the polling loop (awaiters will throw).\n  let job: Promise<TResult> | undefined;\n  let cancelJob: (() => void) | undefined;\n\n  // Progress handlers\n  type Handler = (state: TState) => void;\n  const handlers = new Map<symbol, Handler>();\n  const handleProgressEvents = async (): Promise<void> => handlers.forEach((h) => h(state));\n\n  const self: ThisPoller = {\n    onProgress: (callback: (state: TState) => void) => {\n      const s = Symbol();\n      handlers.set(s, callback);\n      return () => handlers.delete(s);\n    },\n    stopPolling: () => cancelJob?.(),\n    poll: async (options) => {\n      state = await spec.poll(\n        {\n          abortSignal: options?.abortSignal,\n          updateDelay: (interval) => {\n            serverDrivenDelay = interval;\n          },\n        },\n        state,\n      );\n      handleProgressEvents();\n    },\n    pollUntilDone: (options) =>\n      (job ??= (async () => {\n        // Technically, the poller could complete during initialization\n        if (!self.isDone()) {\n          // Poll once to get the ball rolling, this avoids a delay if the operation completes immediately\n          await self.poll(options);\n          while (!self.isDone()) {\n            const finalPollingInterval = Math.max(\n              serverDrivenDelay ?? 0,\n              pollingInterval ?? DEFAULT_POLLING_INTERVAL,\n            );\n            const delay = delayMs(finalPollingInterval, options?.abortSignal);\n            cancelJob = delay.cancel;\n            await delay.then(() => self.poll());\n          }\n        }\n        const result = self.getResult();\n\n        // The state says it's done, so we know we are in either a success case, an error case, or an _internal_ error.\n        if (result !== undefined) return result;\n        else if (state.error !== undefined) throw state.error;\n        // Unreachable\n        else {\n          throw new Error(\n            `Internal Client Error: analysis poller completed without success or error: ${state}`,\n          );\n        }\n      })().finally(() => {\n        job = undefined;\n      })),\n    // The poller is stopped if there is no job running\n    isStopped: () => !!job,\n    // The operation is complete if either a result or error is produced\n    isDone: () => !!state.result || !!state.error,\n    // In FR, all operations run to completion\n    cancelOperation() {\n      throw new Error(\"The Azure Form Recognizer service does not support operation cancellation.\");\n    },\n    getOperationState: () => state,\n    getResult: () => state.result,\n    toString: () => spec.serialize(state),\n  };\n\n  return self;\n}\n"]}

package/dist/commonjs/models/contentSource.d.ts

@@ -0,0 +1,56 @@
+import { AzureBlobContentSource as AzureBlobSourceDetails, AzureBlobFileListContentSource as AzureBlobFileListSourceDetails } from "../generated/index.js";
+export { AzureBlobSourceDetails, AzureBlobFileListSourceDetails };
+/**
+ * A training data source defined by an Azure Blob Container.
+ */
+export interface AzureBlobSource {
+    /**
+     * The underlying details of the Azure Blob Source.
+     */
+    azureBlobSource: AzureBlobSourceDetails;
+    /**
+     * Must be undefined for a Blob Source.
+     */
+    azureBlobFileListSource?: undefined;
+}
+/**
+ * A training data source defined by an Azure Blob Container and a JSONL file list within the container.
+ */
+export 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;
+}
+/**
+ * A content source that may be used to build a document model.
+ *
+ * One of:
+ * - BlobSource
+ * - BlobFileListSource
+ */
+export type DocumentModelSource = AzureBlobSource | AzureBlobFileListSource;
+/**
+ * A content source that may be used to build a document classifier.
+ *
+ * One of:
+ * - BlobSource
+ * - BlobFileListSource
+ */
+export type DocumentClassifierSource = AzureBlobSource | AzureBlobFileListSource;
+/**
+ * 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 interface DocumentClassifierDocumentTypeSources {
+    /**
+     * The training data source of a given document type name.
+     */
+    [docType: string]: DocumentClassifierSource;
+}
+//# sourceMappingURL=contentSource.d.ts.map

package/dist/commonjs/models/contentSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentSource.d.ts","sourceRoot":"","sources":["../../../src/models/contentSource.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,sBAAsB,IAAI,sBAAsB,EAChD,8BAA8B,IAAI,8BAA8B,EACjE,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,sBAAsB,EAAE,8BAA8B,EAAE,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,EAAE,sBAAsB,CAAC;IAExC;;OAEG;IACH,uBAAuB,CAAC,EAAE,SAAS,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,uBAAuB,EAAE,8BAA8B,CAAC;IAExD;;OAEG;IACH,eAAe,CAAC,EAAE,SAAS,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,uBAAuB,CAAC;AAE5E;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG,uBAAuB,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,CAAC,OAAO,EAAE,MAAM,GAAG,wBAAwB,CAAC;CAC7C"}

package/dist/commonjs/models/contentSource.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contentSource.js.map

package/dist/commonjs/models/contentSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentSource.js","sourceRoot":"","sources":["../../../src/models/contentSource.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n  AzureBlobContentSource as AzureBlobSourceDetails,\n  AzureBlobFileListContentSource as AzureBlobFileListSourceDetails,\n} from \"../generated/index.js\";\n\nexport { AzureBlobSourceDetails, AzureBlobFileListSourceDetails };\n\n/**\n * A training data source defined by an Azure Blob Container.\n */\nexport interface AzureBlobSource {\n  /**\n   * The underlying details of the Azure Blob Source.\n   */\n  azureBlobSource: AzureBlobSourceDetails;\n\n  /**\n   * Must be undefined for a Blob Source.\n   */\n  azureBlobFileListSource?: undefined;\n}\n\n/**\n * A training data source defined by an Azure Blob Container and a JSONL file list within the container.\n */\nexport interface AzureBlobFileListSource {\n  /**\n   * The underlying details of the Azure Blob File List Source.\n   */\n  azureBlobFileListSource: AzureBlobFileListSourceDetails;\n\n  /**\n   * Must be undefined for a Blob File List Source.\n   */\n  azureBlobSource?: undefined;\n}\n\n/**\n * A content source that may be used to build a document model.\n *\n * One of:\n * - BlobSource\n * - BlobFileListSource\n */\nexport type DocumentModelSource = AzureBlobSource | AzureBlobFileListSource;\n\n/**\n * A content source that may be used to build a document classifier.\n *\n * One of:\n * - BlobSource\n * - BlobFileListSource\n */\nexport type DocumentClassifierSource = AzureBlobSource | AzureBlobFileListSource;\n\n/**\n * A set of sources used to create a document classifier. This is a map of\n * document type names to sources that will be used to train the model to\n * classify documents of the corresponding source type.\n */\nexport interface DocumentClassifierDocumentTypeSources {\n  /**\n   * The training data source of a given document type name.\n   */\n  [docType: string]: DocumentClassifierSource;\n}\n"]}

package/dist/commonjs/models/documentElements.d.ts

@@ -0,0 +1,210 @@
+import type { Point2D } from "../transforms/polygon.js";
+import type { DocumentSpan, DocumentTableCellKind, DocumentField as GeneratedDocumentField, LengthUnit, ParagraphRole, SelectionMarkState, DocumentBarcodeKind, DocumentFormulaKind } from "../generated/index.js";
+/** Simple document elements such as words, selection marks and lines are bounded by the polygon. */
+export interface HasBoundingPolygon {
+    /** Bounding polygon of the entity. */
+    polygon?: Point2D[];
+}
+/** Bounding polygon on a specific page of the input. */
+export interface BoundingRegion extends HasBoundingPolygon {
+    /** 1-based page number of page containing the bounding region. */
+    pageNumber: number;
+}
+/** A word object consisting of a contiguous sequence of characters.  For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word. */
+export interface DocumentWord extends HasBoundingPolygon {
+    /** Text content of the word. */
+    content: string;
+    /** Location of the word in the reading order concatenated content. */
+    span: DocumentSpan;
+    /** Confidence of correctly extracting the word. */
+    confidence: number;
+}
+/** A selection mark object representing check boxes, radio buttons, and other elements indicating a selection. */
+export interface DocumentSelectionMark extends HasBoundingPolygon {
+    /** State of the selection mark. */
+    state: SelectionMarkState;
+    /** Location of the selection mark in the reading order concatenated content. */
+    span: DocumentSpan;
+    /** Confidence of correctly extracting the selection mark. */
+    confidence: number;
+}
+/** A content line object consisting of an adjacent sequence of content elements, such as words and selection marks. */
+export interface DocumentLine extends HasBoundingPolygon {
+    /** Concatenated content of the contained elements in reading order. */
+    content: string;
+    /** Location of the line in the reading order concatenated content. */
+    spans: DocumentSpan[];
+    /**
+     * Compute the `DocumentWord`s that are related to this line.
+     *
+     * This function produces a lazy iterator that will yield one word before computing the next.
+     */
+    words: () => IterableIterator<DocumentWord>;
+}
+/** A paragraph object consisting with contiguous lines generally with common alignment and spacing. */
+export interface DocumentParagraph {
+    /** Semantic role of the paragraph. */
+    role?: ParagraphRole;
+    /** Concatenated content of the paragraph in reading order. */
+    content: string;
+    /** Bounding regions covering the paragraph. */
+    boundingRegions?: BoundingRegion[];
+    /** Location of the paragraph in the reading order concatenated content. */
+    spans: DocumentSpan[];
+}
+/** A table object consisting table cells arranged in a rectangular layout. */
+export interface DocumentTable {
+    /** Number of rows in the table. */
+    rowCount: number;
+    /** Number of columns in the table. */
+    columnCount: number;
+    /** Cells contained within the table. */
+    cells: DocumentTableCell[];
+    /** Bounding regions covering the table. */
+    boundingRegions?: BoundingRegion[];
+    /** Location of the table in the reading order concatenated content. */
+    spans: DocumentSpan[];
+}
+/** An object representing the location and content of a table cell. */
+export interface DocumentTableCell {
+    /** Table cell kind. */
+    kind?: DocumentTableCellKind;
+    /** Row index of the cell. */
+    rowIndex: number;
+    /** Column index of the cell. */
+    columnIndex: number;
+    /** Number of rows spanned by this cell. */
+    rowSpan?: number;
+    /** Number of columns spanned by this cell. */
+    columnSpan?: number;
+    /** Concatenated content of the table cell in reading order. */
+    content: string;
+    /** Bounding regions covering the table cell. */
+    boundingRegions?: BoundingRegion[];
+    /** Location of the table cell in the reading order concatenated content. */
+    spans: DocumentSpan[];
+}
+/** An object representing the location and content of a table caption. */
+export interface DocumentCaption {
+    /** Table caption content. */
+    content: string;
+    /** Bounding regions covering the table caption. */
+    boundingRegions?: BoundingRegion[];
+    /** Location of the table caption in the reading order concatenated content. */
+    spans: DocumentSpan[];
+}
+/** An object representing the location and content of a table footnote. */
+export interface DocumentFootnote {
+    /** Table footnote content. */
+    content: string;
+    /** Bounding regions covering the table footnote. */
+    boundingRegions?: BoundingRegion[];
+    /** Location of the table footnote in the reading order concatenated content. */
+    spans: DocumentSpan[];
+}
+/** An object representing the field key or value in a key-value pair. */
+export interface DocumentKeyValueElement {
+    /** Concatenated content of the key-value element in reading order. */
+    content: string;
+    /** Bounding regions covering the key-value element. */
+    boundingRegions?: BoundingRegion[];
+    /** Location of the key-value element in the reading order concatenated content. */
+    spans: DocumentSpan[];
+}
+/** An object describing the location and semantic content of a document. */
+export interface Document {
+    /** Document type. */
+    docType: string;
+    /** Bounding regions covering the document. */
+    boundingRegions?: BoundingRegion[];
+    /** Location of the document in the reading order concatenated content. */
+    spans: DocumentSpan[];
+    /** Dictionary of named field values. */
+    fields?: {
+        [propertyName: string]: GeneratedDocumentField;
+    };
+    /** Confidence of correctly extracting the document. */
+    confidence: number;
+}
+/** An object representing a form field with distinct field label (key) and field value (may be empty). */
+export interface DocumentKeyValuePair {
+    /** Field label of the key-value pair. */
+    key: DocumentKeyValueElement;
+    /** Field value of the key-value pair. */
+    value?: DocumentKeyValueElement;
+    /** Confidence of correctly extracting the key-value pair. */
+    confidence: number;
+}
+/**
+ * A visual annotation element in the document, such as a check mark or cross.
+ */
+export interface DocumentAnnotation extends HasBoundingPolygon {
+    /** Confidence of correctly extracting the annotation. */
+    confidence: number;
+}
+/**
+ * An extracted barcode.
+ */
+export interface DocumentBarcode extends HasBoundingPolygon {
+    /**
+     * The type of barcode that was extracted. See the `DocumentBarcodeKind` type for a list of possible values.
+     */
+    kind: DocumentBarcodeKind;
+    /** The encoded data in the barcode. */
+    value: string;
+    /** The location of the barcode in the reading-order concatenated `content`. */
+    span: DocumentSpan;
+    /** Confidence of correctly extracting the barcode. */
+    confidence: number;
+}
+/**
+ * An extracted formula.
+ */
+export interface DocumentFormula extends HasBoundingPolygon {
+    /**
+     * The type of formula that was extracted. One of:
+     * - "inline": a formula embedded in the content of a paragraph.
+     * - "display": a formula in display mode that takes up a whole line.
+     */
+    kind: DocumentFormulaKind;
+    /** A LaTeX expression describing the formula. */
+    value: string;
+    /** Location of the formula in the reading-order concatenated content. */
+    span: DocumentSpan;
+    /** Confidence of correctly extracting the formula. */
+    confidence: number;
+}
+/** Content and layout elements extracted from a page from the input. */
+export interface DocumentPage {
+    /** 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]. */
+    angle?: number;
+    /** The width of the image/PDF in pixels/inches, respectively. */
+    width?: number;
+    /** The height of the image/PDF in pixels/inches, respectively. */
+    height?: number;
+    /** The unit used by the width, height, and polygon properties. For images, the unit is "pixel". PDF, the unit is "inch". */
+    unit?: LengthUnit;
+    /** Location of the page in the reading order concatenated content. */
+    spans: DocumentSpan[];
+    /** Extracted words from the page. */
+    words?: DocumentWord[];
+    /** Extracted selection marks from the page. */
+    selectionMarks?: DocumentSelectionMark[];
+    /** Extracted lines from the page, potentially containing both textual and visual elements. */
+    lines?: DocumentLine[];
+    /**
+     * Extracted barcodes from the page.
+     */
+    barcodes?: DocumentBarcode[];
+    /**
+     * Extracted formulas from the page.
+     *
+     * The `"formulas"` feature must be enabled or this property will be undefined.
+     *
+     * See {@link AnalyzeDocumentOptions#features}.
+     */
+    formulas?: DocumentFormula[];
+}
+//# sourceMappingURL=documentElements.d.ts.map

package/dist/commonjs/models/documentElements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentElements.d.ts","sourceRoot":"","sources":["../../../src/models/documentElements.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,KAAK,EACV,YAAY,EACZ,qBAAqB,EACrB,aAAa,IAAI,sBAAsB,EACvC,UAAU,EACV,aAAa,EACb,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAG/B,oGAAoG;AACpG,MAAM,WAAW,kBAAkB;IACjC,sCAAsC;IACtC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;CACrB;AAWD,wDAAwD;AACxD,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD,kEAAkE;IAClE,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,iMAAiM;AACjM,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IACtD,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,IAAI,EAAE,YAAY,CAAC;IACnB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,kHAAkH;AAClH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D,mCAAmC;IACnC,KAAK,EAAE,kBAAkB,CAAC;IAC1B,gFAAgF;IAChF,IAAI,EAAE,YAAY,CAAC;IACnB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,uHAAuH;AACvH,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IACtD,uEAAuE;IACvE,OAAO,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB;;;;OAIG;IACH,KAAK,EAAE,MAAM,gBAAgB,CAAC,YAAY,CAAC,CAAC;CAC7C;AAED,uGAAuG;AACvG,MAAM,WAAW,iBAAiB;IAChC,sCAAsC;IACtC,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,2EAA2E;IAC3E,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAED,8EAA8E;AAC9E,MAAM,WAAW,aAAa;IAC5B,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,KAAK,EAAE,iBAAiB,EAAE,CAAC;IAC3B,2CAA2C;IAC3C,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,uEAAuE;IACvE,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAED,uEAAuE;AACvE,MAAM,WAAW,iBAAiB;IAChC,uBAAuB;IACvB,IAAI,CAAC,EAAE,qBAAqB,CAAC;IAC7B,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,4EAA4E;IAC5E,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAED,0EAA0E;AAC1E,MAAM,WAAW,eAAe;IAC9B,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,+EAA+E;IAC/E,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAED,2EAA2E;AAC3E,MAAM,WAAW,gBAAgB;IAC/B,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,gFAAgF;IAChF,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAED,yEAAyE;AACzE,MAAM,WAAW,uBAAuB;IACtC,sEAAsE;IACtE,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,mFAAmF;IACnF,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAED,4EAA4E;AAC5E,MAAM,WAAW,QAAQ;IACvB,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,0EAA0E;IAC1E,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,wCAAwC;IACxC,MAAM,CAAC,EAAE;QAAE,CAAC,YAAY,EAAE,MAAM,GAAG,sBAAsB,CAAA;KAAE,CAAC;IAC5D,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,0GAA0G;AAC1G,MAAM,WAAW,oBAAoB;IACnC,yCAAyC;IACzC,GAAG,EAAE,uBAAuB,CAAC;IAC7B,yCAAyC;IACzC,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAEhC,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;IAC1B,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;IAEd,+EAA+E;IAC/E,IAAI,EAAE,YAAY,CAAC;IAEnB,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD;;;;OAIG;IACH,IAAI,EAAE,mBAAmB,CAAC;IAE1B,iDAAiD;IACjD,KAAK,EAAE,MAAM,CAAC;IAEd,yEAAyE;IACzE,IAAI,EAAE,YAAY,CAAC;IAEnB,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,wEAAwE;AACxE,MAAM,WAAW,YAAY;IAC3B,iDAAiD;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,8GAA8G;IAC9G,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4HAA4H;IAC5H,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,sEAAsE;IACtE,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,qCAAqC;IACrC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,+CAA+C;IAC/C,cAAc,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACzC,8FAA8F;IAC9F,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAE7B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;CAC9B"}

package/dist/commonjs/models/documentElements.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=documentElements.js.map

package/dist/commonjs/models/documentElements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentElements.js","sourceRoot":"","sources":["../../../src/models/documentElements.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { Point2D } from \"../transforms/polygon.js\";\nimport type {\n  DocumentSpan,\n  DocumentTableCellKind,\n  DocumentField as GeneratedDocumentField,\n  LengthUnit,\n  ParagraphRole,\n  SelectionMarkState,\n  DocumentBarcodeKind,\n  DocumentFormulaKind,\n} from \"../generated/index.js\";\nimport { AnalyzeDocumentOptions } from \"../options/index.js\";\n\n/** Simple document elements such as words, selection marks and lines are bounded by the polygon. */\nexport interface HasBoundingPolygon {\n  /** Bounding polygon of the entity. */\n  polygon?: Point2D[];\n}\n\n// ------------------------------------\n// Following are the interfaces that are redefined with the property `polygon?: Point2D[];`\n// instead of the generated `polygon?: number[];` for the interfaces in the generated code with the same names.\n//\n// To avoid going out-of-sync with the generated types, we test the re-constructed interfaces are following the shapes in the generated interfaces in the following test file.\n// `test/internal/convenienceModelAssignability.spec.ts`\n//\n// If the generated code is updated and if there are new additions in the generated interfaces, the function calls \"checkAssign\" would fail in the test file, which would mean we need to revisit the re-constructed shapes here.\n\n/** Bounding polygon on a specific page of the input. */\nexport interface BoundingRegion extends HasBoundingPolygon {\n  /** 1-based page number of page containing the bounding region. */\n  pageNumber: number;\n}\n\n/** A word object consisting of a contiguous sequence of characters.  For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word. */\nexport interface DocumentWord extends HasBoundingPolygon {\n  /** Text content of the word. */\n  content: string;\n  /** Location of the word in the reading order concatenated content. */\n  span: DocumentSpan;\n  /** Confidence of correctly extracting the word. */\n  confidence: number;\n}\n\n/** A selection mark object representing check boxes, radio buttons, and other elements indicating a selection. */\nexport interface DocumentSelectionMark extends HasBoundingPolygon {\n  /** State of the selection mark. */\n  state: SelectionMarkState;\n  /** Location of the selection mark in the reading order concatenated content. */\n  span: DocumentSpan;\n  /** Confidence of correctly extracting the selection mark. */\n  confidence: number;\n}\n\n/** A content line object consisting of an adjacent sequence of content elements, such as words and selection marks. */\nexport interface DocumentLine extends HasBoundingPolygon {\n  /** Concatenated content of the contained elements in reading order. */\n  content: string;\n  /** Location of the line in the reading order concatenated content. */\n  spans: DocumentSpan[];\n  /**\n   * Compute the `DocumentWord`s that are related to this line.\n   *\n   * This function produces a lazy iterator that will yield one word before computing the next.\n   */\n  words: () => IterableIterator<DocumentWord>;\n}\n\n/** A paragraph object consisting with contiguous lines generally with common alignment and spacing. */\nexport interface DocumentParagraph {\n  /** Semantic role of the paragraph. */\n  role?: ParagraphRole;\n  /** Concatenated content of the paragraph in reading order. */\n  content: string;\n  /** Bounding regions covering the paragraph. */\n  boundingRegions?: BoundingRegion[];\n  /** Location of the paragraph in the reading order concatenated content. */\n  spans: DocumentSpan[];\n}\n\n/** A table object consisting table cells arranged in a rectangular layout. */\nexport interface DocumentTable {\n  /** Number of rows in the table. */\n  rowCount: number;\n  /** Number of columns in the table. */\n  columnCount: number;\n  /** Cells contained within the table. */\n  cells: DocumentTableCell[];\n  /** Bounding regions covering the table. */\n  boundingRegions?: BoundingRegion[];\n  /** Location of the table in the reading order concatenated content. */\n  spans: DocumentSpan[];\n}\n\n/** An object representing the location and content of a table cell. */\nexport interface DocumentTableCell {\n  /** Table cell kind. */\n  kind?: DocumentTableCellKind;\n  /** Row index of the cell. */\n  rowIndex: number;\n  /** Column index of the cell. */\n  columnIndex: number;\n  /** Number of rows spanned by this cell. */\n  rowSpan?: number;\n  /** Number of columns spanned by this cell. */\n  columnSpan?: number;\n  /** Concatenated content of the table cell in reading order. */\n  content: string;\n  /** Bounding regions covering the table cell. */\n  boundingRegions?: BoundingRegion[];\n  /** Location of the table cell in the reading order concatenated content. */\n  spans: DocumentSpan[];\n}\n\n/** An object representing the location and content of a table caption. */\nexport interface DocumentCaption {\n  /** Table caption content. */\n  content: string;\n  /** Bounding regions covering the table caption. */\n  boundingRegions?: BoundingRegion[];\n  /** Location of the table caption in the reading order concatenated content. */\n  spans: DocumentSpan[];\n}\n\n/** An object representing the location and content of a table footnote. */\nexport interface DocumentFootnote {\n  /** Table footnote content. */\n  content: string;\n  /** Bounding regions covering the table footnote. */\n  boundingRegions?: BoundingRegion[];\n  /** Location of the table footnote in the reading order concatenated content. */\n  spans: DocumentSpan[];\n}\n\n/** An object representing the field key or value in a key-value pair. */\nexport interface DocumentKeyValueElement {\n  /** Concatenated content of the key-value element in reading order. */\n  content: string;\n  /** Bounding regions covering the key-value element. */\n  boundingRegions?: BoundingRegion[];\n  /** Location of the key-value element in the reading order concatenated content. */\n  spans: DocumentSpan[];\n}\n\n/** An object describing the location and semantic content of a document. */\nexport interface Document {\n  /** Document type. */\n  docType: string;\n  /** Bounding regions covering the document. */\n  boundingRegions?: BoundingRegion[];\n  /** Location of the document in the reading order concatenated content. */\n  spans: DocumentSpan[];\n  /** Dictionary of named field values. */\n  fields?: { [propertyName: string]: GeneratedDocumentField };\n  /** Confidence of correctly extracting the document. */\n  confidence: number;\n}\n\n/** An object representing a form field with distinct field label (key) and field value (may be empty). */\nexport interface DocumentKeyValuePair {\n  /** Field label of the key-value pair. */\n  key: DocumentKeyValueElement;\n  /** Field value of the key-value pair. */\n  value?: DocumentKeyValueElement;\n\n  /** Confidence of correctly extracting the key-value pair. */\n  confidence: number;\n}\n\n/**\n * A visual annotation element in the document, such as a check mark or cross.\n */\nexport interface DocumentAnnotation extends HasBoundingPolygon {\n  /** Confidence of correctly extracting the annotation. */\n  confidence: number;\n}\n\n/**\n * An extracted barcode.\n */\nexport interface DocumentBarcode extends HasBoundingPolygon {\n  /**\n   * The type of barcode that was extracted. See the `DocumentBarcodeKind` type for a list of possible values.\n   */\n  kind: DocumentBarcodeKind;\n  /** The encoded data in the barcode. */\n  value: string;\n\n  /** The location of the barcode in the reading-order concatenated `content`. */\n  span: DocumentSpan;\n\n  /** Confidence of correctly extracting the barcode. */\n  confidence: number;\n}\n\n/**\n * An extracted formula.\n */\nexport interface DocumentFormula extends HasBoundingPolygon {\n  /**\n   * The type of formula that was extracted. One of:\n   * - \"inline\": a formula embedded in the content of a paragraph.\n   * - \"display\": a formula in display mode that takes up a whole line.\n   */\n  kind: DocumentFormulaKind;\n\n  /** A LaTeX expression describing the formula. */\n  value: string;\n\n  /** Location of the formula in the reading-order concatenated content. */\n  span: DocumentSpan;\n\n  /** Confidence of correctly extracting the formula. */\n  confidence: number;\n}\n\n/** Content and layout elements extracted from a page from the input. */\nexport interface DocumentPage {\n  /** 1-based page number in the input document. */\n  pageNumber: number;\n  /** The general orientation of the content in clockwise direction, measured in degrees between (-180, 180]. */\n  angle?: number;\n  /** The width of the image/PDF in pixels/inches, respectively. */\n  width?: number;\n  /** The height of the image/PDF in pixels/inches, respectively. */\n  height?: number;\n  /** The unit used by the width, height, and polygon properties. For images, the unit is \"pixel\". PDF, the unit is \"inch\". */\n  unit?: LengthUnit;\n  /** Location of the page in the reading order concatenated content. */\n  spans: DocumentSpan[];\n  /** Extracted words from the page. */\n  words?: DocumentWord[];\n  /** Extracted selection marks from the page. */\n  selectionMarks?: DocumentSelectionMark[];\n  /** Extracted lines from the page, potentially containing both textual and visual elements. */\n  lines?: DocumentLine[];\n\n  /**\n   * Extracted barcodes from the page.\n   */\n  barcodes?: DocumentBarcode[];\n\n  /**\n   * Extracted formulas from the page.\n   *\n   * The `\"formulas\"` feature must be enabled or this property will be undefined.\n   *\n   * See {@link AnalyzeDocumentOptions#features}.\n   */\n  formulas?: DocumentFormula[];\n}\n"]}

package/dist/commonjs/models/fields.d.ts

@@ -0,0 +1,205 @@
+import type { DocumentSpan } from "../index.js";
+import type { AddressValue, CurrencyValue, DocumentField as GeneratedDocumentField } from "../generated/index.js";
+import type { BoundingRegion } from "./documentElements.js";
+/**
+ * Fields that are common to all DocumentField variants.
+ */
+export interface DocumentFieldCommon {
+    /**
+     * The verbatim extracted text content of the field.
+     */
+    content?: string;
+    /**
+     * Bounding regions covering the field.
+     */
+    boundingRegions?: BoundingRegion[];
+    /**
+     * Confidence of correctly extracting the field.
+     */
+    confidence?: number;
+    /**
+     * Location of the field in the reading order concatenated content.
+     */
+    spans?: DocumentSpan[];
+}
+/**
+ * A simple field that has a primitive value, such as a string, number etc.
+ */
+export interface DocumentValueField<T> extends DocumentFieldCommon {
+    /**
+     * The field's value, which has the type specified in the field's schema.
+     */
+    value?: T;
+}
+/**
+ * An extracted field. The `kind` property identifies (discriminates) the type of the `DocumentField`.
+ */
+export type DocumentField = DocumentStringField | DocumentDateField | DocumentTimeField | DocumentPhoneNumberField | DocumentNumberField | DocumentIntegerField | DocumentBooleanField | DocumentSelectionMarkField | DocumentCountryRegionField | DocumentSignatureField | DocumentCurrencyField | DocumentAddressField | DocumentArrayField | DocumentObjectField;
+/**
+ * A DocumentField that has a string value.
+ */
+export interface DocumentStringField<Value extends string = string> extends DocumentValueField<Value> {
+    /** Field kind: "string". */
+    kind: "string";
+}
+/**
+ * A DocumentField that has a Date value.
+ */
+export interface DocumentDateField extends DocumentValueField<Date> {
+    /** Field kind: "date". */
+    kind: "date";
+}
+/**
+ * A DocumentField that has a time value, represented as a string.
+ */
+export interface DocumentTimeField extends DocumentFieldCommon {
+    /** Field kind: "time". */
+    kind: "time";
+    /**
+     * The field's value, which is a time in "HH:MM:SS" (ISO 8601) format.
+     */
+    value?: string;
+}
+/**
+ * A DocumentField that has a phone number value, represented as a string.
+ */
+export interface DocumentPhoneNumberField extends DocumentFieldCommon {
+    /** Field kind: "phoneNumber". */
+    kind: "phoneNumber";
+    /**
+     * The field's value, which is a string containing the phone number.
+     *
+     * The phone number value is normalized to a standard format. If the value could not be normalized, this value may be
+     * undefined, and the `content` property will contain the verbatim text of the DocumentField as it appeared in the
+     * input.
+     */
+    value?: string;
+}
+/**
+ * A DocumentField that has a number value.
+ */
+export interface DocumentNumberField extends DocumentValueField<number> {
+    /** Field kind: "number". */
+    kind: "number";
+}
+/**
+ * A DocumentField that has an integer value.
+ */
+export interface DocumentIntegerField extends DocumentValueField<number> {
+    /** Field kind: "integer". */
+    kind: "integer";
+}
+/**
+ * A DocumentField that is has a value indicating a selection mark state (such as a checkbox or radio button),
+ * represented as a string.
+ */
+export interface DocumentSelectionMarkField extends DocumentFieldCommon {
+    /** Field kind: "selectionMark". */
+    kind: "selectionMark";
+    /**
+     * The state of the selection mark. One of:
+     *
+     * - "selected"
+     * - "unselected"
+     *
+     * This value may be undefined, and other variants may be introduced in the future.
+     */
+    value?: string;
+}
+/**
+ * A DocumentField that has a value indicating a country or region, represented as a string.
+ */
+export interface DocumentCountryRegionField extends DocumentFieldCommon {
+    /** Field kind: "countryRegion". */
+    kind: "countryRegion";
+    /**
+     * The 3-letter country/region code (ISO 3166-1 alpha-3) of the extracted country or region.
+     */
+    value?: string;
+}
+/**
+ * A DocumentField that indicates the state of a signature, represented as a string.
+ */
+export interface DocumentSignatureField extends DocumentFieldCommon {
+    /** Field kind: "signature". */
+    kind: "signature";
+    /**
+     * The state of the signature field. One of:
+     *
+     * - "unsigned"
+     * - "signed"
+     *
+     * This value may be undefined, and other variants may be introduced in the future.
+     */
+    value: "signed" | "unsigned";
+}
+/**
+ * A DocumentField that consists of an array of nested fields. All fields in the array will have the same type.
+ */
+export interface DocumentArrayField<T = DocumentField> extends DocumentFieldCommon {
+    /** Field kind: "array". */
+    kind: "array";
+    /**
+     * The extracted members of the array field.
+     */
+    values: T[];
+}
+/**
+ * A DocumentField that describes an amount of a certain currency.
+ */
+export interface DocumentCurrencyField extends DocumentFieldCommon {
+    /** Field kind: "currency". */
+    kind: "currency";
+    /**
+     * The properties of the extracted currency.
+     */
+    value?: CurrencyValue;
+}
+/**
+ * A document field that describes a structured physical address.
+ */
+export interface DocumentAddressField extends DocumentFieldCommon {
+    /** Field kind: "address". */
+    kind: "address";
+    /**
+     * The properties of the extracted address.
+     */
+    value?: AddressValue;
+}
+/**
+ * A DocumentField that has a boolean value.
+ */
+export interface DocumentBooleanField extends DocumentValueField<boolean> {
+    /** Field kind: "boolean". */
+    kind: "boolean";
+}
+/**
+ * A DocumentField that consists of several named properties that have their own DocumentField values.
+ */
+export interface DocumentObjectField<Properties = {
+    [k: string]: DocumentField | undefined;
+}> extends DocumentFieldCommon {
+    /** Field kind: "object". */
+    kind: "object";
+    /**
+     * The extracted object properties. Each property of this object is, itself, a nested DocumentField.
+     */
+    properties: Properties;
+}
+/**
+ * Convert a record of generated fields to a record of strongly-typed fields.
+ * @internal
+ * @param fields - a map of field names to generated field values
+ * @returns - an object with the same keys, where all values have been mapped to DocumentFields
+ */
+export declare function toAnalyzedDocumentFieldsFromGenerated(fields: {
+    [k: string]: GeneratedDocumentField;
+}): {
+    [k: string]: DocumentField;
+};
+/**
+ * Convert a generated document field into a strong TypeScriptified document field.
+ * @internal
+ */
+export declare function toDocumentField(field: GeneratedDocumentField): DocumentField;
+//# sourceMappingURL=fields.d.ts.map

package/dist/commonjs/models/fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../src/models/fields.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,aAAa,IAAI,sBAAsB,EACxC,MAAM,uBAAuB,CAAC;AAG/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,CAAE,SAAQ,mBAAmB;IAChE;;OAEG;IACH,KAAK,CAAC,EAAE,CAAC,CAAC;CACX;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,mBAAmB,GACnB,iBAAiB,GACjB,iBAAiB,GACjB,wBAAwB,GACxB,mBAAmB,GACnB,oBAAoB,GACpB,oBAAoB,GACpB,0BAA0B,GAC1B,0BAA0B,GAC1B,sBAAsB,GACtB,qBAAqB,GACrB,oBAAoB,GACpB,kBAAkB,GAClB,mBAAmB,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,CAChE,SAAQ,kBAAkB,CAAC,KAAK,CAAC;IACjC,4BAA4B;IAC5B,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB,CAAC,IAAI,CAAC;IACjE,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE,iCAAiC;IACjC,IAAI,EAAE,aAAa,CAAC;IACpB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB,CAAC,MAAM,CAAC;IACrE,4BAA4B;IAC5B,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB,CAAC,MAAM,CAAC;IACtE,6BAA6B;IAC7B,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB;IACrE,mCAAmC;IACnC,IAAI,EAAE,eAAe,CAAC;IACtB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB;IACrE,mCAAmC;IACnC,IAAI,EAAE,eAAe,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,+BAA+B;IAC/B,IAAI,EAAE,WAAW,CAAC;IAClB;;;;;;;OAOG;IACH,KAAK,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,aAAa,CAAE,SAAQ,mBAAmB;IAChF,2BAA2B;IAC3B,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,CAAC,EAAE,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,8BAA8B;IAC9B,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC/D,6BAA6B;IAC7B,IAAI,EAAE,SAAS,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB,CAAC,OAAO,CAAC;IACvE,6BAA6B;IAC7B,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,UAAU,GAAG;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;CAAE,CAC1F,SAAQ,mBAAmB;IAC3B,4BAA4B;IAC5B,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;;;;GAKG;AACH,wBAAgB,qCAAqC,CAAC,MAAM,EAAE;IAC5D,CAAC,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;CACrC,GAAG;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;CAAE,CAQjC;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,sBAAsB,GAAG,aAAa,CA+C5E"}