@azure/ai-form-recognizer 5.0.0 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +3 -3
- package/README.md +322 -340
- package/dist/browser/azureKeyCredentialPolicy.d.ts +8 -0
- package/dist/browser/azureKeyCredentialPolicy.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/azureKeyCredentialPolicy.js +1 -1
- package/dist/browser/azureKeyCredentialPolicy.js.map +1 -0
- package/dist/browser/bin/defaultFields.d.ts +14 -0
- package/dist/browser/bin/defaultFields.d.ts.map +1 -0
- package/dist/browser/bin/defaultFields.js +83 -0
- package/dist/browser/bin/defaultFields.js.map +1 -0
- package/dist/browser/bin/gen-model.d.ts +3 -0
- package/dist/browser/bin/gen-model.d.ts.map +1 -0
- package/dist/browser/bin/gen-model.js +101 -0
- package/dist/browser/bin/gen-model.js.map +1 -0
- package/dist/browser/bin/utils.d.ts +22 -0
- package/dist/browser/bin/utils.d.ts.map +1 -0
- package/dist/browser/bin/utils.js +21 -0
- package/dist/browser/bin/utils.js.map +1 -0
- package/dist/browser/bin/writeModelCode.d.ts +9 -0
- package/dist/browser/bin/writeModelCode.d.ts.map +1 -0
- package/dist/browser/bin/writeModelCode.js +323 -0
- package/dist/browser/bin/writeModelCode.js.map +1 -0
- package/dist/browser/constants.d.ts +29 -0
- package/dist/browser/constants.d.ts.map +1 -0
- package/dist/browser/constants.js +32 -0
- package/dist/browser/constants.js.map +1 -0
- package/dist/browser/documentAnalysisClient.d.ts +485 -0
- package/dist/browser/documentAnalysisClient.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/documentAnalysisClient.js +85 -47
- package/dist/browser/documentAnalysisClient.js.map +1 -0
- package/dist/browser/documentModel.d.ts +34 -0
- package/dist/browser/documentModel.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/documentModel.js +3 -3
- package/dist/browser/documentModel.js.map +1 -0
- package/dist/browser/documentModelAdministrationClient.d.ts +792 -0
- package/dist/browser/documentModelAdministrationClient.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/documentModelAdministrationClient.js +202 -92
- package/dist/browser/documentModelAdministrationClient.js.map +1 -0
- package/dist/browser/error.d.ts +31 -0
- package/dist/browser/error.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/error.js +1 -1
- package/dist/browser/error.js.map +1 -0
- package/dist/browser/generated/generatedClient.d.ts +21 -0
- package/dist/browser/generated/generatedClient.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/generated/generatedClient.js +2 -2
- package/dist/browser/generated/generatedClient.js.map +1 -0
- package/dist/browser/generated/index.d.ts +4 -0
- package/dist/browser/generated/index.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/generated/index.js +3 -3
- package/dist/browser/generated/index.js.map +1 -0
- package/dist/browser/generated/models/index.d.ts +1208 -0
- package/dist/browser/generated/models/index.d.ts.map +1 -0
- package/dist/browser/generated/models/mappers.d.ts +67 -0
- package/dist/browser/generated/models/mappers.d.ts.map +1 -0
- package/dist/browser/generated/models/parameters.d.ts +31 -0
- package/dist/browser/generated/models/parameters.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/generated/models/parameters.js +1 -1
- package/dist/browser/generated/models/parameters.js.map +1 -0
- package/dist/browser/generated/operations/documentClassifiers.d.ts +78 -0
- package/dist/browser/generated/operations/documentClassifiers.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/generated/operations/documentClassifiers.js +5 -10
- package/dist/browser/generated/operations/documentClassifiers.js.map +1 -0
- package/dist/browser/generated/operations/documentModels.d.ts +98 -0
- package/dist/browser/generated/operations/documentModels.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/generated/operations/documentModels.js +5 -10
- package/dist/browser/generated/operations/documentModels.js.map +1 -0
- package/dist/browser/generated/operations/index.d.ts +4 -0
- package/dist/browser/generated/operations/index.d.ts.map +1 -0
- package/{dist-esm/src/generated/operationsInterfaces → dist/browser/generated/operations}/index.js +3 -3
- package/{dist-esm/src → dist/browser}/generated/operations/index.js.map +1 -1
- package/dist/browser/generated/operations/miscellaneous.d.ts +43 -0
- package/dist/browser/generated/operations/miscellaneous.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/generated/operations/miscellaneous.js +5 -10
- package/dist/browser/generated/operations/miscellaneous.js.map +1 -0
- package/dist/browser/generated/operationsInterfaces/documentClassifiers.d.ts +53 -0
- package/dist/browser/generated/operationsInterfaces/documentClassifiers.d.ts.map +1 -0
- package/dist/browser/generated/operationsInterfaces/documentClassifiers.js.map +1 -0
- package/dist/browser/generated/operationsInterfaces/documentModels.d.ts +69 -0
- package/dist/browser/generated/operationsInterfaces/documentModels.d.ts.map +1 -0
- package/dist/browser/generated/operationsInterfaces/documentModels.js.map +1 -0
- package/dist/browser/generated/operationsInterfaces/index.d.ts +4 -0
- package/dist/browser/generated/operationsInterfaces/index.d.ts.map +1 -0
- package/dist/browser/generated/operationsInterfaces/index.js +11 -0
- package/{dist-esm/src → dist/browser}/generated/operationsInterfaces/index.js.map +1 -1
- package/dist/browser/generated/operationsInterfaces/miscellaneous.d.ts +22 -0
- package/dist/browser/generated/operationsInterfaces/miscellaneous.d.ts.map +1 -0
- package/dist/browser/generated/operationsInterfaces/miscellaneous.js.map +1 -0
- package/dist/browser/index.d.ts +18 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/index.js +8 -7
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/lro/administration.d.ts +101 -0
- package/dist/browser/lro/administration.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/lro/administration.js +2 -2
- package/dist/browser/lro/administration.js.map +1 -0
- package/dist/browser/lro/analysis.d.ts +210 -0
- package/dist/browser/lro/analysis.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/lro/analysis.js +5 -5
- package/dist/browser/lro/analysis.js.map +1 -0
- package/dist/browser/lro/util/delayMs.d.ts +32 -0
- package/dist/browser/lro/util/delayMs.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/lro/util/delayMs.js +3 -3
- package/dist/browser/lro/util/delayMs.js.map +1 -0
- package/dist/browser/lro/util/poller.d.ts +41 -0
- package/dist/browser/lro/util/poller.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/lro/util/poller.js +2 -2
- package/dist/browser/lro/util/poller.js.map +1 -0
- package/dist/browser/models/contentSource.d.ts +56 -0
- package/dist/browser/models/contentSource.d.ts.map +1 -0
- package/dist/browser/models/contentSource.js +4 -0
- package/dist/browser/models/contentSource.js.map +1 -0
- package/dist/browser/models/documentElements.d.ts +210 -0
- package/dist/browser/models/documentElements.d.ts.map +1 -0
- package/dist/browser/models/documentElements.js +4 -0
- package/dist/browser/models/documentElements.js.map +1 -0
- package/dist/browser/models/fields.d.ts +205 -0
- package/dist/browser/models/fields.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/models/fields.js +3 -3
- package/{dist-esm/src → dist/browser}/models/fields.js.map +1 -1
- package/dist/browser/models/index.d.ts +4 -0
- package/dist/browser/models/index.d.ts.map +1 -0
- package/dist/browser/models/index.js +4 -0
- package/dist/browser/models/index.js.map +1 -0
- package/dist/browser/options/AnalyzeDocumentOptions.d.ts +69 -0
- package/dist/browser/options/AnalyzeDocumentOptions.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/options/AnalyzeDocumentOptions.js +1 -1
- package/dist/browser/options/AnalyzeDocumentOptions.js.map +1 -0
- package/dist/browser/options/BeginCopyModelOptions.d.ts +9 -0
- package/dist/browser/options/BeginCopyModelOptions.d.ts.map +1 -0
- package/dist/browser/options/BeginCopyModelOptions.js +4 -0
- package/dist/browser/options/BeginCopyModelOptions.js.map +1 -0
- package/dist/browser/options/BuildDocumentClassifierOptions.d.ts +13 -0
- package/dist/browser/options/BuildDocumentClassifierOptions.d.ts.map +1 -0
- package/dist/browser/options/BuildDocumentClassifierOptions.js +4 -0
- package/dist/browser/options/BuildDocumentClassifierOptions.js.map +1 -0
- package/dist/browser/options/BuildModelOptions.d.ts +61 -0
- package/dist/browser/options/BuildModelOptions.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/options/BuildModelOptions.js +1 -1
- package/dist/browser/options/BuildModelOptions.js.map +1 -0
- package/dist/browser/options/ClassifyDocumentOptions.d.ts +9 -0
- package/dist/browser/options/ClassifyDocumentOptions.d.ts.map +1 -0
- package/dist/browser/options/ClassifyDocumentOptions.js +4 -0
- package/dist/browser/options/ClassifyDocumentOptions.js.map +1 -0
- package/dist/browser/options/DeleteModelOptions.d.ts +7 -0
- package/dist/browser/options/DeleteModelOptions.d.ts.map +1 -0
- package/dist/browser/options/DeleteModelOptions.js +4 -0
- package/dist/browser/options/DeleteModelOptions.js.map +1 -0
- package/dist/browser/options/FormRecognizerClientOptions.d.ts +70 -0
- package/dist/browser/options/FormRecognizerClientOptions.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/options/FormRecognizerClientOptions.js +1 -1
- package/dist/browser/options/FormRecognizerClientOptions.js.map +1 -0
- package/dist/browser/options/GetCopyAuthorizationOptions.d.ts +8 -0
- package/dist/browser/options/GetCopyAuthorizationOptions.d.ts.map +1 -0
- package/dist/browser/options/GetCopyAuthorizationOptions.js +4 -0
- package/dist/browser/options/GetCopyAuthorizationOptions.js.map +1 -0
- package/dist/browser/options/GetModelOptions.d.ts +7 -0
- package/dist/browser/options/GetModelOptions.d.ts.map +1 -0
- package/dist/browser/options/GetModelOptions.js +4 -0
- package/dist/browser/options/GetModelOptions.js.map +1 -0
- package/dist/browser/options/GetOperationOptions.d.ts +7 -0
- package/dist/browser/options/GetOperationOptions.d.ts.map +1 -0
- package/dist/browser/options/GetOperationOptions.js +4 -0
- package/dist/browser/options/GetOperationOptions.js.map +1 -0
- package/dist/browser/options/GetResourceDetailsOptions.d.ts +7 -0
- package/dist/browser/options/GetResourceDetailsOptions.d.ts.map +1 -0
- package/dist/browser/options/GetResourceDetailsOptions.js +4 -0
- package/{dist-esm/src → dist/browser}/options/GetResourceDetailsOptions.js.map +1 -1
- package/dist/browser/options/ListModelsOptions.d.ts +7 -0
- package/dist/browser/options/ListModelsOptions.d.ts.map +1 -0
- package/dist/browser/options/ListModelsOptions.js +4 -0
- package/dist/browser/options/ListModelsOptions.js.map +1 -0
- package/dist/browser/options/ListOperationsOptions.d.ts +7 -0
- package/dist/browser/options/ListOperationsOptions.d.ts.map +1 -0
- package/dist/browser/options/ListOperationsOptions.js +4 -0
- package/{dist-esm/src → dist/browser}/options/ListOperationsOptions.js.map +1 -1
- package/dist/browser/options/PollerOptions.d.ts +22 -0
- package/dist/browser/options/PollerOptions.d.ts.map +1 -0
- package/dist/browser/options/PollerOptions.js +4 -0
- package/dist/browser/options/PollerOptions.js.map +1 -0
- package/dist/browser/options/index.d.ts +16 -0
- package/dist/browser/options/index.d.ts.map +1 -0
- package/dist/browser/options/index.js +7 -0
- package/dist/browser/options/index.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/transforms/polygon.d.ts +20 -0
- package/dist/browser/transforms/polygon.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/transforms/polygon.js +1 -1
- package/dist/browser/transforms/polygon.js.map +1 -0
- package/dist/browser/util.d.ts +33 -0
- package/dist/browser/util.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/util.js +12 -7
- package/dist/browser/util.js.map +1 -0
- package/dist/commonjs/azureKeyCredentialPolicy.d.ts +8 -0
- package/dist/commonjs/azureKeyCredentialPolicy.d.ts.map +1 -0
- package/dist/commonjs/azureKeyCredentialPolicy.js +20 -0
- package/dist/commonjs/azureKeyCredentialPolicy.js.map +1 -0
- package/dist/commonjs/bin/defaultFields.d.ts +14 -0
- package/dist/commonjs/bin/defaultFields.d.ts.map +1 -0
- package/dist/commonjs/bin/defaultFields.js +87 -0
- package/dist/commonjs/bin/defaultFields.js.map +1 -0
- package/dist/commonjs/bin/gen-model.d.ts +3 -0
- package/dist/commonjs/bin/gen-model.d.ts.map +1 -0
- package/dist/commonjs/bin/gen-model.js +103 -0
- package/dist/commonjs/bin/gen-model.js.map +1 -0
- package/dist/commonjs/bin/utils.d.ts +22 -0
- package/dist/commonjs/bin/utils.d.ts.map +1 -0
- package/dist/commonjs/bin/utils.js +26 -0
- package/dist/commonjs/bin/utils.js.map +1 -0
- package/dist/commonjs/bin/writeModelCode.d.ts +9 -0
- package/dist/commonjs/bin/writeModelCode.d.ts.map +1 -0
- package/dist/commonjs/bin/writeModelCode.js +326 -0
- package/dist/commonjs/bin/writeModelCode.js.map +1 -0
- package/dist/commonjs/constants.d.ts +29 -0
- package/dist/commonjs/constants.d.ts.map +1 -0
- package/dist/commonjs/constants.js +35 -0
- package/dist/commonjs/constants.js.map +1 -0
- package/dist/commonjs/documentAnalysisClient.d.ts +485 -0
- package/dist/commonjs/documentAnalysisClient.d.ts.map +1 -0
- package/dist/commonjs/documentAnalysisClient.js +351 -0
- package/dist/commonjs/documentAnalysisClient.js.map +1 -0
- package/dist/commonjs/documentModel.d.ts +34 -0
- package/dist/commonjs/documentModel.d.ts.map +1 -0
- package/dist/commonjs/documentModel.js +76 -0
- package/dist/commonjs/documentModel.js.map +1 -0
- package/dist/commonjs/documentModelAdministrationClient.d.ts +792 -0
- package/dist/commonjs/documentModelAdministrationClient.d.ts.map +1 -0
- package/dist/commonjs/documentModelAdministrationClient.js +763 -0
- package/dist/commonjs/documentModelAdministrationClient.js.map +1 -0
- package/dist/commonjs/error.d.ts +31 -0
- package/dist/commonjs/error.d.ts.map +1 -0
- package/dist/commonjs/error.js +43 -0
- package/dist/commonjs/error.js.map +1 -0
- package/dist/commonjs/generated/generatedClient.d.ts +21 -0
- package/dist/commonjs/generated/generatedClient.d.ts.map +1 -0
- package/dist/commonjs/generated/generatedClient.js +94 -0
- package/dist/commonjs/generated/generatedClient.js.map +1 -0
- package/dist/commonjs/generated/index.d.ts +4 -0
- package/dist/commonjs/generated/index.d.ts.map +1 -0
- package/dist/commonjs/generated/index.js +17 -0
- package/dist/commonjs/generated/index.js.map +1 -0
- package/dist/commonjs/generated/models/index.d.ts +1208 -0
- package/dist/commonjs/generated/models/index.d.ts.map +1 -0
- package/dist/commonjs/generated/models/index.js +207 -0
- package/dist/commonjs/generated/models/index.js.map +1 -0
- package/dist/commonjs/generated/models/mappers.d.ts +67 -0
- package/dist/commonjs/generated/models/mappers.d.ts.map +1 -0
- package/dist/commonjs/generated/models/mappers.js +2505 -0
- package/dist/commonjs/generated/models/mappers.js.map +1 -0
- package/dist/commonjs/generated/models/parameters.d.ts +31 -0
- package/dist/commonjs/generated/models/parameters.d.ts.map +1 -0
- package/dist/commonjs/generated/models/parameters.js +294 -0
- package/dist/commonjs/generated/models/parameters.js.map +1 -0
- package/dist/commonjs/generated/operations/documentClassifiers.d.ts +78 -0
- package/dist/commonjs/generated/operations/documentClassifiers.d.ts.map +1 -0
- package/dist/commonjs/generated/operations/documentClassifiers.js +334 -0
- package/dist/commonjs/generated/operations/documentClassifiers.js.map +1 -0
- package/dist/commonjs/generated/operations/documentModels.d.ts +98 -0
- package/dist/commonjs/generated/operations/documentModels.d.ts.map +1 -0
- package/dist/commonjs/generated/operations/documentModels.js +428 -0
- package/dist/commonjs/generated/operations/documentModels.js.map +1 -0
- package/dist/commonjs/generated/operations/index.d.ts +4 -0
- package/dist/commonjs/generated/operations/index.d.ts.map +1 -0
- package/dist/commonjs/generated/operations/index.js +14 -0
- package/dist/commonjs/generated/operations/index.js.map +1 -0
- package/dist/commonjs/generated/operations/miscellaneous.d.ts +43 -0
- package/dist/commonjs/generated/operations/miscellaneous.d.ts.map +1 -0
- package/dist/commonjs/generated/operations/miscellaneous.js +173 -0
- package/dist/commonjs/generated/operations/miscellaneous.js.map +1 -0
- package/dist/commonjs/generated/operationsInterfaces/documentClassifiers.d.ts +53 -0
- package/dist/commonjs/generated/operationsInterfaces/documentClassifiers.d.ts.map +1 -0
- package/{dist-esm/src/generated/operations/index.js → dist/commonjs/generated/operationsInterfaces/documentClassifiers.js} +3 -4
- package/dist/commonjs/generated/operationsInterfaces/documentClassifiers.js.map +1 -0
- package/dist/commonjs/generated/operationsInterfaces/documentModels.d.ts +69 -0
- package/dist/commonjs/generated/operationsInterfaces/documentModels.d.ts.map +1 -0
- package/dist/commonjs/generated/operationsInterfaces/documentModels.js +10 -0
- package/dist/commonjs/generated/operationsInterfaces/documentModels.js.map +1 -0
- package/dist/commonjs/generated/operationsInterfaces/index.d.ts +4 -0
- package/dist/commonjs/generated/operationsInterfaces/index.d.ts.map +1 -0
- package/dist/commonjs/generated/operationsInterfaces/index.js +14 -0
- package/dist/commonjs/generated/operationsInterfaces/index.js.map +1 -0
- package/dist/commonjs/generated/operationsInterfaces/miscellaneous.d.ts +22 -0
- package/dist/commonjs/generated/operationsInterfaces/miscellaneous.d.ts.map +1 -0
- package/dist/commonjs/generated/operationsInterfaces/miscellaneous.js +10 -0
- package/dist/commonjs/generated/operationsInterfaces/miscellaneous.js.map +1 -0
- package/dist/commonjs/index.d.ts +18 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +38 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/lro/administration.d.ts +101 -0
- package/dist/commonjs/lro/administration.d.ts.map +1 -0
- package/dist/commonjs/lro/administration.js +32 -0
- package/dist/commonjs/lro/administration.js.map +1 -0
- package/dist/commonjs/lro/analysis.d.ts +210 -0
- package/dist/commonjs/lro/analysis.d.ts.map +1 -0
- package/dist/commonjs/lro/analysis.js +186 -0
- package/dist/commonjs/lro/analysis.js.map +1 -0
- package/dist/commonjs/lro/util/delayMs.d.ts +32 -0
- package/dist/commonjs/lro/util/delayMs.d.ts.map +1 -0
- package/dist/commonjs/lro/util/delayMs.js +55 -0
- package/dist/commonjs/lro/util/delayMs.js.map +1 -0
- package/dist/commonjs/lro/util/poller.d.ts +41 -0
- package/dist/commonjs/lro/util/poller.d.ts.map +1 -0
- package/dist/commonjs/lro/util/poller.js +87 -0
- package/dist/commonjs/lro/util/poller.js.map +1 -0
- package/dist/commonjs/models/contentSource.d.ts +56 -0
- package/dist/commonjs/models/contentSource.d.ts.map +1 -0
- package/dist/commonjs/models/contentSource.js +5 -0
- package/dist/commonjs/models/contentSource.js.map +1 -0
- package/dist/commonjs/models/documentElements.d.ts +210 -0
- package/dist/commonjs/models/documentElements.d.ts.map +1 -0
- package/dist/commonjs/models/documentElements.js +5 -0
- package/dist/commonjs/models/documentElements.js.map +1 -0
- package/dist/commonjs/models/fields.d.ts +205 -0
- package/dist/commonjs/models/fields.d.ts.map +1 -0
- package/dist/commonjs/models/fields.js +59 -0
- package/dist/commonjs/models/fields.js.map +1 -0
- package/dist/commonjs/models/index.d.ts +4 -0
- package/dist/commonjs/models/index.d.ts.map +1 -0
- package/dist/commonjs/models/index.js +5 -0
- package/dist/commonjs/models/index.js.map +1 -0
- package/dist/commonjs/options/AnalyzeDocumentOptions.d.ts +69 -0
- package/dist/commonjs/options/AnalyzeDocumentOptions.d.ts.map +1 -0
- package/dist/commonjs/options/AnalyzeDocumentOptions.js +36 -0
- package/dist/commonjs/options/AnalyzeDocumentOptions.js.map +1 -0
- package/dist/commonjs/options/BeginCopyModelOptions.d.ts +9 -0
- package/dist/commonjs/options/BeginCopyModelOptions.d.ts.map +1 -0
- package/dist/commonjs/options/BeginCopyModelOptions.js +5 -0
- package/dist/commonjs/options/BeginCopyModelOptions.js.map +1 -0
- package/dist/commonjs/options/BuildDocumentClassifierOptions.d.ts +13 -0
- package/dist/commonjs/options/BuildDocumentClassifierOptions.d.ts.map +1 -0
- package/dist/commonjs/options/BuildDocumentClassifierOptions.js +5 -0
- package/dist/commonjs/options/BuildDocumentClassifierOptions.js.map +1 -0
- package/dist/commonjs/options/BuildModelOptions.d.ts +61 -0
- package/dist/commonjs/options/BuildModelOptions.d.ts.map +1 -0
- package/dist/commonjs/options/BuildModelOptions.js +22 -0
- package/dist/commonjs/options/BuildModelOptions.js.map +1 -0
- package/dist/commonjs/options/ClassifyDocumentOptions.d.ts +9 -0
- package/dist/commonjs/options/ClassifyDocumentOptions.d.ts.map +1 -0
- package/dist/commonjs/options/ClassifyDocumentOptions.js +5 -0
- package/dist/commonjs/options/ClassifyDocumentOptions.js.map +1 -0
- package/dist/commonjs/options/DeleteModelOptions.d.ts +7 -0
- package/dist/commonjs/options/DeleteModelOptions.d.ts.map +1 -0
- package/dist/commonjs/options/DeleteModelOptions.js +5 -0
- package/dist/commonjs/options/DeleteModelOptions.js.map +1 -0
- package/dist/commonjs/options/FormRecognizerClientOptions.d.ts +70 -0
- package/dist/commonjs/options/FormRecognizerClientOptions.d.ts.map +1 -0
- package/dist/commonjs/options/FormRecognizerClientOptions.js +28 -0
- package/dist/commonjs/options/FormRecognizerClientOptions.js.map +1 -0
- package/dist/commonjs/options/GetCopyAuthorizationOptions.d.ts +8 -0
- package/dist/commonjs/options/GetCopyAuthorizationOptions.d.ts.map +1 -0
- package/dist/commonjs/options/GetCopyAuthorizationOptions.js +5 -0
- package/dist/commonjs/options/GetCopyAuthorizationOptions.js.map +1 -0
- package/dist/commonjs/options/GetModelOptions.d.ts +7 -0
- package/dist/commonjs/options/GetModelOptions.d.ts.map +1 -0
- package/dist/commonjs/options/GetModelOptions.js +5 -0
- package/dist/commonjs/options/GetModelOptions.js.map +1 -0
- package/dist/commonjs/options/GetOperationOptions.d.ts +7 -0
- package/dist/commonjs/options/GetOperationOptions.d.ts.map +1 -0
- package/dist/commonjs/options/GetOperationOptions.js +5 -0
- package/dist/commonjs/options/GetOperationOptions.js.map +1 -0
- package/dist/commonjs/options/GetResourceDetailsOptions.d.ts +7 -0
- package/dist/commonjs/options/GetResourceDetailsOptions.d.ts.map +1 -0
- package/dist/commonjs/options/GetResourceDetailsOptions.js +5 -0
- package/dist/commonjs/options/GetResourceDetailsOptions.js.map +1 -0
- package/dist/commonjs/options/ListModelsOptions.d.ts +7 -0
- package/dist/commonjs/options/ListModelsOptions.d.ts.map +1 -0
- package/dist/commonjs/options/ListModelsOptions.js +5 -0
- package/dist/commonjs/options/ListModelsOptions.js.map +1 -0
- package/dist/commonjs/options/ListOperationsOptions.d.ts +7 -0
- package/dist/commonjs/options/ListOperationsOptions.d.ts.map +1 -0
- package/dist/commonjs/options/ListOperationsOptions.js +5 -0
- package/dist/commonjs/options/ListOperationsOptions.js.map +1 -0
- package/dist/commonjs/options/PollerOptions.d.ts +22 -0
- package/dist/commonjs/options/PollerOptions.d.ts.map +1 -0
- package/dist/commonjs/options/PollerOptions.js +5 -0
- package/dist/commonjs/options/PollerOptions.js.map +1 -0
- package/dist/commonjs/options/index.d.ts +16 -0
- package/dist/commonjs/options/index.d.ts.map +1 -0
- package/dist/commonjs/options/index.js +12 -0
- package/dist/commonjs/options/index.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/transforms/polygon.d.ts +20 -0
- package/dist/commonjs/transforms/polygon.d.ts.map +1 -0
- package/dist/commonjs/transforms/polygon.js +32 -0
- package/dist/commonjs/transforms/polygon.js.map +1 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/commonjs/util.d.ts +33 -0
- package/dist/commonjs/util.d.ts.map +1 -0
- package/dist/commonjs/util.js +65 -0
- package/dist/commonjs/util.js.map +1 -0
- package/dist/esm/azureKeyCredentialPolicy.d.ts +8 -0
- package/dist/esm/azureKeyCredentialPolicy.d.ts.map +1 -0
- package/dist/esm/azureKeyCredentialPolicy.js +17 -0
- package/dist/esm/azureKeyCredentialPolicy.js.map +1 -0
- package/dist/esm/bin/defaultFields.d.ts +14 -0
- package/dist/esm/bin/defaultFields.d.ts.map +1 -0
- package/dist/esm/bin/defaultFields.js +83 -0
- package/dist/esm/bin/defaultFields.js.map +1 -0
- package/dist/esm/bin/gen-model.d.ts +3 -0
- package/dist/esm/bin/gen-model.d.ts.map +1 -0
- package/dist/esm/bin/gen-model.js +101 -0
- package/dist/esm/bin/gen-model.js.map +1 -0
- package/dist/esm/bin/utils.d.ts +22 -0
- package/dist/esm/bin/utils.d.ts.map +1 -0
- package/dist/esm/bin/utils.js +21 -0
- package/dist/esm/bin/utils.js.map +1 -0
- package/dist/esm/bin/writeModelCode.d.ts +9 -0
- package/dist/esm/bin/writeModelCode.d.ts.map +1 -0
- package/dist/esm/bin/writeModelCode.js +323 -0
- package/dist/esm/bin/writeModelCode.js.map +1 -0
- package/dist/esm/constants.d.ts +29 -0
- package/dist/esm/constants.d.ts.map +1 -0
- package/dist/esm/constants.js +32 -0
- package/dist/esm/constants.js.map +1 -0
- package/dist/esm/documentAnalysisClient.d.ts +485 -0
- package/dist/esm/documentAnalysisClient.d.ts.map +1 -0
- package/dist/esm/documentAnalysisClient.js +347 -0
- package/dist/esm/documentAnalysisClient.js.map +1 -0
- package/dist/esm/documentModel.d.ts +34 -0
- package/dist/esm/documentModel.d.ts.map +1 -0
- package/dist/esm/documentModel.js +73 -0
- package/dist/esm/documentModel.js.map +1 -0
- package/dist/esm/documentModelAdministrationClient.d.ts +792 -0
- package/dist/esm/documentModelAdministrationClient.d.ts.map +1 -0
- package/dist/esm/documentModelAdministrationClient.js +759 -0
- package/dist/esm/documentModelAdministrationClient.js.map +1 -0
- package/dist/esm/error.d.ts +31 -0
- package/dist/esm/error.d.ts.map +1 -0
- package/dist/esm/error.js +39 -0
- package/dist/esm/error.js.map +1 -0
- package/dist/esm/generated/generatedClient.d.ts +21 -0
- package/dist/esm/generated/generatedClient.d.ts.map +1 -0
- package/dist/esm/generated/generatedClient.js +89 -0
- package/dist/esm/generated/generatedClient.js.map +1 -0
- package/dist/esm/generated/index.d.ts +4 -0
- package/dist/esm/generated/index.d.ts.map +1 -0
- package/dist/esm/generated/index.js +12 -0
- package/dist/esm/generated/index.js.map +1 -0
- package/dist/esm/generated/models/index.d.ts +1208 -0
- package/dist/esm/generated/models/index.d.ts.map +1 -0
- package/dist/esm/generated/models/index.js +204 -0
- package/dist/esm/generated/models/index.js.map +1 -0
- package/dist/esm/generated/models/mappers.d.ts +67 -0
- package/dist/esm/generated/models/mappers.d.ts.map +1 -0
- package/dist/esm/generated/models/mappers.js +2501 -0
- package/dist/esm/generated/models/mappers.js.map +1 -0
- package/dist/esm/generated/models/parameters.d.ts +31 -0
- package/dist/esm/generated/models/parameters.d.ts.map +1 -0
- package/dist/esm/generated/models/parameters.js +291 -0
- package/dist/esm/generated/models/parameters.js.map +1 -0
- package/dist/esm/generated/operations/documentClassifiers.d.ts +78 -0
- package/dist/esm/generated/operations/documentClassifiers.d.ts.map +1 -0
- package/dist/esm/generated/operations/documentClassifiers.js +330 -0
- package/dist/esm/generated/operations/documentClassifiers.js.map +1 -0
- package/dist/esm/generated/operations/documentModels.d.ts +98 -0
- package/dist/esm/generated/operations/documentModels.d.ts.map +1 -0
- package/dist/esm/generated/operations/documentModels.js +424 -0
- package/dist/esm/generated/operations/documentModels.js.map +1 -0
- package/dist/esm/generated/operations/index.d.ts +4 -0
- package/dist/esm/generated/operations/index.d.ts.map +1 -0
- package/dist/esm/generated/operations/index.js +11 -0
- package/dist/esm/generated/operations/index.js.map +1 -0
- package/dist/esm/generated/operations/miscellaneous.d.ts +43 -0
- package/dist/esm/generated/operations/miscellaneous.d.ts.map +1 -0
- package/dist/esm/generated/operations/miscellaneous.js +169 -0
- package/dist/esm/generated/operations/miscellaneous.js.map +1 -0
- package/dist/esm/generated/operationsInterfaces/documentClassifiers.d.ts +53 -0
- package/dist/esm/generated/operationsInterfaces/documentClassifiers.d.ts.map +1 -0
- package/dist/esm/generated/operationsInterfaces/documentClassifiers.js +9 -0
- package/dist/esm/generated/operationsInterfaces/documentClassifiers.js.map +1 -0
- package/dist/esm/generated/operationsInterfaces/documentModels.d.ts +69 -0
- package/dist/esm/generated/operationsInterfaces/documentModels.d.ts.map +1 -0
- package/dist/esm/generated/operationsInterfaces/documentModels.js +9 -0
- package/dist/esm/generated/operationsInterfaces/documentModels.js.map +1 -0
- package/dist/esm/generated/operationsInterfaces/index.d.ts +4 -0
- package/dist/esm/generated/operationsInterfaces/index.d.ts.map +1 -0
- package/dist/esm/generated/operationsInterfaces/index.js +11 -0
- package/dist/esm/generated/operationsInterfaces/index.js.map +1 -0
- package/dist/esm/generated/operationsInterfaces/miscellaneous.d.ts +22 -0
- package/dist/esm/generated/operationsInterfaces/miscellaneous.d.ts.map +1 -0
- package/dist/esm/generated/operationsInterfaces/miscellaneous.js +9 -0
- package/dist/esm/generated/operationsInterfaces/miscellaneous.js.map +1 -0
- package/dist/esm/index.d.ts +18 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +19 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/lro/administration.d.ts +101 -0
- package/dist/esm/lro/administration.d.ts.map +1 -0
- package/dist/esm/lro/administration.js +29 -0
- package/dist/esm/lro/administration.js.map +1 -0
- package/dist/esm/lro/analysis.d.ts +210 -0
- package/dist/esm/lro/analysis.d.ts.map +1 -0
- package/dist/esm/lro/analysis.js +175 -0
- package/dist/esm/lro/analysis.js.map +1 -0
- package/dist/esm/lro/util/delayMs.d.ts +32 -0
- package/dist/esm/lro/util/delayMs.d.ts.map +1 -0
- package/dist/esm/lro/util/delayMs.js +52 -0
- package/dist/esm/lro/util/delayMs.js.map +1 -0
- package/dist/esm/lro/util/poller.d.ts +41 -0
- package/dist/esm/lro/util/poller.d.ts.map +1 -0
- package/dist/esm/lro/util/poller.js +84 -0
- package/dist/esm/lro/util/poller.js.map +1 -0
- package/dist/esm/models/contentSource.d.ts +56 -0
- package/dist/esm/models/contentSource.d.ts.map +1 -0
- package/dist/esm/models/contentSource.js +4 -0
- package/dist/esm/models/contentSource.js.map +1 -0
- package/dist/esm/models/documentElements.d.ts +210 -0
- package/dist/esm/models/documentElements.d.ts.map +1 -0
- package/dist/esm/models/documentElements.js +4 -0
- package/dist/esm/models/documentElements.js.map +1 -0
- package/dist/esm/models/fields.d.ts +205 -0
- package/dist/esm/models/fields.d.ts.map +1 -0
- package/dist/esm/models/fields.js +55 -0
- package/dist/esm/models/fields.js.map +1 -0
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.d.ts.map +1 -0
- package/dist/esm/models/index.js +4 -0
- package/dist/esm/models/index.js.map +1 -0
- package/dist/esm/options/AnalyzeDocumentOptions.d.ts +69 -0
- package/dist/esm/options/AnalyzeDocumentOptions.d.ts.map +1 -0
- package/dist/esm/options/AnalyzeDocumentOptions.js +33 -0
- package/dist/esm/options/AnalyzeDocumentOptions.js.map +1 -0
- package/dist/esm/options/BeginCopyModelOptions.d.ts +9 -0
- package/dist/esm/options/BeginCopyModelOptions.d.ts.map +1 -0
- package/dist/esm/options/BeginCopyModelOptions.js +4 -0
- package/dist/esm/options/BeginCopyModelOptions.js.map +1 -0
- package/dist/esm/options/BuildDocumentClassifierOptions.d.ts +13 -0
- package/dist/esm/options/BuildDocumentClassifierOptions.d.ts.map +1 -0
- package/dist/esm/options/BuildDocumentClassifierOptions.js +4 -0
- package/dist/esm/options/BuildDocumentClassifierOptions.js.map +1 -0
- package/dist/esm/options/BuildModelOptions.d.ts +61 -0
- package/dist/esm/options/BuildModelOptions.d.ts.map +1 -0
- package/dist/esm/options/BuildModelOptions.js +19 -0
- package/dist/esm/options/BuildModelOptions.js.map +1 -0
- package/dist/esm/options/ClassifyDocumentOptions.d.ts +9 -0
- package/dist/esm/options/ClassifyDocumentOptions.d.ts.map +1 -0
- package/dist/esm/options/ClassifyDocumentOptions.js +4 -0
- package/dist/esm/options/ClassifyDocumentOptions.js.map +1 -0
- package/dist/esm/options/DeleteModelOptions.d.ts +7 -0
- package/dist/esm/options/DeleteModelOptions.d.ts.map +1 -0
- package/dist/esm/options/DeleteModelOptions.js +4 -0
- package/dist/esm/options/DeleteModelOptions.js.map +1 -0
- package/dist/esm/options/FormRecognizerClientOptions.d.ts +70 -0
- package/dist/esm/options/FormRecognizerClientOptions.d.ts.map +1 -0
- package/dist/esm/options/FormRecognizerClientOptions.js +25 -0
- package/dist/esm/options/FormRecognizerClientOptions.js.map +1 -0
- package/dist/esm/options/GetCopyAuthorizationOptions.d.ts +8 -0
- package/dist/esm/options/GetCopyAuthorizationOptions.d.ts.map +1 -0
- package/dist/esm/options/GetCopyAuthorizationOptions.js +4 -0
- package/dist/esm/options/GetCopyAuthorizationOptions.js.map +1 -0
- package/dist/esm/options/GetModelOptions.d.ts +7 -0
- package/dist/esm/options/GetModelOptions.d.ts.map +1 -0
- package/dist/esm/options/GetModelOptions.js +4 -0
- package/dist/esm/options/GetModelOptions.js.map +1 -0
- package/dist/esm/options/GetOperationOptions.d.ts +7 -0
- package/dist/esm/options/GetOperationOptions.d.ts.map +1 -0
- package/dist/esm/options/GetOperationOptions.js +4 -0
- package/dist/esm/options/GetOperationOptions.js.map +1 -0
- package/dist/esm/options/GetResourceDetailsOptions.d.ts +7 -0
- package/dist/esm/options/GetResourceDetailsOptions.d.ts.map +1 -0
- package/dist/esm/options/GetResourceDetailsOptions.js +4 -0
- package/dist/esm/options/GetResourceDetailsOptions.js.map +1 -0
- package/dist/esm/options/ListModelsOptions.d.ts +7 -0
- package/dist/esm/options/ListModelsOptions.d.ts.map +1 -0
- package/dist/esm/options/ListModelsOptions.js +4 -0
- package/dist/esm/options/ListModelsOptions.js.map +1 -0
- package/dist/esm/options/ListOperationsOptions.d.ts +7 -0
- package/dist/esm/options/ListOperationsOptions.d.ts.map +1 -0
- package/dist/esm/options/ListOperationsOptions.js +4 -0
- package/dist/esm/options/ListOperationsOptions.js.map +1 -0
- package/dist/esm/options/PollerOptions.d.ts +22 -0
- package/dist/esm/options/PollerOptions.d.ts.map +1 -0
- package/dist/esm/options/PollerOptions.js +4 -0
- package/dist/esm/options/PollerOptions.js.map +1 -0
- package/dist/esm/options/index.d.ts +16 -0
- package/dist/esm/options/index.d.ts.map +1 -0
- package/dist/esm/options/index.js +7 -0
- package/dist/esm/options/index.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/transforms/polygon.d.ts +20 -0
- package/dist/esm/transforms/polygon.d.ts.map +1 -0
- package/dist/esm/transforms/polygon.js +26 -0
- package/dist/esm/transforms/polygon.js.map +1 -0
- package/dist/esm/util.d.ts +33 -0
- package/dist/esm/util.d.ts.map +1 -0
- package/dist/esm/util.js +56 -0
- package/dist/esm/util.js.map +1 -0
- package/dist/react-native/azureKeyCredentialPolicy.d.ts +8 -0
- package/dist/react-native/azureKeyCredentialPolicy.d.ts.map +1 -0
- package/dist/react-native/azureKeyCredentialPolicy.js +17 -0
- package/dist/react-native/azureKeyCredentialPolicy.js.map +1 -0
- package/dist/react-native/bin/defaultFields.d.ts +14 -0
- package/dist/react-native/bin/defaultFields.d.ts.map +1 -0
- package/dist/react-native/bin/defaultFields.js +83 -0
- package/dist/react-native/bin/defaultFields.js.map +1 -0
- package/dist/react-native/bin/gen-model.d.ts +3 -0
- package/dist/react-native/bin/gen-model.d.ts.map +1 -0
- package/dist/react-native/bin/gen-model.js +101 -0
- package/dist/react-native/bin/gen-model.js.map +1 -0
- package/dist/react-native/bin/utils.d.ts +22 -0
- package/dist/react-native/bin/utils.d.ts.map +1 -0
- package/dist/react-native/bin/utils.js +21 -0
- package/dist/react-native/bin/utils.js.map +1 -0
- package/dist/react-native/bin/writeModelCode.d.ts +9 -0
- package/dist/react-native/bin/writeModelCode.d.ts.map +1 -0
- package/dist/react-native/bin/writeModelCode.js +323 -0
- package/dist/react-native/bin/writeModelCode.js.map +1 -0
- package/dist/react-native/constants.d.ts +29 -0
- package/dist/react-native/constants.d.ts.map +1 -0
- package/dist/react-native/constants.js +32 -0
- package/dist/react-native/constants.js.map +1 -0
- package/dist/react-native/documentAnalysisClient.d.ts +485 -0
- package/dist/react-native/documentAnalysisClient.d.ts.map +1 -0
- package/dist/react-native/documentAnalysisClient.js +347 -0
- package/dist/react-native/documentAnalysisClient.js.map +1 -0
- package/dist/react-native/documentModel.d.ts +34 -0
- package/dist/react-native/documentModel.d.ts.map +1 -0
- package/dist/react-native/documentModel.js +73 -0
- package/dist/react-native/documentModel.js.map +1 -0
- package/dist/react-native/documentModelAdministrationClient.d.ts +792 -0
- package/dist/react-native/documentModelAdministrationClient.d.ts.map +1 -0
- package/dist/react-native/documentModelAdministrationClient.js +759 -0
- package/dist/react-native/documentModelAdministrationClient.js.map +1 -0
- package/dist/react-native/error.d.ts +31 -0
- package/dist/react-native/error.d.ts.map +1 -0
- package/dist/react-native/error.js +39 -0
- package/dist/react-native/error.js.map +1 -0
- package/dist/react-native/generated/generatedClient.d.ts +21 -0
- package/dist/react-native/generated/generatedClient.d.ts.map +1 -0
- package/dist/react-native/generated/generatedClient.js +89 -0
- package/dist/react-native/generated/generatedClient.js.map +1 -0
- package/dist/react-native/generated/index.d.ts +4 -0
- package/dist/react-native/generated/index.d.ts.map +1 -0
- package/dist/react-native/generated/index.js +12 -0
- package/dist/react-native/generated/index.js.map +1 -0
- package/dist/react-native/generated/models/index.d.ts +1208 -0
- package/dist/react-native/generated/models/index.d.ts.map +1 -0
- package/dist/react-native/generated/models/index.js +204 -0
- package/dist/react-native/generated/models/index.js.map +1 -0
- package/dist/react-native/generated/models/mappers.d.ts +67 -0
- package/dist/react-native/generated/models/mappers.d.ts.map +1 -0
- package/dist/react-native/generated/models/mappers.js +2501 -0
- package/dist/react-native/generated/models/mappers.js.map +1 -0
- package/dist/react-native/generated/models/parameters.d.ts +31 -0
- package/dist/react-native/generated/models/parameters.d.ts.map +1 -0
- package/dist/react-native/generated/models/parameters.js +291 -0
- package/dist/react-native/generated/models/parameters.js.map +1 -0
- package/dist/react-native/generated/operations/documentClassifiers.d.ts +78 -0
- package/dist/react-native/generated/operations/documentClassifiers.d.ts.map +1 -0
- package/dist/react-native/generated/operations/documentClassifiers.js +330 -0
- package/dist/react-native/generated/operations/documentClassifiers.js.map +1 -0
- package/dist/react-native/generated/operations/documentModels.d.ts +98 -0
- package/dist/react-native/generated/operations/documentModels.d.ts.map +1 -0
- package/dist/react-native/generated/operations/documentModels.js +424 -0
- package/dist/react-native/generated/operations/documentModels.js.map +1 -0
- package/dist/react-native/generated/operations/index.d.ts +4 -0
- package/dist/react-native/generated/operations/index.d.ts.map +1 -0
- package/dist/react-native/generated/operations/index.js +11 -0
- package/dist/react-native/generated/operations/index.js.map +1 -0
- package/dist/react-native/generated/operations/miscellaneous.d.ts +43 -0
- package/dist/react-native/generated/operations/miscellaneous.d.ts.map +1 -0
- package/dist/react-native/generated/operations/miscellaneous.js +169 -0
- package/dist/react-native/generated/operations/miscellaneous.js.map +1 -0
- package/dist/react-native/generated/operationsInterfaces/documentClassifiers.d.ts +53 -0
- package/dist/react-native/generated/operationsInterfaces/documentClassifiers.d.ts.map +1 -0
- package/dist/react-native/generated/operationsInterfaces/documentClassifiers.js +9 -0
- package/dist/react-native/generated/operationsInterfaces/documentClassifiers.js.map +1 -0
- package/dist/react-native/generated/operationsInterfaces/documentModels.d.ts +69 -0
- package/dist/react-native/generated/operationsInterfaces/documentModels.d.ts.map +1 -0
- package/dist/react-native/generated/operationsInterfaces/documentModels.js +9 -0
- package/dist/react-native/generated/operationsInterfaces/documentModels.js.map +1 -0
- package/dist/react-native/generated/operationsInterfaces/index.d.ts +4 -0
- package/dist/react-native/generated/operationsInterfaces/index.d.ts.map +1 -0
- package/dist/react-native/generated/operationsInterfaces/index.js +11 -0
- package/dist/react-native/generated/operationsInterfaces/index.js.map +1 -0
- package/dist/react-native/generated/operationsInterfaces/miscellaneous.d.ts +22 -0
- package/dist/react-native/generated/operationsInterfaces/miscellaneous.d.ts.map +1 -0
- package/dist/react-native/generated/operationsInterfaces/miscellaneous.js +9 -0
- package/dist/react-native/generated/operationsInterfaces/miscellaneous.js.map +1 -0
- package/dist/react-native/index.d.ts +18 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +19 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/lro/administration.d.ts +101 -0
- package/dist/react-native/lro/administration.d.ts.map +1 -0
- package/dist/react-native/lro/administration.js +29 -0
- package/dist/react-native/lro/administration.js.map +1 -0
- package/dist/react-native/lro/analysis.d.ts +210 -0
- package/dist/react-native/lro/analysis.d.ts.map +1 -0
- package/dist/react-native/lro/analysis.js +175 -0
- package/dist/react-native/lro/analysis.js.map +1 -0
- package/dist/react-native/lro/util/delayMs.d.ts +32 -0
- package/dist/react-native/lro/util/delayMs.d.ts.map +1 -0
- package/dist/react-native/lro/util/delayMs.js +52 -0
- package/dist/react-native/lro/util/delayMs.js.map +1 -0
- package/dist/react-native/lro/util/poller.d.ts +41 -0
- package/dist/react-native/lro/util/poller.d.ts.map +1 -0
- package/dist/react-native/lro/util/poller.js +84 -0
- package/dist/react-native/lro/util/poller.js.map +1 -0
- package/dist/react-native/models/contentSource.d.ts +56 -0
- package/dist/react-native/models/contentSource.d.ts.map +1 -0
- package/dist/react-native/models/contentSource.js +4 -0
- package/dist/react-native/models/contentSource.js.map +1 -0
- package/dist/react-native/models/documentElements.d.ts +210 -0
- package/dist/react-native/models/documentElements.d.ts.map +1 -0
- package/dist/react-native/models/documentElements.js +4 -0
- package/dist/react-native/models/documentElements.js.map +1 -0
- package/dist/react-native/models/fields.d.ts +205 -0
- package/dist/react-native/models/fields.d.ts.map +1 -0
- package/dist/react-native/models/fields.js +55 -0
- package/dist/react-native/models/fields.js.map +1 -0
- package/dist/react-native/models/index.d.ts +4 -0
- package/dist/react-native/models/index.d.ts.map +1 -0
- package/dist/react-native/models/index.js +4 -0
- package/dist/react-native/models/index.js.map +1 -0
- package/dist/react-native/options/AnalyzeDocumentOptions.d.ts +69 -0
- package/dist/react-native/options/AnalyzeDocumentOptions.d.ts.map +1 -0
- package/dist/react-native/options/AnalyzeDocumentOptions.js +33 -0
- package/dist/react-native/options/AnalyzeDocumentOptions.js.map +1 -0
- package/dist/react-native/options/BeginCopyModelOptions.d.ts +9 -0
- package/dist/react-native/options/BeginCopyModelOptions.d.ts.map +1 -0
- package/dist/react-native/options/BeginCopyModelOptions.js +4 -0
- package/dist/react-native/options/BeginCopyModelOptions.js.map +1 -0
- package/dist/react-native/options/BuildDocumentClassifierOptions.d.ts +13 -0
- package/dist/react-native/options/BuildDocumentClassifierOptions.d.ts.map +1 -0
- package/dist/react-native/options/BuildDocumentClassifierOptions.js +4 -0
- package/dist/react-native/options/BuildDocumentClassifierOptions.js.map +1 -0
- package/dist/react-native/options/BuildModelOptions.d.ts +61 -0
- package/dist/react-native/options/BuildModelOptions.d.ts.map +1 -0
- package/dist/react-native/options/BuildModelOptions.js +19 -0
- package/dist/react-native/options/BuildModelOptions.js.map +1 -0
- package/dist/react-native/options/ClassifyDocumentOptions.d.ts +9 -0
- package/dist/react-native/options/ClassifyDocumentOptions.d.ts.map +1 -0
- package/dist/react-native/options/ClassifyDocumentOptions.js +4 -0
- package/dist/react-native/options/ClassifyDocumentOptions.js.map +1 -0
- package/dist/react-native/options/DeleteModelOptions.d.ts +7 -0
- package/dist/react-native/options/DeleteModelOptions.d.ts.map +1 -0
- package/dist/react-native/options/DeleteModelOptions.js +4 -0
- package/dist/react-native/options/DeleteModelOptions.js.map +1 -0
- package/dist/react-native/options/FormRecognizerClientOptions.d.ts +70 -0
- package/dist/react-native/options/FormRecognizerClientOptions.d.ts.map +1 -0
- package/dist/react-native/options/FormRecognizerClientOptions.js +25 -0
- package/dist/react-native/options/FormRecognizerClientOptions.js.map +1 -0
- package/dist/react-native/options/GetCopyAuthorizationOptions.d.ts +8 -0
- package/dist/react-native/options/GetCopyAuthorizationOptions.d.ts.map +1 -0
- package/dist/react-native/options/GetCopyAuthorizationOptions.js +4 -0
- package/dist/react-native/options/GetCopyAuthorizationOptions.js.map +1 -0
- package/dist/react-native/options/GetModelOptions.d.ts +7 -0
- package/dist/react-native/options/GetModelOptions.d.ts.map +1 -0
- package/dist/react-native/options/GetModelOptions.js +4 -0
- package/dist/react-native/options/GetModelOptions.js.map +1 -0
- package/dist/react-native/options/GetOperationOptions.d.ts +7 -0
- package/dist/react-native/options/GetOperationOptions.d.ts.map +1 -0
- package/dist/react-native/options/GetOperationOptions.js +4 -0
- package/dist/react-native/options/GetOperationOptions.js.map +1 -0
- package/dist/react-native/options/GetResourceDetailsOptions.d.ts +7 -0
- package/dist/react-native/options/GetResourceDetailsOptions.d.ts.map +1 -0
- package/dist/react-native/options/GetResourceDetailsOptions.js +4 -0
- package/dist/react-native/options/GetResourceDetailsOptions.js.map +1 -0
- package/dist/react-native/options/ListModelsOptions.d.ts +7 -0
- package/dist/react-native/options/ListModelsOptions.d.ts.map +1 -0
- package/dist/react-native/options/ListModelsOptions.js +4 -0
- package/dist/react-native/options/ListModelsOptions.js.map +1 -0
- package/dist/react-native/options/ListOperationsOptions.d.ts +7 -0
- package/dist/react-native/options/ListOperationsOptions.d.ts.map +1 -0
- package/dist/react-native/options/ListOperationsOptions.js +4 -0
- package/dist/react-native/options/ListOperationsOptions.js.map +1 -0
- package/dist/react-native/options/PollerOptions.d.ts +22 -0
- package/dist/react-native/options/PollerOptions.d.ts.map +1 -0
- package/dist/react-native/options/PollerOptions.js +4 -0
- package/dist/react-native/options/PollerOptions.js.map +1 -0
- package/dist/react-native/options/index.d.ts +16 -0
- package/dist/react-native/options/index.d.ts.map +1 -0
- package/dist/react-native/options/index.js +7 -0
- package/dist/react-native/options/index.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/dist/react-native/transforms/polygon.d.ts +20 -0
- package/dist/react-native/transforms/polygon.d.ts.map +1 -0
- package/dist/react-native/transforms/polygon.js +26 -0
- package/dist/react-native/transforms/polygon.js.map +1 -0
- package/dist/react-native/util.d.ts +33 -0
- package/dist/react-native/util.d.ts.map +1 -0
- package/dist/react-native/util.js +56 -0
- package/dist/react-native/util.js.map +1 -0
- package/package.json +85 -74
- package/dist/index.js +0 -5721
- package/dist/index.js.map +0 -1
- package/dist-esm/src/azureKeyCredentialPolicy.js.map +0 -1
- package/dist-esm/src/constants.js +0 -13
- package/dist-esm/src/constants.js.map +0 -1
- package/dist-esm/src/documentAnalysisClient.js.map +0 -1
- package/dist-esm/src/documentModel.js.map +0 -1
- package/dist-esm/src/documentModelAdministrationClient.js.map +0 -1
- package/dist-esm/src/error.js.map +0 -1
- package/dist-esm/src/generated/generatedClient.js.map +0 -1
- package/dist-esm/src/generated/index.js.map +0 -1
- package/dist-esm/src/generated/models/parameters.js.map +0 -1
- package/dist-esm/src/generated/operations/documentClassifiers.js.map +0 -1
- package/dist-esm/src/generated/operations/documentModels.js.map +0 -1
- package/dist-esm/src/generated/operations/miscellaneous.js.map +0 -1
- package/dist-esm/src/generated/operationsInterfaces/documentClassifiers.js.map +0 -1
- package/dist-esm/src/generated/operationsInterfaces/documentModels.js.map +0 -1
- package/dist-esm/src/generated/operationsInterfaces/miscellaneous.js.map +0 -1
- package/dist-esm/src/index.js.map +0 -1
- package/dist-esm/src/lro/administration.js.map +0 -1
- package/dist-esm/src/lro/analysis.js.map +0 -1
- package/dist-esm/src/lro/util/delayMs.js.map +0 -1
- package/dist-esm/src/lro/util/poller.js.map +0 -1
- package/dist-esm/src/models/contentSource.js +0 -4
- package/dist-esm/src/models/contentSource.js.map +0 -1
- package/dist-esm/src/models/documentElements.js +0 -4
- package/dist-esm/src/models/documentElements.js.map +0 -1
- package/dist-esm/src/models/index.js +0 -4
- package/dist-esm/src/models/index.js.map +0 -1
- package/dist-esm/src/options/AnalyzeDocumentOptions.js.map +0 -1
- package/dist-esm/src/options/BeginCopyModelOptions.js +0 -4
- package/dist-esm/src/options/BeginCopyModelOptions.js.map +0 -1
- package/dist-esm/src/options/BuildDocumentClassifierOptions.js +0 -4
- package/dist-esm/src/options/BuildDocumentClassifierOptions.js.map +0 -1
- package/dist-esm/src/options/BuildModelOptions.js.map +0 -1
- package/dist-esm/src/options/ClassifyDocumentOptions.js +0 -4
- package/dist-esm/src/options/ClassifyDocumentOptions.js.map +0 -1
- package/dist-esm/src/options/DeleteModelOptions.js +0 -4
- package/dist-esm/src/options/DeleteModelOptions.js.map +0 -1
- package/dist-esm/src/options/FormRecognizerClientOptions.js.map +0 -1
- package/dist-esm/src/options/GetCopyAuthorizationOptions.js +0 -4
- package/dist-esm/src/options/GetCopyAuthorizationOptions.js.map +0 -1
- package/dist-esm/src/options/GetModelOptions.js +0 -4
- package/dist-esm/src/options/GetModelOptions.js.map +0 -1
- package/dist-esm/src/options/GetOperationOptions.js +0 -4
- package/dist-esm/src/options/GetOperationOptions.js.map +0 -1
- package/dist-esm/src/options/GetResourceDetailsOptions.js +0 -4
- package/dist-esm/src/options/ListModelsOptions.js +0 -4
- package/dist-esm/src/options/ListModelsOptions.js.map +0 -1
- package/dist-esm/src/options/ListOperationsOptions.js +0 -4
- package/dist-esm/src/options/PollerOptions.js +0 -4
- package/dist-esm/src/options/PollerOptions.js.map +0 -1
- package/dist-esm/src/options/index.js +0 -7
- package/dist-esm/src/options/index.js.map +0 -1
- package/dist-esm/src/transforms/polygon.js.map +0 -1
- package/dist-esm/src/util.js.map +0 -1
- package/types/ai-form-recognizer.d.ts +0 -2670
- /package/{dist-esm/src → dist/browser}/generated/models/index.js +0 -0
- /package/{dist-esm/src → dist/browser}/generated/models/index.js.map +0 -0
- /package/{dist-esm/src → dist/browser}/generated/models/mappers.js +0 -0
- /package/{dist-esm/src → dist/browser}/generated/models/mappers.js.map +0 -0
- /package/{dist-esm/src → dist/browser}/generated/operationsInterfaces/documentClassifiers.js +0 -0
- /package/{dist-esm/src → dist/browser}/generated/operationsInterfaces/documentModels.js +0 -0
- /package/{dist-esm/src → dist/browser}/generated/operationsInterfaces/miscellaneous.js +0 -0
|
@@ -0,0 +1,485 @@
|
|
|
1
|
+
import type { KeyCredential, TokenCredential } from "@azure/core-auth";
|
|
2
|
+
import type { AnalysisPoller, FormRecognizerRequestBody } from "./lro/analysis.js";
|
|
3
|
+
import type { AnalyzeDocumentOptions } from "./options/AnalyzeDocumentOptions.js";
|
|
4
|
+
import type { DocumentAnalysisClientOptions } from "./options/FormRecognizerClientOptions.js";
|
|
5
|
+
import type { DocumentModel } from "./documentModel.js";
|
|
6
|
+
import type { ClassifyDocumentOptions } from "./options/ClassifyDocumentOptions.js";
|
|
7
|
+
/**
|
|
8
|
+
* A client for interacting with the Form Recognizer service's analysis features.
|
|
9
|
+
*
|
|
10
|
+
* ### Examples:
|
|
11
|
+
*
|
|
12
|
+
* The Form Recognizer service and clients support two means of authentication:
|
|
13
|
+
*
|
|
14
|
+
* #### Azure Active Directory
|
|
15
|
+
*
|
|
16
|
+
* ```ts snippet:ReadmeSampleCreateClient_TokenCredential
|
|
17
|
+
* import { DefaultAzureCredential } from "@azure/identity";
|
|
18
|
+
* import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
|
|
19
|
+
*
|
|
20
|
+
* const credential = new DefaultAzureCredential();
|
|
21
|
+
* const client = new DocumentAnalysisClient(
|
|
22
|
+
* "https://<resource name>.cognitiveservices.azure.com",
|
|
23
|
+
* credential,
|
|
24
|
+
* );
|
|
25
|
+
* ```
|
|
26
|
+
*
|
|
27
|
+
* #### API Key (Subscription Key)
|
|
28
|
+
*
|
|
29
|
+
* ```ts snippet:ReadmeSampleCreateClient_KeyCredential
|
|
30
|
+
* import { AzureKeyCredential, DocumentAnalysisClient } from "@azure/ai-form-recognizer";
|
|
31
|
+
*
|
|
32
|
+
* const credential = new AzureKeyCredential("<API key>");
|
|
33
|
+
* const client = new DocumentAnalysisClient(
|
|
34
|
+
* "https://<resource name>.cognitiveservices.azure.com",
|
|
35
|
+
* credential,
|
|
36
|
+
* );
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
export declare class DocumentAnalysisClient {
|
|
40
|
+
private _restClient;
|
|
41
|
+
private _tracing;
|
|
42
|
+
/**
|
|
43
|
+
* Create a `DocumentAnalysisClient` instance from a resource endpoint and a an Azure Identity `TokenCredential`.
|
|
44
|
+
*
|
|
45
|
+
* See the [`@azure/identity`](https://npmjs.com/package/\@azure/identity) package for more information about
|
|
46
|
+
* authenticating with Azure Active Directory.
|
|
47
|
+
*
|
|
48
|
+
* ### Example:
|
|
49
|
+
*
|
|
50
|
+
* ```ts snippet:ReadmeSampleCreateClient_TokenCredential
|
|
51
|
+
* import { DefaultAzureCredential } from "@azure/identity";
|
|
52
|
+
* import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
|
|
53
|
+
*
|
|
54
|
+
* const credential = new DefaultAzureCredential();
|
|
55
|
+
* const client = new DocumentAnalysisClient(
|
|
56
|
+
* "https://<resource name>.cognitiveservices.azure.com",
|
|
57
|
+
* credential,
|
|
58
|
+
* );
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
61
|
+
* @param endpoint - the endpoint URL of an Azure Cognitive Services instance
|
|
62
|
+
* @param credential - a TokenCredential instance from the `@azure/identity` package
|
|
63
|
+
* @param options - optional settings for configuring all methods in the client
|
|
64
|
+
*/
|
|
65
|
+
constructor(endpoint: string, credential: TokenCredential, options?: DocumentAnalysisClientOptions);
|
|
66
|
+
/**
|
|
67
|
+
* Create a `DocumentAnalysisClient` instance from a resource endpoint and a static API key (`KeyCredential`),
|
|
68
|
+
*
|
|
69
|
+
* ### Example:
|
|
70
|
+
*
|
|
71
|
+
* ```ts snippet:ReadmeSampleCreateClient_KeyCredential
|
|
72
|
+
* import { AzureKeyCredential, DocumentAnalysisClient } from "@azure/ai-form-recognizer";
|
|
73
|
+
*
|
|
74
|
+
* const credential = new AzureKeyCredential("<API key>");
|
|
75
|
+
* const client = new DocumentAnalysisClient(
|
|
76
|
+
* "https://<resource name>.cognitiveservices.azure.com",
|
|
77
|
+
* credential,
|
|
78
|
+
* );
|
|
79
|
+
* ```
|
|
80
|
+
*
|
|
81
|
+
* @param endpoint - the endpoint URL of an Azure Cognitive Services instance
|
|
82
|
+
* @param credential - a KeyCredential containing the Cognitive Services instance subscription key
|
|
83
|
+
* @param options - optional settings for configuring all methods in the client
|
|
84
|
+
*/
|
|
85
|
+
constructor(endpoint: string, credential: KeyCredential, options?: DocumentAnalysisClientOptions);
|
|
86
|
+
/**
|
|
87
|
+
* @hidden
|
|
88
|
+
*/
|
|
89
|
+
constructor(endpoint: string, credential: KeyCredential | TokenCredential, options?: DocumentAnalysisClientOptions);
|
|
90
|
+
/**
|
|
91
|
+
* Extract data from an input using a model given by its unique ID.
|
|
92
|
+
*
|
|
93
|
+
* This operation supports custom as well as prebuilt models. For example, to use the prebuilt invoice model, provide
|
|
94
|
+
* the model ID "prebuilt-invoice", or to use the simpler prebuilt layout model, provide the model ID
|
|
95
|
+
* "prebuilt-layout".
|
|
96
|
+
*
|
|
97
|
+
* The fields produced in the `AnalyzeResult` depend on the model that is used for analysis, and the values in any
|
|
98
|
+
* extracted documents' fields depend on the document types in the model (if any) and their corresponding field
|
|
99
|
+
* schemas.
|
|
100
|
+
*
|
|
101
|
+
* ### Examples
|
|
102
|
+
*
|
|
103
|
+
* This method supports streamable request bodies ({@link FormRecognizerRequestBody}) such as Node.JS `ReadableStream`
|
|
104
|
+
* objects, browser `Blob`s, and `ArrayBuffer`s. The contents of the body will be uploaded to the service for analysis.
|
|
105
|
+
*
|
|
106
|
+
* ```ts snippet:ReadmeSamplePrebuiltReceipt
|
|
107
|
+
* import { DefaultAzureCredential } from "@azure/identity";
|
|
108
|
+
* import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
|
|
109
|
+
* import { createReadStream } from "node:fs";
|
|
110
|
+
* import { PrebuiltReceiptModel } from "../samples-dev/prebuilt/prebuilt-receipt.js";
|
|
111
|
+
*
|
|
112
|
+
* const credential = new DefaultAzureCredential();
|
|
113
|
+
* const client = new DocumentAnalysisClient(
|
|
114
|
+
* "https://<resource name>.cognitiveservices.azure.com",
|
|
115
|
+
* credential,
|
|
116
|
+
* );
|
|
117
|
+
*
|
|
118
|
+
* const path = "<path to a document>";
|
|
119
|
+
* const readStream = createReadStream(path);
|
|
120
|
+
*
|
|
121
|
+
* // The PrebuiltReceiptModel `DocumentModel` instance encodes both the model ID and a stronger return type for the operation
|
|
122
|
+
* const poller = await client.beginAnalyzeDocument(PrebuiltReceiptModel, readStream, {
|
|
123
|
+
* onProgress: ({ status }) => {
|
|
124
|
+
* console.log(`status: ${status}`);
|
|
125
|
+
* },
|
|
126
|
+
* });
|
|
127
|
+
*
|
|
128
|
+
* const {
|
|
129
|
+
* documents: [receiptDocument],
|
|
130
|
+
* } = await poller.pollUntilDone();
|
|
131
|
+
*
|
|
132
|
+
* // The fields of the document constitute the extracted receipt data.
|
|
133
|
+
* const receipt = receiptDocument.fields;
|
|
134
|
+
*
|
|
135
|
+
* if (receipt === undefined) {
|
|
136
|
+
* throw new Error("Expected at least one receipt in analysis result.");
|
|
137
|
+
* }
|
|
138
|
+
*
|
|
139
|
+
* console.log(`Receipt data (${receiptDocument.docType})`);
|
|
140
|
+
* console.log(" Merchant Name:", receipt.merchantName?.value);
|
|
141
|
+
*
|
|
142
|
+
* // The items of the receipt are an example of a `DocumentArrayValue`
|
|
143
|
+
* if (receipt.items !== undefined) {
|
|
144
|
+
* console.log("Items:");
|
|
145
|
+
* for (const { properties: item } of receipt.items.values) {
|
|
146
|
+
* console.log("- Description:", item.description?.value);
|
|
147
|
+
* console.log(" Total Price:", item.totalPrice?.value);
|
|
148
|
+
* }
|
|
149
|
+
* }
|
|
150
|
+
*
|
|
151
|
+
* console.log(" Total:", receipt.total?.value);
|
|
152
|
+
* ```
|
|
153
|
+
*
|
|
154
|
+
*
|
|
155
|
+
* @param modelId - the unique ID (name) of the model within this client's resource
|
|
156
|
+
* @param document - a {@link FormRecognizerRequestBody} that will be uploaded with the request
|
|
157
|
+
* @param options - optional settings for the analysis operation and poller
|
|
158
|
+
* @returns a long-running operation (poller) that will eventually produce an `AnalyzeResult`
|
|
159
|
+
*/
|
|
160
|
+
beginAnalyzeDocument(modelId: string, document: FormRecognizerRequestBody, options?: AnalyzeDocumentOptions): Promise<AnalysisPoller>;
|
|
161
|
+
/**
|
|
162
|
+
* Extract data from an input using a model that has a known, strongly-typed document schema (a {@link DocumentModel}).
|
|
163
|
+
*
|
|
164
|
+
* The fields produced in the `AnalyzeResult` depend on the model that is used for analysis. In TypeScript, the type
|
|
165
|
+
* of the result for this method overload is inferred from the type of the input `DocumentModel`.
|
|
166
|
+
*
|
|
167
|
+
* ### Examples
|
|
168
|
+
*
|
|
169
|
+
* This method supports streamable request bodies ({@link FormRecognizerRequestBody}) such as Node.JS `ReadableStream`
|
|
170
|
+
* objects, browser `Blob`s, and `ArrayBuffer`s. The contents of the body will be uploaded to the service for analysis.
|
|
171
|
+
*
|
|
172
|
+
* If the input provided is a string, it will be treated as a URL to the location of a document to be analyzed. See the
|
|
173
|
+
* {@link beginAnalyzeDocumentFromUrl} method for more information. Use of that method is preferred when using URLs,
|
|
174
|
+
* and URL support is only provided in this method for backwards compatibility.
|
|
175
|
+
*
|
|
176
|
+
* ```ts snippet:ReadmeSamplePrebuiltReceipt
|
|
177
|
+
* import { DefaultAzureCredential } from "@azure/identity";
|
|
178
|
+
* import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
|
|
179
|
+
* import { createReadStream } from "node:fs";
|
|
180
|
+
* import { PrebuiltReceiptModel } from "../samples-dev/prebuilt/prebuilt-receipt.js";
|
|
181
|
+
*
|
|
182
|
+
* const credential = new DefaultAzureCredential();
|
|
183
|
+
* const client = new DocumentAnalysisClient(
|
|
184
|
+
* "https://<resource name>.cognitiveservices.azure.com",
|
|
185
|
+
* credential,
|
|
186
|
+
* );
|
|
187
|
+
*
|
|
188
|
+
* const path = "<path to a document>";
|
|
189
|
+
* const readStream = createReadStream(path);
|
|
190
|
+
*
|
|
191
|
+
* // The PrebuiltReceiptModel `DocumentModel` instance encodes both the model ID and a stronger return type for the operation
|
|
192
|
+
* const poller = await client.beginAnalyzeDocument(PrebuiltReceiptModel, readStream, {
|
|
193
|
+
* onProgress: ({ status }) => {
|
|
194
|
+
* console.log(`status: ${status}`);
|
|
195
|
+
* },
|
|
196
|
+
* });
|
|
197
|
+
*
|
|
198
|
+
* const {
|
|
199
|
+
* documents: [receiptDocument],
|
|
200
|
+
* } = await poller.pollUntilDone();
|
|
201
|
+
*
|
|
202
|
+
* // The fields of the document constitute the extracted receipt data.
|
|
203
|
+
* const receipt = receiptDocument.fields;
|
|
204
|
+
*
|
|
205
|
+
* if (receipt === undefined) {
|
|
206
|
+
* throw new Error("Expected at least one receipt in analysis result.");
|
|
207
|
+
* }
|
|
208
|
+
*
|
|
209
|
+
* console.log(`Receipt data (${receiptDocument.docType})`);
|
|
210
|
+
* console.log(" Merchant Name:", receipt.merchantName?.value);
|
|
211
|
+
*
|
|
212
|
+
* // The items of the receipt are an example of a `DocumentArrayValue`
|
|
213
|
+
* if (receipt.items !== undefined) {
|
|
214
|
+
* console.log("Items:");
|
|
215
|
+
* for (const { properties: item } of receipt.items.values) {
|
|
216
|
+
* console.log("- Description:", item.description?.value);
|
|
217
|
+
* console.log(" Total Price:", item.totalPrice?.value);
|
|
218
|
+
* }
|
|
219
|
+
* }
|
|
220
|
+
*
|
|
221
|
+
* console.log(" Total:", receipt.total?.value);
|
|
222
|
+
* ```
|
|
223
|
+
*
|
|
224
|
+
* @param model - a {@link DocumentModel} representing the model to use for analysis and the expected output type
|
|
225
|
+
* @param document - a {@link FormRecognizerRequestBody} that will be uploaded with the request
|
|
226
|
+
* @param options - optional settings for the analysis operation and poller
|
|
227
|
+
* @returns a long-running operation (poller) that will eventually produce an `AnalyzeResult` with documents that have
|
|
228
|
+
* the result type associated with the input model
|
|
229
|
+
*/
|
|
230
|
+
beginAnalyzeDocument<Result>(model: DocumentModel<Result>, document: FormRecognizerRequestBody, options?: AnalyzeDocumentOptions<Result>): Promise<AnalysisPoller<Result>>;
|
|
231
|
+
/**
|
|
232
|
+
* Extract data from an input using a model given by its unique ID.
|
|
233
|
+
*
|
|
234
|
+
* This operation supports custom as well as prebuilt models. For example, to use the prebuilt invoice model, provide
|
|
235
|
+
* the model ID "prebuilt-invoice", or to use the simpler prebuilt layout model, provide the model ID
|
|
236
|
+
* "prebuilt-layout".
|
|
237
|
+
*
|
|
238
|
+
* The fields produced in the `AnalyzeResult` depend on the model that is used for analysis, and the values in any
|
|
239
|
+
* extracted documents' fields depend on the document types in the model (if any) and their corresponding field
|
|
240
|
+
* schemas.
|
|
241
|
+
*
|
|
242
|
+
* ### Examples
|
|
243
|
+
*
|
|
244
|
+
* This method supports extracting data from a file at a given URL. The Form Recognizer service will attempt to
|
|
245
|
+
* download a file using the submitted URL, so the URL must be accessible from the public internet. For example, a SAS
|
|
246
|
+
* token can be used to grant read access to a blob in Azure Storage, and the service will use the SAS-encoded URL to
|
|
247
|
+
* request the file.
|
|
248
|
+
*
|
|
249
|
+
* ```ts snippet:ReadmeSampleReceiptModelID_URL
|
|
250
|
+
* import { DefaultAzureCredential } from "@azure/identity";
|
|
251
|
+
* import {
|
|
252
|
+
* DocumentAnalysisClient,
|
|
253
|
+
* DocumentStringField,
|
|
254
|
+
* DocumentArrayField,
|
|
255
|
+
* DocumentObjectField,
|
|
256
|
+
* } from "@azure/ai-form-recognizer";
|
|
257
|
+
*
|
|
258
|
+
* const credential = new DefaultAzureCredential();
|
|
259
|
+
* const client = new DocumentAnalysisClient(
|
|
260
|
+
* "https://<resource name>.cognitiveservices.azure.com",
|
|
261
|
+
* credential,
|
|
262
|
+
* );
|
|
263
|
+
*
|
|
264
|
+
* const poller = await client.beginAnalyzeDocumentFromUrl(
|
|
265
|
+
* "prebuilt-receipt",
|
|
266
|
+
* // The Document Intelligence service will access the following URL to a receipt image and extract data from it
|
|
267
|
+
* "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/main/sdk/formrecognizer/ai-form-recognizer/assets/receipt/contoso-receipt.png",
|
|
268
|
+
* );
|
|
269
|
+
* poller.onProgress((state) => console.log("Operation:", state.modelId, state.status));
|
|
270
|
+
*
|
|
271
|
+
* const { documents } = await poller.pollUntilDone();
|
|
272
|
+
*
|
|
273
|
+
* const result = documents && documents[0];
|
|
274
|
+
* if (result) {
|
|
275
|
+
* const receipt = result.fields;
|
|
276
|
+
* console.log("=== Receipt Information ===");
|
|
277
|
+
* console.log("Type:", result.docType);
|
|
278
|
+
* console.log("Merchant:", (receipt["MerchantName"] as DocumentStringField).value);
|
|
279
|
+
*
|
|
280
|
+
* console.log("Items:");
|
|
281
|
+
* for (const { properties: item } of ((receipt["Items"] as DocumentArrayField).values ||
|
|
282
|
+
* []) as DocumentObjectField[]) {
|
|
283
|
+
* console.log("- Description:", (item["Description"] as DocumentStringField).value);
|
|
284
|
+
* console.log(" Total Price:", (item["TotalPrice"] as DocumentStringField).value);
|
|
285
|
+
* }
|
|
286
|
+
* } else {
|
|
287
|
+
* throw new Error("Expected at least one receipt in the result.");
|
|
288
|
+
* }
|
|
289
|
+
* ```
|
|
290
|
+
*
|
|
291
|
+
* @param modelId - the unique ID (name) of the model within this client's resource
|
|
292
|
+
* @param documentUrl - a URL (string) to an input document accessible from the public internet
|
|
293
|
+
* @param options - optional settings for the analysis operation and poller
|
|
294
|
+
* @returns a long-running operation (poller) that will eventually produce an `AnalyzeResult`
|
|
295
|
+
*/
|
|
296
|
+
beginAnalyzeDocumentFromUrl(modelId: string, documentUrl: string, options?: AnalyzeDocumentOptions): Promise<AnalysisPoller>;
|
|
297
|
+
/**
|
|
298
|
+
* Extract data from an input using a model that has a known, strongly-typed document schema (a {@link DocumentModel}).
|
|
299
|
+
*
|
|
300
|
+
* The fields produced in the `AnalyzeResult` depend on the model that is used for analysis. In TypeScript, the type
|
|
301
|
+
* of the result for this method overload is inferred from the type of the input `DocumentModel`.
|
|
302
|
+
*
|
|
303
|
+
* ### Examples
|
|
304
|
+
*
|
|
305
|
+
* This method supports extracting data from a file at a given URL. The Form Recognizer service will attempt to
|
|
306
|
+
* download a file using the submitted URL, so the URL must be accessible from the public internet. For example, a SAS
|
|
307
|
+
* token can be used to grant read access to a blob in Azure Storage, and the service will use the SAS-encoded URL to
|
|
308
|
+
* request the file.
|
|
309
|
+
*
|
|
310
|
+
* ```ts snippet:ReadmeSampleReceiptPrebuilt_URL
|
|
311
|
+
* import { DefaultAzureCredential } from "@azure/identity";
|
|
312
|
+
* import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
|
|
313
|
+
* import { PrebuiltReceiptModel } from "../samples-dev/prebuilt/prebuilt-receipt.js";
|
|
314
|
+
*
|
|
315
|
+
* const credential = new DefaultAzureCredential();
|
|
316
|
+
* const client = new DocumentAnalysisClient(
|
|
317
|
+
* "https://<resource name>.cognitiveservices.azure.com",
|
|
318
|
+
* credential,
|
|
319
|
+
* );
|
|
320
|
+
*
|
|
321
|
+
* const poller = await client.beginAnalyzeDocumentFromUrl(
|
|
322
|
+
* PrebuiltReceiptModel,
|
|
323
|
+
* // The Document Intelligence service will access the following URL to a receipt image and extract data from it
|
|
324
|
+
* "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/main/sdk/formrecognizer/ai-form-recognizer/assets/receipt/contoso-receipt.png",
|
|
325
|
+
* );
|
|
326
|
+
*
|
|
327
|
+
* const {
|
|
328
|
+
* documents: [document],
|
|
329
|
+
* } = await poller.pollUntilDone();
|
|
330
|
+
*
|
|
331
|
+
* // Use of PrebuiltModels.Receipt above (rather than the raw model ID), as it adds strong typing of the model's output
|
|
332
|
+
* if (document) {
|
|
333
|
+
* const { merchantName, items, total } = document.fields;
|
|
334
|
+
*
|
|
335
|
+
* console.log("=== Receipt Information ===");
|
|
336
|
+
* console.log("Type:", document.docType);
|
|
337
|
+
* console.log("Merchant:", merchantName && merchantName.value);
|
|
338
|
+
*
|
|
339
|
+
* console.log("Items:");
|
|
340
|
+
* for (const item of (items && items.values) || []) {
|
|
341
|
+
* const { description, totalPrice } = item.properties;
|
|
342
|
+
*
|
|
343
|
+
* console.log("- Description:", description && description.value);
|
|
344
|
+
* console.log(" Total Price:", totalPrice && totalPrice.value);
|
|
345
|
+
* }
|
|
346
|
+
*
|
|
347
|
+
* console.log("Total:", total && total.value);
|
|
348
|
+
* } else {
|
|
349
|
+
* throw new Error("Expected at least one receipt in the result.");
|
|
350
|
+
* }
|
|
351
|
+
* ```
|
|
352
|
+
*
|
|
353
|
+
* @param model - a {@link DocumentModel} representing the model to use for analysis and the expected output type
|
|
354
|
+
* @param documentUrl - a URL (string) to an input document accessible from the public internet
|
|
355
|
+
* @param options - optional settings for the analysis operation and poller
|
|
356
|
+
* @returns a long-running operation (poller) that will eventually produce an `AnalyzeResult`
|
|
357
|
+
*/
|
|
358
|
+
beginAnalyzeDocumentFromUrl<Result>(model: DocumentModel<Result>, documentUrl: string, options?: AnalyzeDocumentOptions<Result>): Promise<AnalysisPoller<Result>>;
|
|
359
|
+
/**
|
|
360
|
+
* A helper method for running analysis polymorphically.
|
|
361
|
+
*
|
|
362
|
+
* @param model - the model ID or DocumentModel to use for analysis
|
|
363
|
+
* @param input - the string URL or request body to use
|
|
364
|
+
* @param options - analysis options
|
|
365
|
+
* @returns - an analysis poller
|
|
366
|
+
*/
|
|
367
|
+
private analyze;
|
|
368
|
+
/**
|
|
369
|
+
* Classify a document using a custom classifier given by its ID.
|
|
370
|
+
*
|
|
371
|
+
* This method produces a long-running operation (poller) that will eventually produce an `AnalyzeResult`. This is the
|
|
372
|
+
* same type as `beginAnalyzeDocument` and `beginAnalyzeDocumentFromUrl`, but the result will only contain a small
|
|
373
|
+
* subset of its fields. Only the `documents` field and `pages` field will be populated, and only minimal page
|
|
374
|
+
* information will be returned. The `documents` field will contain information about all the identified documents and
|
|
375
|
+
* the `docType` that they were classified as.
|
|
376
|
+
*
|
|
377
|
+
* ### Example
|
|
378
|
+
*
|
|
379
|
+
* This method supports streamable request bodies ({@link FormRecognizerRequestBody}) such as Node.JS `ReadableStream`
|
|
380
|
+
* objects, browser `Blob`s, and `ArrayBuffer`s. The contents of the body will be uploaded to the service for analysis.
|
|
381
|
+
*
|
|
382
|
+
* ```ts snippet:ReadmeSampleClassifyDocument_File
|
|
383
|
+
* import { DefaultAzureCredential } from "@azure/identity";
|
|
384
|
+
* import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
|
|
385
|
+
* import { createReadStream } from "node:fs";
|
|
386
|
+
*
|
|
387
|
+
* const credential = new DefaultAzureCredential();
|
|
388
|
+
* const client = new DocumentAnalysisClient(
|
|
389
|
+
* "https://<resource name>.cognitiveservices.azure.com",
|
|
390
|
+
* credential,
|
|
391
|
+
* );
|
|
392
|
+
*
|
|
393
|
+
* const path = "<path to a document>";
|
|
394
|
+
* const readStream = createReadStream(path);
|
|
395
|
+
*
|
|
396
|
+
* const poller = await client.beginClassifyDocument("<classifier id>", readStream);
|
|
397
|
+
*
|
|
398
|
+
* const result = await poller.pollUntilDone();
|
|
399
|
+
*
|
|
400
|
+
* if (result?.documents?.length === 0) {
|
|
401
|
+
* throw new Error("Failed to extract any documents.");
|
|
402
|
+
* }
|
|
403
|
+
*
|
|
404
|
+
* for (const document of result.documents) {
|
|
405
|
+
* console.log(
|
|
406
|
+
* `Extracted a document with type '${document.docType}' on page ${document.boundingRegions?.[0].pageNumber} (confidence: ${document.confidence})`,
|
|
407
|
+
* );
|
|
408
|
+
* }
|
|
409
|
+
* ```
|
|
410
|
+
*
|
|
411
|
+
* @param classifierId - the ID of the custom classifier to use for analysis
|
|
412
|
+
* @param document - the document to classify
|
|
413
|
+
* @param options - options for the classification operation
|
|
414
|
+
* @returns a long-running operation (poller) that will eventually produce an `AnalyzeResult`
|
|
415
|
+
*/
|
|
416
|
+
beginClassifyDocument(classifierId: string, document: FormRecognizerRequestBody, options?: ClassifyDocumentOptions): Promise<AnalysisPoller>;
|
|
417
|
+
/**
|
|
418
|
+
* Classify a document from a URL using a custom classifier given by its ID.
|
|
419
|
+
*
|
|
420
|
+
* This method produces a long-running operation (poller) that will eventually produce an `AnalyzeResult`. This is the
|
|
421
|
+
* same type as `beginAnalyzeDocument` and `beginAnalyzeDocumentFromUrl`, but the result will only contain a small
|
|
422
|
+
* subset of its fields. Only the `documents` field and `pages` field will be populated, and only minimal page
|
|
423
|
+
* information will be returned. The `documents` field will contain information about all the identified documents and
|
|
424
|
+
* the `docType` that they were classified as.
|
|
425
|
+
*
|
|
426
|
+
* ### Example
|
|
427
|
+
*
|
|
428
|
+
* This method supports extracting data from a file at a given URL. The Form Recognizer service will attempt to
|
|
429
|
+
* download a file using the submitted URL, so the URL must be accessible from the public internet. For example, a SAS
|
|
430
|
+
* token can be used to grant read access to a blob in Azure Storage, and the service will use the SAS-encoded URL to
|
|
431
|
+
* request the file.
|
|
432
|
+
*
|
|
433
|
+
* ```ts snippet:ReadmeSampleClassifyDocument
|
|
434
|
+
* import { DefaultAzureCredential } from "@azure/identity";
|
|
435
|
+
* import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
|
|
436
|
+
*
|
|
437
|
+
* const credential = new DefaultAzureCredential();
|
|
438
|
+
* const client = new DocumentAnalysisClient(
|
|
439
|
+
* "https://<resource name>.cognitiveservices.azure.com",
|
|
440
|
+
* credential,
|
|
441
|
+
* );
|
|
442
|
+
*
|
|
443
|
+
* const documentUrl =
|
|
444
|
+
* "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/main/sdk/formrecognizer/ai-form-recognizer/assets/invoice/Invoice_1.pdf";
|
|
445
|
+
*
|
|
446
|
+
* const poller = await client.beginClassifyDocumentFromUrl("<classifier id>", documentUrl);
|
|
447
|
+
*
|
|
448
|
+
* const result = await poller.pollUntilDone();
|
|
449
|
+
*
|
|
450
|
+
* if (result?.documents?.length === 0) {
|
|
451
|
+
* throw new Error("Failed to extract any documents.");
|
|
452
|
+
* }
|
|
453
|
+
*
|
|
454
|
+
* for (const document of result.documents) {
|
|
455
|
+
* console.log(
|
|
456
|
+
* `Extracted a document with type '${document.docType}' on page ${document.boundingRegions?.[0].pageNumber} (confidence: ${document.confidence})`,
|
|
457
|
+
* );
|
|
458
|
+
* }
|
|
459
|
+
* ```
|
|
460
|
+
* @param classifierId - the ID of the custom classifier to use for analysis
|
|
461
|
+
* @param documentUrl - the URL of the document to classify
|
|
462
|
+
* @param options -
|
|
463
|
+
* @returns
|
|
464
|
+
*/
|
|
465
|
+
beginClassifyDocumentFromUrl(classifierId: string, documentUrl: string, options?: ClassifyDocumentOptions): Promise<AnalysisPoller>;
|
|
466
|
+
/**
|
|
467
|
+
* A helper method for running classification polymorphically.
|
|
468
|
+
* @param classifierId - the ID of the classifier to use
|
|
469
|
+
* @param input - the string URL or request body to use
|
|
470
|
+
* @param options - analysis options
|
|
471
|
+
* @returns an analysis poller
|
|
472
|
+
*/
|
|
473
|
+
private classify;
|
|
474
|
+
/**
|
|
475
|
+
* Create an LRO poller that handles analysis operations.
|
|
476
|
+
*
|
|
477
|
+
* This is the meat of all analysis polling operations.
|
|
478
|
+
*
|
|
479
|
+
* @param startOperation - function that starts the operation and returns the operation location
|
|
480
|
+
* @param definition - operation definition (initial model ID, operation transforms, request options)
|
|
481
|
+
* @returns - an analysis poller that produces the given return types according to the operation spec
|
|
482
|
+
*/
|
|
483
|
+
private createUnifiedPoller;
|
|
484
|
+
}
|
|
485
|
+
//# sourceMappingURL=documentAnalysisClient.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documentAnalysisClient.d.ts","sourceRoot":"","sources":["../../src/documentAnalysisClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAUvE,OAAO,KAAK,EAEV,cAAc,EAGd,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAO3B,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,0CAA0C,CAAC;AAC9F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGxD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;;;;;;;;;;;OAsBG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,eAAe,EAC3B,OAAO,CAAC,EAAE,6BAA6B;IAEzC;;;;;;;;;;;;;;;;;;OAkBG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,EACzB,OAAO,CAAC,EAAE,6BAA6B;IAEzC;;OAEG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,GAAG,eAAe,EAC3C,OAAO,CAAC,EAAE,6BAA6B;IAiBzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACU,oBAAoB,CAC/B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,yBAAyB,EAEnC,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,cAAc,CAAC;IAC1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEG;IACU,oBAAoB,CAAC,MAAM,EACtC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,EAC5B,QAAQ,EAAE,yBAAyB,EAEnC,OAAO,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC,GACvC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAoBlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACU,2BAA2B,CACtC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EAEnB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,cAAc,CAAC;IAC1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACU,2BAA2B,CAAC,MAAM,EAC7C,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,EAC5B,WAAW,EAAE,MAAM,EAEnB,OAAO,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC,GACvC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAclC;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO;IAiDf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACU,qBAAqB,CAChC,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,yBAAyB,EAEnC,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,cAAc,CAAC;IAQ1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACU,4BAA4B,CACvC,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,MAAM,EAEnB,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,cAAc,CAAC;IAQ1B;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;IAuChB;;;;;;;;OAQG;YACW,mBAAmB;CA6JlC"}
|