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

package/dist-esm/src/lro/analysis.js.map

@@ -1 +1 @@
-{"version":3,"file":"analysis.js","sourceRoot":"","sources":["../../../src/lro/analysis.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAS/C,OAAO,EAAiB,qCAAqC,EAAE,MAAM,kBAAkB,CAAC;AAGxF,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,4BAA4B,EAC5B,2BAA2B,GAC5B,MAAM,uBAAuB,CAAC;AA4D/B;;;;;;GAMG;AACH,MAAM,UAAU,+BAA+B,CAAC,QAA2B;;IACzE,uCACK,QAAQ,KACX,eAAe,EAAE,iBAAiB,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC5D,MAAM,EAAE,qCAAqC,CAAC,MAAA,QAAQ,CAAC,MAAM,mCAAI,EAAE,CAAC,IACpE;AACJ,CAAC;AAgED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAmB,EAAE,KAAmB;IAC/D,OAAO,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;AACpG,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,KAAK;IACb,yBAAyB;AAC3B,CAAC;AAED;;;;;GAKG;AACH,MAAM,SAAS,CAAC,CAAC,QAAQ,CAAI,KAAU,EAAE,GAAW;IAClD,IAAI,CAAC,GAAG,GAAG,CAAC;IAEZ,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE;QACvB,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;KAClB;AACH,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,SAAgC,EAChC,IAA2B;IAE1B,SAA0B,CAAC,KAAK,GAAG,GAAG,EAAE;;QACvC,OAAA,eAAe,CACb,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,EAC5B,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,uCAAY,IAAI,KAAE,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAG;QAC/D,CAAC,CAAC,mCAAI,EAAE,CACT,CAAA;KAAA,CAAC;IAEH,SAA0B,CAAC,OAAO,GAAG,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE3E,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE;QACxC,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,OAAO,SAAyB,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,SAAgC;;IAC1E,uCACK,SAAS,KACZ,KAAK,EAAE,MAAA,SAAS,CAAC,KAAK,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,2BAA2B,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,EACnF,cAAc,EAAE,MAAA,SAAS,CAAC,cAAc,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iCACnD,IAAI,KACP,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IACxC,CAAC,EACH,KAAK,EAAE,MAAA,SAAS,CAAC,KAAK,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iCACjC,IAAI,KACP,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IACxC,CAAC,IACH;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,kCAAkC,CAChD,IAAkB,EAClB,KAAgB;IAEhB,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvC,IAAI,OAAO,GAAG,GAAG,CAAC;IAClB,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC;IAEvB,MAAM,KAAK,GAAG,GAAY,EAAE;IAC1B,oHAAoH;IACpH,mEAAmE;IACnE,OAAA,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,MAAA,MAAA,MAAA,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,0CAAE,IAAI,0CAAE,MAAM,mCAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAA,EAAA,CAAC;IAE9F,gEAAgE;IAChE,GAAG;QACD,IAAI,KAAK,EAAE,EAAE;YACX,OAAO,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;SAC7B;aAAM,IAAI,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE;YAC/C,GAAG,GAAG,OAAO,GAAG,GAAG,CAAC;YACpB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;SACzC;aAAM;YACL,GAAG,GAAG,OAAO,GAAG,GAAG,CAAC;YACpB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;SACzC;KACF,QAAQ,GAAG,KAAK,OAAO,EAAE;IAE1B,wFAAwF;IACxF,OAAO,KAAK,EAAE,CAAC;AACjB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,SAAS,CAAC,CAAC,eAAe,CAC9B,KAA6B,EAC7B,aAAwB;IAExB,IAAI,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAE3B,4CAA4C;IAC5C,IAAI,OAAO,CAAC,IAAI,EAAE;QAChB,OAAO;KACR;IAED,MAAM,QAAQ,GAAG,kCAAkC,CAAC,OAAO,CAAC,KAAqB,EAAE,aAAa,CAAC,CAAC;IAClG,IAAI,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE/B,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;QACvC,IAAI,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YAChD,oEAAoE;YACpE,MAAM,QAAQ,CAAC,KAAK,CAAC;YACrB,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC5B;aAAM,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;YACnF,oFAAoF;YACpF,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;SACxB;aAAM;YACL,yFAAyF;YACzF,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC5B;KACF;AACH,CAAC;AA+CD;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAA8B;;IACzE,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,UAAsC;QACzD,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QACpE,MAAM,EAAE,MAAA,MAAM,CAAC,MAAM,0CAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;QAC1E,aAAa,EAAE,MAAA,MAAM,CAAC,aAAa,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QACrF,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iCACxC,IAAI,KACP,eAAe,EAAE,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,IACxD,CAAC;QACH,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,0CAAE,GAAG,CAAC,+BAA+B,CAAC;KAClE,CAAC;AACJ,CAAC;AAeD;;;GAGG;AACH,MAAM,UAAU,oCAAoC,CAClD,UAA+C,EAC/C,OAAe,EACf,iBAAyB,EACzB,QAAgC;IAEhC,OAAO;QACL,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,OAAO,EAAE,OAAO;QAChB,aAAa,EAAE,QAAQ,CAAC,mBAAmB;QAC3C,SAAS,EAAE,QAAQ,CAAC,eAAe;QACnC,iBAAiB;QACjB,MAAM,EAAE,QAAQ,CAAC,aAAa,IAAI,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,aAAa,CAAC;QACpF,KAAK,EAAE,QAAQ,CAAC,KAAK,IAAI,IAAI,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChE,WAAW,EAAE,KAAK;QAClB,SAAS,EAAE,QAAQ,CAAC,MAAM,KAAK,YAAY;QAC3C,WAAW,EAAE,QAAQ,CAAC,MAAM,KAAK,WAAW;KAC7C,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { PollOperationState, PollerLike } from \"@azure/core-lro\";\nimport { FormRecognizerError } from \"../error\";\nimport {\n  AnalyzeResult as GeneratedAnalyzeResult,\n  AnalyzeResultOperation,\n  AnalyzeResultOperationStatus as AnalyzeOperationStatus,\n  DocumentLanguage,\n  DocumentSpan,\n  DocumentStyle,\n} from \"../generated\";\nimport { DocumentField, toAnalyzedDocumentFieldsFromGenerated } from \"../models/fields\";\nimport { FormRecognizerApiVersion, PollerOptions } from \"../options\";\nimport { AnalyzeDocumentOptions } from \"../options/AnalyzeDocumentsOptions\";\nimport {\n  toBoundingPolygon,\n  toBoundingRegions,\n  toDocumentTableFromGenerated,\n  toKeyValuePairFromGenerated,\n} from \"../transforms/polygon\";\nimport {\n  BoundingRegion,\n  DocumentTable,\n  DocumentKeyValuePair,\n  DocumentPage,\n  DocumentLine,\n  DocumentParagraph,\n} from \"../models/documentElements\";\nimport {\n  Document as GeneratedDocument,\n  DocumentPage as GeneratedDocumentPage,\n  DocumentLine as GeneratedDocumentLine,\n} from \"../generated\";\n\n/**\n * A request input that can be uploaded as binary data to the Form Recognizer service. Form Recognizer treats `string`\n * inputs as URLs, so to send a string as a _binary_ input, first convert the string to one of the following input\n * types.\n */\nexport type FormRecognizerRequestBody =\n  | NodeJS.ReadableStream\n  | Blob\n  | ArrayBuffer\n  | ArrayBufferView;\n\n/**\n * An extracted document object.\n *\n * An AnalyzedDocument is an instance of one of the document types within a model. Its fields correspond to the field\n * schema of the document type.\n */\nexport interface AnalyzedDocument {\n  /**\n   * The type of the document that was extracted. A model can have multiple document types (for example, in a composed\n   * model), so this property indicates which document type the fields of this document correspond to.\n   */\n  docType: string;\n\n  /**\n   * The extracted fields, which correspond to the document type's field schema.\n   */\n  fields: { [field: string]: DocumentField };\n\n  /**\n   * Bounding regions covering the document.\n   */\n  boundingRegions?: BoundingRegion[];\n\n  /**\n   * Locations of the document's elements in the `content` text (reading-order-concatenated content).\n   */\n  spans: DocumentSpan[];\n\n  /**\n   * The service's confidence that it has correctly extracted the document.\n   */\n  confidence: number;\n}\n\n/**\n * Transform a REST-level Document response object into the more strongly-typed AnalyzedDocument.\n *\n * @internal\n * @param document - a REST-level document response object\n * @returns an AnalyzedDocument (which has had its fields mapped to stronger DocumentField types)\n */\nexport function toAnalyzedDocumentFromGenerated(document: GeneratedDocument): AnalyzedDocument {\n  return {\n    ...document,\n    boundingRegions: toBoundingRegions(document.boundingRegions),\n    fields: toAnalyzedDocumentFieldsFromGenerated(document.fields ?? {}),\n  };\n}\n\n/**\n * The common fields of all AnalyzeResult-like types, such as LayoutResult, ReadResult, and GeneralDocumentResult.\n */\nexport interface AnalyzeResultCommon {\n  /**\n   * The service API version used to produce this result.\n   */\n  apiVersion: FormRecognizerApiVersion;\n\n  /**\n   * The unique ID of the model that was used to produce this result.\n   */\n  modelId: string;\n\n  /**\n   * A string representation of all textual and visual elements in the input, concatenated by reading order (the order\n   * in which the service \"reads\" or extracts the textual and visual content from the document).\n   */\n  content: string;\n}\n\n/**\n * The result of an analysis operation. The type of the Document may be determined by the model used to perform the\n * analysis.\n */\nexport interface AnalyzeResult<Document = AnalyzedDocument> extends AnalyzeResultCommon {\n  /**\n   * Extracted pages.\n   */\n  pages?: DocumentPage[];\n\n  /**\n   * Extracted tables.\n   */\n  tables?: DocumentTable[];\n\n  /**\n   * Extracted key-value pairs.\n   */\n  keyValuePairs?: DocumentKeyValuePair[];\n\n  /**\n   * Extracted text languages.\n   */\n  languages?: DocumentLanguage[];\n\n  /**\n   * Extracted font styles.\n   */\n  styles?: DocumentStyle[];\n\n  /**\n   * Extracted documents (instances of any of the model's document types and corresponding field schemas).\n   */\n  documents?: Document[];\n\n  /**\n   * Extracted document paragraphs.\n   */\n  paragraphs?: DocumentParagraph[];\n}\n\n/**\n * Tests if one span contains another, by testing that the outer span starts before or at the same character as the\n * inner span, and that the end position of the outer span is greater than or equal to the end position of the inner\n * span.\n *\n * @internal\n * @param outer - the outer (potentially containing) span\n * @param inner - the span to test if `outer` contains\n * @returns true if `inner` is contained inside of `outer`.\n */\nexport function contains(outer: DocumentSpan, inner: DocumentSpan): boolean {\n  return outer.offset <= inner.offset && outer.offset + outer.length >= inner.offset + inner.length;\n}\n\n/**\n * Make an empty generator. This might seem silly, but it's useful for satisfying invariants.\n */\nfunction* empty(): Generator<never> {\n  /* intentionally empty */\n}\n\n/**\n * Produces an iterator of the given items starting from the given index.\n *\n * @param items - the items to iterate over\n * @param idx - the index of the first item to begin iterating from\n */\nexport function* iterFrom<T>(items: T[], idx: number): Generator<T> {\n  let i = idx;\n\n  while (i < items.length) {\n    yield items[i++];\n  }\n}\n\nexport function toDocumentLineFromGenerated(\n  generated: GeneratedDocumentLine,\n  page: GeneratedDocumentPage\n): DocumentLine {\n  (generated as DocumentLine).words = () =>\n    fastGetChildren(\n      iterFrom(generated.spans, 0),\n      page.words?.map((word) => {\n        return { ...word, polygon: toBoundingPolygon(word.polygon) };\n      }) ?? []\n    );\n\n  (generated as DocumentLine).polygon = toBoundingPolygon(generated.polygon);\n\n  Object.defineProperty(generated, \"words\", {\n    enumerable: false,\n  });\n\n  return generated as DocumentLine;\n}\n\nexport function toDocumentPageFromGenerated(generated: GeneratedDocumentPage): DocumentPage {\n  return {\n    ...generated,\n    lines: generated.lines?.map((line) => toDocumentLineFromGenerated(line, generated)),\n    selectionMarks: generated.selectionMarks?.map((mark) => ({\n      ...mark,\n      polygon: toBoundingPolygon(mark.polygon),\n    })),\n    words: generated.words?.map((word) => ({\n      ...word,\n      polygon: toBoundingPolygon(word.polygon),\n    })),\n  };\n}\n\n/**\n * Binary search through an array of items to find the first item that could possibly be contained by the given span,\n * then return an iterator beginning from that item.\n *\n * This allows a program to quickly find the first relevant item in the array for consideration when testing for span\n * inclusion.\n *\n * @internal\n * @param span - the span to use when testing each individual item\n * @param items - an array of items to binary search through\n * @returns an iterator beginning from the item identified by the search\n */\nexport function iteratorFromFirstMatchBinarySearch<Spanned extends { span: DocumentSpan }>(\n  span: DocumentSpan,\n  items: Spanned[]\n): IterableIterator<Spanned> {\n  let idx = Math.floor(items.length / 2);\n  let prevIdx = idx;\n  let min = 0;\n  let max = items.length;\n\n  const found = (): boolean =>\n    // The item is found if it starts after the current span and the item before it does not. That means it is the first\n    // item in the array that could be a child if the spans are sorted.\n    items[idx].span.offset >= span.offset && (items[idx - 1]?.span?.offset ?? -1) < span.offset;\n\n  // Binary search to find the first element that could be a child\n  do {\n    if (found()) {\n      return iterFrom(items, idx);\n    } else if (span.offset > items[idx].span.offset) {\n      min = prevIdx = idx;\n      idx = Math.floor(idx + (max - idx) / 2);\n    } else {\n      max = prevIdx = idx;\n      idx = Math.floor(idx - (idx - min) / 2);\n    }\n  } while (idx !== prevIdx);\n\n  // This might seem weird, but it's a simple way to make the types a little more elegant.\n  return empty();\n}\n\n/**\n * This fast algorithm tests the elements of `childArray` for inclusion in any of the given `spans`, assuming that both\n * the spans and child items are sorted.\n *\n * INVARIANT: the items in both the `spans` iterator and `childrenArray` MUST BE SORTED INCREASING by span _offset_.\n *\n * @internal\n * @param spans - the spans that contain the child elements\n * @param childrenArray - an array of child items (items that have spans) to test for inclusion in the spans\n * @returns - an IterableIterator of child items that are included in any span in the `spans` iterator\n */\nexport function* fastGetChildren<Spanned extends { span: DocumentSpan }>(\n  spans: Iterator<DocumentSpan>,\n  childrenArray: Spanned[]\n): Generator<Spanned> {\n  let curSpan = spans.next();\n\n  // Need to exit early if there are no spans.\n  if (curSpan.done) {\n    return;\n  }\n\n  const children = iteratorFromFirstMatchBinarySearch(curSpan.value as DocumentSpan, childrenArray);\n  let curChild = children.next();\n\n  while (!(curChild.done || curSpan.done)) {\n    if (contains(curSpan.value, curChild.value.span)) {\n      // The span is contained, so yield the current child and advance it.\n      yield curChild.value;\n      curChild = children.next();\n    } else if (curSpan.value.offset + curSpan.value.length < curChild.value.span.offset) {\n      // The current span ends before the next potential child starts, so advance the span\n      curSpan = spans.next();\n    } else {\n      // The current child was not contained in the current span, so advance to the next child.\n      curChild = children.next();\n    }\n  }\n}\n\n/**\n * The state of an analysis operation, which will eventually produce the result type that corresponds to the model.\n */\nexport interface DocumentAnalysisPollOperationState<Result = AnalyzeResult<AnalyzedDocument>>\n  extends PollOperationState<Result> {\n  /**\n   * The status of the operation. One of:\n   *\n   * - \"notStarted\"\n   * - \"running\"\n   * - \"succeeded\"\n   * - \"failed\"\n   */\n  status: AnalyzeOperationStatus;\n\n  /**\n   * The model ID that the analysis operation will use to produce the result.\n   */\n  modelId: string;\n\n  /**\n   * The URL to the operation.\n   */\n  operationLocation: string;\n\n  /**\n   * The Date and Time that the operation was created.\n   */\n  createdOn: Date;\n\n  /**\n   * The date & time that the operation state was last modified.\n   */\n  lastUpdatedOn: Date;\n}\n\n/**\n * A long-running operation (poller) that tracks the state of an analysis operation, eventually producing the result\n * type that corresponds to the model.\n */\nexport type AnalysisPoller<Result = AnalyzeResult<AnalyzedDocument>> = PollerLike<\n  DocumentAnalysisPollOperationState<Result>,\n  Result\n>;\n\n/**\n * Convert a generated AnalyzeResult into a convenience layer AnalyzeResult.\n * @internal\n */\nexport function toAnalyzeResultFromGenerated(result: GeneratedAnalyzeResult): AnalyzeResult {\n  return {\n    apiVersion: result.apiVersion as FormRecognizerApiVersion,\n    modelId: result.modelId,\n    content: result.content,\n    pages: result.pages.map((page) => toDocumentPageFromGenerated(page)),\n    tables: result.tables?.map((table) => toDocumentTableFromGenerated(table)),\n    keyValuePairs: result.keyValuePairs?.map((pair) => toKeyValuePairFromGenerated(pair)),\n    languages: result.languages,\n    styles: result.styles,\n    paragraphs: result.paragraphs?.map((para) => ({\n      ...para,\n      boundingRegions: toBoundingRegions(para.boundingRegions),\n    })),\n    documents: result.documents?.map(toAnalyzedDocumentFromGenerated),\n  };\n}\n\n/**\n * Defines an analysis operation by the initial request model ID, poller options, and a transform to apply to the\n * eventual result,\n *\n * @internal\n */\nexport interface AnalysisOperationDefinition<Result = AnalyzeResult> {\n  transformResult: (primitiveResult: GeneratedAnalyzeResult) => Result;\n  initialModelId: string;\n  options: PollerOptions<DocumentAnalysisPollOperationState<Result>> &\n    AnalyzeDocumentOptions<Result>;\n}\n\n/**\n * Converts an AnalyzeResultOperation (LRO response) to a DocumentAnalysisPollOperationState\n * @internal\n */\nexport function toDocumentAnalysisPollOperationState<Result>(\n  definition: AnalysisOperationDefinition<Result>,\n  modelId: string,\n  operationLocation: string,\n  response: AnalyzeResultOperation\n): DocumentAnalysisPollOperationState<Result> {\n  return {\n    status: response.status,\n    modelId: modelId,\n    lastUpdatedOn: response.lastUpdatedDateTime,\n    createdOn: response.createdDateTime,\n    operationLocation,\n    result: response.analyzeResult && definition.transformResult(response.analyzeResult),\n    error: response.error && new FormRecognizerError(response.error),\n    isCancelled: false, // Not supported\n    isStarted: response.status !== \"notStarted\",\n    isCompleted: response.status === \"succeeded\",\n  };\n}\n"]}
+{"version":3,"file":"analysis.js","sourceRoot":"","sources":["../../../src/lro/analysis.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAS/C,OAAO,EAAiB,qCAAqC,EAAE,MAAM,kBAAkB,CAAC;AAGxF,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,4BAA4B,EAC5B,2BAA2B,GAC5B,MAAM,uBAAuB,CAAC;AA4D/B;;;;;;GAMG;AACH,MAAM,UAAU,+BAA+B,CAAC,QAA2B;;IACzE,uCACK,QAAQ,KACX,eAAe,EAAE,iBAAiB,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC5D,MAAM,EAAE,qCAAqC,CAAC,MAAA,QAAQ,CAAC,MAAM,mCAAI,EAAE,CAAC,IACpE;AACJ,CAAC;AAgED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAmB,EAAE,KAAmB;IAC/D,OAAO,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;AACpG,CAAC;AAED;;GAEG;AACH,QAAQ,CAAC,CAAC,KAAK;IACb,yBAAyB;AAC3B,CAAC;AAED;;;;;GAKG;AACH,MAAM,SAAS,CAAC,CAAC,QAAQ,CAAI,KAAU,EAAE,GAAW;IAClD,IAAI,CAAC,GAAG,GAAG,CAAC;IAEZ,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE;QACvB,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;KAClB;AACH,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,SAAgC,EAChC,IAA2B;IAE1B,SAA0B,CAAC,KAAK,GAAG,GAAG,EAAE;;QACvC,OAAA,eAAe,CACb,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,EAC5B,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,uCAAY,IAAI,KAAE,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAG;QAC/D,CAAC,CAAC,mCAAI,EAAE,CACT,CAAA;KAAA,CAAC;IAEH,SAA0B,CAAC,OAAO,GAAG,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE3E,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE;QACxC,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,OAAO,SAAyB,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,SAAgC;;IAC1E,uCACK,SAAS,KACZ,KAAK,EAAE,MAAA,SAAS,CAAC,KAAK,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,2BAA2B,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,EACnF,cAAc,EAAE,MAAA,SAAS,CAAC,cAAc,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iCACnD,IAAI,KACP,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IACxC,CAAC,EACH,KAAK,EAAE,MAAA,SAAS,CAAC,KAAK,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iCACjC,IAAI,KACP,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IACxC,CAAC,IACH;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,kCAAkC,CAChD,IAAkB,EAClB,KAAgB;IAEhB,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvC,IAAI,OAAO,GAAG,GAAG,CAAC;IAClB,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC;IAEvB,MAAM,KAAK,GAAG,GAAY,EAAE;IAC1B,oHAAoH;IACpH,mEAAmE;IACnE,OAAA,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,MAAA,MAAA,MAAA,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,0CAAE,IAAI,0CAAE,MAAM,mCAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAA,EAAA,CAAC;IAE9F,gEAAgE;IAChE,GAAG;QACD,IAAI,KAAK,EAAE,EAAE;YACX,OAAO,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;SAC7B;aAAM,IAAI,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE;YAC/C,GAAG,GAAG,OAAO,GAAG,GAAG,CAAC;YACpB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;SACzC;aAAM;YACL,GAAG,GAAG,OAAO,GAAG,GAAG,CAAC;YACpB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;SACzC;KACF,QAAQ,GAAG,KAAK,OAAO,EAAE;IAE1B,wFAAwF;IACxF,OAAO,KAAK,EAAE,CAAC;AACjB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,SAAS,CAAC,CAAC,eAAe,CAC9B,KAA6B,EAC7B,aAAwB;IAExB,IAAI,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAE3B,4CAA4C;IAC5C,IAAI,OAAO,CAAC,IAAI,EAAE;QAChB,OAAO;KACR;IAED,MAAM,QAAQ,GAAG,kCAAkC,CAAC,OAAO,CAAC,KAAqB,EAAE,aAAa,CAAC,CAAC;IAClG,IAAI,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE/B,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;QACvC,IAAI,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YAChD,oEAAoE;YACpE,MAAM,QAAQ,CAAC,KAAK,CAAC;YACrB,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC5B;aAAM,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;YACnF,oFAAoF;YACpF,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;SACxB;aAAM;YACL,yFAAyF;YACzF,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC5B;KACF;AACH,CAAC;AA+CD;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAA8B;;IACzE,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,UAAsC;QACzD,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QACpE,MAAM,EAAE,MAAA,MAAM,CAAC,MAAM,0CAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;QAC1E,aAAa,EAAE,MAAA,MAAM,CAAC,aAAa,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QACrF,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,iCACxC,IAAI,KACP,eAAe,EAAE,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,IACxD,CAAC;QACH,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,0CAAE,GAAG,CAAC,+BAA+B,CAAC;KAClE,CAAC;AACJ,CAAC;AAeD;;;GAGG;AACH,MAAM,UAAU,oCAAoC,CAClD,UAA+C,EAC/C,OAAe,EACf,iBAAyB,EACzB,QAAgC;IAEhC,OAAO;QACL,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,OAAO,EAAE,OAAO;QAChB,aAAa,EAAE,QAAQ,CAAC,aAAa;QACrC,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,iBAAiB;QACjB,MAAM,EAAE,QAAQ,CAAC,aAAa,IAAI,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,aAAa,CAAC;QACpF,KAAK,EAAE,QAAQ,CAAC,KAAK,IAAI,IAAI,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChE,WAAW,EAAE,KAAK;QAClB,SAAS,EAAE,QAAQ,CAAC,MAAM,KAAK,YAAY;QAC3C,WAAW,EAAE,QAAQ,CAAC,MAAM,KAAK,WAAW;KAC7C,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { PollOperationState, PollerLike } from \"@azure/core-lro\";\nimport { FormRecognizerError } from \"../error\";\nimport {\n  AnalyzeResult as GeneratedAnalyzeResult,\n  AnalyzeResultOperation,\n  AnalyzeResultOperationStatus as AnalyzeOperationStatus,\n  DocumentLanguage,\n  DocumentSpan,\n  DocumentStyle,\n} from \"../generated\";\nimport { DocumentField, toAnalyzedDocumentFieldsFromGenerated } from \"../models/fields\";\nimport { FormRecognizerApiVersion, PollerOptions } from \"../options\";\nimport { AnalyzeDocumentOptions } from \"../options/AnalyzeDocumentsOptions\";\nimport {\n  toBoundingPolygon,\n  toBoundingRegions,\n  toDocumentTableFromGenerated,\n  toKeyValuePairFromGenerated,\n} from \"../transforms/polygon\";\nimport {\n  BoundingRegion,\n  DocumentTable,\n  DocumentKeyValuePair,\n  DocumentPage,\n  DocumentLine,\n  DocumentParagraph,\n} from \"../models/documentElements\";\nimport {\n  Document as GeneratedDocument,\n  DocumentPage as GeneratedDocumentPage,\n  DocumentLine as GeneratedDocumentLine,\n} from \"../generated\";\n\n/**\n * A request input that can be uploaded as binary data to the Form Recognizer service. Form Recognizer treats `string`\n * inputs as URLs, so to send a string as a _binary_ input, first convert the string to one of the following input\n * types.\n */\nexport type FormRecognizerRequestBody =\n  | NodeJS.ReadableStream\n  | Blob\n  | ArrayBuffer\n  | ArrayBufferView;\n\n/**\n * An extracted document object.\n *\n * An AnalyzedDocument is an instance of one of the document types within a model. Its fields correspond to the field\n * schema of the document type.\n */\nexport interface AnalyzedDocument {\n  /**\n   * The type of the document that was extracted. A model can have multiple document types (for example, in a composed\n   * model), so this property indicates which document type the fields of this document correspond to.\n   */\n  docType: string;\n\n  /**\n   * The extracted fields, which correspond to the document type's field schema.\n   */\n  fields: { [field: string]: DocumentField };\n\n  /**\n   * Bounding regions covering the document.\n   */\n  boundingRegions?: BoundingRegion[];\n\n  /**\n   * Locations of the document's elements in the `content` text (reading-order-concatenated content).\n   */\n  spans: DocumentSpan[];\n\n  /**\n   * The service's confidence that it has correctly extracted the document.\n   */\n  confidence: number;\n}\n\n/**\n * Transform a REST-level Document response object into the more strongly-typed AnalyzedDocument.\n *\n * @internal\n * @param document - a REST-level document response object\n * @returns an AnalyzedDocument (which has had its fields mapped to stronger DocumentField types)\n */\nexport function toAnalyzedDocumentFromGenerated(document: GeneratedDocument): AnalyzedDocument {\n  return {\n    ...document,\n    boundingRegions: toBoundingRegions(document.boundingRegions),\n    fields: toAnalyzedDocumentFieldsFromGenerated(document.fields ?? {}),\n  };\n}\n\n/**\n * The common fields of all AnalyzeResult-like types, such as LayoutResult, ReadResult, and GeneralDocumentResult.\n */\nexport interface AnalyzeResultCommon {\n  /**\n   * The service API version used to produce this result.\n   */\n  apiVersion: FormRecognizerApiVersion;\n\n  /**\n   * The unique ID of the model that was used to produce this result.\n   */\n  modelId: string;\n\n  /**\n   * A string representation of all textual and visual elements in the input, concatenated by reading order (the order\n   * in which the service \"reads\" or extracts the textual and visual content from the document).\n   */\n  content: string;\n}\n\n/**\n * The result of an analysis operation. The type of the Document may be determined by the model used to perform the\n * analysis.\n */\nexport interface AnalyzeResult<Document = AnalyzedDocument> extends AnalyzeResultCommon {\n  /**\n   * Extracted pages.\n   */\n  pages?: DocumentPage[];\n\n  /**\n   * Extracted tables.\n   */\n  tables?: DocumentTable[];\n\n  /**\n   * Extracted key-value pairs.\n   */\n  keyValuePairs?: DocumentKeyValuePair[];\n\n  /**\n   * Extracted text languages.\n   */\n  languages?: DocumentLanguage[];\n\n  /**\n   * Extracted font styles.\n   */\n  styles?: DocumentStyle[];\n\n  /**\n   * Extracted documents (instances of any of the model's document types and corresponding field schemas).\n   */\n  documents?: Document[];\n\n  /**\n   * Extracted document paragraphs.\n   */\n  paragraphs?: DocumentParagraph[];\n}\n\n/**\n * Tests if one span contains another, by testing that the outer span starts before or at the same character as the\n * inner span, and that the end position of the outer span is greater than or equal to the end position of the inner\n * span.\n *\n * @internal\n * @param outer - the outer (potentially containing) span\n * @param inner - the span to test if `outer` contains\n * @returns true if `inner` is contained inside of `outer`.\n */\nexport function contains(outer: DocumentSpan, inner: DocumentSpan): boolean {\n  return outer.offset <= inner.offset && outer.offset + outer.length >= inner.offset + inner.length;\n}\n\n/**\n * Make an empty generator. This might seem silly, but it's useful for satisfying invariants.\n */\nfunction* empty(): Generator<never> {\n  /* intentionally empty */\n}\n\n/**\n * Produces an iterator of the given items starting from the given index.\n *\n * @param items - the items to iterate over\n * @param idx - the index of the first item to begin iterating from\n */\nexport function* iterFrom<T>(items: T[], idx: number): Generator<T> {\n  let i = idx;\n\n  while (i < items.length) {\n    yield items[i++];\n  }\n}\n\nexport function toDocumentLineFromGenerated(\n  generated: GeneratedDocumentLine,\n  page: GeneratedDocumentPage\n): DocumentLine {\n  (generated as DocumentLine).words = () =>\n    fastGetChildren(\n      iterFrom(generated.spans, 0),\n      page.words?.map((word) => {\n        return { ...word, polygon: toBoundingPolygon(word.polygon) };\n      }) ?? []\n    );\n\n  (generated as DocumentLine).polygon = toBoundingPolygon(generated.polygon);\n\n  Object.defineProperty(generated, \"words\", {\n    enumerable: false,\n  });\n\n  return generated as DocumentLine;\n}\n\nexport function toDocumentPageFromGenerated(generated: GeneratedDocumentPage): DocumentPage {\n  return {\n    ...generated,\n    lines: generated.lines?.map((line) => toDocumentLineFromGenerated(line, generated)),\n    selectionMarks: generated.selectionMarks?.map((mark) => ({\n      ...mark,\n      polygon: toBoundingPolygon(mark.polygon),\n    })),\n    words: generated.words?.map((word) => ({\n      ...word,\n      polygon: toBoundingPolygon(word.polygon),\n    })),\n  };\n}\n\n/**\n * Binary search through an array of items to find the first item that could possibly be contained by the given span,\n * then return an iterator beginning from that item.\n *\n * This allows a program to quickly find the first relevant item in the array for consideration when testing for span\n * inclusion.\n *\n * @internal\n * @param span - the span to use when testing each individual item\n * @param items - an array of items to binary search through\n * @returns an iterator beginning from the item identified by the search\n */\nexport function iteratorFromFirstMatchBinarySearch<Spanned extends { span: DocumentSpan }>(\n  span: DocumentSpan,\n  items: Spanned[]\n): IterableIterator<Spanned> {\n  let idx = Math.floor(items.length / 2);\n  let prevIdx = idx;\n  let min = 0;\n  let max = items.length;\n\n  const found = (): boolean =>\n    // The item is found if it starts after the current span and the item before it does not. That means it is the first\n    // item in the array that could be a child if the spans are sorted.\n    items[idx].span.offset >= span.offset && (items[idx - 1]?.span?.offset ?? -1) < span.offset;\n\n  // Binary search to find the first element that could be a child\n  do {\n    if (found()) {\n      return iterFrom(items, idx);\n    } else if (span.offset > items[idx].span.offset) {\n      min = prevIdx = idx;\n      idx = Math.floor(idx + (max - idx) / 2);\n    } else {\n      max = prevIdx = idx;\n      idx = Math.floor(idx - (idx - min) / 2);\n    }\n  } while (idx !== prevIdx);\n\n  // This might seem weird, but it's a simple way to make the types a little more elegant.\n  return empty();\n}\n\n/**\n * This fast algorithm tests the elements of `childArray` for inclusion in any of the given `spans`, assuming that both\n * the spans and child items are sorted.\n *\n * INVARIANT: the items in both the `spans` iterator and `childrenArray` MUST BE SORTED INCREASING by span _offset_.\n *\n * @internal\n * @param spans - the spans that contain the child elements\n * @param childrenArray - an array of child items (items that have spans) to test for inclusion in the spans\n * @returns - an IterableIterator of child items that are included in any span in the `spans` iterator\n */\nexport function* fastGetChildren<Spanned extends { span: DocumentSpan }>(\n  spans: Iterator<DocumentSpan>,\n  childrenArray: Spanned[]\n): Generator<Spanned> {\n  let curSpan = spans.next();\n\n  // Need to exit early if there are no spans.\n  if (curSpan.done) {\n    return;\n  }\n\n  const children = iteratorFromFirstMatchBinarySearch(curSpan.value as DocumentSpan, childrenArray);\n  let curChild = children.next();\n\n  while (!(curChild.done || curSpan.done)) {\n    if (contains(curSpan.value, curChild.value.span)) {\n      // The span is contained, so yield the current child and advance it.\n      yield curChild.value;\n      curChild = children.next();\n    } else if (curSpan.value.offset + curSpan.value.length < curChild.value.span.offset) {\n      // The current span ends before the next potential child starts, so advance the span\n      curSpan = spans.next();\n    } else {\n      // The current child was not contained in the current span, so advance to the next child.\n      curChild = children.next();\n    }\n  }\n}\n\n/**\n * The state of an analysis operation, which will eventually produce the result type that corresponds to the model.\n */\nexport interface DocumentAnalysisPollOperationState<Result = AnalyzeResult<AnalyzedDocument>>\n  extends PollOperationState<Result> {\n  /**\n   * The status of the operation. One of:\n   *\n   * - \"notStarted\"\n   * - \"running\"\n   * - \"succeeded\"\n   * - \"failed\"\n   */\n  status: AnalyzeOperationStatus;\n\n  /**\n   * The model ID that the analysis operation will use to produce the result.\n   */\n  modelId: string;\n\n  /**\n   * The URL to the operation.\n   */\n  operationLocation: string;\n\n  /**\n   * The Date and Time that the operation was created.\n   */\n  createdOn: Date;\n\n  /**\n   * The date & time that the operation state was last modified.\n   */\n  lastUpdatedOn: Date;\n}\n\n/**\n * A long-running operation (poller) that tracks the state of an analysis operation, eventually producing the result\n * type that corresponds to the model.\n */\nexport type AnalysisPoller<Result = AnalyzeResult<AnalyzedDocument>> = PollerLike<\n  DocumentAnalysisPollOperationState<Result>,\n  Result\n>;\n\n/**\n * Convert a generated AnalyzeResult into a convenience layer AnalyzeResult.\n * @internal\n */\nexport function toAnalyzeResultFromGenerated(result: GeneratedAnalyzeResult): AnalyzeResult {\n  return {\n    apiVersion: result.apiVersion as FormRecognizerApiVersion,\n    modelId: result.modelId,\n    content: result.content,\n    pages: result.pages.map((page) => toDocumentPageFromGenerated(page)),\n    tables: result.tables?.map((table) => toDocumentTableFromGenerated(table)),\n    keyValuePairs: result.keyValuePairs?.map((pair) => toKeyValuePairFromGenerated(pair)),\n    languages: result.languages,\n    styles: result.styles,\n    paragraphs: result.paragraphs?.map((para) => ({\n      ...para,\n      boundingRegions: toBoundingRegions(para.boundingRegions),\n    })),\n    documents: result.documents?.map(toAnalyzedDocumentFromGenerated),\n  };\n}\n\n/**\n * Defines an analysis operation by the initial request model ID, poller options, and a transform to apply to the\n * eventual result,\n *\n * @internal\n */\nexport interface AnalysisOperationDefinition<Result = AnalyzeResult> {\n  transformResult: (primitiveResult: GeneratedAnalyzeResult) => Result;\n  initialModelId: string;\n  options: PollerOptions<DocumentAnalysisPollOperationState<Result>> &\n    AnalyzeDocumentOptions<Result>;\n}\n\n/**\n * Converts an AnalyzeResultOperation (LRO response) to a DocumentAnalysisPollOperationState\n * @internal\n */\nexport function toDocumentAnalysisPollOperationState<Result>(\n  definition: AnalysisOperationDefinition<Result>,\n  modelId: string,\n  operationLocation: string,\n  response: AnalyzeResultOperation\n): DocumentAnalysisPollOperationState<Result> {\n  return {\n    status: response.status,\n    modelId: modelId,\n    lastUpdatedOn: response.lastUpdatedOn,\n    createdOn: response.createdOn,\n    operationLocation,\n    result: response.analyzeResult && definition.transformResult(response.analyzeResult),\n    error: response.error && new FormRecognizerError(response.error),\n    isCancelled: false, // Not supported\n    isStarted: response.status !== \"notStarted\",\n    isCompleted: response.status === \"succeeded\",\n  };\n}\n"]}

package/dist-esm/src/models/documentElements.js.map

@@ -1 +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 { Point2D } from \"../transforms/polygon\";\nimport {\n  DocumentPageKind,\n  DocumentSpan,\n  DocumentTableCellKind,\n  DocumentField as GeneratedDocumentField,\n  LengthUnit,\n  ParagraphRole,\n  SelectionMarkState,\n} from \"../generated\";\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  /** Confidence of correctly extracting the key-value pair. */\n  confidence: number;\n}\n\n/** Content and layout elements extracted from a page from the input. */\nexport interface DocumentPage {\n  /** Kind of document page. */\n  kind: DocumentPageKind;\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"]}
+{"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 { Point2D } from \"../transforms/polygon\";\nimport {\n  DocumentSpan,\n  DocumentTableCellKind,\n  DocumentField as GeneratedDocumentField,\n  LengthUnit,\n  ParagraphRole,\n  SelectionMarkState,\n} from \"../generated\";\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  /** Confidence of correctly extracting the key-value pair. */\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"]}

package/dist-esm/src/options/BuildModelOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"BuildModelOptions.js","sourceRoot":"","sources":["../../../src/options/BuildModelOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAqBlC;;GAEG;AACH,2DAA2D;AAC3D,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC;;;OAGG;IACH,QAAQ,EAAE,UAAU;IACpB;;;OAGG;IACH,MAAM,EAAE,QAAQ;CACR,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { OperationOptions } from \"@azure/core-client\";\nimport { DocumentModelOperationState } from \"../lro/administration\";\nimport { PollerOptions } from \"./PollerOptions\";\n\n/**\n * Supported model build modes. The model build mode selects the engine that the service uses to train the model based\n * on the labeled training data.\n *\n * The options are:\n * - \"neural\", which yields the highest quality of model that is capable of extracting data from classes of documents\n *   that have the same structure of data, but different layouts (for example, W2 tax forms, which may vary from company\n *   to company, but always contain the same information).\n * - \"template\", which requires all documents to have the same fixed layout (template).\n *\n * Please see the following link for more information: https://aka.ms/azsdk/formrecognizer/buildmode\n */\nexport type DocumentModelBuildMode =\n  typeof DocumentModelBuildMode[keyof typeof DocumentModelBuildMode];\n\n/**\n * Supported values of `DocumentModelBuildMode`.\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const DocumentModelBuildMode = {\n  /**\n   * A mode that builds a model assuming that documents all follow the same, fixed template layout (the same relative\n   * positioning of fields between documents).\n   */\n  Template: \"template\",\n  /**\n   * A mode that uses a neural engine to extract fields, allowing for documents that have different visual appearances,\n   * but that contain the same information.\n   */\n  Neural: \"neural\",\n} as const;\n\n/**\n * Options common to all operations that define new models, such as `beginBuildModel`, `beginComposeModel`, and\n * `getCopyAuthorization`.\n */\nexport interface CommonModelCreationOptions {\n  /**\n   * A textual description of the model (can be any text).\n   */\n  description?: string;\n\n  /**\n   * Additional, user-specified key-value pairs to associate with the model as persistent metadata.\n   */\n  tags?: Record<string, string>;\n}\n\n/**\n * Options for the model creation operation.\n */\nexport interface CreateModelOptions\n  extends OperationOptions,\n    CommonModelCreationOptions,\n    PollerOptions<DocumentModelOperationState> {}\n\n/**\n * Options for the model build operation.\n */\nexport interface BeginBuildModelOptions extends CreateModelOptions {}\n\n/**\n * Options for the model compose operation.\n */\nexport interface BeginComposeModelOptions extends CreateModelOptions {}\n"]}
+{"version":3,"file":"BuildModelOptions.js","sourceRoot":"","sources":["../../../src/options/BuildModelOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAqBlC;;GAEG;AACH,2DAA2D;AAC3D,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC;;;OAGG;IACH,QAAQ,EAAE,UAAU;IACpB;;;OAGG;IACH,MAAM,EAAE,QAAQ;CACR,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { OperationOptions } from \"@azure/core-client\";\nimport { DocumentModelOperationState } from \"../lro/administration\";\nimport { PollerOptions } from \"./PollerOptions\";\n\n/**\n * Supported model build modes. The model build mode selects the engine that the service uses to train the model based\n * on the labeled training data.\n *\n * The options are:\n * - \"neural\", which yields the highest quality of model that is capable of extracting data from classes of documents\n *   that have the same structure of data, but different layouts (for example, W2 tax forms, which may vary from company\n *   to company, but always contain the same information).\n * - \"template\", which requires all documents to have the same fixed layout (template).\n *\n * Please see the following link for more information: https://aka.ms/azsdk/formrecognizer/buildmode\n */\nexport type DocumentModelBuildMode =\n  typeof DocumentModelBuildMode[keyof typeof DocumentModelBuildMode];\n\n/**\n * Supported values of `DocumentModelBuildMode`.\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const DocumentModelBuildMode = {\n  /**\n   * A mode that builds a model assuming that documents all follow the same, fixed template layout (the same relative\n   * positioning of fields between documents).\n   */\n  Template: \"template\",\n  /**\n   * A mode that uses a neural engine to extract fields, allowing for documents that have different visual appearances,\n   * but that contain the same information.\n   */\n  Neural: \"neural\",\n} as const;\n\n/**\n * Options common to all operations that define new models, such as `beginBuildDocumentModel`,\n * `beginComposeDocumentModel`, and `getCopyAuthorization`.\n */\nexport interface CommonModelCreationOptions {\n  /**\n   * A textual description of the model (can be any text).\n   */\n  description?: string;\n\n  /**\n   * Additional, user-specified key-value pairs to associate with the model as persistent metadata.\n   */\n  tags?: Record<string, string>;\n}\n\n/**\n * Options for the model creation operation.\n */\nexport interface CreateDocumentModelOptions\n  extends OperationOptions,\n    CommonModelCreationOptions,\n    PollerOptions<DocumentModelOperationState> {}\n\n/**\n * Options for the model build operation.\n */\nexport interface BeginBuildDocumentModelOptions extends CreateDocumentModelOptions {}\n\n/**\n * Options for the model compose operation.\n */\nexport interface BeginComposeDocumentModelOptions extends CreateDocumentModelOptions {}\n"]}

package/dist-esm/src/options/DeleteModelOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeleteModelOptions.js","sourceRoot":"","sources":["../../../src/options/DeleteModelOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { OperationOptions } from \"@azure/core-client\";\n\n/**\n * Options for model deletion.\n */\nexport interface DeleteModelOptions extends OperationOptions {}\n"]}
+{"version":3,"file":"DeleteModelOptions.js","sourceRoot":"","sources":["../../../src/options/DeleteModelOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { OperationOptions } from \"@azure/core-client\";\n\n/**\n * Options for model deletion.\n */\nexport interface DeleteDocumentModelOptions extends OperationOptions {}\n"]}

package/dist-esm/src/options/FormRecognizerClientOptions.js

@@ -11,9 +11,10 @@ export const FormRecognizerApiVersion = {
      * 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.
      */
-    Latest: "2022-06-30-preview",
+    Latest: "2022-08-31",
     // TODO (GA): Add a `Stable` version selector that picks the latest GA version, even in beta packages, and an exact
     // version entry for the GA version.
+    Stable: "2022-08-31",
 };
 /**
  * Supported values of StringIndexType.
@@ -36,6 +37,6 @@ export const StringIndexType = {
  */
 export const DEFAULT_GENERATED_CLIENT_OPTIONS = {
     stringIndexType: StringIndexType.Utf16CodeUnit,
-    apiVersion: FormRecognizerApiVersion.Latest,
+    apiVersion: FormRecognizerApiVersion.Stable,
 };
 //# sourceMappingURL=FormRecognizerClientOptions.js.map

package/dist-esm/src/options/FormRecognizerClientOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormRecognizerClientOptions.js","sourceRoot":"","sources":["../../../src/options/FormRecognizerClientOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAUlC;;GAEG;AACH,2DAA2D;AAC3D,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC;;;;;OAKG;IACH,MAAM,EAAE,oBAAoB;IAC5B,mHAAmH;IACnH,oCAAoC;CAC5B,CAAC;AAOX;;GAEG;AACH,2DAA2D;AAC3D,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B;;OAEG;IACH,aAAa,EAAE,eAAe;IAC9B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;CAC5B,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG;IAC9C,eAAe,EAAE,eAAe,CAAC,aAAa;IAC9C,UAAU,EAAE,wBAAwB,CAAC,MAAM;CACnC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { CommonClientOptions } from \"@azure/core-client\";\n\n/**\n * Valid values of the Form Recognizer service REST API version.\n */\nexport type FormRecognizerApiVersion =\n  typeof FormRecognizerApiVersion[keyof typeof FormRecognizerApiVersion];\n\n/**\n * Supported and common values of FormRecognizerApiVersion.\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const FormRecognizerApiVersion = {\n  /**\n   * The newest version of the service known to be supported by the client (default).\n   *\n   * If using a beta package version, this will be identical to the latest preview version. Otherwise, it will be\n   * identical to the latest stable version.\n   */\n  Latest: \"2022-06-30-preview\",\n  // TODO (GA): Add a `Stable` version selector that picks the latest GA version, even in beta packages, and an exact\n  // version entry for the GA version.\n} as const;\n\n/**\n * Valid string index types supported by the Form Recognizer service and SDK clients.\n */\nexport type StringIndexType = typeof StringIndexType[keyof typeof StringIndexType];\n\n/**\n * Supported values of StringIndexType.\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const StringIndexType = {\n  /**\n   * UTF-16 code units\n   */\n  Utf16CodeUnit: \"utf16CodeUnit\",\n  /**\n   * Unicode code points\n   */\n  UnicodeCodePoint: \"unicodeCodePoint\",\n} as const;\n\n/**\n * Default settings for Form Recognizer clients.\n *\n * @internal\n */\nexport const DEFAULT_GENERATED_CLIENT_OPTIONS = {\n  stringIndexType: StringIndexType.Utf16CodeUnit,\n  apiVersion: FormRecognizerApiVersion.Latest,\n} as const;\n\n/**\n * Configurable options for the Form Recognizer service clients (DocumentAnalysisClient and\n * DocumentModelAdministrationClient).\n */\nexport interface FormRecognizerCommonClientOptions extends CommonClientOptions {\n  /**\n   * The version of the Form Recognizer REST API to call. Service versions 2.1 and lower (non-date-based versions) are\n   * not supported by this client. To use API version 2.1, please use version 3 of the Azure Form Recognizer SDK for\n   * JavaScript (\\@azure/ai-form-recognizer\\@^3.2.0).\n   *\n   * Default: FormRecognizerApiVersion.Latest (\"2022-06-30-preview\")\n   */\n  apiVersion?: FormRecognizerApiVersion;\n}\n\n/**\n * Configurable options for DocumentAnalysisClient.\n */\nexport interface DocumentAnalysisClientOptions extends FormRecognizerCommonClientOptions {\n  /**\n   * The unit of string offset/length values that the service returns.\n   *\n   * In JavaScript, strings are indexed by UTF-16 code units. Do _NOT_ set this value unless you are certain you need\n   * Unicode code-point units instead.\n   *\n   * Default: \"utf16CodeUnit\"\n   */\n  stringIndexType?: StringIndexType;\n}\n\n/**\n * Configurable options for DocumentModelAdministrationClient.\n */\nexport interface DocumentModelAdministrationClientOptions\n  extends FormRecognizerCommonClientOptions {}\n"]}
+{"version":3,"file":"FormRecognizerClientOptions.js","sourceRoot":"","sources":["../../../src/options/FormRecognizerClientOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAUlC;;GAEG;AACH,2DAA2D;AAC3D,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC;;;;;OAKG;IACH,MAAM,EAAE,YAAY;IACpB,mHAAmH;IACnH,oCAAoC;IACpC,MAAM,EAAE,YAAY;CACZ,CAAC;AAOX;;GAEG;AACH,2DAA2D;AAC3D,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B;;OAEG;IACH,aAAa,EAAE,eAAe;IAC9B;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;CAC5B,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG;IAC9C,eAAe,EAAE,eAAe,CAAC,aAAa;IAC9C,UAAU,EAAE,wBAAwB,CAAC,MAAM;CACnC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { CommonClientOptions } from \"@azure/core-client\";\n\n/**\n * Valid values of the Form Recognizer service REST API version.\n */\nexport type FormRecognizerApiVersion =\n  typeof FormRecognizerApiVersion[keyof typeof FormRecognizerApiVersion];\n\n/**\n * Supported and common values of FormRecognizerApiVersion.\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const FormRecognizerApiVersion = {\n  /**\n   * The newest version of the service known to be supported by the client (default).\n   *\n   * If using a beta package version, this will be identical to the latest preview version. Otherwise, it will be\n   * identical to the latest stable version.\n   */\n  Latest: \"2022-08-31\",\n  // TODO (GA): Add a `Stable` version selector that picks the latest GA version, even in beta packages, and an exact\n  // version entry for the GA version.\n  Stable: \"2022-08-31\",\n} as const;\n\n/**\n * Valid string index types supported by the Form Recognizer service and SDK clients.\n */\nexport type StringIndexType = typeof StringIndexType[keyof typeof StringIndexType];\n\n/**\n * Supported values of StringIndexType.\n */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const StringIndexType = {\n  /**\n   * UTF-16 code units\n   */\n  Utf16CodeUnit: \"utf16CodeUnit\",\n  /**\n   * Unicode code points\n   */\n  UnicodeCodePoint: \"unicodeCodePoint\",\n} as const;\n\n/**\n * Default settings for Form Recognizer clients.\n *\n * @internal\n */\nexport const DEFAULT_GENERATED_CLIENT_OPTIONS = {\n  stringIndexType: StringIndexType.Utf16CodeUnit,\n  apiVersion: FormRecognizerApiVersion.Stable,\n} as const;\n\n/**\n * Configurable options for the Form Recognizer service clients (DocumentAnalysisClient and\n * DocumentModelAdministrationClient).\n */\nexport interface FormRecognizerCommonClientOptions extends CommonClientOptions {\n  /**\n   * The version of the Form Recognizer REST API to call. Service versions 2.1 and lower (non-date-based versions) are\n   * not supported by this client. To use API version 2.1, please use version 3 of the Azure Form Recognizer SDK for\n   * JavaScript (\\@azure/ai-form-recognizer\\@^3.2.0).\n   *\n   * Default: FormRecognizerApiVersion.Stable (\"2022-08-31\")\n   */\n  apiVersion?: FormRecognizerApiVersion;\n}\n\n/**\n * Configurable options for DocumentAnalysisClient.\n */\nexport interface DocumentAnalysisClientOptions extends FormRecognizerCommonClientOptions {\n  /**\n   * The unit of string offset/length values that the service returns.\n   *\n   * In JavaScript, strings are indexed by UTF-16 code units. Do _NOT_ set this value unless you are certain you need\n   * Unicode code-point units instead.\n   *\n   * Default: \"utf16CodeUnit\"\n   */\n  stringIndexType?: StringIndexType;\n}\n\n/**\n * Configurable options for DocumentModelAdministrationClient.\n */\nexport interface DocumentModelAdministrationClientOptions\n  extends FormRecognizerCommonClientOptions {}\n"]}

package/dist-esm/src/options/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/options/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAGL,sBAAsB,GAGvB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAGL,wBAAwB,EAExB,eAAe,GAChB,MAAM,+BAA+B,CAAC;AASvC,OAAO,EAOL,sBAAsB,EAYtB,eAAe,EACf,wBAAwB,GACzB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AnalyzeDocumentOptions } from \"./AnalyzeDocumentsOptions\";\nimport {\n  CreateModelOptions,\n  CommonModelCreationOptions,\n  DocumentModelBuildMode,\n  BeginBuildModelOptions,\n  BeginComposeModelOptions,\n} from \"./BuildModelOptions\";\nimport { BeginCopyModelOptions } from \"./BeginCopyModelOptions\";\nimport { DeleteModelOptions } from \"./DeleteModelOptions\";\nimport {\n  DocumentAnalysisClientOptions,\n  DocumentModelAdministrationClientOptions,\n  FormRecognizerApiVersion,\n  FormRecognizerCommonClientOptions,\n  StringIndexType,\n} from \"./FormRecognizerClientOptions\";\nimport { GetCopyAuthorizationOptions } from \"./GetCopyAuthorizationOptions\";\nimport { GetResourceDetailsOptions } from \"./GetResourceDetailsOptions\";\nimport { GetModelOptions } from \"./GetModelOptions\";\nimport { GetOperationOptions } from \"./GetOperationOptions\";\nimport { ListModelsOptions } from \"./ListModelsOptions\";\nimport { ListOperationsOptions } from \"./ListOperationsOptions\";\nimport { PollerOptions } from \"./PollerOptions\";\n\nexport {\n  AnalyzeDocumentOptions,\n  CreateModelOptions,\n  BeginBuildModelOptions,\n  BeginComposeModelOptions,\n  CommonModelCreationOptions,\n  BeginCopyModelOptions,\n  DocumentModelBuildMode,\n  FormRecognizerCommonClientOptions,\n  DocumentAnalysisClientOptions,\n  DocumentModelAdministrationClientOptions,\n  GetCopyAuthorizationOptions,\n  GetResourceDetailsOptions,\n  GetModelOptions,\n  GetOperationOptions,\n  DeleteModelOptions,\n  ListModelsOptions,\n  ListOperationsOptions,\n  PollerOptions,\n  StringIndexType,\n  FormRecognizerApiVersion,\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/options/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAGL,sBAAsB,GAGvB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAGL,wBAAwB,EAExB,eAAe,GAChB,MAAM,+BAA+B,CAAC;AASvC,OAAO,EAOL,sBAAsB,EAYtB,eAAe,EACf,wBAAwB,GACzB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AnalyzeDocumentOptions } from \"./AnalyzeDocumentsOptions\";\nimport {\n  CreateDocumentModelOptions,\n  CommonModelCreationOptions,\n  DocumentModelBuildMode,\n  BeginBuildDocumentModelOptions,\n  BeginComposeDocumentModelOptions,\n} from \"./BuildModelOptions\";\nimport { BeginCopyModelOptions } from \"./BeginCopyModelOptions\";\nimport { DeleteDocumentModelOptions } from \"./DeleteModelOptions\";\nimport {\n  DocumentAnalysisClientOptions,\n  DocumentModelAdministrationClientOptions,\n  FormRecognizerApiVersion,\n  FormRecognizerCommonClientOptions,\n  StringIndexType,\n} from \"./FormRecognizerClientOptions\";\nimport { GetCopyAuthorizationOptions } from \"./GetCopyAuthorizationOptions\";\nimport { GetResourceDetailsOptions } from \"./GetResourceDetailsOptions\";\nimport { GetModelOptions } from \"./GetModelOptions\";\nimport { GetOperationOptions } from \"./GetOperationOptions\";\nimport { ListModelsOptions } from \"./ListModelsOptions\";\nimport { ListOperationsOptions } from \"./ListOperationsOptions\";\nimport { PollerOptions } from \"./PollerOptions\";\n\nexport {\n  AnalyzeDocumentOptions,\n  CreateDocumentModelOptions,\n  BeginBuildDocumentModelOptions,\n  BeginComposeDocumentModelOptions,\n  CommonModelCreationOptions,\n  BeginCopyModelOptions,\n  DocumentModelBuildMode,\n  FormRecognizerCommonClientOptions,\n  DocumentAnalysisClientOptions,\n  DocumentModelAdministrationClientOptions,\n  GetCopyAuthorizationOptions,\n  GetResourceDetailsOptions,\n  GetModelOptions,\n  GetOperationOptions,\n  DeleteDocumentModelOptions,\n  ListModelsOptions,\n  ListOperationsOptions,\n  PollerOptions,\n  StringIndexType,\n  FormRecognizerApiVersion,\n};\n"]}

package/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.0.0-beta.6",
+  "version": "4.0.0",
   "keywords": [
     "node",
     "azure",

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

@@ -158,13 +158,13 @@ export { AzureKeyCredential }
 /**
  * Options for the model build operation.
  */
-export declare interface BeginBuildModelOptions extends CreateModelOptions {
+export declare interface BeginBuildDocumentModelOptions extends CreateDocumentModelOptions {
 }
 
 /**
  * Options for the model compose operation.
  */
-export declare interface BeginComposeModelOptions extends CreateModelOptions {
+export declare interface BeginComposeDocumentModelOptions extends CreateDocumentModelOptions {
 }
 
 /**
@@ -180,8 +180,8 @@ export declare interface BoundingRegion extends HasBoundingPolygon {
 }
 
 /**
- * Options common to all operations that define new models, such as `beginBuildModel`, `beginComposeModel`, and
- * `getCopyAuthorization`.
+ * Options common to all operations that define new models, such as `beginBuildDocumentModel`,
+ * `beginComposeDocumentModel`, and `getCopyAuthorization`.
  */
 export declare interface CommonModelCreationOptions {
     /**
@@ -210,6 +210,12 @@ export declare interface CopyAuthorization {
     expirationDateTime: Date;
 }
 
+/**
+ * Options for the model creation operation.
+ */
+export declare interface CreateDocumentModelOptions extends OperationOptions, CommonModelCreationOptions, PollerOptions<DocumentModelOperationState> {
+}
+
 /**
  * Create a DocumentModel that performs analysis using the given schema.
  *
@@ -220,13 +226,7 @@ export declare interface CopyAuthorization {
  * @param schema - model schema contents
  * @returns - a DocumentModel that encodes the schema
  */
-export declare function createModelFromSchema(schema: Omit<DocumentModelDetails, "createdDateTime">): DocumentModel<AnalyzeResult<unknown>>;
-
-/**
- * Options for the model creation operation.
- */
-export declare interface CreateModelOptions extends OperationOptions, CommonModelCreationOptions, PollerOptions<DocumentModelOperationState> {
-}
+export declare function createModelFromSchema(schema: Omit<DocumentModelDetails, "createdOn">): DocumentModel<AnalyzeResult<unknown>>;
 
 /** Currency field value. */
 export declare interface CurrencyValue {
@@ -247,7 +247,7 @@ export declare interface CustomDocumentModelsDetails {
 /**
  * Options for model deletion.
  */
-export declare interface DeleteModelOptions extends OperationOptions {
+export declare interface DeleteDocumentModelOptions extends OperationOptions {
 }
 
 /**
@@ -911,7 +911,7 @@ export declare class DocumentModelAdministrationClient {
      * const modelId = "aNewModel";
      * const containerUrl = "<training data container SAS URL>";
      *
-     * const poller = await client.beginBuildModel(modelId, containerUrl, {
+     * const poller = await client.beginBuildDocumentModel(modelId, containerUrl, {
      *   // Optionally, a text description may be attached to the model
      *   description: "This is an example model!"
      * });
@@ -923,7 +923,7 @@ export declare class DocumentModelAdministrationClient {
      * const {
      *   modelId, // identical to the modelId given when creating the model
      *   description, // identical to the description given when creating the model
-     *   createdDateTime, // the Date (timestamp) that the model was created
+     *   createdOn, // the Date (timestamp) that the model was created
      *   docTypes // information about the document types in the model and their field schemas
      * } = modelDetails;
      * ```
@@ -934,7 +934,7 @@ export declare class DocumentModelAdministrationClient {
      * @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
      */
-    beginBuildModel(modelId: string, containerUrl: string, buildMode: DocumentModelBuildMode, options?: BeginBuildModelOptions): Promise<DocumentModelPoller>;
+    beginBuildDocumentModel(modelId: string, containerUrl: string, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>;
     /**
      * Creates a single composed model from several pre-existing submodels.
      *
@@ -953,7 +953,7 @@ export declare class DocumentModelAdministrationClient {
      *
      * // The resulting composed model can classify and extract data from documents
      * // conforming to any of the above document types
-     * const poller = await client.beginComposeModel(modelId, subModelIds, {
+     * const poller = await client.beginComposeDocumentModel(modelId, subModelIds, {
      *   description: "This is a composed model that can handle several document types."
      * });
      *
@@ -964,7 +964,7 @@ export declare class DocumentModelAdministrationClient {
      * const {
      *   modelId, // identical to the modelId given when creating the model
      *   description, // identical to the description given when creating the model
-     *   createdDateTime, // the Date (timestamp) that the model was created
+     *   createdOn, // the Date (timestamp) that the model was created
      *   docTypes // information about the document types of the composed submodels
      * } = modelDetails;
      * ```
@@ -974,7 +974,7 @@ export declare class DocumentModelAdministrationClient {
      * @param options - optional settings for model creation
      * @returns a long-running operation (poller) that will eventually produce the created model information or an error
      */
-    beginComposeModel(modelId: string, componentModelIds: Iterable<string>, options?: BeginComposeModelOptions): Promise<DocumentModelPoller>;
+    beginComposeDocumentModel(modelId: string, componentModelIds: Iterable<string>, options?: BeginComposeDocumentModelOptions): Promise<DocumentModelPoller>;
     /**
      * Creates an authorization to copy a model into the resource, used with the `beginCopyModelTo` method.
      *
@@ -1021,7 +1021,7 @@ export declare class DocumentModelAdministrationClient {
      * const {
      *   modelId, // identical to the modelId given when creating the copy authorization
      *   description, // identical to the description given when creating the copy authorization
-     *   createdDateTime, // the Date (timestamp) that the model was created
+     *   createdOn, // the Date (timestamp) that the model was created
      *   docTypes // information about the document types of the model (identical to the original, source model)
      * } = modelDetails;
      * ```
@@ -1070,9 +1070,9 @@ export declare class DocumentModelAdministrationClient {
      * ### **Breaking Change**
      *
      * In previous versions of the Form Recognizer REST API and SDK, the `getModel` method could return any model, even
-     * one that failed to create due to errors. In the new service versions, `getModel` and `listModels` _only produce
-     * successfully created models_ (i.e. models that are "ready" for use). Failed models are now retrieved through the
-     * "operations" APIs, see {@link getOperation} and {@link listOperations}.
+     * one that failed to create due to errors. In the new service versions, `getDocumentModel` and `listDocumentModels`
+     * _only produce successfully created models_ (i.e. models that are "ready" for use). Failed models are now retrieved
+     * through the "operations" APIs, see {@link getOperation} and {@link listOperations}.
      *
      * ### Example
      *
@@ -1081,9 +1081,9 @@ export declare class DocumentModelAdministrationClient {
      * const modelId = "prebuilt-businessCard";
      *
      * const {
-     *   modelId, // identical to the modelId given when calling `getModel`
+     *   modelId, // identical to the modelId given when calling `getDocumentModel`
      *   description, // a textual description of the model, if provided during model creation
-     *   createdDateTime, // the Date (timestamp) that the model was created
+     *   createdOn, // the Date (timestamp) that the model was created
      *   // information about the document types in the model and their field schemas
      *   docTypes: {
      *     // the document type of the prebuilt business card model
@@ -1097,14 +1097,14 @@ export declare class DocumentModelAdministrationClient {
      *       fieldConfidence
      *     }
      *   }
-     * } = await client.getModel(modelId);
+     * } = await client.getDocumentModel(modelId);
      * ```
      *
      * @param modelId - the unique ID of the model to query
      * @param options - optional settings for the request
      * @returns information about the model with the given ID
      */
-    getModel(modelId: string, options?: GetModelOptions): Promise<DocumentModelDetails>;
+    getDocumentModel(modelId: string, options?: GetModelOptions): Promise<DocumentModelDetails>;
     /**
      * List summaries of models in the resource. Custom as well as prebuilt models will be included. This operation
      * supports paging.
@@ -1112,36 +1112,36 @@ export declare class DocumentModelAdministrationClient {
      * The model summary ({@link ModelSummary}) includes only the basic information about the model, and does not include
      * information about the document types in the model (such as the field schemas and confidence values).
      *
-     * To access the full information about the model, use {@link getModel}.
+     * To access the full information about the model, use {@link getDocumentModel}.
      *
      * ### **Breaking Change**
      *
      * In previous versions of the Form Recognizer REST API and SDK, the `listModels` method would return all models, even
-     * those that failed to create due to errors. In the new service versions, `listModels` and `getModels` _only produce
-     * successfully created models_ (i.e. models that are "ready" for use). Failed models are now retrieved through the
-     * "operations" APIs, see {@link getOperation} and {@link listOperations}.
+     * those that failed to create due to errors. In the new service versions, `listDocumentModels` and `getDocumentModel`
+     * _only produce successfully created models_ (i.e. models that are "ready" for use). Failed models are now retrieved
+     * through the "operations" APIs, see {@link getOperation} and {@link listOperations}.
      *
      * ### Examples
      *
      * #### Async Iteration
      *
      * ```javascript
-     * for await (const summary of client.listModels()) {
+     * for await (const summary of client.listDocumentModels()) {
      *   const {
      *     modelId, // The model's unique ID
      *     description, // a textual description of the model, if provided during model creation
      *   } = summary;
      *
-     *   // You can get the full model info using `getModel`
-     *   const model = await client.getModel(modelId);
+     *   // You can get the full model info using `getDocumentModel`
+     *   const model = await client.getDocumentModel(modelId);
      * }
      * ```
      *
      * #### By Page
      *
      * ```javascript
-     * // The listModels method is paged, and you can iterate by page using the `byPage` method.
-     * const pages = client.listModels().byPage();
+     * // The listDocumentModels method is paged, and you can iterate by page using the `byPage` method.
+     * const pages = client.listDocumentModels().byPage();
      *
      * for await (const page of pages) {
      *   // Each page is an array of models and can be iterated synchronously
@@ -1151,8 +1151,8 @@ export declare class DocumentModelAdministrationClient {
      *       description, // a textual description of the model, if provided during model creation
      *     } = summary;
      *
-     *     // You can get the full model info using `getModel`
-     *     const model = await client.getModel(modelId);
+     *     // You can get the full model info using `getDocumentModel`
+     *     const model = await client.getDocumentModel(modelId);
      *   }
      * }
      * ```
@@ -1160,7 +1160,7 @@ export declare class DocumentModelAdministrationClient {
      * @param options - optional settings for the model requests
      * @returns an async iterable of model summaries that supports paging
      */
-    listModels(options?: ListModelsOptions): PagedAsyncIterableIterator<DocumentModelSummary>;
+    listDocumentModels(options?: ListModelsOptions): PagedAsyncIterableIterator<DocumentModelSummary>;
     /**
      * Retrieves information about an operation (`OperationDetails`) by its ID.
      *
@@ -1181,8 +1181,8 @@ export declare class DocumentModelAdministrationClient {
      *   kind, // the operation kind, one of "documentModelBuild", "documentModelCompose", or "documentModelCopyTo"
      *   status, // the status of the operation, one of "notStarted", "running", "failed", "succeeded", or "canceled"
      *   percentCompleted, // a number between 0 and 100 representing the progress of the operation
-     *   createdDateTime, // a Date object that reflects the time when the operation was started
-     *   lastUpdatedDateTime, // a Date object that reflects the time when the operation state was last modified
+     *   createdOn, // a Date object that reflects the time when the operation was started
+     *   lastUpdatedOn, // a Date object that reflects the time when the operation state was last modified
      * } = await client.getOperation(operationId);
      * ```
      */
@@ -1239,7 +1239,7 @@ export declare class DocumentModelAdministrationClient {
      * @param modelId - the unique ID of the model to delete from the resource
      * @param options - optional settings for the request
      */
-    deleteModel(modelId: string, options?: DeleteModelOptions): Promise<void>;
+    deleteDocumentModel(modelId: string, options?: DeleteDocumentModelOptions): Promise<void>;
 }
 
 /**
@@ -1278,8 +1278,44 @@ export declare const DocumentModelBuildMode: {
     readonly Neural: "neural";
 };
 
+/** Get Operation response object. */
+export declare interface DocumentModelBuildOperationDetails extends OperationDetails {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "documentModelBuild";
+    /** Operation result upon success. */
+    result?: DocumentModelDetails;
+}
+
+/** Get Operation response object. */
+export declare interface DocumentModelComposeOperationDetails extends OperationDetails {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "documentModelCompose";
+    /** Operation result upon success. */
+    result?: DocumentModelDetails;
+}
+
+/** Get Operation response object. */
+export declare interface DocumentModelCopyToOperationDetails extends OperationDetails {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "documentModelCopyTo";
+    /** Operation result upon success. */
+    result?: DocumentModelDetails;
+}
+
 /** Document model info. */
-export declare interface DocumentModelDetails extends DocumentModelSummary {
+export declare interface DocumentModelDetails {
+    /** Unique document model name. */
+    modelId: string;
+    /** Document model description. */
+    description?: string;
+    /** Date and time (UTC) when the document model was created. */
+    createdOn: Date;
+    /** API version used to create this document model. */
+    apiVersion?: string;
+    /** List of key-value tag attributes associated with the document model. */
+    tags?: {
+        [propertyName: string]: string;
+    };
     /** Supported document types. */
     docTypes?: {
         [propertyName: string]: DocumentTypeDetails;
@@ -1339,7 +1375,7 @@ export declare interface DocumentModelSummary {
     /** Document model description. */
     description?: string;
     /** Date and time (UTC) when the document model was created. */
-    createdDateTime: Date;
+    createdOn: Date;
     /** API version used to create this document model. */
     apiVersion?: string;
     /** List of key-value tag attributes associated with the document model. */
@@ -1372,8 +1408,6 @@ export declare interface DocumentObjectField<Properties = {
 
 /** Content and layout elements extracted from a page from the input. */
 export declare interface DocumentPage {
-    /** Kind of document page. */
-    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]. */
@@ -1394,18 +1428,6 @@ export declare interface DocumentPage {
     lines?: DocumentLine[];
 }
 
-/**
- * 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** \
- * **sheet** \
- * **slide** \
- * **image**
- */
-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. */
@@ -1639,7 +1661,8 @@ export declare const FormRecognizerApiVersion: {
      * 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: "2022-06-30-preview";
+    readonly Latest: "2022-08-31";
+    readonly Stable: "2022-08-31";
 };
 
 /**
@@ -1652,7 +1675,7 @@ export declare interface FormRecognizerCommonClientOptions extends CommonClientO
      * 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.Latest ("2022-06-30-preview")
+     * Default: FormRecognizerApiVersion.Stable ("2022-08-31")
      */
     apiVersion?: FormRecognizerApiVersion;
 }
@@ -1683,7 +1706,7 @@ export declare interface GetOperationOptions extends OperationOptions {
 }
 
 /** Contains response data for the getOperation operation. */
-export declare type GetOperationResponse = OperationDetails;
+export declare type GetOperationResponse = OperationDetailsUnion;
 
 /**
  * Options for retrieving Form Recognizer resource information.
@@ -1730,13 +1753,33 @@ export declare interface ListOperationsOptions extends OperationOptions {
 }
 
 /** Get Operation response object. */
-export declare interface OperationDetails extends OperationSummary {
+export declare interface OperationDetails {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "documentModelBuild" | "documentModelCompose" | "documentModelCopyTo";
+    /** Operation ID */
+    operationId: string;
+    /** Operation status. */
+    status: OperationStatus;
+    /** Operation progress (0-100). */
+    percentCompleted?: number;
+    /** Date and time (UTC) when the operation was created. */
+    createdOn: Date;
+    /** Date and time (UTC) when the status was last updated. */
+    lastUpdatedOn: Date;
+    /** URL of the resource targeted by this operation. */
+    resourceLocation: string;
+    /** API version used to create this operation. */
+    apiVersion?: string;
+    /** List of key-value tag attributes associated with the document model. */
+    tags?: {
+        [propertyName: string]: string;
+    };
     /** Encountered error. */
     error?: ErrorModel;
-    /** Operation result upon success. */
-    result?: Record<string, unknown>;
 }
 
+export declare type OperationDetailsUnion = OperationDetails | DocumentModelBuildOperationDetails | DocumentModelComposeOperationDetails | DocumentModelCopyToOperationDetails;
+
 /**
  * Defines values for OperationKind. \
  * {@link KnownOperationKind} can be used interchangeably with OperationKind,
@@ -1760,9 +1803,9 @@ export declare interface OperationSummary {
     /** Operation progress (0-100). */
     percentCompleted?: number;
     /** Date and time (UTC) when the operation was created. */
-    createdDateTime: Date;
+    createdOn: Date;
     /** Date and time (UTC) when the status was last updated. */
-    lastUpdatedDateTime: Date;
+    lastUpdatedOn: Date;
     /** Type of operation. */
     kind: OperationKind;
     /** URL of the resource targeted by this operation. */