@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
|
@@ -1,2003 +0,0 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
|
-
|
|
3
|
-
import { Client } from '@azure-rest/core-client';
|
|
4
|
-
import { ClientOptions } from '@azure-rest/core-client';
|
|
5
|
-
import { CreateHttpPollerOptions } from '@azure/core-lro';
|
|
6
|
-
import { HttpResponse } from '@azure-rest/core-client';
|
|
7
|
-
import { KeyCredential } from '@azure/core-auth';
|
|
8
|
-
import { OperationState } from '@azure/core-lro';
|
|
9
|
-
import { Paged } from '@azure/core-paging';
|
|
10
|
-
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
11
|
-
import { PathUncheckedResponse } from '@azure-rest/core-client';
|
|
12
|
-
import { RawHttpHeaders } from '@azure/core-rest-pipeline';
|
|
13
|
-
import { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
|
|
14
|
-
import { RequestParameters } from '@azure-rest/core-client';
|
|
15
|
-
import { SimplePollerLike } from '@azure/core-lro';
|
|
16
|
-
import { StreamableMethod } from '@azure-rest/core-client';
|
|
17
|
-
import { TokenCredential } from '@azure/core-auth';
|
|
18
|
-
|
|
19
|
-
/** Address field value. */
|
|
20
|
-
export declare interface AddressValueOutput {
|
|
21
|
-
/** House or building number. */
|
|
22
|
-
houseNumber?: string;
|
|
23
|
-
/** Post office box number. */
|
|
24
|
-
poBox?: string;
|
|
25
|
-
/** Street name. */
|
|
26
|
-
road?: string;
|
|
27
|
-
/** Name of city, town, village, etc. */
|
|
28
|
-
city?: string;
|
|
29
|
-
/** First-level administrative division. */
|
|
30
|
-
state?: string;
|
|
31
|
-
/** Postal code used for mail sorting. */
|
|
32
|
-
postalCode?: string;
|
|
33
|
-
/** Country/region. */
|
|
34
|
-
countryRegion?: string;
|
|
35
|
-
/** Street-level address, excluding city, state, countryRegion, and postalCode. */
|
|
36
|
-
streetAddress?: string;
|
|
37
|
-
/** Apartment or office number */
|
|
38
|
-
unit?: string;
|
|
39
|
-
/**
|
|
40
|
-
* Districts or boroughs within a city, such as Brooklyn in New York City or City
|
|
41
|
-
* of Westminster in London.
|
|
42
|
-
*/
|
|
43
|
-
cityDistrict?: string;
|
|
44
|
-
/** Second-level administrative division used in certain locales. */
|
|
45
|
-
stateDistrict?: string;
|
|
46
|
-
/** Unofficial neighborhood name, like Chinatown. */
|
|
47
|
-
suburb?: string;
|
|
48
|
-
/** Build name, such as World Trade Center. */
|
|
49
|
-
house?: string;
|
|
50
|
-
/** Floor number, such as 3F. */
|
|
51
|
-
level?: string;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
export declare interface AnalyzeDocument202Headers {
|
|
55
|
-
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
|
|
56
|
-
"retry-after"?: number;
|
|
57
|
-
"operation-location": string;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
/** The request has been accepted for processing, but processing has not yet completed. */
|
|
61
|
-
export declare interface AnalyzeDocument202Response extends HttpResponse {
|
|
62
|
-
status: "202";
|
|
63
|
-
headers: RawHttpHeaders & AnalyzeDocument202Headers;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
export declare interface AnalyzeDocumentBodyParam {
|
|
67
|
-
/** Analyze request parameters. */
|
|
68
|
-
body?: AnalyzeDocumentRequest;
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
export declare interface AnalyzeDocumentDefaultResponse extends HttpResponse {
|
|
72
|
-
status: string;
|
|
73
|
-
body: ErrorResponseOutput;
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
export declare interface AnalyzeDocumentFromStream {
|
|
77
|
-
/** Analyzes document with document model. */
|
|
78
|
-
post(options: AnalyzeDocumentFromStreamParameters): StreamableMethod<AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse>;
|
|
79
|
-
/** Analyzes document with document model. */
|
|
80
|
-
post(options: AnalyzeDocumentParameters): StreamableMethod<AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse>;
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
export declare interface AnalyzeDocumentFromStream202Headers {
|
|
84
|
-
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
|
|
85
|
-
"retry-after"?: number;
|
|
86
|
-
"operation-location": string;
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
/** The request has been accepted for processing, but processing has not yet completed. */
|
|
90
|
-
export declare interface AnalyzeDocumentFromStream202Response extends HttpResponse {
|
|
91
|
-
status: "202";
|
|
92
|
-
headers: RawHttpHeaders & AnalyzeDocumentFromStream202Headers;
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
export declare interface AnalyzeDocumentFromStreamBodyParam {
|
|
96
|
-
/**
|
|
97
|
-
* Input content.
|
|
98
|
-
*
|
|
99
|
-
* Value may contain any sequence of octets
|
|
100
|
-
*/
|
|
101
|
-
body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream;
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
export declare interface AnalyzeDocumentFromStreamDefaultResponse extends HttpResponse {
|
|
105
|
-
status: string;
|
|
106
|
-
body: ErrorResponseOutput;
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
/** The final response for long-running analyzeDocumentFromStream operation */
|
|
110
|
-
export declare interface AnalyzeDocumentFromStreamLogicalResponse extends HttpResponse {
|
|
111
|
-
status: "200";
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
export declare interface AnalyzeDocumentFromStreamMediaTypesParam {
|
|
115
|
-
/** Input content type. */
|
|
116
|
-
contentType: "application/octet-stream" | "application/pdf" | "image/jpeg" | "image/png" | "image/tiff" | "image/bmp" | "image/heif" | "text/html" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.openxmlformats-officedocument.presentationml.presentation";
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
export declare type AnalyzeDocumentFromStreamParameters = AnalyzeDocumentFromStreamQueryParam & AnalyzeDocumentFromStreamMediaTypesParam & AnalyzeDocumentFromStreamBodyParam & RequestParameters;
|
|
120
|
-
|
|
121
|
-
export declare interface AnalyzeDocumentFromStreamQueryParam {
|
|
122
|
-
queryParameters?: AnalyzeDocumentFromStreamQueryParamProperties;
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
export declare interface AnalyzeDocumentFromStreamQueryParamProperties {
|
|
126
|
-
/** List of 1-based page numbers to analyze. Ex. "1-3,5,7-9" */
|
|
127
|
-
pages?: string;
|
|
128
|
-
/**
|
|
129
|
-
* Locale hint for text recognition and document analysis. Value may contain only
|
|
130
|
-
* the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").
|
|
131
|
-
*/
|
|
132
|
-
locale?: string;
|
|
133
|
-
/**
|
|
134
|
-
* Method used to compute string offset and length.
|
|
135
|
-
*
|
|
136
|
-
* Possible values: "textElements", "unicodeCodePoint", "utf16CodeUnit"
|
|
137
|
-
*/
|
|
138
|
-
stringIndexType?: string;
|
|
139
|
-
/** List of optional analysis features. */
|
|
140
|
-
features?: string[];
|
|
141
|
-
/** List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber" */
|
|
142
|
-
queryFields?: string[];
|
|
143
|
-
/**
|
|
144
|
-
* Format of the analyze result top-level content.
|
|
145
|
-
*
|
|
146
|
-
* Possible values: "text", "markdown"
|
|
147
|
-
*/
|
|
148
|
-
outputContentFormat?: string;
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
/** The final response for long-running analyzeDocument operation */
|
|
152
|
-
export declare interface AnalyzeDocumentLogicalResponse extends HttpResponse {
|
|
153
|
-
status: "200";
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
export declare interface AnalyzeDocumentMediaTypesParam {
|
|
157
|
-
/** Input content type */
|
|
158
|
-
contentType: "application/json";
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
export declare type AnalyzeDocumentParameters = AnalyzeDocumentQueryParam & AnalyzeDocumentMediaTypesParam & AnalyzeDocumentBodyParam & RequestParameters;
|
|
162
|
-
|
|
163
|
-
export declare interface AnalyzeDocumentQueryParam {
|
|
164
|
-
queryParameters?: AnalyzeDocumentQueryParamProperties;
|
|
165
|
-
}
|
|
166
|
-
|
|
167
|
-
export declare interface AnalyzeDocumentQueryParamProperties {
|
|
168
|
-
/** List of 1-based page numbers to analyze. Ex. "1-3,5,7-9" */
|
|
169
|
-
pages?: string;
|
|
170
|
-
/**
|
|
171
|
-
* Locale hint for text recognition and document analysis. Value may contain only
|
|
172
|
-
* the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").
|
|
173
|
-
*/
|
|
174
|
-
locale?: string;
|
|
175
|
-
/**
|
|
176
|
-
* Method used to compute string offset and length.
|
|
177
|
-
*
|
|
178
|
-
* Possible values: "textElements", "unicodeCodePoint", "utf16CodeUnit"
|
|
179
|
-
*/
|
|
180
|
-
stringIndexType?: string;
|
|
181
|
-
/** List of optional analysis features. */
|
|
182
|
-
features?: string[];
|
|
183
|
-
/** List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber" */
|
|
184
|
-
queryFields?: string[];
|
|
185
|
-
/**
|
|
186
|
-
* Format of the analyze result top-level content.
|
|
187
|
-
*
|
|
188
|
-
* Possible values: "text", "markdown"
|
|
189
|
-
*/
|
|
190
|
-
outputContentFormat?: string;
|
|
191
|
-
}
|
|
192
|
-
|
|
193
|
-
/** Document analysis parameters. */
|
|
194
|
-
export declare interface AnalyzeDocumentRequest {
|
|
195
|
-
/** Document URL to analyze. Either urlSource or base64Source must be specified. */
|
|
196
|
-
urlSource?: string;
|
|
197
|
-
/**
|
|
198
|
-
* Base64 encoding of the document to analyze. Either urlSource or base64Source
|
|
199
|
-
* must be specified.
|
|
200
|
-
*/
|
|
201
|
-
base64Source?: string;
|
|
202
|
-
}
|
|
203
|
-
|
|
204
|
-
/** Status and result of the analyze operation. */
|
|
205
|
-
export declare interface AnalyzeResultOperationOutput {
|
|
206
|
-
/**
|
|
207
|
-
* Operation status. notStarted, running, succeeded, or failed
|
|
208
|
-
*
|
|
209
|
-
* Possible values: "notStarted", "running", "failed", "succeeded", "completed", "canceled"
|
|
210
|
-
*/
|
|
211
|
-
status: string;
|
|
212
|
-
/** Date and time (UTC) when the analyze operation was submitted. */
|
|
213
|
-
createdDateTime: string;
|
|
214
|
-
/** Date and time (UTC) when the status was last updated. */
|
|
215
|
-
lastUpdatedDateTime: string;
|
|
216
|
-
/** Encountered error during document analysis. */
|
|
217
|
-
error?: ErrorModelOutput;
|
|
218
|
-
/** Document analysis result. */
|
|
219
|
-
analyzeResult?: AnalyzeResultOutput;
|
|
220
|
-
}
|
|
221
|
-
|
|
222
|
-
/** Document analysis result. */
|
|
223
|
-
export declare interface AnalyzeResultOutput {
|
|
224
|
-
/** API version used to produce this result. */
|
|
225
|
-
apiVersion: string;
|
|
226
|
-
/** Document model ID used to produce this result. */
|
|
227
|
-
modelId: string;
|
|
228
|
-
/**
|
|
229
|
-
* Method used to compute string offset and length.
|
|
230
|
-
*
|
|
231
|
-
* Possible values: "textElements", "unicodeCodePoint", "utf16CodeUnit"
|
|
232
|
-
*/
|
|
233
|
-
stringIndexType: string;
|
|
234
|
-
/**
|
|
235
|
-
* Format of the analyze result top-level content.
|
|
236
|
-
*
|
|
237
|
-
* Possible values: "text", "markdown"
|
|
238
|
-
*/
|
|
239
|
-
contentFormat?: string;
|
|
240
|
-
/**
|
|
241
|
-
* Concatenate string representation of all textual and visual elements in reading
|
|
242
|
-
* order.
|
|
243
|
-
*/
|
|
244
|
-
content: string;
|
|
245
|
-
/** Analyzed pages. */
|
|
246
|
-
pages: Array<DocumentPageOutput>;
|
|
247
|
-
/** Extracted paragraphs. */
|
|
248
|
-
paragraphs?: Array<DocumentParagraphOutput>;
|
|
249
|
-
/** Extracted tables. */
|
|
250
|
-
tables?: Array<DocumentTableOutput>;
|
|
251
|
-
/** Extracted figures. */
|
|
252
|
-
figures?: Array<DocumentFigureOutput>;
|
|
253
|
-
/** Extracted lists. */
|
|
254
|
-
lists?: Array<DocumentListOutput>;
|
|
255
|
-
/** Extracted sections. */
|
|
256
|
-
sections?: Array<DocumentSectionOutput>;
|
|
257
|
-
/** Extracted key-value pairs. */
|
|
258
|
-
keyValuePairs?: Array<DocumentKeyValuePairOutput>;
|
|
259
|
-
/** Extracted font styles. */
|
|
260
|
-
styles?: Array<DocumentStyleOutput>;
|
|
261
|
-
/** Detected languages. */
|
|
262
|
-
languages?: Array<DocumentLanguageOutput>;
|
|
263
|
-
/** Extracted documents. */
|
|
264
|
-
documents?: Array<DocumentOutput>;
|
|
265
|
-
}
|
|
266
|
-
|
|
267
|
-
/** Request body to authorize document model copy. */
|
|
268
|
-
export declare interface AuthorizeCopyRequest {
|
|
269
|
-
/** Unique document model name. */
|
|
270
|
-
modelId: string;
|
|
271
|
-
/** Document model description. */
|
|
272
|
-
description?: string;
|
|
273
|
-
/** List of key-value tag attributes associated with the document model. */
|
|
274
|
-
tags?: Record<string, string>;
|
|
275
|
-
}
|
|
276
|
-
|
|
277
|
-
export declare interface AuthorizeModelCopy {
|
|
278
|
-
/**
|
|
279
|
-
* Generates authorization to copy a document model to this location with
|
|
280
|
-
* specified modelId and optional description.
|
|
281
|
-
*/
|
|
282
|
-
post(options: AuthorizeModelCopyParameters): StreamableMethod<AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse>;
|
|
283
|
-
}
|
|
284
|
-
|
|
285
|
-
/** The request has succeeded. */
|
|
286
|
-
export declare interface AuthorizeModelCopy200Response extends HttpResponse {
|
|
287
|
-
status: "200";
|
|
288
|
-
body: CopyAuthorizationOutput;
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
export declare interface AuthorizeModelCopyBodyParam {
|
|
292
|
-
/** Authorize copy request parameters. */
|
|
293
|
-
body: AuthorizeCopyRequest;
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
export declare interface AuthorizeModelCopyDefaultResponse extends HttpResponse {
|
|
297
|
-
status: string;
|
|
298
|
-
body: ErrorResponseOutput;
|
|
299
|
-
}
|
|
300
|
-
|
|
301
|
-
export declare type AuthorizeModelCopyParameters = AuthorizeModelCopyBodyParam & RequestParameters;
|
|
302
|
-
|
|
303
|
-
/** Azure Blob Storage content. */
|
|
304
|
-
export declare interface AzureBlobContentSource {
|
|
305
|
-
/** Azure Blob Storage container URL. */
|
|
306
|
-
containerUrl: string;
|
|
307
|
-
/** Blob name prefix. */
|
|
308
|
-
prefix?: string;
|
|
309
|
-
}
|
|
310
|
-
|
|
311
|
-
/** Azure Blob Storage content. */
|
|
312
|
-
export declare interface AzureBlobContentSourceOutput {
|
|
313
|
-
/** Azure Blob Storage container URL. */
|
|
314
|
-
containerUrl: string;
|
|
315
|
-
/** Blob name prefix. */
|
|
316
|
-
prefix?: string;
|
|
317
|
-
}
|
|
318
|
-
|
|
319
|
-
/** File list in Azure Blob Storage. */
|
|
320
|
-
export declare interface AzureBlobFileListContentSource {
|
|
321
|
-
/** Azure Blob Storage container URL. */
|
|
322
|
-
containerUrl: string;
|
|
323
|
-
/** Path to a JSONL file within the container specifying a subset of documents. */
|
|
324
|
-
fileList: string;
|
|
325
|
-
}
|
|
326
|
-
|
|
327
|
-
/** File list in Azure Blob Storage. */
|
|
328
|
-
export declare interface AzureBlobFileListContentSourceOutput {
|
|
329
|
-
/** Azure Blob Storage container URL. */
|
|
330
|
-
containerUrl: string;
|
|
331
|
-
/** Path to a JSONL file within the container specifying a subset of documents. */
|
|
332
|
-
fileList: string;
|
|
333
|
-
}
|
|
334
|
-
|
|
335
|
-
/** Bounding polygon on a specific page of the input. */
|
|
336
|
-
export declare interface BoundingRegionOutput {
|
|
337
|
-
/** 1-based page number of page containing the bounding region. */
|
|
338
|
-
pageNumber: number;
|
|
339
|
-
/**
|
|
340
|
-
* Bounding polygon on the page, or the entire page if not specified.
|
|
341
|
-
* Coordinates specified relative to the top-left of the page. The numbers
|
|
342
|
-
* represent the x, y values of the polygon vertices, clockwise from the left
|
|
343
|
-
* (-180 degrees inclusive) relative to the element orientation.
|
|
344
|
-
*/
|
|
345
|
-
polygon: number[];
|
|
346
|
-
}
|
|
347
|
-
|
|
348
|
-
export declare interface BuildClassifier {
|
|
349
|
-
/** Builds a custom document classifier. */
|
|
350
|
-
post(options: BuildClassifierParameters): StreamableMethod<BuildClassifier202Response | BuildClassifierDefaultResponse>;
|
|
351
|
-
}
|
|
352
|
-
|
|
353
|
-
export declare interface BuildClassifier202Headers {
|
|
354
|
-
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
|
|
355
|
-
"retry-after"?: number;
|
|
356
|
-
"operation-location": string;
|
|
357
|
-
}
|
|
358
|
-
|
|
359
|
-
/** The request has been accepted for processing, but processing has not yet completed. */
|
|
360
|
-
export declare interface BuildClassifier202Response extends HttpResponse {
|
|
361
|
-
status: "202";
|
|
362
|
-
headers: RawHttpHeaders & BuildClassifier202Headers;
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
export declare interface BuildClassifierBodyParam {
|
|
366
|
-
/** Build request parameters. */
|
|
367
|
-
body: BuildDocumentClassifierRequest;
|
|
368
|
-
}
|
|
369
|
-
|
|
370
|
-
export declare interface BuildClassifierDefaultResponse extends HttpResponse {
|
|
371
|
-
status: string;
|
|
372
|
-
body: ErrorResponseOutput;
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
/** The final response for long-running buildClassifier operation */
|
|
376
|
-
export declare interface BuildClassifierLogicalResponse extends HttpResponse {
|
|
377
|
-
status: "200";
|
|
378
|
-
}
|
|
379
|
-
|
|
380
|
-
export declare type BuildClassifierParameters = BuildClassifierBodyParam & RequestParameters;
|
|
381
|
-
|
|
382
|
-
/** Request body to build a new custom document classifier. */
|
|
383
|
-
export declare interface BuildDocumentClassifierRequest {
|
|
384
|
-
/** Unique document classifier name. */
|
|
385
|
-
classifierId: string;
|
|
386
|
-
/** Document classifier description. */
|
|
387
|
-
description?: string;
|
|
388
|
-
/** Base classifierId on top of which to train the classifier. */
|
|
389
|
-
baseClassifierId?: string;
|
|
390
|
-
/** List of document types to classify against. */
|
|
391
|
-
docTypes: Record<string, ClassifierDocumentTypeDetails>;
|
|
392
|
-
}
|
|
393
|
-
|
|
394
|
-
/** Request body to build a new custom document model. */
|
|
395
|
-
export declare interface BuildDocumentModelRequest {
|
|
396
|
-
/** Unique document model name. */
|
|
397
|
-
modelId: string;
|
|
398
|
-
/** Document model description. */
|
|
399
|
-
description?: string;
|
|
400
|
-
/**
|
|
401
|
-
* Custom document model build mode.
|
|
402
|
-
*
|
|
403
|
-
* Possible values: "template", "neural"
|
|
404
|
-
*/
|
|
405
|
-
buildMode: string;
|
|
406
|
-
/**
|
|
407
|
-
* Azure Blob Storage location containing the training data. Either
|
|
408
|
-
* azureBlobSource or azureBlobFileListSource must be specified.
|
|
409
|
-
*/
|
|
410
|
-
azureBlobSource?: AzureBlobContentSource;
|
|
411
|
-
/**
|
|
412
|
-
* Azure Blob Storage file list specifying the training data. Either
|
|
413
|
-
* azureBlobSource or azureBlobFileListSource must be specified.
|
|
414
|
-
*/
|
|
415
|
-
azureBlobFileListSource?: AzureBlobFileListContentSource;
|
|
416
|
-
/** List of key-value tag attributes associated with the document model. */
|
|
417
|
-
tags?: Record<string, string>;
|
|
418
|
-
}
|
|
419
|
-
|
|
420
|
-
export declare interface BuildModel {
|
|
421
|
-
/** Builds a custom document analysis model. */
|
|
422
|
-
post(options: BuildModelParameters): StreamableMethod<BuildModel202Response | BuildModelDefaultResponse>;
|
|
423
|
-
}
|
|
424
|
-
|
|
425
|
-
export declare interface BuildModel202Headers {
|
|
426
|
-
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
|
|
427
|
-
"retry-after"?: number;
|
|
428
|
-
"operation-location": string;
|
|
429
|
-
}
|
|
430
|
-
|
|
431
|
-
/** The request has been accepted for processing, but processing has not yet completed. */
|
|
432
|
-
export declare interface BuildModel202Response extends HttpResponse {
|
|
433
|
-
status: "202";
|
|
434
|
-
headers: RawHttpHeaders & BuildModel202Headers;
|
|
435
|
-
}
|
|
436
|
-
|
|
437
|
-
export declare interface BuildModelBodyParam {
|
|
438
|
-
/** Build request parameters. */
|
|
439
|
-
body: BuildDocumentModelRequest;
|
|
440
|
-
}
|
|
441
|
-
|
|
442
|
-
export declare interface BuildModelDefaultResponse extends HttpResponse {
|
|
443
|
-
status: string;
|
|
444
|
-
body: ErrorResponseOutput;
|
|
445
|
-
}
|
|
446
|
-
|
|
447
|
-
/** The final response for long-running buildModel operation */
|
|
448
|
-
export declare interface BuildModelLogicalResponse extends HttpResponse {
|
|
449
|
-
status: "200";
|
|
450
|
-
}
|
|
451
|
-
|
|
452
|
-
export declare type BuildModelParameters = BuildModelBodyParam & RequestParameters;
|
|
453
|
-
|
|
454
|
-
/** Classifier document type info. */
|
|
455
|
-
export declare interface ClassifierDocumentTypeDetails {
|
|
456
|
-
/**
|
|
457
|
-
* Type of training data source.
|
|
458
|
-
*
|
|
459
|
-
* Possible values: "url", "base64", "azureBlob", "azureBlobFileList"
|
|
460
|
-
*/
|
|
461
|
-
sourceKind?: string;
|
|
462
|
-
/**
|
|
463
|
-
* Azure Blob Storage location containing the training data for a classifier
|
|
464
|
-
* document type. Either azureBlobSource or azureBlobFileListSource must be
|
|
465
|
-
* specified.
|
|
466
|
-
*/
|
|
467
|
-
azureBlobSource?: AzureBlobContentSource;
|
|
468
|
-
/**
|
|
469
|
-
* Azure Blob Storage file list specifying the training data for a classifier
|
|
470
|
-
* document type. Either azureBlobSource or azureBlobFileListSource must be
|
|
471
|
-
* specified.
|
|
472
|
-
*/
|
|
473
|
-
azureBlobFileListSource?: AzureBlobFileListContentSource;
|
|
474
|
-
}
|
|
475
|
-
|
|
476
|
-
/** Classifier document type info. */
|
|
477
|
-
export declare interface ClassifierDocumentTypeDetailsOutput {
|
|
478
|
-
/**
|
|
479
|
-
* Type of training data source.
|
|
480
|
-
*
|
|
481
|
-
* Possible values: "url", "base64", "azureBlob", "azureBlobFileList"
|
|
482
|
-
*/
|
|
483
|
-
sourceKind?: string;
|
|
484
|
-
/**
|
|
485
|
-
* Azure Blob Storage location containing the training data for a classifier
|
|
486
|
-
* document type. Either azureBlobSource or azureBlobFileListSource must be
|
|
487
|
-
* specified.
|
|
488
|
-
*/
|
|
489
|
-
azureBlobSource?: AzureBlobContentSourceOutput;
|
|
490
|
-
/**
|
|
491
|
-
* Azure Blob Storage file list specifying the training data for a classifier
|
|
492
|
-
* document type. Either azureBlobSource or azureBlobFileListSource must be
|
|
493
|
-
* specified.
|
|
494
|
-
*/
|
|
495
|
-
azureBlobFileListSource?: AzureBlobFileListContentSourceOutput;
|
|
496
|
-
}
|
|
497
|
-
|
|
498
|
-
export declare interface ClassifyDocument202Headers {
|
|
499
|
-
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
|
|
500
|
-
"retry-after"?: number;
|
|
501
|
-
"operation-location": string;
|
|
502
|
-
}
|
|
503
|
-
|
|
504
|
-
/** The request has been accepted for processing, but processing has not yet completed. */
|
|
505
|
-
export declare interface ClassifyDocument202Response extends HttpResponse {
|
|
506
|
-
status: "202";
|
|
507
|
-
headers: RawHttpHeaders & ClassifyDocument202Headers;
|
|
508
|
-
}
|
|
509
|
-
|
|
510
|
-
export declare interface ClassifyDocumentBodyParam {
|
|
511
|
-
/** Classify request parameters. */
|
|
512
|
-
body: ClassifyDocumentRequest;
|
|
513
|
-
}
|
|
514
|
-
|
|
515
|
-
export declare interface ClassifyDocumentDefaultResponse extends HttpResponse {
|
|
516
|
-
status: string;
|
|
517
|
-
body: ErrorResponseOutput;
|
|
518
|
-
}
|
|
519
|
-
|
|
520
|
-
export declare interface ClassifyDocumentFromStream {
|
|
521
|
-
/** Classifies document with document classifier. */
|
|
522
|
-
post(options: ClassifyDocumentFromStreamParameters): StreamableMethod<ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse>;
|
|
523
|
-
/** Classifies document with document classifier. */
|
|
524
|
-
post(options: ClassifyDocumentParameters): StreamableMethod<ClassifyDocument202Response | ClassifyDocumentDefaultResponse>;
|
|
525
|
-
}
|
|
526
|
-
|
|
527
|
-
export declare interface ClassifyDocumentFromStream202Headers {
|
|
528
|
-
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
|
|
529
|
-
"retry-after"?: number;
|
|
530
|
-
"operation-location": string;
|
|
531
|
-
}
|
|
532
|
-
|
|
533
|
-
/** The request has been accepted for processing, but processing has not yet completed. */
|
|
534
|
-
export declare interface ClassifyDocumentFromStream202Response extends HttpResponse {
|
|
535
|
-
status: "202";
|
|
536
|
-
headers: RawHttpHeaders & ClassifyDocumentFromStream202Headers;
|
|
537
|
-
}
|
|
538
|
-
|
|
539
|
-
export declare interface ClassifyDocumentFromStreamBodyParam {
|
|
540
|
-
/**
|
|
541
|
-
* Input content.
|
|
542
|
-
*
|
|
543
|
-
* Value may contain any sequence of octets
|
|
544
|
-
*/
|
|
545
|
-
body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream;
|
|
546
|
-
}
|
|
547
|
-
|
|
548
|
-
export declare interface ClassifyDocumentFromStreamDefaultResponse extends HttpResponse {
|
|
549
|
-
status: string;
|
|
550
|
-
body: ErrorResponseOutput;
|
|
551
|
-
}
|
|
552
|
-
|
|
553
|
-
/** The final response for long-running classifyDocumentFromStream operation */
|
|
554
|
-
export declare interface ClassifyDocumentFromStreamLogicalResponse extends HttpResponse {
|
|
555
|
-
status: "200";
|
|
556
|
-
}
|
|
557
|
-
|
|
558
|
-
export declare interface ClassifyDocumentFromStreamMediaTypesParam {
|
|
559
|
-
/** Input content type. */
|
|
560
|
-
contentType: "application/octet-stream" | "application/pdf" | "image/jpeg" | "image/png" | "image/tiff" | "image/bmp" | "image/heif" | "text/html" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.openxmlformats-officedocument.presentationml.presentation";
|
|
561
|
-
}
|
|
562
|
-
|
|
563
|
-
export declare type ClassifyDocumentFromStreamParameters = ClassifyDocumentFromStreamQueryParam & ClassifyDocumentFromStreamMediaTypesParam & ClassifyDocumentFromStreamBodyParam & RequestParameters;
|
|
564
|
-
|
|
565
|
-
export declare interface ClassifyDocumentFromStreamQueryParam {
|
|
566
|
-
queryParameters?: ClassifyDocumentFromStreamQueryParamProperties;
|
|
567
|
-
}
|
|
568
|
-
|
|
569
|
-
export declare interface ClassifyDocumentFromStreamQueryParamProperties {
|
|
570
|
-
/**
|
|
571
|
-
* Method used to compute string offset and length.
|
|
572
|
-
*
|
|
573
|
-
* Possible values: "textElements", "unicodeCodePoint", "utf16CodeUnit"
|
|
574
|
-
*/
|
|
575
|
-
stringIndexType?: string;
|
|
576
|
-
/**
|
|
577
|
-
* Document splitting mode.
|
|
578
|
-
*
|
|
579
|
-
* Possible values: "auto", "none", "perPage"
|
|
580
|
-
*/
|
|
581
|
-
split?: string;
|
|
582
|
-
}
|
|
583
|
-
|
|
584
|
-
/** The final response for long-running classifyDocument operation */
|
|
585
|
-
export declare interface ClassifyDocumentLogicalResponse extends HttpResponse {
|
|
586
|
-
status: "200";
|
|
587
|
-
}
|
|
588
|
-
|
|
589
|
-
export declare interface ClassifyDocumentMediaTypesParam {
|
|
590
|
-
/** Input content type */
|
|
591
|
-
contentType: "application/json";
|
|
592
|
-
}
|
|
593
|
-
|
|
594
|
-
export declare type ClassifyDocumentParameters = ClassifyDocumentQueryParam & ClassifyDocumentMediaTypesParam & ClassifyDocumentBodyParam & RequestParameters;
|
|
595
|
-
|
|
596
|
-
export declare interface ClassifyDocumentQueryParam {
|
|
597
|
-
queryParameters?: ClassifyDocumentQueryParamProperties;
|
|
598
|
-
}
|
|
599
|
-
|
|
600
|
-
export declare interface ClassifyDocumentQueryParamProperties {
|
|
601
|
-
/**
|
|
602
|
-
* Method used to compute string offset and length.
|
|
603
|
-
*
|
|
604
|
-
* Possible values: "textElements", "unicodeCodePoint", "utf16CodeUnit"
|
|
605
|
-
*/
|
|
606
|
-
stringIndexType?: string;
|
|
607
|
-
/**
|
|
608
|
-
* Document splitting mode.
|
|
609
|
-
*
|
|
610
|
-
* Possible values: "auto", "none", "perPage"
|
|
611
|
-
*/
|
|
612
|
-
split?: string;
|
|
613
|
-
}
|
|
614
|
-
|
|
615
|
-
/** Document classification parameters. */
|
|
616
|
-
export declare interface ClassifyDocumentRequest {
|
|
617
|
-
/** Document URL to classify. Either urlSource or base64Source must be specified. */
|
|
618
|
-
urlSource?: string;
|
|
619
|
-
/**
|
|
620
|
-
* Base64 encoding of the document to classify. Either urlSource or base64Source
|
|
621
|
-
* must be specified.
|
|
622
|
-
*/
|
|
623
|
-
base64Source?: string;
|
|
624
|
-
}
|
|
625
|
-
|
|
626
|
-
/** Provides the 'x-ms-client-request-id' header to enable request correlation in requests and responses. */
|
|
627
|
-
export declare interface ClientRequestIdHeaderOutput {
|
|
628
|
-
}
|
|
629
|
-
|
|
630
|
-
/** A component of a composed document model. */
|
|
631
|
-
export declare interface ComponentDocumentModelDetails {
|
|
632
|
-
/** Unique document model name. */
|
|
633
|
-
modelId: string;
|
|
634
|
-
}
|
|
635
|
-
|
|
636
|
-
/** Request body to create a composed document model from component document models. */
|
|
637
|
-
export declare interface ComposeDocumentModelRequest {
|
|
638
|
-
/** Unique document model name. */
|
|
639
|
-
modelId: string;
|
|
640
|
-
/** Document model description. */
|
|
641
|
-
description?: string;
|
|
642
|
-
/** List of component document models to compose. */
|
|
643
|
-
componentModels: Array<ComponentDocumentModelDetails>;
|
|
644
|
-
/** List of key-value tag attributes associated with the document model. */
|
|
645
|
-
tags?: Record<string, string>;
|
|
646
|
-
}
|
|
647
|
-
|
|
648
|
-
export declare interface ComposeModel {
|
|
649
|
-
/** Creates a new document model from document types of existing document models. */
|
|
650
|
-
post(options: ComposeModelParameters): StreamableMethod<ComposeModel202Response | ComposeModelDefaultResponse>;
|
|
651
|
-
}
|
|
652
|
-
|
|
653
|
-
export declare interface ComposeModel202Headers {
|
|
654
|
-
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
|
|
655
|
-
"retry-after"?: number;
|
|
656
|
-
"operation-location": string;
|
|
657
|
-
}
|
|
658
|
-
|
|
659
|
-
/** The request has been accepted for processing, but processing has not yet completed. */
|
|
660
|
-
export declare interface ComposeModel202Response extends HttpResponse {
|
|
661
|
-
status: "202";
|
|
662
|
-
headers: RawHttpHeaders & ComposeModel202Headers;
|
|
663
|
-
}
|
|
664
|
-
|
|
665
|
-
export declare interface ComposeModelBodyParam {
|
|
666
|
-
/** Compose request parameters. */
|
|
667
|
-
body: ComposeDocumentModelRequest;
|
|
668
|
-
}
|
|
669
|
-
|
|
670
|
-
export declare interface ComposeModelDefaultResponse extends HttpResponse {
|
|
671
|
-
status: string;
|
|
672
|
-
body: ErrorResponseOutput;
|
|
673
|
-
}
|
|
674
|
-
|
|
675
|
-
/** The final response for long-running composeModel operation */
|
|
676
|
-
export declare interface ComposeModelLogicalResponse extends HttpResponse {
|
|
677
|
-
status: "200";
|
|
678
|
-
}
|
|
679
|
-
|
|
680
|
-
export declare type ComposeModelParameters = ComposeModelBodyParam & RequestParameters;
|
|
681
|
-
|
|
682
|
-
/**
|
|
683
|
-
* Authorization to copy a document model to the specified target resource and
|
|
684
|
-
* modelId.
|
|
685
|
-
*/
|
|
686
|
-
export declare interface CopyAuthorization {
|
|
687
|
-
/** ID of the target Azure resource where the document model should be copied to. */
|
|
688
|
-
targetResourceId: string;
|
|
689
|
-
/**
|
|
690
|
-
* Location of the target Azure resource where the document model should be copied
|
|
691
|
-
* to.
|
|
692
|
-
*/
|
|
693
|
-
targetResourceRegion: string;
|
|
694
|
-
/** Identifier of the target document model. */
|
|
695
|
-
targetModelId: string;
|
|
696
|
-
/** URL of the copied document model in the target account. */
|
|
697
|
-
targetModelLocation: string;
|
|
698
|
-
/** Token used to authorize the request. */
|
|
699
|
-
accessToken: string;
|
|
700
|
-
/** Date/time when the access token expires. */
|
|
701
|
-
expirationDateTime: Date | string;
|
|
702
|
-
}
|
|
703
|
-
|
|
704
|
-
/**
|
|
705
|
-
* Authorization to copy a document model to the specified target resource and
|
|
706
|
-
* modelId.
|
|
707
|
-
*/
|
|
708
|
-
export declare interface CopyAuthorizationOutput {
|
|
709
|
-
/** ID of the target Azure resource where the document model should be copied to. */
|
|
710
|
-
targetResourceId: string;
|
|
711
|
-
/**
|
|
712
|
-
* Location of the target Azure resource where the document model should be copied
|
|
713
|
-
* to.
|
|
714
|
-
*/
|
|
715
|
-
targetResourceRegion: string;
|
|
716
|
-
/** Identifier of the target document model. */
|
|
717
|
-
targetModelId: string;
|
|
718
|
-
/** URL of the copied document model in the target account. */
|
|
719
|
-
targetModelLocation: string;
|
|
720
|
-
/** Token used to authorize the request. */
|
|
721
|
-
accessToken: string;
|
|
722
|
-
/** Date/time when the access token expires. */
|
|
723
|
-
expirationDateTime: string;
|
|
724
|
-
}
|
|
725
|
-
|
|
726
|
-
export declare interface CopyModelTo {
|
|
727
|
-
/** Copies document model to the target resource, region, and modelId. */
|
|
728
|
-
post(options: CopyModelToParameters): StreamableMethod<CopyModelTo202Response | CopyModelToDefaultResponse>;
|
|
729
|
-
}
|
|
730
|
-
|
|
731
|
-
export declare interface CopyModelTo202Headers {
|
|
732
|
-
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
|
|
733
|
-
"retry-after"?: number;
|
|
734
|
-
"operation-location": string;
|
|
735
|
-
}
|
|
736
|
-
|
|
737
|
-
/** The request has been accepted for processing, but processing has not yet completed. */
|
|
738
|
-
export declare interface CopyModelTo202Response extends HttpResponse {
|
|
739
|
-
status: "202";
|
|
740
|
-
headers: RawHttpHeaders & CopyModelTo202Headers;
|
|
741
|
-
}
|
|
742
|
-
|
|
743
|
-
export declare interface CopyModelToBodyParam {
|
|
744
|
-
/** Copy to request parameters. */
|
|
745
|
-
body: CopyAuthorization;
|
|
746
|
-
}
|
|
747
|
-
|
|
748
|
-
export declare interface CopyModelToDefaultResponse extends HttpResponse {
|
|
749
|
-
status: string;
|
|
750
|
-
body: ErrorResponseOutput;
|
|
751
|
-
}
|
|
752
|
-
|
|
753
|
-
/** The final response for long-running copyModelTo operation */
|
|
754
|
-
export declare interface CopyModelToLogicalResponse extends HttpResponse {
|
|
755
|
-
status: "200";
|
|
756
|
-
}
|
|
757
|
-
|
|
758
|
-
export declare type CopyModelToParameters = CopyModelToBodyParam & RequestParameters;
|
|
759
|
-
|
|
760
|
-
/**
|
|
761
|
-
* Initialize a new instance of `DocumentIntelligenceClient`
|
|
762
|
-
* @param endpoint - The Document Intelligence service endpoint.
|
|
763
|
-
* @param credentials - uniquely identify client credential
|
|
764
|
-
* @param options - the parameter for all optional parameters
|
|
765
|
-
*/
|
|
766
|
-
declare function createClient(endpoint: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): DocumentIntelligenceClient;
|
|
767
|
-
export default createClient;
|
|
768
|
-
|
|
769
|
-
/** Currency field value. */
|
|
770
|
-
export declare interface CurrencyValueOutput {
|
|
771
|
-
/** Currency amount. */
|
|
772
|
-
amount: number;
|
|
773
|
-
/** Currency symbol label, if any. */
|
|
774
|
-
currencySymbol?: string;
|
|
775
|
-
/** Resolved currency code (ISO 4217), if any. */
|
|
776
|
-
currencyCode?: string;
|
|
777
|
-
}
|
|
778
|
-
|
|
779
|
-
/** Details regarding custom document models. */
|
|
780
|
-
export declare interface CustomDocumentModelsDetailsOutput {
|
|
781
|
-
/** Number of custom document models in the current resource. */
|
|
782
|
-
count: number;
|
|
783
|
-
/** Maximum number of custom document models supported in the current resource. */
|
|
784
|
-
limit: number;
|
|
785
|
-
}
|
|
786
|
-
|
|
787
|
-
export declare interface DeleteClassifier204Headers {
|
|
788
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
789
|
-
"x-ms-client-request-id"?: string;
|
|
790
|
-
}
|
|
791
|
-
|
|
792
|
-
/** There is no content to send for this request, but the headers may be useful. */
|
|
793
|
-
export declare interface DeleteClassifier204Response extends HttpResponse {
|
|
794
|
-
status: "204";
|
|
795
|
-
headers: RawHttpHeaders & DeleteClassifier204Headers;
|
|
796
|
-
}
|
|
797
|
-
|
|
798
|
-
export declare interface DeleteClassifierDefaultResponse extends HttpResponse {
|
|
799
|
-
status: string;
|
|
800
|
-
body: ErrorResponseOutput;
|
|
801
|
-
}
|
|
802
|
-
|
|
803
|
-
export declare interface DeleteClassifierHeaderParam {
|
|
804
|
-
headers?: RawHttpHeadersInput & DeleteClassifierHeaders;
|
|
805
|
-
}
|
|
806
|
-
|
|
807
|
-
export declare interface DeleteClassifierHeaders {
|
|
808
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
809
|
-
"x-ms-client-request-id"?: string;
|
|
810
|
-
}
|
|
811
|
-
|
|
812
|
-
export declare type DeleteClassifierParameters = DeleteClassifierHeaderParam & RequestParameters;
|
|
813
|
-
|
|
814
|
-
export declare interface DeleteModel204Headers {
|
|
815
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
816
|
-
"x-ms-client-request-id"?: string;
|
|
817
|
-
}
|
|
818
|
-
|
|
819
|
-
/** There is no content to send for this request, but the headers may be useful. */
|
|
820
|
-
export declare interface DeleteModel204Response extends HttpResponse {
|
|
821
|
-
status: "204";
|
|
822
|
-
headers: RawHttpHeaders & DeleteModel204Headers;
|
|
823
|
-
}
|
|
824
|
-
|
|
825
|
-
export declare interface DeleteModelDefaultResponse extends HttpResponse {
|
|
826
|
-
status: string;
|
|
827
|
-
body: ErrorResponseOutput;
|
|
828
|
-
}
|
|
829
|
-
|
|
830
|
-
export declare interface DeleteModelHeaderParam {
|
|
831
|
-
headers?: RawHttpHeadersInput & DeleteModelHeaders;
|
|
832
|
-
}
|
|
833
|
-
|
|
834
|
-
export declare interface DeleteModelHeaders {
|
|
835
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
836
|
-
"x-ms-client-request-id"?: string;
|
|
837
|
-
}
|
|
838
|
-
|
|
839
|
-
export declare type DeleteModelParameters = DeleteModelHeaderParam & RequestParameters;
|
|
840
|
-
|
|
841
|
-
/** A barcode object. */
|
|
842
|
-
export declare interface DocumentBarcodeOutput {
|
|
843
|
-
/**
|
|
844
|
-
* Barcode kind.
|
|
845
|
-
*
|
|
846
|
-
* Possible values: "QRCode", "PDF417", "UPCA", "UPCE", "Code39", "Code128", "EAN8", "EAN13", "DataBar", "Code93", "Codabar", "DataBarExpanded", "ITF", "MicroQRCode", "Aztec", "DataMatrix", "MaxiCode"
|
|
847
|
-
*/
|
|
848
|
-
kind: string;
|
|
849
|
-
/** Barcode value. */
|
|
850
|
-
value: string;
|
|
851
|
-
/**
|
|
852
|
-
* Bounding polygon of the barcode, with coordinates specified relative to the
|
|
853
|
-
* top-left of the page. The numbers represent the x, y values of the polygon
|
|
854
|
-
* vertices, clockwise from the left (-180 degrees inclusive) relative to the
|
|
855
|
-
* element orientation.
|
|
856
|
-
*/
|
|
857
|
-
polygon?: number[];
|
|
858
|
-
/** Location of the barcode in the reading order concatenated content. */
|
|
859
|
-
span: DocumentSpanOutput;
|
|
860
|
-
/** Confidence of correctly extracting the barcode. */
|
|
861
|
-
confidence: number;
|
|
862
|
-
}
|
|
863
|
-
|
|
864
|
-
/** A caption object describing a table or figure. */
|
|
865
|
-
export declare interface DocumentCaptionOutput {
|
|
866
|
-
/** Content of the caption. */
|
|
867
|
-
content: string;
|
|
868
|
-
/** Bounding regions covering the caption. */
|
|
869
|
-
boundingRegions?: Array<BoundingRegionOutput>;
|
|
870
|
-
/** Location of the caption in the reading order concatenated content. */
|
|
871
|
-
spans: Array<DocumentSpanOutput>;
|
|
872
|
-
/** Child elements of the caption. */
|
|
873
|
-
elements?: string[];
|
|
874
|
-
}
|
|
875
|
-
|
|
876
|
-
/** Get Operation response object. */
|
|
877
|
-
export declare interface DocumentClassifierBuildOperationDetailsOutput extends OperationDetailsOutputParent {
|
|
878
|
-
/** Operation result upon success. */
|
|
879
|
-
result?: DocumentClassifierDetailsOutput;
|
|
880
|
-
/** Type of operation. */
|
|
881
|
-
kind: "documentClassifierBuild";
|
|
882
|
-
}
|
|
883
|
-
|
|
884
|
-
/** Document classifier info. */
|
|
885
|
-
export declare interface DocumentClassifierDetailsOutput {
|
|
886
|
-
/** Unique document classifier name. */
|
|
887
|
-
classifierId: string;
|
|
888
|
-
/** Document classifier description. */
|
|
889
|
-
description?: string;
|
|
890
|
-
/** Date and time (UTC) when the document classifier was created. */
|
|
891
|
-
createdDateTime: string;
|
|
892
|
-
/** Date and time (UTC) when the document classifier will expire. */
|
|
893
|
-
expirationDateTime?: string;
|
|
894
|
-
/** API version used to create this document classifier. */
|
|
895
|
-
apiVersion: string;
|
|
896
|
-
/** Base classifierId on top of which the classifier was trained. */
|
|
897
|
-
baseClassifierId?: string;
|
|
898
|
-
/** List of document types to classify against. */
|
|
899
|
-
docTypes: Record<string, ClassifierDocumentTypeDetailsOutput>;
|
|
900
|
-
/** List of warnings encountered while building the classifier. */
|
|
901
|
-
warnings?: Array<WarningOutput>;
|
|
902
|
-
}
|
|
903
|
-
|
|
904
|
-
/** An object representing the content and location of a field value. */
|
|
905
|
-
export declare interface DocumentFieldOutput {
|
|
906
|
-
/**
|
|
907
|
-
* Data type of the field value.
|
|
908
|
-
*
|
|
909
|
-
* Possible values: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"
|
|
910
|
-
*/
|
|
911
|
-
type: string;
|
|
912
|
-
/** String value. */
|
|
913
|
-
valueString?: string;
|
|
914
|
-
/** Date value in YYYY-MM-DD format (ISO 8601). */
|
|
915
|
-
valueDate?: string;
|
|
916
|
-
/** Time value in hh:mm:ss format (ISO 8601). */
|
|
917
|
-
valueTime?: string;
|
|
918
|
-
/** Phone number value in E.164 format (ex. +19876543210). */
|
|
919
|
-
valuePhoneNumber?: string;
|
|
920
|
-
/** Floating point value. */
|
|
921
|
-
valueNumber?: number;
|
|
922
|
-
/** Integer value. */
|
|
923
|
-
valueInteger?: number;
|
|
924
|
-
/**
|
|
925
|
-
* Selection mark value.
|
|
926
|
-
*
|
|
927
|
-
* Possible values: "selected", "unselected"
|
|
928
|
-
*/
|
|
929
|
-
valueSelectionMark?: string;
|
|
930
|
-
/**
|
|
931
|
-
* Presence of signature.
|
|
932
|
-
*
|
|
933
|
-
* Possible values: "signed", "unsigned"
|
|
934
|
-
*/
|
|
935
|
-
valueSignature?: string;
|
|
936
|
-
/** 3-letter country code value (ISO 3166-1 alpha-3). */
|
|
937
|
-
valueCountryRegion?: string;
|
|
938
|
-
/** Array of field values. */
|
|
939
|
-
valueArray?: Array<DocumentFieldOutput>;
|
|
940
|
-
/** Dictionary of named field values. */
|
|
941
|
-
valueObject?: Record<string, DocumentFieldOutput>;
|
|
942
|
-
/** Currency value. */
|
|
943
|
-
valueCurrency?: CurrencyValueOutput;
|
|
944
|
-
/** Address value. */
|
|
945
|
-
valueAddress?: AddressValueOutput;
|
|
946
|
-
/** Boolean value. */
|
|
947
|
-
valueBoolean?: boolean;
|
|
948
|
-
/** Selection group value. */
|
|
949
|
-
valueSelectionGroup?: string[];
|
|
950
|
-
/** Field content. */
|
|
951
|
-
content?: string;
|
|
952
|
-
/** Bounding regions covering the field. */
|
|
953
|
-
boundingRegions?: Array<BoundingRegionOutput>;
|
|
954
|
-
/** Location of the field in the reading order concatenated content. */
|
|
955
|
-
spans?: Array<DocumentSpanOutput>;
|
|
956
|
-
/** Confidence of correctly extracting the field. */
|
|
957
|
-
confidence?: number;
|
|
958
|
-
}
|
|
959
|
-
|
|
960
|
-
/** Description of the field semantic schema using a JSON Schema style syntax. */
|
|
961
|
-
export declare interface DocumentFieldSchemaOutput {
|
|
962
|
-
/**
|
|
963
|
-
* Semantic data type of the field value.
|
|
964
|
-
*
|
|
965
|
-
* Possible values: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"
|
|
966
|
-
*/
|
|
967
|
-
type: string;
|
|
968
|
-
/** Field description. */
|
|
969
|
-
description?: string;
|
|
970
|
-
/** Example field content. */
|
|
971
|
-
example?: string;
|
|
972
|
-
/** Field type schema of each array element. */
|
|
973
|
-
items?: DocumentFieldSchemaOutput;
|
|
974
|
-
/** Named sub-fields of the object field. */
|
|
975
|
-
properties?: Record<string, DocumentFieldSchemaOutput>;
|
|
976
|
-
}
|
|
977
|
-
|
|
978
|
-
/** An object representing a figure in the document. */
|
|
979
|
-
export declare interface DocumentFigureOutput {
|
|
980
|
-
/** Bounding regions covering the figure. */
|
|
981
|
-
boundingRegions?: Array<BoundingRegionOutput>;
|
|
982
|
-
/** Location of the figure in the reading order concatenated content. */
|
|
983
|
-
spans: Array<DocumentSpanOutput>;
|
|
984
|
-
/** Child elements of the figure, excluding any caption or footnotes. */
|
|
985
|
-
elements?: string[];
|
|
986
|
-
/** Caption associated with the figure. */
|
|
987
|
-
caption?: DocumentCaptionOutput;
|
|
988
|
-
/** List of footnotes associated with the figure. */
|
|
989
|
-
footnotes?: Array<DocumentFootnoteOutput>;
|
|
990
|
-
}
|
|
991
|
-
|
|
992
|
-
/** A footnote object describing a table or figure. */
|
|
993
|
-
export declare interface DocumentFootnoteOutput {
|
|
994
|
-
/** Content of the footnote. */
|
|
995
|
-
content: string;
|
|
996
|
-
/** Bounding regions covering the footnote. */
|
|
997
|
-
boundingRegions?: Array<BoundingRegionOutput>;
|
|
998
|
-
/** Location of the footnote in the reading order concatenated content. */
|
|
999
|
-
spans: Array<DocumentSpanOutput>;
|
|
1000
|
-
/** Child elements of the footnote. */
|
|
1001
|
-
elements?: string[];
|
|
1002
|
-
}
|
|
1003
|
-
|
|
1004
|
-
/** A formula object. */
|
|
1005
|
-
export declare interface DocumentFormulaOutput {
|
|
1006
|
-
/**
|
|
1007
|
-
* Formula kind.
|
|
1008
|
-
*
|
|
1009
|
-
* Possible values: "inline", "display"
|
|
1010
|
-
*/
|
|
1011
|
-
kind: string;
|
|
1012
|
-
/** LaTex expression describing the formula. */
|
|
1013
|
-
value: string;
|
|
1014
|
-
/**
|
|
1015
|
-
* Bounding polygon of the formula, with coordinates specified relative to the
|
|
1016
|
-
* top-left of the page. The numbers represent the x, y values of the polygon
|
|
1017
|
-
* vertices, clockwise from the left (-180 degrees inclusive) relative to the
|
|
1018
|
-
* element orientation.
|
|
1019
|
-
*/
|
|
1020
|
-
polygon?: number[];
|
|
1021
|
-
/** Location of the formula in the reading order concatenated content. */
|
|
1022
|
-
span: DocumentSpanOutput;
|
|
1023
|
-
/** Confidence of correctly extracting the formula. */
|
|
1024
|
-
confidence: number;
|
|
1025
|
-
}
|
|
1026
|
-
|
|
1027
|
-
export declare type DocumentIntelligenceClient = Client & {
|
|
1028
|
-
path: Routes;
|
|
1029
|
-
};
|
|
1030
|
-
|
|
1031
|
-
/** An object representing the field key or value in a key-value pair. */
|
|
1032
|
-
export declare interface DocumentKeyValueElementOutput {
|
|
1033
|
-
/** Concatenated content of the key-value element in reading order. */
|
|
1034
|
-
content: string;
|
|
1035
|
-
/** Bounding regions covering the key-value element. */
|
|
1036
|
-
boundingRegions?: Array<BoundingRegionOutput>;
|
|
1037
|
-
/** Location of the key-value element in the reading order concatenated content. */
|
|
1038
|
-
spans: Array<DocumentSpanOutput>;
|
|
1039
|
-
}
|
|
1040
|
-
|
|
1041
|
-
/**
|
|
1042
|
-
* An object representing a form field with distinct field label (key) and field
|
|
1043
|
-
* value (may be empty).
|
|
1044
|
-
*/
|
|
1045
|
-
export declare interface DocumentKeyValuePairOutput {
|
|
1046
|
-
/** Field label of the key-value pair. */
|
|
1047
|
-
key: DocumentKeyValueElementOutput;
|
|
1048
|
-
/** Field value of the key-value pair. */
|
|
1049
|
-
value?: DocumentKeyValueElementOutput;
|
|
1050
|
-
/** Confidence of correctly extracting the key-value pair. */
|
|
1051
|
-
confidence: number;
|
|
1052
|
-
}
|
|
1053
|
-
|
|
1054
|
-
/** An object representing the detected language for a given text span. */
|
|
1055
|
-
export declare interface DocumentLanguageOutput {
|
|
1056
|
-
/**
|
|
1057
|
-
* Detected language. Value may an ISO 639-1 language code (ex. "en", "fr")
|
|
1058
|
-
* or BCP 47 language tag (ex. "zh-Hans").
|
|
1059
|
-
*/
|
|
1060
|
-
locale: string;
|
|
1061
|
-
/**
|
|
1062
|
-
* Location of the text elements in the concatenated content the language applies
|
|
1063
|
-
* to.
|
|
1064
|
-
*/
|
|
1065
|
-
spans: Array<DocumentSpanOutput>;
|
|
1066
|
-
/** Confidence of correctly identifying the language. */
|
|
1067
|
-
confidence: number;
|
|
1068
|
-
}
|
|
1069
|
-
|
|
1070
|
-
/**
|
|
1071
|
-
* A content line object consisting of an adjacent sequence of content elements,
|
|
1072
|
-
* such as words and selection marks.
|
|
1073
|
-
*/
|
|
1074
|
-
export declare interface DocumentLineOutput {
|
|
1075
|
-
/** Concatenated content of the contained elements in reading order. */
|
|
1076
|
-
content: string;
|
|
1077
|
-
/**
|
|
1078
|
-
* Bounding polygon of the line, with coordinates specified relative to the
|
|
1079
|
-
* top-left of the page. The numbers represent the x, y values of the polygon
|
|
1080
|
-
* vertices, clockwise from the left (-180 degrees inclusive) relative to the
|
|
1081
|
-
* element orientation.
|
|
1082
|
-
*/
|
|
1083
|
-
polygon?: number[];
|
|
1084
|
-
/** Location of the line in the reading order concatenated content. */
|
|
1085
|
-
spans: Array<DocumentSpanOutput>;
|
|
1086
|
-
}
|
|
1087
|
-
|
|
1088
|
-
/** An object representing a list item in the document. */
|
|
1089
|
-
export declare interface DocumentListItemOutput {
|
|
1090
|
-
/** Level of the list item (1-indexed). */
|
|
1091
|
-
level: number;
|
|
1092
|
-
/** Content of the list item. */
|
|
1093
|
-
content: string;
|
|
1094
|
-
/** Bounding regions covering the list item. */
|
|
1095
|
-
boundingRegions?: Array<BoundingRegionOutput>;
|
|
1096
|
-
/** Location of the list item in the reading order concatenated content. */
|
|
1097
|
-
spans: Array<DocumentSpanOutput>;
|
|
1098
|
-
/** Child elements of the list item. */
|
|
1099
|
-
elements?: string[];
|
|
1100
|
-
}
|
|
1101
|
-
|
|
1102
|
-
/** An object representing a list in the document. */
|
|
1103
|
-
export declare interface DocumentListOutput {
|
|
1104
|
-
/** Location of the list in the reading order concatenated content. */
|
|
1105
|
-
spans: Array<DocumentSpanOutput>;
|
|
1106
|
-
/** Items in the list. */
|
|
1107
|
-
items: Array<DocumentListItemOutput>;
|
|
1108
|
-
}
|
|
1109
|
-
|
|
1110
|
-
/** Get Operation response object. */
|
|
1111
|
-
export declare interface DocumentModelBuildOperationDetailsOutput extends OperationDetailsOutputParent {
|
|
1112
|
-
/** Operation result upon success. */
|
|
1113
|
-
result?: DocumentModelDetailsOutput;
|
|
1114
|
-
/** Type of operation. */
|
|
1115
|
-
kind: "documentModelBuild";
|
|
1116
|
-
}
|
|
1117
|
-
|
|
1118
|
-
/** Get Operation response object. */
|
|
1119
|
-
export declare interface DocumentModelComposeOperationDetailsOutput extends OperationDetailsOutputParent {
|
|
1120
|
-
/** Operation result upon success. */
|
|
1121
|
-
result?: DocumentModelDetailsOutput;
|
|
1122
|
-
/** Type of operation. */
|
|
1123
|
-
kind: "documentModelCompose";
|
|
1124
|
-
}
|
|
1125
|
-
|
|
1126
|
-
/** Get Operation response object. */
|
|
1127
|
-
export declare interface DocumentModelCopyToOperationDetailsOutput extends OperationDetailsOutputParent {
|
|
1128
|
-
/** Operation result upon success. */
|
|
1129
|
-
result?: DocumentModelDetailsOutput;
|
|
1130
|
-
/** Type of operation. */
|
|
1131
|
-
kind: "documentModelCopyTo";
|
|
1132
|
-
}
|
|
1133
|
-
|
|
1134
|
-
/** Document model info. */
|
|
1135
|
-
export declare interface DocumentModelDetailsOutput {
|
|
1136
|
-
/** Unique document model name. */
|
|
1137
|
-
modelId: string;
|
|
1138
|
-
/** Document model description. */
|
|
1139
|
-
description?: string;
|
|
1140
|
-
/** Date and time (UTC) when the document model was created. */
|
|
1141
|
-
createdDateTime: string;
|
|
1142
|
-
/** Date and time (UTC) when the document model will expire. */
|
|
1143
|
-
expirationDateTime?: string;
|
|
1144
|
-
/** API version used to create this document model. */
|
|
1145
|
-
apiVersion?: string;
|
|
1146
|
-
/** List of key-value tag attributes associated with the document model. */
|
|
1147
|
-
tags?: Record<string, string>;
|
|
1148
|
-
/**
|
|
1149
|
-
* Custom document model build mode.
|
|
1150
|
-
*
|
|
1151
|
-
* Possible values: "template", "neural"
|
|
1152
|
-
*/
|
|
1153
|
-
buildMode?: string;
|
|
1154
|
-
/**
|
|
1155
|
-
* Azure Blob Storage location containing the training data. Either
|
|
1156
|
-
* azureBlobSource or azureBlobFileListSource must be specified.
|
|
1157
|
-
*/
|
|
1158
|
-
azureBlobSource?: AzureBlobContentSourceOutput;
|
|
1159
|
-
/**
|
|
1160
|
-
* Azure Blob Storage file list specifying the training data. Either
|
|
1161
|
-
* azureBlobSource or azureBlobFileListSource must be specified.
|
|
1162
|
-
*/
|
|
1163
|
-
azureBlobFileListSource?: AzureBlobFileListContentSourceOutput;
|
|
1164
|
-
/** Supported document types. */
|
|
1165
|
-
docTypes?: Record<string, DocumentTypeDetailsOutput>;
|
|
1166
|
-
/** List of warnings encountered while building the model. */
|
|
1167
|
-
warnings?: Array<WarningOutput>;
|
|
1168
|
-
}
|
|
1169
|
-
|
|
1170
|
-
/** An object describing the location and semantic content of a document. */
|
|
1171
|
-
export declare interface DocumentOutput {
|
|
1172
|
-
/** Document type. */
|
|
1173
|
-
docType: string;
|
|
1174
|
-
/** Bounding regions covering the document. */
|
|
1175
|
-
boundingRegions?: Array<BoundingRegionOutput>;
|
|
1176
|
-
/** Location of the document in the reading order concatenated content. */
|
|
1177
|
-
spans: Array<DocumentSpanOutput>;
|
|
1178
|
-
/** Dictionary of named field values. */
|
|
1179
|
-
fields?: Record<string, DocumentFieldOutput>;
|
|
1180
|
-
/** Confidence of correctly extracting the document. */
|
|
1181
|
-
confidence: number;
|
|
1182
|
-
}
|
|
1183
|
-
|
|
1184
|
-
/** Content and layout elements extracted from a page from the input. */
|
|
1185
|
-
export declare interface DocumentPageOutput {
|
|
1186
|
-
/** 1-based page number in the input document. */
|
|
1187
|
-
pageNumber: number;
|
|
1188
|
-
/**
|
|
1189
|
-
* The general orientation of the content in clockwise direction, measured in
|
|
1190
|
-
* degrees between (-180, 180].
|
|
1191
|
-
*/
|
|
1192
|
-
angle?: number;
|
|
1193
|
-
/** The width of the image/PDF in pixels/inches, respectively. */
|
|
1194
|
-
width?: number;
|
|
1195
|
-
/** The height of the image/PDF in pixels/inches, respectively. */
|
|
1196
|
-
height?: number;
|
|
1197
|
-
/**
|
|
1198
|
-
* The unit used by the width, height, and polygon properties. For images, the
|
|
1199
|
-
* unit is "pixel". For PDF, the unit is "inch".
|
|
1200
|
-
*
|
|
1201
|
-
* Possible values: "pixel", "inch"
|
|
1202
|
-
*/
|
|
1203
|
-
unit?: string;
|
|
1204
|
-
/** Location of the page in the reading order concatenated content. */
|
|
1205
|
-
spans: Array<DocumentSpanOutput>;
|
|
1206
|
-
/** Extracted words from the page. */
|
|
1207
|
-
words?: Array<DocumentWordOutput>;
|
|
1208
|
-
/** Extracted selection marks from the page. */
|
|
1209
|
-
selectionMarks?: Array<DocumentSelectionMarkOutput>;
|
|
1210
|
-
/**
|
|
1211
|
-
* Extracted lines from the page, potentially containing both textual and visual
|
|
1212
|
-
* elements.
|
|
1213
|
-
*/
|
|
1214
|
-
lines?: Array<DocumentLineOutput>;
|
|
1215
|
-
/** Extracted barcodes from the page. */
|
|
1216
|
-
barcodes?: Array<DocumentBarcodeOutput>;
|
|
1217
|
-
/** Extracted formulas from the page. */
|
|
1218
|
-
formulas?: Array<DocumentFormulaOutput>;
|
|
1219
|
-
}
|
|
1220
|
-
|
|
1221
|
-
/**
|
|
1222
|
-
* A paragraph object consisting with contiguous lines generally with common
|
|
1223
|
-
* alignment and spacing.
|
|
1224
|
-
*/
|
|
1225
|
-
export declare interface DocumentParagraphOutput {
|
|
1226
|
-
/**
|
|
1227
|
-
* Semantic role of the paragraph.
|
|
1228
|
-
*
|
|
1229
|
-
* Possible values: "pageHeader", "pageFooter", "pageNumber", "title", "sectionHeading", "footnote", "formulaBlock"
|
|
1230
|
-
*/
|
|
1231
|
-
role?: string;
|
|
1232
|
-
/** Concatenated content of the paragraph in reading order. */
|
|
1233
|
-
content: string;
|
|
1234
|
-
/** Bounding regions covering the paragraph. */
|
|
1235
|
-
boundingRegions?: Array<BoundingRegionOutput>;
|
|
1236
|
-
/** Location of the paragraph in the reading order concatenated content. */
|
|
1237
|
-
spans: Array<DocumentSpanOutput>;
|
|
1238
|
-
}
|
|
1239
|
-
|
|
1240
|
-
/** An object representing a section in the document. */
|
|
1241
|
-
export declare interface DocumentSectionOutput {
|
|
1242
|
-
/** Location of the section in the reading order concatenated content. */
|
|
1243
|
-
spans: Array<DocumentSpanOutput>;
|
|
1244
|
-
/** Child elements of the section. */
|
|
1245
|
-
elements?: string[];
|
|
1246
|
-
}
|
|
1247
|
-
|
|
1248
|
-
/**
|
|
1249
|
-
* A selection mark object representing check boxes, radio buttons, and other
|
|
1250
|
-
* elements indicating a selection.
|
|
1251
|
-
*/
|
|
1252
|
-
export declare interface DocumentSelectionMarkOutput {
|
|
1253
|
-
/**
|
|
1254
|
-
* State of the selection mark.
|
|
1255
|
-
*
|
|
1256
|
-
* Possible values: "selected", "unselected"
|
|
1257
|
-
*/
|
|
1258
|
-
state: string;
|
|
1259
|
-
/**
|
|
1260
|
-
* Bounding polygon of the selection mark, with coordinates specified relative
|
|
1261
|
-
* to the top-left of the page. The numbers represent the x, y values of the
|
|
1262
|
-
* polygon vertices, clockwise from the left (-180 degrees inclusive) relative
|
|
1263
|
-
* to the element orientation.
|
|
1264
|
-
*/
|
|
1265
|
-
polygon?: number[];
|
|
1266
|
-
/** Location of the selection mark in the reading order concatenated content. */
|
|
1267
|
-
span: DocumentSpanOutput;
|
|
1268
|
-
/** Confidence of correctly extracting the selection mark. */
|
|
1269
|
-
confidence: number;
|
|
1270
|
-
}
|
|
1271
|
-
|
|
1272
|
-
/**
|
|
1273
|
-
* Contiguous region of the concatenated content property, specified as an offset
|
|
1274
|
-
* and length.
|
|
1275
|
-
*/
|
|
1276
|
-
export declare interface DocumentSpanOutput {
|
|
1277
|
-
/** Zero-based index of the content represented by the span. */
|
|
1278
|
-
offset: number;
|
|
1279
|
-
/** Number of characters in the content represented by the span. */
|
|
1280
|
-
length: number;
|
|
1281
|
-
}
|
|
1282
|
-
|
|
1283
|
-
/** An object representing observed text styles. */
|
|
1284
|
-
export declare interface DocumentStyleOutput {
|
|
1285
|
-
/** Is content handwritten? */
|
|
1286
|
-
isHandwritten?: boolean;
|
|
1287
|
-
/**
|
|
1288
|
-
* Visually most similar font from among the set of supported font families, with
|
|
1289
|
-
* fallback fonts following CSS convention (ex. 'Arial, sans-serif').
|
|
1290
|
-
*/
|
|
1291
|
-
similarFontFamily?: string;
|
|
1292
|
-
/**
|
|
1293
|
-
* Font style.
|
|
1294
|
-
*
|
|
1295
|
-
* Possible values: "normal", "italic"
|
|
1296
|
-
*/
|
|
1297
|
-
fontStyle?: string;
|
|
1298
|
-
/**
|
|
1299
|
-
* Font weight.
|
|
1300
|
-
*
|
|
1301
|
-
* Possible values: "normal", "bold"
|
|
1302
|
-
*/
|
|
1303
|
-
fontWeight?: string;
|
|
1304
|
-
/** Foreground color in #rrggbb hexadecimal format. */
|
|
1305
|
-
color?: string;
|
|
1306
|
-
/** Background color in #rrggbb hexadecimal format.. */
|
|
1307
|
-
backgroundColor?: string;
|
|
1308
|
-
/** Location of the text elements in the concatenated content the style applies to. */
|
|
1309
|
-
spans: Array<DocumentSpanOutput>;
|
|
1310
|
-
/** Confidence of correctly identifying the style. */
|
|
1311
|
-
confidence: number;
|
|
1312
|
-
}
|
|
1313
|
-
|
|
1314
|
-
/** An object representing the location and content of a table cell. */
|
|
1315
|
-
export declare interface DocumentTableCellOutput {
|
|
1316
|
-
/**
|
|
1317
|
-
* Table cell kind.
|
|
1318
|
-
*
|
|
1319
|
-
* Possible values: "content", "rowHeader", "columnHeader", "stubHead", "description"
|
|
1320
|
-
*/
|
|
1321
|
-
kind?: string;
|
|
1322
|
-
/** Row index of the cell. */
|
|
1323
|
-
rowIndex: number;
|
|
1324
|
-
/** Column index of the cell. */
|
|
1325
|
-
columnIndex: number;
|
|
1326
|
-
/** Number of rows spanned by this cell. */
|
|
1327
|
-
rowSpan?: number;
|
|
1328
|
-
/** Number of columns spanned by this cell. */
|
|
1329
|
-
columnSpan?: number;
|
|
1330
|
-
/** Concatenated content of the table cell in reading order. */
|
|
1331
|
-
content: string;
|
|
1332
|
-
/** Bounding regions covering the table cell. */
|
|
1333
|
-
boundingRegions?: Array<BoundingRegionOutput>;
|
|
1334
|
-
/** Location of the table cell in the reading order concatenated content. */
|
|
1335
|
-
spans: Array<DocumentSpanOutput>;
|
|
1336
|
-
/** Child elements of the table cell. */
|
|
1337
|
-
elements?: string[];
|
|
1338
|
-
}
|
|
1339
|
-
|
|
1340
|
-
/** A table object consisting table cells arranged in a rectangular layout. */
|
|
1341
|
-
export declare interface DocumentTableOutput {
|
|
1342
|
-
/** Number of rows in the table. */
|
|
1343
|
-
rowCount: number;
|
|
1344
|
-
/** Number of columns in the table. */
|
|
1345
|
-
columnCount: number;
|
|
1346
|
-
/** Cells contained within the table. */
|
|
1347
|
-
cells: Array<DocumentTableCellOutput>;
|
|
1348
|
-
/** Bounding regions covering the table. */
|
|
1349
|
-
boundingRegions?: Array<BoundingRegionOutput>;
|
|
1350
|
-
/** Location of the table in the reading order concatenated content. */
|
|
1351
|
-
spans: Array<DocumentSpanOutput>;
|
|
1352
|
-
/** Caption associated with the table. */
|
|
1353
|
-
caption?: DocumentCaptionOutput;
|
|
1354
|
-
/** List of footnotes associated with the table. */
|
|
1355
|
-
footnotes?: Array<DocumentFootnoteOutput>;
|
|
1356
|
-
}
|
|
1357
|
-
|
|
1358
|
-
/** Document type info. */
|
|
1359
|
-
export declare interface DocumentTypeDetailsOutput {
|
|
1360
|
-
/** Document model description. */
|
|
1361
|
-
description?: string;
|
|
1362
|
-
/**
|
|
1363
|
-
* Custom document model build mode.
|
|
1364
|
-
*
|
|
1365
|
-
* Possible values: "template", "neural"
|
|
1366
|
-
*/
|
|
1367
|
-
buildMode?: string;
|
|
1368
|
-
/** Description of the document semantic schema using a JSON Schema style syntax. */
|
|
1369
|
-
fieldSchema: Record<string, DocumentFieldSchemaOutput>;
|
|
1370
|
-
/** Estimated confidence for each field. */
|
|
1371
|
-
fieldConfidence?: Record<string, number>;
|
|
1372
|
-
}
|
|
1373
|
-
|
|
1374
|
-
/**
|
|
1375
|
-
* A word object consisting of a contiguous sequence of characters. For non-space
|
|
1376
|
-
* delimited languages, such as Chinese, Japanese, and Korean, each character is
|
|
1377
|
-
* represented as its own word.
|
|
1378
|
-
*/
|
|
1379
|
-
export declare interface DocumentWordOutput {
|
|
1380
|
-
/** Text content of the word. */
|
|
1381
|
-
content: string;
|
|
1382
|
-
/**
|
|
1383
|
-
* Bounding polygon of the word, with coordinates specified relative to the
|
|
1384
|
-
* top-left of the page. The numbers represent the x, y values of the polygon
|
|
1385
|
-
* vertices, clockwise from the left (-180 degrees inclusive) relative to the
|
|
1386
|
-
* element orientation.
|
|
1387
|
-
*/
|
|
1388
|
-
polygon?: number[];
|
|
1389
|
-
/** Location of the word in the reading order concatenated content. */
|
|
1390
|
-
span: DocumentSpanOutput;
|
|
1391
|
-
/** Confidence of correctly extracting the word. */
|
|
1392
|
-
confidence: number;
|
|
1393
|
-
}
|
|
1394
|
-
|
|
1395
|
-
/** The error object. */
|
|
1396
|
-
export declare interface ErrorModelOutput {
|
|
1397
|
-
/** One of a server-defined set of error codes. */
|
|
1398
|
-
code: string;
|
|
1399
|
-
/** A human-readable representation of the error. */
|
|
1400
|
-
message: string;
|
|
1401
|
-
/** The target of the error. */
|
|
1402
|
-
target?: string;
|
|
1403
|
-
/** An array of details about specific errors that led to this reported error. */
|
|
1404
|
-
details?: Array<ErrorModelOutput>;
|
|
1405
|
-
/** An object containing more specific information than the current object about the error. */
|
|
1406
|
-
innererror?: InnerErrorOutput;
|
|
1407
|
-
}
|
|
1408
|
-
|
|
1409
|
-
/** Error response object. */
|
|
1410
|
-
export declare interface ErrorResponseOutput {
|
|
1411
|
-
/** Error info. */
|
|
1412
|
-
error: ErrorModelOutput;
|
|
1413
|
-
}
|
|
1414
|
-
|
|
1415
|
-
export declare interface GetAnalyzeResult {
|
|
1416
|
-
/** Gets the result of document analysis. */
|
|
1417
|
-
get(options?: GetAnalyzeResultParameters): StreamableMethod<GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse>;
|
|
1418
|
-
}
|
|
1419
|
-
|
|
1420
|
-
/** The request has succeeded. */
|
|
1421
|
-
export declare interface GetAnalyzeResult200Response extends HttpResponse {
|
|
1422
|
-
status: "200";
|
|
1423
|
-
body: AnalyzeResultOperationOutput;
|
|
1424
|
-
}
|
|
1425
|
-
|
|
1426
|
-
export declare interface GetAnalyzeResultDefaultResponse extends HttpResponse {
|
|
1427
|
-
status: string;
|
|
1428
|
-
body: ErrorResponseOutput;
|
|
1429
|
-
}
|
|
1430
|
-
|
|
1431
|
-
export declare type GetAnalyzeResultParameters = RequestParameters;
|
|
1432
|
-
|
|
1433
|
-
/**
|
|
1434
|
-
* Helper type to extract the type of an array
|
|
1435
|
-
*/
|
|
1436
|
-
export declare type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
|
|
1437
|
-
|
|
1438
|
-
export declare interface GetClassifier {
|
|
1439
|
-
/** Gets detailed document classifier information. */
|
|
1440
|
-
get(options?: GetClassifierParameters): StreamableMethod<GetClassifier200Response | GetClassifierDefaultResponse>;
|
|
1441
|
-
/** Deletes document classifier. */
|
|
1442
|
-
delete(options?: DeleteClassifierParameters): StreamableMethod<DeleteClassifier204Response | DeleteClassifierDefaultResponse>;
|
|
1443
|
-
}
|
|
1444
|
-
|
|
1445
|
-
export declare interface GetClassifier200Headers {
|
|
1446
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1447
|
-
"x-ms-client-request-id"?: string;
|
|
1448
|
-
}
|
|
1449
|
-
|
|
1450
|
-
/** The request has succeeded. */
|
|
1451
|
-
export declare interface GetClassifier200Response extends HttpResponse {
|
|
1452
|
-
status: "200";
|
|
1453
|
-
body: DocumentClassifierDetailsOutput;
|
|
1454
|
-
headers: RawHttpHeaders & GetClassifier200Headers;
|
|
1455
|
-
}
|
|
1456
|
-
|
|
1457
|
-
export declare interface GetClassifierDefaultResponse extends HttpResponse {
|
|
1458
|
-
status: string;
|
|
1459
|
-
body: ErrorResponseOutput;
|
|
1460
|
-
}
|
|
1461
|
-
|
|
1462
|
-
export declare interface GetClassifierHeaderParam {
|
|
1463
|
-
headers?: RawHttpHeadersInput & GetClassifierHeaders;
|
|
1464
|
-
}
|
|
1465
|
-
|
|
1466
|
-
export declare interface GetClassifierHeaders {
|
|
1467
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1468
|
-
"x-ms-client-request-id"?: string;
|
|
1469
|
-
}
|
|
1470
|
-
|
|
1471
|
-
export declare type GetClassifierParameters = GetClassifierHeaderParam & RequestParameters;
|
|
1472
|
-
|
|
1473
|
-
export declare interface GetClassifyResult {
|
|
1474
|
-
/** Gets the result of document classifier. */
|
|
1475
|
-
get(options?: GetClassifyResultParameters): StreamableMethod<GetClassifyResult200Response | GetClassifyResultDefaultResponse>;
|
|
1476
|
-
}
|
|
1477
|
-
|
|
1478
|
-
/** The request has succeeded. */
|
|
1479
|
-
export declare interface GetClassifyResult200Response extends HttpResponse {
|
|
1480
|
-
status: "200";
|
|
1481
|
-
body: AnalyzeResultOperationOutput;
|
|
1482
|
-
}
|
|
1483
|
-
|
|
1484
|
-
export declare interface GetClassifyResultDefaultResponse extends HttpResponse {
|
|
1485
|
-
status: string;
|
|
1486
|
-
body: ErrorResponseOutput;
|
|
1487
|
-
}
|
|
1488
|
-
|
|
1489
|
-
export declare type GetClassifyResultParameters = RequestParameters;
|
|
1490
|
-
|
|
1491
|
-
export declare interface GetDocumentClassifierBuildOperation200Headers {
|
|
1492
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1493
|
-
"x-ms-client-request-id"?: string;
|
|
1494
|
-
}
|
|
1495
|
-
|
|
1496
|
-
/** The request has succeeded. */
|
|
1497
|
-
export declare interface GetDocumentClassifierBuildOperation200Response extends HttpResponse {
|
|
1498
|
-
status: "200";
|
|
1499
|
-
body: DocumentClassifierBuildOperationDetailsOutput;
|
|
1500
|
-
headers: RawHttpHeaders & GetDocumentClassifierBuildOperation200Headers;
|
|
1501
|
-
}
|
|
1502
|
-
|
|
1503
|
-
export declare interface GetDocumentClassifierBuildOperationDefaultResponse extends HttpResponse {
|
|
1504
|
-
status: string;
|
|
1505
|
-
body: ErrorResponseOutput;
|
|
1506
|
-
}
|
|
1507
|
-
|
|
1508
|
-
export declare interface GetDocumentClassifierBuildOperationHeaderParam {
|
|
1509
|
-
headers?: RawHttpHeadersInput & GetDocumentClassifierBuildOperationHeaders;
|
|
1510
|
-
}
|
|
1511
|
-
|
|
1512
|
-
export declare interface GetDocumentClassifierBuildOperationHeaders {
|
|
1513
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1514
|
-
"x-ms-client-request-id"?: string;
|
|
1515
|
-
}
|
|
1516
|
-
|
|
1517
|
-
export declare type GetDocumentClassifierBuildOperationParameters = GetDocumentClassifierBuildOperationHeaderParam & RequestParameters;
|
|
1518
|
-
|
|
1519
|
-
export declare interface GetDocumentModelBuildOperation {
|
|
1520
|
-
/** Gets operation info. */
|
|
1521
|
-
get(options?: GetDocumentModelBuildOperationParameters): StreamableMethod<GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse>;
|
|
1522
|
-
/** Gets operation info. */
|
|
1523
|
-
get(options?: GetDocumentModelComposeOperationParameters): StreamableMethod<GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse>;
|
|
1524
|
-
/** Gets operation info. */
|
|
1525
|
-
get(options?: GetDocumentModelCopyToOperationParameters): StreamableMethod<GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse>;
|
|
1526
|
-
/** Gets operation info. */
|
|
1527
|
-
get(options?: GetDocumentClassifierBuildOperationParameters): StreamableMethod<GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse>;
|
|
1528
|
-
/** Gets operation info. */
|
|
1529
|
-
get(options?: GetOperationParameters): StreamableMethod<GetOperation200Response | GetOperationDefaultResponse>;
|
|
1530
|
-
}
|
|
1531
|
-
|
|
1532
|
-
export declare interface GetDocumentModelBuildOperation200Headers {
|
|
1533
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1534
|
-
"x-ms-client-request-id"?: string;
|
|
1535
|
-
}
|
|
1536
|
-
|
|
1537
|
-
/** The request has succeeded. */
|
|
1538
|
-
export declare interface GetDocumentModelBuildOperation200Response extends HttpResponse {
|
|
1539
|
-
status: "200";
|
|
1540
|
-
body: DocumentModelBuildOperationDetailsOutput;
|
|
1541
|
-
headers: RawHttpHeaders & GetDocumentModelBuildOperation200Headers;
|
|
1542
|
-
}
|
|
1543
|
-
|
|
1544
|
-
export declare interface GetDocumentModelBuildOperationDefaultResponse extends HttpResponse {
|
|
1545
|
-
status: string;
|
|
1546
|
-
body: ErrorResponseOutput;
|
|
1547
|
-
}
|
|
1548
|
-
|
|
1549
|
-
export declare interface GetDocumentModelBuildOperationHeaderParam {
|
|
1550
|
-
headers?: RawHttpHeadersInput & GetDocumentModelBuildOperationHeaders;
|
|
1551
|
-
}
|
|
1552
|
-
|
|
1553
|
-
export declare interface GetDocumentModelBuildOperationHeaders {
|
|
1554
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1555
|
-
"x-ms-client-request-id"?: string;
|
|
1556
|
-
}
|
|
1557
|
-
|
|
1558
|
-
export declare type GetDocumentModelBuildOperationParameters = GetDocumentModelBuildOperationHeaderParam & RequestParameters;
|
|
1559
|
-
|
|
1560
|
-
export declare interface GetDocumentModelComposeOperation200Headers {
|
|
1561
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1562
|
-
"x-ms-client-request-id"?: string;
|
|
1563
|
-
}
|
|
1564
|
-
|
|
1565
|
-
/** The request has succeeded. */
|
|
1566
|
-
export declare interface GetDocumentModelComposeOperation200Response extends HttpResponse {
|
|
1567
|
-
status: "200";
|
|
1568
|
-
body: DocumentModelComposeOperationDetailsOutput;
|
|
1569
|
-
headers: RawHttpHeaders & GetDocumentModelComposeOperation200Headers;
|
|
1570
|
-
}
|
|
1571
|
-
|
|
1572
|
-
export declare interface GetDocumentModelComposeOperationDefaultResponse extends HttpResponse {
|
|
1573
|
-
status: string;
|
|
1574
|
-
body: ErrorResponseOutput;
|
|
1575
|
-
}
|
|
1576
|
-
|
|
1577
|
-
export declare interface GetDocumentModelComposeOperationHeaderParam {
|
|
1578
|
-
headers?: RawHttpHeadersInput & GetDocumentModelComposeOperationHeaders;
|
|
1579
|
-
}
|
|
1580
|
-
|
|
1581
|
-
export declare interface GetDocumentModelComposeOperationHeaders {
|
|
1582
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1583
|
-
"x-ms-client-request-id"?: string;
|
|
1584
|
-
}
|
|
1585
|
-
|
|
1586
|
-
export declare type GetDocumentModelComposeOperationParameters = GetDocumentModelComposeOperationHeaderParam & RequestParameters;
|
|
1587
|
-
|
|
1588
|
-
export declare interface GetDocumentModelCopyToOperation200Headers {
|
|
1589
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1590
|
-
"x-ms-client-request-id"?: string;
|
|
1591
|
-
}
|
|
1592
|
-
|
|
1593
|
-
/** The request has succeeded. */
|
|
1594
|
-
export declare interface GetDocumentModelCopyToOperation200Response extends HttpResponse {
|
|
1595
|
-
status: "200";
|
|
1596
|
-
body: DocumentModelCopyToOperationDetailsOutput;
|
|
1597
|
-
headers: RawHttpHeaders & GetDocumentModelCopyToOperation200Headers;
|
|
1598
|
-
}
|
|
1599
|
-
|
|
1600
|
-
export declare interface GetDocumentModelCopyToOperationDefaultResponse extends HttpResponse {
|
|
1601
|
-
status: string;
|
|
1602
|
-
body: ErrorResponseOutput;
|
|
1603
|
-
}
|
|
1604
|
-
|
|
1605
|
-
export declare interface GetDocumentModelCopyToOperationHeaderParam {
|
|
1606
|
-
headers?: RawHttpHeadersInput & GetDocumentModelCopyToOperationHeaders;
|
|
1607
|
-
}
|
|
1608
|
-
|
|
1609
|
-
export declare interface GetDocumentModelCopyToOperationHeaders {
|
|
1610
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1611
|
-
"x-ms-client-request-id"?: string;
|
|
1612
|
-
}
|
|
1613
|
-
|
|
1614
|
-
export declare type GetDocumentModelCopyToOperationParameters = GetDocumentModelCopyToOperationHeaderParam & RequestParameters;
|
|
1615
|
-
|
|
1616
|
-
/**
|
|
1617
|
-
* Helper function that builds a Poller object to help polling a long running operation.
|
|
1618
|
-
* @param client - Client to use for sending the request to get additional pages.
|
|
1619
|
-
* @param initialResponse - The initial response.
|
|
1620
|
-
* @param options - Options to set a resume state or custom polling interval.
|
|
1621
|
-
* @returns - A poller object to poll for operation state updates and eventually get the final response.
|
|
1622
|
-
*/
|
|
1623
|
-
export declare function getLongRunningPoller<TResult extends BuildModelLogicalResponse | BuildModelDefaultResponse>(client: Client, initialResponse: BuildModel202Response | BuildModelDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
1624
|
-
|
|
1625
|
-
export declare function getLongRunningPoller<TResult extends ComposeModelLogicalResponse | ComposeModelDefaultResponse>(client: Client, initialResponse: ComposeModel202Response | ComposeModelDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
1626
|
-
|
|
1627
|
-
export declare function getLongRunningPoller<TResult extends CopyModelToLogicalResponse | CopyModelToDefaultResponse>(client: Client, initialResponse: CopyModelTo202Response | CopyModelToDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
1628
|
-
|
|
1629
|
-
export declare function getLongRunningPoller<TResult extends BuildClassifierLogicalResponse | BuildClassifierDefaultResponse>(client: Client, initialResponse: BuildClassifier202Response | BuildClassifierDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
1630
|
-
|
|
1631
|
-
export declare function getLongRunningPoller<TResult extends AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse>(client: Client, initialResponse: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
1632
|
-
|
|
1633
|
-
export declare function getLongRunningPoller<TResult extends ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse>(client: Client, initialResponse: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
1634
|
-
|
|
1635
|
-
export declare interface GetModel {
|
|
1636
|
-
/** Gets detailed document model information. */
|
|
1637
|
-
get(options?: GetModelParameters): StreamableMethod<GetModel200Response | GetModelDefaultResponse>;
|
|
1638
|
-
/** Deletes document model. */
|
|
1639
|
-
delete(options?: DeleteModelParameters): StreamableMethod<DeleteModel204Response | DeleteModelDefaultResponse>;
|
|
1640
|
-
}
|
|
1641
|
-
|
|
1642
|
-
export declare interface GetModel200Headers {
|
|
1643
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1644
|
-
"x-ms-client-request-id"?: string;
|
|
1645
|
-
}
|
|
1646
|
-
|
|
1647
|
-
/** The request has succeeded. */
|
|
1648
|
-
export declare interface GetModel200Response extends HttpResponse {
|
|
1649
|
-
status: "200";
|
|
1650
|
-
body: DocumentModelDetailsOutput;
|
|
1651
|
-
headers: RawHttpHeaders & GetModel200Headers;
|
|
1652
|
-
}
|
|
1653
|
-
|
|
1654
|
-
export declare interface GetModelDefaultResponse extends HttpResponse {
|
|
1655
|
-
status: string;
|
|
1656
|
-
body: ErrorResponseOutput;
|
|
1657
|
-
}
|
|
1658
|
-
|
|
1659
|
-
export declare interface GetModelHeaderParam {
|
|
1660
|
-
headers?: RawHttpHeadersInput & GetModelHeaders;
|
|
1661
|
-
}
|
|
1662
|
-
|
|
1663
|
-
export declare interface GetModelHeaders {
|
|
1664
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1665
|
-
"x-ms-client-request-id"?: string;
|
|
1666
|
-
}
|
|
1667
|
-
|
|
1668
|
-
export declare type GetModelParameters = GetModelHeaderParam & RequestParameters;
|
|
1669
|
-
|
|
1670
|
-
export declare interface GetOperation200Headers {
|
|
1671
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1672
|
-
"x-ms-client-request-id"?: string;
|
|
1673
|
-
}
|
|
1674
|
-
|
|
1675
|
-
/** The request has succeeded. */
|
|
1676
|
-
export declare interface GetOperation200Response extends HttpResponse {
|
|
1677
|
-
status: "200";
|
|
1678
|
-
body: OperationDetailsOutput;
|
|
1679
|
-
headers: RawHttpHeaders & GetOperation200Headers;
|
|
1680
|
-
}
|
|
1681
|
-
|
|
1682
|
-
export declare interface GetOperationDefaultResponse extends HttpResponse {
|
|
1683
|
-
status: string;
|
|
1684
|
-
body: ErrorResponseOutput;
|
|
1685
|
-
}
|
|
1686
|
-
|
|
1687
|
-
export declare interface GetOperationHeaderParam {
|
|
1688
|
-
headers?: RawHttpHeadersInput & GetOperationHeaders;
|
|
1689
|
-
}
|
|
1690
|
-
|
|
1691
|
-
export declare interface GetOperationHeaders {
|
|
1692
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1693
|
-
"x-ms-client-request-id"?: string;
|
|
1694
|
-
}
|
|
1695
|
-
|
|
1696
|
-
export declare type GetOperationParameters = GetOperationHeaderParam & RequestParameters;
|
|
1697
|
-
|
|
1698
|
-
/**
|
|
1699
|
-
* The type of a custom function that defines how to get a page and a link to the next one if any.
|
|
1700
|
-
*/
|
|
1701
|
-
export declare type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
|
|
1702
|
-
page: TPage;
|
|
1703
|
-
nextPageLink?: string;
|
|
1704
|
-
}>;
|
|
1705
|
-
|
|
1706
|
-
export declare interface GetResourceInfo {
|
|
1707
|
-
/** Return information about the current resource. */
|
|
1708
|
-
get(options?: GetResourceInfoParameters): StreamableMethod<GetResourceInfo200Response | GetResourceInfoDefaultResponse>;
|
|
1709
|
-
}
|
|
1710
|
-
|
|
1711
|
-
/** The request has succeeded. */
|
|
1712
|
-
export declare interface GetResourceInfo200Response extends HttpResponse {
|
|
1713
|
-
status: "200";
|
|
1714
|
-
body: ResourceDetailsOutput;
|
|
1715
|
-
}
|
|
1716
|
-
|
|
1717
|
-
export declare interface GetResourceInfoDefaultResponse extends HttpResponse {
|
|
1718
|
-
status: string;
|
|
1719
|
-
body: ErrorResponseOutput;
|
|
1720
|
-
}
|
|
1721
|
-
|
|
1722
|
-
export declare type GetResourceInfoParameters = RequestParameters;
|
|
1723
|
-
|
|
1724
|
-
/** An object containing more specific information about the error. */
|
|
1725
|
-
export declare interface InnerErrorOutput {
|
|
1726
|
-
/** One of a server-defined set of error codes. */
|
|
1727
|
-
code?: string;
|
|
1728
|
-
/** A human-readable representation of the error. */
|
|
1729
|
-
message?: string;
|
|
1730
|
-
/** Inner error. */
|
|
1731
|
-
innererror?: InnerErrorOutput;
|
|
1732
|
-
}
|
|
1733
|
-
|
|
1734
|
-
export declare function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response is ListOperationsDefaultResponse;
|
|
1735
|
-
|
|
1736
|
-
export declare function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response is GetDocumentModelBuildOperationDefaultResponse;
|
|
1737
|
-
|
|
1738
|
-
export declare function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): response is GetResourceInfoDefaultResponse;
|
|
1739
|
-
|
|
1740
|
-
export declare function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response is GetAnalyzeResultDefaultResponse;
|
|
1741
|
-
|
|
1742
|
-
export declare function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse): response is AnalyzeDocumentFromStreamDefaultResponse;
|
|
1743
|
-
|
|
1744
|
-
export declare function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response is GetModelDefaultResponse;
|
|
1745
|
-
|
|
1746
|
-
export declare function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response is DeleteModelDefaultResponse;
|
|
1747
|
-
|
|
1748
|
-
export declare function isUnexpected(response: BuildModel202Response | BuildModelLogicalResponse | BuildModelDefaultResponse): response is BuildModelDefaultResponse;
|
|
1749
|
-
|
|
1750
|
-
export declare function isUnexpected(response: ComposeModel202Response | ComposeModelLogicalResponse | ComposeModelDefaultResponse): response is ComposeModelDefaultResponse;
|
|
1751
|
-
|
|
1752
|
-
export declare function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response is AuthorizeModelCopyDefaultResponse;
|
|
1753
|
-
|
|
1754
|
-
export declare function isUnexpected(response: CopyModelTo202Response | CopyModelToLogicalResponse | CopyModelToDefaultResponse): response is CopyModelToDefaultResponse;
|
|
1755
|
-
|
|
1756
|
-
export declare function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response is ListModelsDefaultResponse;
|
|
1757
|
-
|
|
1758
|
-
export declare function isUnexpected(response: BuildClassifier202Response | BuildClassifierLogicalResponse | BuildClassifierDefaultResponse): response is BuildClassifierDefaultResponse;
|
|
1759
|
-
|
|
1760
|
-
export declare function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response is ListClassifiersDefaultResponse;
|
|
1761
|
-
|
|
1762
|
-
export declare function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response is GetClassifierDefaultResponse;
|
|
1763
|
-
|
|
1764
|
-
export declare function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response is DeleteClassifierDefaultResponse;
|
|
1765
|
-
|
|
1766
|
-
export declare function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentLogicalResponse | ClassifyDocumentFromStreamDefaultResponse): response is ClassifyDocumentFromStreamDefaultResponse;
|
|
1767
|
-
|
|
1768
|
-
export declare function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response is GetClassifyResultDefaultResponse;
|
|
1769
|
-
|
|
1770
|
-
export declare interface ListClassifiers {
|
|
1771
|
-
/** List all document classifiers. */
|
|
1772
|
-
get(options?: ListClassifiersParameters): StreamableMethod<ListClassifiers200Response | ListClassifiersDefaultResponse>;
|
|
1773
|
-
}
|
|
1774
|
-
|
|
1775
|
-
export declare interface ListClassifiers200Headers {
|
|
1776
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1777
|
-
"x-ms-client-request-id"?: string;
|
|
1778
|
-
}
|
|
1779
|
-
|
|
1780
|
-
/** The request has succeeded. */
|
|
1781
|
-
export declare interface ListClassifiers200Response extends HttpResponse {
|
|
1782
|
-
status: "200";
|
|
1783
|
-
body: PagedDocumentClassifierDetailsOutput;
|
|
1784
|
-
headers: RawHttpHeaders & ListClassifiers200Headers;
|
|
1785
|
-
}
|
|
1786
|
-
|
|
1787
|
-
export declare interface ListClassifiersDefaultResponse extends HttpResponse {
|
|
1788
|
-
status: string;
|
|
1789
|
-
body: ErrorResponseOutput;
|
|
1790
|
-
}
|
|
1791
|
-
|
|
1792
|
-
export declare interface ListClassifiersHeaderParam {
|
|
1793
|
-
headers?: RawHttpHeadersInput & ListClassifiersHeaders;
|
|
1794
|
-
}
|
|
1795
|
-
|
|
1796
|
-
export declare interface ListClassifiersHeaders {
|
|
1797
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1798
|
-
"x-ms-client-request-id"?: string;
|
|
1799
|
-
}
|
|
1800
|
-
|
|
1801
|
-
export declare type ListClassifiersParameters = ListClassifiersHeaderParam & RequestParameters;
|
|
1802
|
-
|
|
1803
|
-
export declare interface ListModels {
|
|
1804
|
-
/** List all document models */
|
|
1805
|
-
get(options?: ListModelsParameters): StreamableMethod<ListModels200Response | ListModelsDefaultResponse>;
|
|
1806
|
-
}
|
|
1807
|
-
|
|
1808
|
-
export declare interface ListModels200Headers {
|
|
1809
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1810
|
-
"x-ms-client-request-id"?: string;
|
|
1811
|
-
}
|
|
1812
|
-
|
|
1813
|
-
/** The request has succeeded. */
|
|
1814
|
-
export declare interface ListModels200Response extends HttpResponse {
|
|
1815
|
-
status: "200";
|
|
1816
|
-
body: PagedDocumentModelDetailsOutput;
|
|
1817
|
-
headers: RawHttpHeaders & ListModels200Headers;
|
|
1818
|
-
}
|
|
1819
|
-
|
|
1820
|
-
export declare interface ListModelsDefaultResponse extends HttpResponse {
|
|
1821
|
-
status: string;
|
|
1822
|
-
body: ErrorResponseOutput;
|
|
1823
|
-
}
|
|
1824
|
-
|
|
1825
|
-
export declare interface ListModelsHeaderParam {
|
|
1826
|
-
headers?: RawHttpHeadersInput & ListModelsHeaders;
|
|
1827
|
-
}
|
|
1828
|
-
|
|
1829
|
-
export declare interface ListModelsHeaders {
|
|
1830
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1831
|
-
"x-ms-client-request-id"?: string;
|
|
1832
|
-
}
|
|
1833
|
-
|
|
1834
|
-
export declare type ListModelsParameters = ListModelsHeaderParam & RequestParameters;
|
|
1835
|
-
|
|
1836
|
-
export declare interface ListOperations {
|
|
1837
|
-
/** Lists all operations. */
|
|
1838
|
-
get(options?: ListOperationsParameters): StreamableMethod<ListOperations200Response | ListOperationsDefaultResponse>;
|
|
1839
|
-
}
|
|
1840
|
-
|
|
1841
|
-
export declare interface ListOperations200Headers {
|
|
1842
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1843
|
-
"x-ms-client-request-id"?: string;
|
|
1844
|
-
}
|
|
1845
|
-
|
|
1846
|
-
/** The request has succeeded. */
|
|
1847
|
-
export declare interface ListOperations200Response extends HttpResponse {
|
|
1848
|
-
status: "200";
|
|
1849
|
-
body: PagedOperationDetailsOutput;
|
|
1850
|
-
headers: RawHttpHeaders & ListOperations200Headers;
|
|
1851
|
-
}
|
|
1852
|
-
|
|
1853
|
-
export declare interface ListOperationsDefaultResponse extends HttpResponse {
|
|
1854
|
-
status: string;
|
|
1855
|
-
body: ErrorResponseOutput;
|
|
1856
|
-
}
|
|
1857
|
-
|
|
1858
|
-
export declare interface ListOperationsHeaderParam {
|
|
1859
|
-
headers?: RawHttpHeadersInput & ListOperationsHeaders;
|
|
1860
|
-
}
|
|
1861
|
-
|
|
1862
|
-
export declare interface ListOperationsHeaders {
|
|
1863
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
1864
|
-
"x-ms-client-request-id"?: string;
|
|
1865
|
-
}
|
|
1866
|
-
|
|
1867
|
-
export declare type ListOperationsParameters = ListOperationsHeaderParam & RequestParameters;
|
|
1868
|
-
|
|
1869
|
-
/** Operation info. */
|
|
1870
|
-
export declare type OperationDetailsOutput = OperationDetailsOutputParent | DocumentModelBuildOperationDetailsOutput | DocumentModelComposeOperationDetailsOutput | DocumentModelCopyToOperationDetailsOutput | DocumentClassifierBuildOperationDetailsOutput;
|
|
1871
|
-
|
|
1872
|
-
/** Operation info. */
|
|
1873
|
-
export declare interface OperationDetailsOutputParent {
|
|
1874
|
-
/** Operation ID */
|
|
1875
|
-
operationId: string;
|
|
1876
|
-
/**
|
|
1877
|
-
* Operation status. notStarted, running, completed, or failed
|
|
1878
|
-
*
|
|
1879
|
-
* Possible values: "notStarted", "running", "failed", "succeeded", "completed", "canceled"
|
|
1880
|
-
*/
|
|
1881
|
-
status: string;
|
|
1882
|
-
/** Operation progress (0-100). */
|
|
1883
|
-
percentCompleted?: number;
|
|
1884
|
-
/** Date and time (UTC) when the operation was created. */
|
|
1885
|
-
createdDateTime: string;
|
|
1886
|
-
/** Date and time (UTC) when the status was last updated. */
|
|
1887
|
-
lastUpdatedDateTime: string;
|
|
1888
|
-
/** URL of the resource targeted by this operation. */
|
|
1889
|
-
resourceLocation: string;
|
|
1890
|
-
/** API version used to create this operation. */
|
|
1891
|
-
apiVersion?: string;
|
|
1892
|
-
/** List of key-value tag attributes associated with the document model. */
|
|
1893
|
-
tags?: Record<string, string>;
|
|
1894
|
-
/** Encountered error. */
|
|
1895
|
-
error?: ErrorModelOutput;
|
|
1896
|
-
kind: string;
|
|
1897
|
-
}
|
|
1898
|
-
|
|
1899
|
-
/** Paged collection of DocumentClassifierDetails items */
|
|
1900
|
-
export declare type PagedDocumentClassifierDetailsOutput = Paged<DocumentClassifierDetailsOutput>;
|
|
1901
|
-
|
|
1902
|
-
/** Paged collection of DocumentModelDetails items */
|
|
1903
|
-
export declare type PagedDocumentModelDetailsOutput = Paged<DocumentModelDetailsOutput>;
|
|
1904
|
-
|
|
1905
|
-
/** Paged collection of OperationDetails items */
|
|
1906
|
-
export declare type PagedOperationDetailsOutput = Paged<OperationDetailsOutput>;
|
|
1907
|
-
|
|
1908
|
-
/**
|
|
1909
|
-
* Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
|
|
1910
|
-
* @param client - Client to use for sending the next page requests
|
|
1911
|
-
* @param initialResponse - Initial response containing the nextLink and current page of elements
|
|
1912
|
-
* @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
|
|
1913
|
-
* @returns - PagedAsyncIterableIterator to iterate the elements
|
|
1914
|
-
*/
|
|
1915
|
-
export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
|
|
1916
|
-
|
|
1917
|
-
/**
|
|
1918
|
-
* Helper type to infer the Type of the paged elements from the response type
|
|
1919
|
-
* This type is generated based on the swagger information for x-ms-pageable
|
|
1920
|
-
* specifically on the itemName property which indicates the property of the response
|
|
1921
|
-
* where the page items are found. The default value is `value`.
|
|
1922
|
-
* This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
|
|
1923
|
-
*/
|
|
1924
|
-
export declare type PaginateReturn<TResult> = TResult extends {
|
|
1925
|
-
body: {
|
|
1926
|
-
value?: infer TPage;
|
|
1927
|
-
};
|
|
1928
|
-
} ? GetArrayType<TPage> : Array<unknown>;
|
|
1929
|
-
|
|
1930
|
-
/**
|
|
1931
|
-
* Options for the paging helper
|
|
1932
|
-
*/
|
|
1933
|
-
export declare interface PagingOptions<TResponse> {
|
|
1934
|
-
/**
|
|
1935
|
-
* Custom function to extract pagination details for crating the PagedAsyncIterableIterator
|
|
1936
|
-
*/
|
|
1937
|
-
customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
|
|
1938
|
-
}
|
|
1939
|
-
|
|
1940
|
-
/** Quota used, limit, and next reset date/time. */
|
|
1941
|
-
export declare interface QuotaDetailsOutput {
|
|
1942
|
-
/** Amount of the resource quota used. */
|
|
1943
|
-
used: number;
|
|
1944
|
-
/** Resource quota limit. */
|
|
1945
|
-
quota: number;
|
|
1946
|
-
/** Date/time when the resource quota usage will be reset. */
|
|
1947
|
-
quotaResetDateTime: string;
|
|
1948
|
-
}
|
|
1949
|
-
|
|
1950
|
-
/** General information regarding the current resource. */
|
|
1951
|
-
export declare interface ResourceDetailsOutput {
|
|
1952
|
-
/** Details regarding custom document models. */
|
|
1953
|
-
customDocumentModels: CustomDocumentModelsDetailsOutput;
|
|
1954
|
-
/** Quota used, limit, and next reset date/time. */
|
|
1955
|
-
customNeuralDocumentModelBuilds: QuotaDetailsOutput;
|
|
1956
|
-
}
|
|
1957
|
-
|
|
1958
|
-
export declare interface Routes {
|
|
1959
|
-
/** Resource for '/operations' has methods for the following verbs: get */
|
|
1960
|
-
(path: "/operations"): ListOperations;
|
|
1961
|
-
/** Resource for '/operations/\{operationId\}' has methods for the following verbs: get */
|
|
1962
|
-
(path: "/operations/{operationId}", operationId: string): GetDocumentModelBuildOperation;
|
|
1963
|
-
/** Resource for '/info' has methods for the following verbs: get */
|
|
1964
|
-
(path: "/info"): GetResourceInfo;
|
|
1965
|
-
/** Resource for '/documentModels/\{modelId\}/analyzeResults/\{resultId\}' has methods for the following verbs: get */
|
|
1966
|
-
(path: "/documentModels/{modelId}/analyzeResults/{resultId}", modelId: string, resultId: string): GetAnalyzeResult;
|
|
1967
|
-
/** Resource for '/documentModels/\{modelId\}:analyze' has methods for the following verbs: post */
|
|
1968
|
-
(path: "/documentModels/{modelId}:analyze", modelId: string): AnalyzeDocumentFromStream;
|
|
1969
|
-
/** Resource for '/documentModels/\{modelId\}' has methods for the following verbs: get, delete */
|
|
1970
|
-
(path: "/documentModels/{modelId}", modelId: string): GetModel;
|
|
1971
|
-
/** Resource for '/documentModels:build' has methods for the following verbs: post */
|
|
1972
|
-
(path: "/documentModels:build"): BuildModel;
|
|
1973
|
-
/** Resource for '/documentModels:compose' has methods for the following verbs: post */
|
|
1974
|
-
(path: "/documentModels:compose"): ComposeModel;
|
|
1975
|
-
/** Resource for '/documentModels:authorizeCopy' has methods for the following verbs: post */
|
|
1976
|
-
(path: "/documentModels:authorizeCopy"): AuthorizeModelCopy;
|
|
1977
|
-
/** Resource for '/documentModels/\{modelId\}:copyTo' has methods for the following verbs: post */
|
|
1978
|
-
(path: "/documentModels/{modelId}:copyTo", modelId: string): CopyModelTo;
|
|
1979
|
-
/** Resource for '/documentModels' has methods for the following verbs: get */
|
|
1980
|
-
(path: "/documentModels"): ListModels;
|
|
1981
|
-
/** Resource for '/documentClassifiers:build' has methods for the following verbs: post */
|
|
1982
|
-
(path: "/documentClassifiers:build"): BuildClassifier;
|
|
1983
|
-
/** Resource for '/documentClassifiers' has methods for the following verbs: get */
|
|
1984
|
-
(path: "/documentClassifiers"): ListClassifiers;
|
|
1985
|
-
/** Resource for '/documentClassifiers/\{classifierId\}' has methods for the following verbs: get, delete */
|
|
1986
|
-
(path: "/documentClassifiers/{classifierId}", classifierId: string): GetClassifier;
|
|
1987
|
-
/** Resource for '/documentClassifiers/\{classifierId\}:analyze' has methods for the following verbs: post */
|
|
1988
|
-
(path: "/documentClassifiers/{classifierId}:analyze", classifierId: string): ClassifyDocumentFromStream;
|
|
1989
|
-
/** Resource for '/documentClassifiers/\{classifierId\}/analyzeResults/\{resultId\}' has methods for the following verbs: get */
|
|
1990
|
-
(path: "/documentClassifiers/{classifierId}/analyzeResults/{resultId}", classifierId: string, resultId: string): GetClassifyResult;
|
|
1991
|
-
}
|
|
1992
|
-
|
|
1993
|
-
/** The error object. */
|
|
1994
|
-
export declare interface WarningOutput {
|
|
1995
|
-
/** One of a server-defined set of warning codes. */
|
|
1996
|
-
code: string;
|
|
1997
|
-
/** A human-readable representation of the warning. */
|
|
1998
|
-
message: string;
|
|
1999
|
-
/** The target of the error. */
|
|
2000
|
-
target?: string;
|
|
2001
|
-
}
|
|
2002
|
-
|
|
2003
|
-
export { }
|