@azure-rest/ai-document-intelligence 1.0.0-beta.2 → 1.0.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/CHANGELOG.md +263 -0
- package/LICENSE +21 -0
- package/README.md +133 -7
- package/dist/browser/clientDefinitions.d.ts +175 -0
- package/dist/browser/clientDefinitions.d.ts.map +1 -0
- package/dist/browser/clientDefinitions.js +4 -0
- package/dist/browser/clientDefinitions.js.map +1 -0
- package/dist/browser/documentIntelligence.d.ts +16 -0
- package/dist/browser/documentIntelligence.d.ts.map +1 -0
- package/dist/browser/documentIntelligence.js +44 -0
- package/dist/browser/documentIntelligence.js.map +1 -0
- package/dist/browser/index.d.ts +13 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +15 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/isUnexpected.d.ts +36 -0
- package/dist/browser/isUnexpected.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/isUnexpected.js +18 -7
- package/dist/browser/isUnexpected.js.map +1 -0
- package/dist/browser/logger.d.ts +2 -0
- package/dist/browser/logger.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/logger.js +1 -1
- package/{dist-esm/src → dist/browser}/logger.js.map +1 -1
- package/dist/browser/models.d.ts +254 -0
- package/dist/browser/models.d.ts.map +1 -0
- package/dist/browser/models.js +4 -0
- package/dist/browser/models.js.map +1 -0
- package/dist/browser/outputModels.d.ts +914 -0
- package/dist/browser/outputModels.d.ts.map +1 -0
- package/dist/browser/outputModels.js +4 -0
- package/dist/browser/outputModels.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/paginateHelper.d.ts +68 -0
- package/dist/browser/paginateHelper.d.ts.map +1 -0
- package/dist/browser/paginateHelper.js +167 -0
- package/dist/browser/paginateHelper.js.map +1 -0
- package/dist/browser/parameters.d.ts +414 -0
- package/dist/browser/parameters.d.ts.map +1 -0
- package/dist/browser/parameters.js +4 -0
- package/dist/browser/parameters.js.map +1 -0
- package/dist/browser/pollingHelper.d.ts +40 -0
- package/dist/browser/pollingHelper.d.ts.map +1 -0
- package/dist/browser/pollingHelper.js +80 -0
- package/dist/browser/pollingHelper.js.map +1 -0
- package/dist/browser/responses.d.ts +473 -0
- package/dist/browser/responses.d.ts.map +1 -0
- package/dist/browser/responses.js +4 -0
- package/dist/browser/responses.js.map +1 -0
- package/dist/browser/utils.d.ts +5 -0
- package/dist/browser/utils.d.ts.map +1 -0
- package/dist/browser/utils.js +33 -0
- package/dist/browser/utils.js.map +1 -0
- package/dist/commonjs/clientDefinitions.d.ts +175 -0
- package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
- package/dist/commonjs/clientDefinitions.js +5 -0
- package/dist/commonjs/clientDefinitions.js.map +1 -0
- package/dist/commonjs/documentIntelligence.d.ts +16 -0
- package/dist/commonjs/documentIntelligence.d.ts.map +1 -0
- package/dist/commonjs/documentIntelligence.js +47 -0
- package/dist/commonjs/documentIntelligence.js.map +1 -0
- package/dist/commonjs/index.d.ts +13 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +18 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/isUnexpected.d.ts +36 -0
- package/dist/commonjs/isUnexpected.d.ts.map +1 -0
- package/dist/commonjs/isUnexpected.js +107 -0
- package/dist/commonjs/isUnexpected.js.map +1 -0
- package/dist/commonjs/logger.d.ts +2 -0
- package/dist/commonjs/logger.d.ts.map +1 -0
- package/dist/commonjs/logger.js +8 -0
- package/dist/commonjs/logger.js.map +1 -0
- package/dist/commonjs/models.d.ts +254 -0
- package/dist/commonjs/models.d.ts.map +1 -0
- package/dist/commonjs/models.js +5 -0
- package/dist/commonjs/models.js.map +1 -0
- package/dist/commonjs/outputModels.d.ts +914 -0
- package/dist/commonjs/outputModels.d.ts.map +1 -0
- package/dist/commonjs/outputModels.js +5 -0
- package/dist/commonjs/outputModels.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/paginateHelper.d.ts +68 -0
- package/dist/commonjs/paginateHelper.d.ts.map +1 -0
- package/dist/commonjs/paginateHelper.js +170 -0
- package/dist/commonjs/paginateHelper.js.map +1 -0
- package/dist/commonjs/parameters.d.ts +414 -0
- package/dist/commonjs/parameters.d.ts.map +1 -0
- package/dist/commonjs/parameters.js +5 -0
- package/dist/commonjs/parameters.js.map +1 -0
- package/dist/commonjs/pollingHelper.d.ts +40 -0
- package/dist/commonjs/pollingHelper.d.ts.map +1 -0
- package/dist/commonjs/pollingHelper.js +84 -0
- package/dist/commonjs/pollingHelper.js.map +1 -0
- package/dist/commonjs/responses.d.ts +473 -0
- package/dist/commonjs/responses.d.ts.map +1 -0
- package/dist/commonjs/responses.js +5 -0
- package/dist/commonjs/responses.js.map +1 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/commonjs/utils.d.ts +5 -0
- package/dist/commonjs/utils.d.ts.map +1 -0
- package/dist/commonjs/utils.js +36 -0
- package/dist/commonjs/utils.js.map +1 -0
- package/dist/esm/clientDefinitions.d.ts +175 -0
- package/dist/esm/clientDefinitions.d.ts.map +1 -0
- package/dist/esm/clientDefinitions.js +4 -0
- package/dist/esm/clientDefinitions.js.map +1 -0
- package/dist/esm/documentIntelligence.d.ts +16 -0
- package/dist/esm/documentIntelligence.d.ts.map +1 -0
- package/dist/esm/documentIntelligence.js +44 -0
- package/dist/esm/documentIntelligence.js.map +1 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +15 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/isUnexpected.d.ts +36 -0
- package/dist/esm/isUnexpected.d.ts.map +1 -0
- package/dist/esm/isUnexpected.js +104 -0
- package/dist/esm/isUnexpected.js.map +1 -0
- package/dist/esm/logger.d.ts +2 -0
- package/dist/esm/logger.d.ts.map +1 -0
- package/dist/esm/logger.js +5 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/models.d.ts +254 -0
- package/dist/esm/models.d.ts.map +1 -0
- package/dist/esm/models.js +4 -0
- package/dist/esm/models.js.map +1 -0
- package/dist/esm/outputModels.d.ts +914 -0
- package/dist/esm/outputModels.d.ts.map +1 -0
- package/dist/esm/outputModels.js +4 -0
- package/dist/esm/outputModels.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/paginateHelper.d.ts +68 -0
- package/dist/esm/paginateHelper.d.ts.map +1 -0
- package/dist/esm/paginateHelper.js +167 -0
- package/dist/esm/paginateHelper.js.map +1 -0
- package/dist/esm/parameters.d.ts +414 -0
- package/dist/esm/parameters.d.ts.map +1 -0
- package/dist/esm/parameters.js +4 -0
- package/dist/esm/parameters.js.map +1 -0
- package/dist/esm/pollingHelper.d.ts +40 -0
- package/dist/esm/pollingHelper.d.ts.map +1 -0
- package/dist/esm/pollingHelper.js +80 -0
- package/dist/esm/pollingHelper.js.map +1 -0
- package/dist/esm/responses.d.ts +473 -0
- package/dist/esm/responses.d.ts.map +1 -0
- package/dist/esm/responses.js +4 -0
- package/dist/esm/responses.js.map +1 -0
- package/dist/esm/utils.d.ts +5 -0
- package/dist/esm/utils.d.ts.map +1 -0
- package/dist/esm/utils.js +33 -0
- package/dist/esm/utils.js.map +1 -0
- package/dist/react-native/clientDefinitions.d.ts +175 -0
- package/dist/react-native/clientDefinitions.d.ts.map +1 -0
- package/dist/react-native/clientDefinitions.js +4 -0
- package/dist/react-native/clientDefinitions.js.map +1 -0
- package/dist/react-native/documentIntelligence.d.ts +16 -0
- package/dist/react-native/documentIntelligence.d.ts.map +1 -0
- package/dist/react-native/documentIntelligence.js +44 -0
- package/dist/react-native/documentIntelligence.js.map +1 -0
- package/dist/react-native/index.d.ts +13 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +15 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/isUnexpected.d.ts +36 -0
- package/dist/react-native/isUnexpected.d.ts.map +1 -0
- package/dist/react-native/isUnexpected.js +104 -0
- package/dist/react-native/isUnexpected.js.map +1 -0
- package/dist/react-native/logger.d.ts +2 -0
- package/dist/react-native/logger.d.ts.map +1 -0
- package/dist/react-native/logger.js +5 -0
- package/dist/react-native/logger.js.map +1 -0
- package/dist/react-native/models.d.ts +254 -0
- package/dist/react-native/models.d.ts.map +1 -0
- package/dist/react-native/models.js +4 -0
- package/dist/react-native/models.js.map +1 -0
- package/dist/react-native/outputModels.d.ts +914 -0
- package/dist/react-native/outputModels.d.ts.map +1 -0
- package/dist/react-native/outputModels.js +4 -0
- package/dist/react-native/outputModels.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/dist/react-native/paginateHelper.d.ts +68 -0
- package/dist/react-native/paginateHelper.d.ts.map +1 -0
- package/dist/react-native/paginateHelper.js +167 -0
- package/dist/react-native/paginateHelper.js.map +1 -0
- package/dist/react-native/parameters.d.ts +414 -0
- package/dist/react-native/parameters.d.ts.map +1 -0
- package/dist/react-native/parameters.js +4 -0
- package/dist/react-native/parameters.js.map +1 -0
- package/dist/react-native/pollingHelper.d.ts +40 -0
- package/dist/react-native/pollingHelper.d.ts.map +1 -0
- package/dist/react-native/pollingHelper.js +80 -0
- package/dist/react-native/pollingHelper.js.map +1 -0
- package/dist/react-native/responses.d.ts +473 -0
- package/dist/react-native/responses.d.ts.map +1 -0
- package/dist/react-native/responses.js +4 -0
- package/dist/react-native/responses.js.map +1 -0
- package/dist/react-native/utils.d.ts +5 -0
- package/dist/react-native/utils.d.ts.map +1 -0
- package/dist/react-native/utils.js +33 -0
- package/dist/react-native/utils.js.map +1 -0
- package/package.json +108 -92
- package/review/ai-document-intelligence.api.md +866 -225
- package/dist/index.js +0 -252
- package/dist/index.js.map +0 -1
- package/dist-esm/src/clientDefinitions.js +0 -4
- package/dist-esm/src/clientDefinitions.js.map +0 -1
- package/dist-esm/src/documentIntelligence.js +0 -30
- package/dist-esm/src/documentIntelligence.js.map +0 -1
- package/dist-esm/src/index.js +0 -14
- package/dist-esm/src/index.js.map +0 -1
- package/dist-esm/src/isUnexpected.js.map +0 -1
- package/dist-esm/src/models.js +0 -4
- package/dist-esm/src/models.js.map +0 -1
- package/dist-esm/src/outputModels.js +0 -4
- package/dist-esm/src/outputModels.js.map +0 -1
- package/dist-esm/src/paginateHelper.js +0 -70
- package/dist-esm/src/paginateHelper.js.map +0 -1
- package/dist-esm/src/parameters.js +0 -4
- package/dist-esm/src/parameters.js.map +0 -1
- package/dist-esm/src/pollingHelper.js +0 -43
- package/dist-esm/src/pollingHelper.js.map +0 -1
- package/dist-esm/src/responses.js +0 -4
- package/dist-esm/src/responses.js.map +0 -1
- package/types/ai-document-intelligence.d.ts +0 -2003
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
/** Azure Blob Storage content. */
|
|
2
|
+
export interface AzureBlobContentSource {
|
|
3
|
+
/** Azure Blob Storage container URL. */
|
|
4
|
+
containerUrl: string;
|
|
5
|
+
/** Blob name prefix. */
|
|
6
|
+
prefix?: string;
|
|
7
|
+
}
|
|
8
|
+
/** File list in Azure Blob Storage. */
|
|
9
|
+
export interface AzureBlobFileListContentSource {
|
|
10
|
+
/** Azure Blob Storage container URL. */
|
|
11
|
+
containerUrl: string;
|
|
12
|
+
/** Path to a JSONL file within the container specifying a subset of documents. */
|
|
13
|
+
fileList: string;
|
|
14
|
+
}
|
|
15
|
+
/** Document type info. */
|
|
16
|
+
export interface DocumentTypeDetails {
|
|
17
|
+
/** Document model description. */
|
|
18
|
+
description?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Custom document model build mode.
|
|
21
|
+
*
|
|
22
|
+
* Possible values: "template", "neural"
|
|
23
|
+
*/
|
|
24
|
+
buildMode?: DocumentBuildMode;
|
|
25
|
+
/** Description of the document semantic schema using a JSON Schema style syntax. */
|
|
26
|
+
fieldSchema?: Record<string, DocumentFieldSchema>;
|
|
27
|
+
/** Estimated confidence for each field. */
|
|
28
|
+
fieldConfidence?: Record<string, number>;
|
|
29
|
+
/** Document model to use for analyzing documents with specified type. */
|
|
30
|
+
modelId?: string;
|
|
31
|
+
/** Only perform analysis if docType confidence is above threshold. */
|
|
32
|
+
confidenceThreshold?: number;
|
|
33
|
+
/** List of optional analysis features. */
|
|
34
|
+
features?: DocumentAnalysisFeature[];
|
|
35
|
+
/** List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber" */
|
|
36
|
+
queryFields?: string[];
|
|
37
|
+
/** Maximum number of documents of specified type to analyze. Default=all. */
|
|
38
|
+
maxDocumentsToAnalyze?: number;
|
|
39
|
+
}
|
|
40
|
+
/** Description of the field semantic schema using a JSON Schema style syntax. */
|
|
41
|
+
export interface DocumentFieldSchema {
|
|
42
|
+
/**
|
|
43
|
+
* Semantic data type of the field value.
|
|
44
|
+
*
|
|
45
|
+
* Possible values: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"
|
|
46
|
+
*/
|
|
47
|
+
type: DocumentFieldType;
|
|
48
|
+
/** Field description. */
|
|
49
|
+
description?: string;
|
|
50
|
+
/** Example field content. */
|
|
51
|
+
example?: string;
|
|
52
|
+
/** Field type schema of each array element. */
|
|
53
|
+
items?: DocumentFieldSchema;
|
|
54
|
+
/** Named sub-fields of the object field. */
|
|
55
|
+
properties?: Record<string, DocumentFieldSchema>;
|
|
56
|
+
}
|
|
57
|
+
/** Classifier document type info. */
|
|
58
|
+
export interface ClassifierDocumentTypeDetails {
|
|
59
|
+
/**
|
|
60
|
+
* Type of training data source.
|
|
61
|
+
*
|
|
62
|
+
* Possible values: "url", "base64", "azureBlob", "azureBlobFileList"
|
|
63
|
+
*/
|
|
64
|
+
sourceKind?: ContentSourceKind;
|
|
65
|
+
/**
|
|
66
|
+
* Azure Blob Storage location containing the training data for a classifier
|
|
67
|
+
* document type. Either azureBlobSource or azureBlobFileListSource must be
|
|
68
|
+
* specified.
|
|
69
|
+
*/
|
|
70
|
+
azureBlobSource?: AzureBlobContentSource;
|
|
71
|
+
/**
|
|
72
|
+
* Azure Blob Storage file list specifying the training data for a classifier
|
|
73
|
+
* document type. Either azureBlobSource or azureBlobFileListSource must be
|
|
74
|
+
* specified.
|
|
75
|
+
*/
|
|
76
|
+
azureBlobFileListSource?: AzureBlobFileListContentSource;
|
|
77
|
+
}
|
|
78
|
+
/** Document analysis parameters. */
|
|
79
|
+
export interface AnalyzeDocumentRequest {
|
|
80
|
+
/** Document URL to analyze. Either urlSource or base64Source must be specified. */
|
|
81
|
+
urlSource?: string;
|
|
82
|
+
/**
|
|
83
|
+
* Base64 encoding of the document to analyze. Either urlSource or base64Source
|
|
84
|
+
* must be specified.
|
|
85
|
+
*/
|
|
86
|
+
base64Source?: string;
|
|
87
|
+
}
|
|
88
|
+
/** Batch document analysis parameters. */
|
|
89
|
+
export interface AnalyzeBatchDocumentsRequest {
|
|
90
|
+
/**
|
|
91
|
+
* Azure Blob Storage location containing the batch documents. Either
|
|
92
|
+
* azureBlobSource or azureBlobFileListSource must be specified.
|
|
93
|
+
*/
|
|
94
|
+
azureBlobSource?: AzureBlobContentSource;
|
|
95
|
+
/**
|
|
96
|
+
* Azure Blob Storage file list specifying the batch documents. Either
|
|
97
|
+
* azureBlobSource or azureBlobFileListSource must be specified.
|
|
98
|
+
*/
|
|
99
|
+
azureBlobFileListSource?: AzureBlobFileListContentSource;
|
|
100
|
+
/** Azure Blob Storage container URL where analyze result files will be stored. */
|
|
101
|
+
resultContainerUrl: string;
|
|
102
|
+
/** Blob name prefix of result files. */
|
|
103
|
+
resultPrefix?: string;
|
|
104
|
+
/** Overwrite existing analyze result files? */
|
|
105
|
+
overwriteExisting?: boolean;
|
|
106
|
+
}
|
|
107
|
+
/** Request body to build a new custom document model. */
|
|
108
|
+
export interface BuildDocumentModelRequest {
|
|
109
|
+
/** Unique document model name. */
|
|
110
|
+
modelId: string;
|
|
111
|
+
/** Document model description. */
|
|
112
|
+
description?: string;
|
|
113
|
+
/**
|
|
114
|
+
* Custom document model build mode.
|
|
115
|
+
*
|
|
116
|
+
* Possible values: "template", "neural"
|
|
117
|
+
*/
|
|
118
|
+
buildMode: DocumentBuildMode;
|
|
119
|
+
/**
|
|
120
|
+
* Azure Blob Storage location containing the training data. Either
|
|
121
|
+
* azureBlobSource or azureBlobFileListSource must be specified.
|
|
122
|
+
*/
|
|
123
|
+
azureBlobSource?: AzureBlobContentSource;
|
|
124
|
+
/**
|
|
125
|
+
* Azure Blob Storage file list specifying the training data. Either
|
|
126
|
+
* azureBlobSource or azureBlobFileListSource must be specified.
|
|
127
|
+
*/
|
|
128
|
+
azureBlobFileListSource?: AzureBlobFileListContentSource;
|
|
129
|
+
/** List of key-value tag attributes associated with the document model. */
|
|
130
|
+
tags?: Record<string, string>;
|
|
131
|
+
/** Max number of V100-equivalent GPU hours to use for model training. Default=0.5. */
|
|
132
|
+
maxTrainingHours?: number;
|
|
133
|
+
/** Allow overwriting an existing model with the same name. */
|
|
134
|
+
allowOverwrite?: boolean;
|
|
135
|
+
}
|
|
136
|
+
/** Request body to create a composed document model from component document models. */
|
|
137
|
+
export interface ComposeDocumentModelRequest {
|
|
138
|
+
/** Unique document model name. */
|
|
139
|
+
modelId: string;
|
|
140
|
+
/** Document model description. */
|
|
141
|
+
description?: string;
|
|
142
|
+
/** Custom classifier to split and classify the input file. */
|
|
143
|
+
classifierId: string;
|
|
144
|
+
/**
|
|
145
|
+
* File splitting behavior.
|
|
146
|
+
*
|
|
147
|
+
* Possible values: "auto", "none", "perPage"
|
|
148
|
+
*/
|
|
149
|
+
split?: SplitMode;
|
|
150
|
+
/** Dictionary mapping supported docTypes to the corresponding document models. */
|
|
151
|
+
docTypes: Record<string, DocumentTypeDetails>;
|
|
152
|
+
/** List of key-value tag attributes associated with the document model. */
|
|
153
|
+
tags?: Record<string, string>;
|
|
154
|
+
}
|
|
155
|
+
/** Request body to authorize document model copy. */
|
|
156
|
+
export interface AuthorizeCopyRequest {
|
|
157
|
+
/** Unique document model name. */
|
|
158
|
+
modelId: string;
|
|
159
|
+
/** Document model description. */
|
|
160
|
+
description?: string;
|
|
161
|
+
/** List of key-value tag attributes associated with the document model. */
|
|
162
|
+
tags?: Record<string, string>;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* Authorization to copy a document model to the specified target resource and
|
|
166
|
+
* modelId.
|
|
167
|
+
*/
|
|
168
|
+
export interface ModelCopyAuthorization {
|
|
169
|
+
/** ID of the target Azure resource where the document model should be copied to. */
|
|
170
|
+
targetResourceId: string;
|
|
171
|
+
/**
|
|
172
|
+
* Location of the target Azure resource where the document model should be copied
|
|
173
|
+
* to.
|
|
174
|
+
*/
|
|
175
|
+
targetResourceRegion: string;
|
|
176
|
+
/** Identifier of the target document model. */
|
|
177
|
+
targetModelId: string;
|
|
178
|
+
/** URL of the copied document model in the target account. */
|
|
179
|
+
targetModelLocation: string;
|
|
180
|
+
/** Token used to authorize the request. */
|
|
181
|
+
accessToken: string;
|
|
182
|
+
/** Date/time when the access token expires. */
|
|
183
|
+
expirationDateTime: Date | string;
|
|
184
|
+
}
|
|
185
|
+
/** Request body to build a new custom document classifier. */
|
|
186
|
+
export interface BuildDocumentClassifierRequest {
|
|
187
|
+
/** Unique document classifier name. */
|
|
188
|
+
classifierId: string;
|
|
189
|
+
/** Document classifier description. */
|
|
190
|
+
description?: string;
|
|
191
|
+
/** Base classifierId on top of which to train the classifier. */
|
|
192
|
+
baseClassifierId?: string;
|
|
193
|
+
/** List of document types to classify against. */
|
|
194
|
+
docTypes: Record<string, ClassifierDocumentTypeDetails>;
|
|
195
|
+
/** Allow overwriting an existing classifier with the same name. */
|
|
196
|
+
allowOverwrite?: boolean;
|
|
197
|
+
}
|
|
198
|
+
/** Document classification parameters. */
|
|
199
|
+
export interface ClassifyDocumentRequest {
|
|
200
|
+
/** Document URL to classify. Either urlSource or base64Source must be specified. */
|
|
201
|
+
urlSource?: string;
|
|
202
|
+
/**
|
|
203
|
+
* Base64 encoding of the document to classify. Either urlSource or base64Source
|
|
204
|
+
* must be specified.
|
|
205
|
+
*/
|
|
206
|
+
base64Source?: string;
|
|
207
|
+
}
|
|
208
|
+
/** Request body to authorize document classifier copy. */
|
|
209
|
+
export interface AuthorizeClassifierCopyRequest {
|
|
210
|
+
/** Unique document classifier name. */
|
|
211
|
+
classifierId: string;
|
|
212
|
+
/** Document classifier description. */
|
|
213
|
+
description?: string;
|
|
214
|
+
/** List of key-value tag attributes associated with the document classifier. */
|
|
215
|
+
tags?: Record<string, string>;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Authorization to copy a document classifier to the specified target resource and
|
|
219
|
+
* classifierId.
|
|
220
|
+
*/
|
|
221
|
+
export interface ClassifierCopyAuthorization {
|
|
222
|
+
/** ID of the target Azure resource where the document classifier should be copied to. */
|
|
223
|
+
targetResourceId: string;
|
|
224
|
+
/**
|
|
225
|
+
* Location of the target Azure resource where the document classifier should be copied
|
|
226
|
+
* to.
|
|
227
|
+
*/
|
|
228
|
+
targetResourceRegion: string;
|
|
229
|
+
/** Identifier of the target document classifier. */
|
|
230
|
+
targetClassifierId: string;
|
|
231
|
+
/** URL of the copied document classifier in the target account. */
|
|
232
|
+
targetClassifierLocation: string;
|
|
233
|
+
/** Token used to authorize the request. */
|
|
234
|
+
accessToken: string;
|
|
235
|
+
/** Date/time when the access token expires. */
|
|
236
|
+
expirationDateTime: Date | string;
|
|
237
|
+
}
|
|
238
|
+
/** Alias for DocumentBuildMode */
|
|
239
|
+
export type DocumentBuildMode = string;
|
|
240
|
+
/** Alias for SplitMode */
|
|
241
|
+
export type SplitMode = string;
|
|
242
|
+
/** Alias for DocumentFieldType */
|
|
243
|
+
export type DocumentFieldType = string;
|
|
244
|
+
/** Alias for DocumentAnalysisFeature */
|
|
245
|
+
export type DocumentAnalysisFeature = string;
|
|
246
|
+
/** Alias for ContentSourceKind */
|
|
247
|
+
export type ContentSourceKind = string;
|
|
248
|
+
/** Alias for StringIndexType */
|
|
249
|
+
export type StringIndexType = string;
|
|
250
|
+
/** Alias for DocumentContentFormat */
|
|
251
|
+
export type DocumentContentFormat = string;
|
|
252
|
+
/** Alias for AnalyzeOutputOption */
|
|
253
|
+
export type AnalyzeOutputOption = string;
|
|
254
|
+
//# sourceMappingURL=models.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAGA,kCAAkC;AAClC,MAAM,WAAW,sBAAsB;IACrC,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,uCAAuC;AACvC,MAAM,WAAW,8BAA8B;IAC7C,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,kFAAkF;IAClF,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,0BAA0B;AAC1B,MAAM,WAAW,mBAAmB;IAClC,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,oFAAoF;IACpF,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAClD,2CAA2C;IAC3C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,uBAAuB,EAAE,CAAC;IACrC,8EAA8E;IAC9E,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,8EAA8E;IAC9E,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,iFAAiF;AACjF,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,IAAI,EAAE,iBAAiB,CAAC;IACxB,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CAClD;AAED,qCAAqC;AACrC,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B;;;;OAIG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,8BAA8B,CAAC;CAC1D;AAED,oCAAoC;AACpC,MAAM,WAAW,sBAAsB;IACrC,oFAAoF;IACpF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,0CAA0C;AAC1C,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,8BAA8B,CAAC;IACzD,kFAAkF;IAClF,kBAAkB,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,yDAAyD;AACzD,MAAM,WAAW,yBAAyB;IACxC,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,SAAS,EAAE,iBAAiB,CAAC;IAC7B;;;OAGG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,8BAA8B,CAAC;IACzD,2EAA2E;IAC3E,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8DAA8D;IAC9D,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,uFAAuF;AACvF,MAAM,WAAW,2BAA2B;IAC1C,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,kFAAkF;IAClF,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC9C,2EAA2E;IAC3E,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED,qDAAqD;AACrD,MAAM,WAAW,oBAAoB;IACnC,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2EAA2E;IAC3E,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,oFAAoF;IACpF,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B,+CAA+C;IAC/C,aAAa,EAAE,MAAM,CAAC;IACtB,8DAA8D;IAC9D,mBAAmB,EAAE,MAAM,CAAC;IAC5B,2CAA2C;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,+CAA+C;IAC/C,kBAAkB,EAAE,IAAI,GAAG,MAAM,CAAC;CACnC;AAED,8DAA8D;AAC9D,MAAM,WAAW,8BAA8B;IAC7C,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;IACxD,mEAAmE;IACnE,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,0CAA0C;AAC1C,MAAM,WAAW,uBAAuB;IACtC,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,0DAA0D;AAC1D,MAAM,WAAW,8BAA8B;IAC7C,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gFAAgF;IAChF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,yFAAyF;IACzF,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oDAAoD;IACpD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mEAAmE;IACnE,wBAAwB,EAAE,MAAM,CAAC;IACjC,2CAA2C;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,+CAA+C;IAC/C,kBAAkB,EAAE,IAAI,GAAG,MAAM,CAAC;CACnC;AAED,kCAAkC;AAClC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,0BAA0B;AAC1B,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,kCAAkC;AAClC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,wCAAwC;AACxC,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC;AAC7C,kCAAkC;AAClC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,gCAAgC;AAChC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AACrC,sCAAsC;AACtC,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAC3C,oCAAoC;AACpC,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** Azure Blob Storage content. */\nexport interface AzureBlobContentSource {\n /** Azure Blob Storage container URL. */\n containerUrl: string;\n /** Blob name prefix. */\n prefix?: string;\n}\n\n/** File list in Azure Blob Storage. */\nexport interface AzureBlobFileListContentSource {\n /** Azure Blob Storage container URL. */\n containerUrl: string;\n /** Path to a JSONL file within the container specifying a subset of documents. */\n fileList: string;\n}\n\n/** Document type info. */\nexport interface DocumentTypeDetails {\n /** Document model description. */\n description?: string;\n /**\n * Custom document model build mode.\n *\n * Possible values: \"template\", \"neural\"\n */\n buildMode?: DocumentBuildMode;\n /** Description of the document semantic schema using a JSON Schema style syntax. */\n fieldSchema?: Record<string, DocumentFieldSchema>;\n /** Estimated confidence for each field. */\n fieldConfidence?: Record<string, number>;\n /** Document model to use for analyzing documents with specified type. */\n modelId?: string;\n /** Only perform analysis if docType confidence is above threshold. */\n confidenceThreshold?: number;\n /** List of optional analysis features. */\n features?: DocumentAnalysisFeature[];\n /** List of additional fields to extract. Ex. \"NumberOfGuests,StoreNumber\" */\n queryFields?: string[];\n /** Maximum number of documents of specified type to analyze. Default=all. */\n maxDocumentsToAnalyze?: number;\n}\n\n/** Description of the field semantic schema using a JSON Schema style syntax. */\nexport interface DocumentFieldSchema {\n /**\n * Semantic data type of the field value.\n *\n * Possible values: \"string\", \"date\", \"time\", \"phoneNumber\", \"number\", \"integer\", \"selectionMark\", \"countryRegion\", \"signature\", \"array\", \"object\", \"currency\", \"address\", \"boolean\", \"selectionGroup\"\n */\n type: DocumentFieldType;\n /** Field description. */\n description?: string;\n /** Example field content. */\n example?: string;\n /** Field type schema of each array element. */\n items?: DocumentFieldSchema;\n /** Named sub-fields of the object field. */\n properties?: Record<string, DocumentFieldSchema>;\n}\n\n/** Classifier document type info. */\nexport interface ClassifierDocumentTypeDetails {\n /**\n * Type of training data source.\n *\n * Possible values: \"url\", \"base64\", \"azureBlob\", \"azureBlobFileList\"\n */\n sourceKind?: ContentSourceKind;\n /**\n * Azure Blob Storage location containing the training data for a classifier\n * document type. Either azureBlobSource or azureBlobFileListSource must be\n * specified.\n */\n azureBlobSource?: AzureBlobContentSource;\n /**\n * Azure Blob Storage file list specifying the training data for a classifier\n * document type. Either azureBlobSource or azureBlobFileListSource must be\n * specified.\n */\n azureBlobFileListSource?: AzureBlobFileListContentSource;\n}\n\n/** Document analysis parameters. */\nexport interface AnalyzeDocumentRequest {\n /** Document URL to analyze. Either urlSource or base64Source must be specified. */\n urlSource?: string;\n /**\n * Base64 encoding of the document to analyze. Either urlSource or base64Source\n * must be specified.\n */\n base64Source?: string;\n}\n\n/** Batch document analysis parameters. */\nexport interface AnalyzeBatchDocumentsRequest {\n /**\n * Azure Blob Storage location containing the batch documents. Either\n * azureBlobSource or azureBlobFileListSource must be specified.\n */\n azureBlobSource?: AzureBlobContentSource;\n /**\n * Azure Blob Storage file list specifying the batch documents. Either\n * azureBlobSource or azureBlobFileListSource must be specified.\n */\n azureBlobFileListSource?: AzureBlobFileListContentSource;\n /** Azure Blob Storage container URL where analyze result files will be stored. */\n resultContainerUrl: string;\n /** Blob name prefix of result files. */\n resultPrefix?: string;\n /** Overwrite existing analyze result files? */\n overwriteExisting?: boolean;\n}\n\n/** Request body to build a new custom document model. */\nexport interface BuildDocumentModelRequest {\n /** Unique document model name. */\n modelId: string;\n /** Document model description. */\n description?: string;\n /**\n * Custom document model build mode.\n *\n * Possible values: \"template\", \"neural\"\n */\n buildMode: DocumentBuildMode;\n /**\n * Azure Blob Storage location containing the training data. Either\n * azureBlobSource or azureBlobFileListSource must be specified.\n */\n azureBlobSource?: AzureBlobContentSource;\n /**\n * Azure Blob Storage file list specifying the training data. Either\n * azureBlobSource or azureBlobFileListSource must be specified.\n */\n azureBlobFileListSource?: AzureBlobFileListContentSource;\n /** List of key-value tag attributes associated with the document model. */\n tags?: Record<string, string>;\n /** Max number of V100-equivalent GPU hours to use for model training. Default=0.5. */\n maxTrainingHours?: number;\n /** Allow overwriting an existing model with the same name. */\n allowOverwrite?: boolean;\n}\n\n/** Request body to create a composed document model from component document models. */\nexport interface ComposeDocumentModelRequest {\n /** Unique document model name. */\n modelId: string;\n /** Document model description. */\n description?: string;\n /** Custom classifier to split and classify the input file. */\n classifierId: string;\n /**\n * File splitting behavior.\n *\n * Possible values: \"auto\", \"none\", \"perPage\"\n */\n split?: SplitMode;\n /** Dictionary mapping supported docTypes to the corresponding document models. */\n docTypes: Record<string, DocumentTypeDetails>;\n /** List of key-value tag attributes associated with the document model. */\n tags?: Record<string, string>;\n}\n\n/** Request body to authorize document model copy. */\nexport interface AuthorizeCopyRequest {\n /** Unique document model name. */\n modelId: string;\n /** Document model description. */\n description?: string;\n /** List of key-value tag attributes associated with the document model. */\n tags?: Record<string, string>;\n}\n\n/**\n * Authorization to copy a document model to the specified target resource and\n * modelId.\n */\nexport interface ModelCopyAuthorization {\n /** ID of the target Azure resource where the document model should be copied to. */\n targetResourceId: string;\n /**\n * Location of the target Azure resource where the document model should be copied\n * to.\n */\n targetResourceRegion: string;\n /** Identifier of the target document model. */\n targetModelId: string;\n /** URL of the copied document model in the target account. */\n targetModelLocation: string;\n /** Token used to authorize the request. */\n accessToken: string;\n /** Date/time when the access token expires. */\n expirationDateTime: Date | string;\n}\n\n/** Request body to build a new custom document classifier. */\nexport interface BuildDocumentClassifierRequest {\n /** Unique document classifier name. */\n classifierId: string;\n /** Document classifier description. */\n description?: string;\n /** Base classifierId on top of which to train the classifier. */\n baseClassifierId?: string;\n /** List of document types to classify against. */\n docTypes: Record<string, ClassifierDocumentTypeDetails>;\n /** Allow overwriting an existing classifier with the same name. */\n allowOverwrite?: boolean;\n}\n\n/** Document classification parameters. */\nexport interface ClassifyDocumentRequest {\n /** Document URL to classify. Either urlSource or base64Source must be specified. */\n urlSource?: string;\n /**\n * Base64 encoding of the document to classify. Either urlSource or base64Source\n * must be specified.\n */\n base64Source?: string;\n}\n\n/** Request body to authorize document classifier copy. */\nexport interface AuthorizeClassifierCopyRequest {\n /** Unique document classifier name. */\n classifierId: string;\n /** Document classifier description. */\n description?: string;\n /** List of key-value tag attributes associated with the document classifier. */\n tags?: Record<string, string>;\n}\n\n/**\n * Authorization to copy a document classifier to the specified target resource and\n * classifierId.\n */\nexport interface ClassifierCopyAuthorization {\n /** ID of the target Azure resource where the document classifier should be copied to. */\n targetResourceId: string;\n /**\n * Location of the target Azure resource where the document classifier should be copied\n * to.\n */\n targetResourceRegion: string;\n /** Identifier of the target document classifier. */\n targetClassifierId: string;\n /** URL of the copied document classifier in the target account. */\n targetClassifierLocation: string;\n /** Token used to authorize the request. */\n accessToken: string;\n /** Date/time when the access token expires. */\n expirationDateTime: Date | string;\n}\n\n/** Alias for DocumentBuildMode */\nexport type DocumentBuildMode = string;\n/** Alias for SplitMode */\nexport type SplitMode = string;\n/** Alias for DocumentFieldType */\nexport type DocumentFieldType = string;\n/** Alias for DocumentAnalysisFeature */\nexport type DocumentAnalysisFeature = string;\n/** Alias for ContentSourceKind */\nexport type ContentSourceKind = string;\n/** Alias for StringIndexType */\nexport type StringIndexType = string;\n/** Alias for DocumentContentFormat */\nexport type DocumentContentFormat = string;\n/** Alias for AnalyzeOutputOption */\nexport type AnalyzeOutputOption = string;\n"]}
|