@azure-rest/ai-document-translator 1.0.0-alpha.20241121.1 → 1.0.0-alpha.20241122.2
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/README.md +1 -1
- package/dist/browser/constants.d.ts +5 -0
- package/dist/browser/constants.d.ts.map +1 -0
- package/dist/browser/documentTranslator.d.ts +130 -0
- package/dist/browser/documentTranslator.d.ts.map +1 -0
- package/dist/browser/documentTranslator.js.map +1 -0
- package/dist/browser/index.d.ts +11 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +14 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/models.d.ts +189 -0
- package/dist/browser/models.d.ts.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/parameters.d.ts +93 -0
- package/dist/browser/parameters.d.ts.map +1 -0
- package/dist/browser/parameters.js.map +1 -0
- package/dist/browser/responses.d.ts +725 -0
- package/dist/browser/responses.d.ts.map +1 -0
- package/dist/browser/responses.js.map +1 -0
- package/dist/commonjs/constants.d.ts +5 -0
- package/dist/commonjs/constants.d.ts.map +1 -0
- package/dist/commonjs/constants.js +10 -0
- package/dist/commonjs/constants.js.map +1 -0
- package/dist/commonjs/documentTranslator.d.ts +130 -0
- package/dist/commonjs/documentTranslator.d.ts.map +1 -0
- package/dist/{index.js → commonjs/documentTranslator.js} +6 -17
- package/dist/commonjs/documentTranslator.js.map +1 -0
- package/dist/commonjs/index.d.ts +11 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +17 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/models.d.ts +189 -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/package.json +3 -0
- package/dist/commonjs/parameters.d.ts +93 -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/responses.d.ts +725 -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/esm/constants.d.ts +5 -0
- package/dist/esm/constants.d.ts.map +1 -0
- package/dist/esm/constants.js +7 -0
- package/dist/esm/constants.js.map +1 -0
- package/dist/esm/documentTranslator.d.ts +130 -0
- package/dist/esm/documentTranslator.d.ts.map +1 -0
- package/dist/esm/documentTranslator.js +13 -0
- package/dist/esm/documentTranslator.js.map +1 -0
- package/dist/esm/index.d.ts +11 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +14 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/models.d.ts +189 -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/package.json +3 -0
- package/dist/esm/parameters.d.ts +93 -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/responses.d.ts +725 -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/react-native/constants.d.ts +5 -0
- package/dist/react-native/constants.d.ts.map +1 -0
- package/dist/react-native/constants.js +7 -0
- package/dist/react-native/constants.js.map +1 -0
- package/dist/react-native/documentTranslator.d.ts +130 -0
- package/dist/react-native/documentTranslator.d.ts.map +1 -0
- package/dist/react-native/documentTranslator.js +13 -0
- package/dist/react-native/documentTranslator.js.map +1 -0
- package/dist/react-native/index.d.ts +11 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +14 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/models.d.ts +189 -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/package.json +3 -0
- package/dist/react-native/parameters.d.ts +93 -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/responses.d.ts +725 -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/package.json +66 -44
- package/dist/index.js.map +0 -1
- package/dist-esm/src/documentTranslator.js.map +0 -1
- package/dist-esm/src/index.js +0 -13
- package/dist-esm/src/index.js.map +0 -1
- package/dist-esm/src/parameters.js.map +0 -1
- package/dist-esm/src/responses.js.map +0 -1
- /package/{types → dist}/ai-document-translator.d.ts +0 -0
- /package/{dist-esm/src → dist/browser}/constants.js +0 -0
- /package/{dist-esm/src → dist/browser}/constants.js.map +0 -0
- /package/{dist-esm/src → dist/browser}/documentTranslator.js +0 -0
- /package/{dist-esm/src → dist/browser}/models.js +0 -0
- /package/{dist-esm/src → dist/browser}/models.js.map +0 -0
- /package/{dist-esm/src → dist/browser}/parameters.js +0 -0
- /package/{dist-esm/src → dist/browser}/responses.js +0 -0
|
@@ -0,0 +1,725 @@
|
|
|
1
|
+
import type { TranslationErrorResponse, TranslationsStatus, DocumentStatus, TranslationStatus, DocumentsStatus, SupportedFileFormats, SupportedStorageSources } from "./models.js";
|
|
2
|
+
import type { HttpResponse } from "@azure-rest/core-client";
|
|
3
|
+
import type { RawHttpHeaders } from "@azure/core-rest-pipeline";
|
|
4
|
+
export interface StartTranslation202Headers {
|
|
5
|
+
/** Location of batch the operation */
|
|
6
|
+
"operation-location"?: string;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Use this API to submit a bulk (batch) translation request to the Document Translation service.
|
|
10
|
+
* Each request can contain multiple documents and must contain a source and destination container for each document.
|
|
11
|
+
*
|
|
12
|
+
* The prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name.
|
|
13
|
+
*
|
|
14
|
+
* Glossaries / Translation memory can be included in the request and are applied by the service when the document is translated.
|
|
15
|
+
*
|
|
16
|
+
* If the glossary is invalid or unreachable during translation, an error is indicated in the document status.
|
|
17
|
+
* If a file with the same name already exists at the destination, it will be overwritten. The targetUrl for each target language must be unique.
|
|
18
|
+
*/
|
|
19
|
+
export interface StartTranslation202Response extends HttpResponse {
|
|
20
|
+
status: "202";
|
|
21
|
+
headers: RawHttpHeaders & StartTranslation202Headers;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Use this API to submit a bulk (batch) translation request to the Document Translation service.
|
|
25
|
+
* Each request can contain multiple documents and must contain a source and destination container for each document.
|
|
26
|
+
*
|
|
27
|
+
* The prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name.
|
|
28
|
+
*
|
|
29
|
+
* Glossaries / Translation memory can be included in the request and are applied by the service when the document is translated.
|
|
30
|
+
*
|
|
31
|
+
* If the glossary is invalid or unreachable during translation, an error is indicated in the document status.
|
|
32
|
+
* If a file with the same name already exists at the destination, it will be overwritten. The targetUrl for each target language must be unique.
|
|
33
|
+
*/
|
|
34
|
+
export interface StartTranslation400Response extends HttpResponse {
|
|
35
|
+
status: "400";
|
|
36
|
+
body: TranslationErrorResponse;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Use this API to submit a bulk (batch) translation request to the Document Translation service.
|
|
40
|
+
* Each request can contain multiple documents and must contain a source and destination container for each document.
|
|
41
|
+
*
|
|
42
|
+
* The prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name.
|
|
43
|
+
*
|
|
44
|
+
* Glossaries / Translation memory can be included in the request and are applied by the service when the document is translated.
|
|
45
|
+
*
|
|
46
|
+
* If the glossary is invalid or unreachable during translation, an error is indicated in the document status.
|
|
47
|
+
* If a file with the same name already exists at the destination, it will be overwritten. The targetUrl for each target language must be unique.
|
|
48
|
+
*/
|
|
49
|
+
export interface StartTranslation401Response extends HttpResponse {
|
|
50
|
+
status: "401";
|
|
51
|
+
body: TranslationErrorResponse;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Use this API to submit a bulk (batch) translation request to the Document Translation service.
|
|
55
|
+
* Each request can contain multiple documents and must contain a source and destination container for each document.
|
|
56
|
+
*
|
|
57
|
+
* The prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name.
|
|
58
|
+
*
|
|
59
|
+
* Glossaries / Translation memory can be included in the request and are applied by the service when the document is translated.
|
|
60
|
+
*
|
|
61
|
+
* If the glossary is invalid or unreachable during translation, an error is indicated in the document status.
|
|
62
|
+
* If a file with the same name already exists at the destination, it will be overwritten. The targetUrl for each target language must be unique.
|
|
63
|
+
*/
|
|
64
|
+
export interface StartTranslation429Response extends HttpResponse {
|
|
65
|
+
status: "429";
|
|
66
|
+
body: TranslationErrorResponse;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Use this API to submit a bulk (batch) translation request to the Document Translation service.
|
|
70
|
+
* Each request can contain multiple documents and must contain a source and destination container for each document.
|
|
71
|
+
*
|
|
72
|
+
* The prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name.
|
|
73
|
+
*
|
|
74
|
+
* Glossaries / Translation memory can be included in the request and are applied by the service when the document is translated.
|
|
75
|
+
*
|
|
76
|
+
* If the glossary is invalid or unreachable during translation, an error is indicated in the document status.
|
|
77
|
+
* If a file with the same name already exists at the destination, it will be overwritten. The targetUrl for each target language must be unique.
|
|
78
|
+
*/
|
|
79
|
+
export interface StartTranslation500Response extends HttpResponse {
|
|
80
|
+
status: "500";
|
|
81
|
+
body: TranslationErrorResponse;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Use this API to submit a bulk (batch) translation request to the Document Translation service.
|
|
85
|
+
* Each request can contain multiple documents and must contain a source and destination container for each document.
|
|
86
|
+
*
|
|
87
|
+
* The prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name.
|
|
88
|
+
*
|
|
89
|
+
* Glossaries / Translation memory can be included in the request and are applied by the service when the document is translated.
|
|
90
|
+
*
|
|
91
|
+
* If the glossary is invalid or unreachable during translation, an error is indicated in the document status.
|
|
92
|
+
* If a file with the same name already exists at the destination, it will be overwritten. The targetUrl for each target language must be unique.
|
|
93
|
+
*/
|
|
94
|
+
export interface StartTranslation503Response extends HttpResponse {
|
|
95
|
+
status: "503";
|
|
96
|
+
body: TranslationErrorResponse;
|
|
97
|
+
}
|
|
98
|
+
export interface GetTranslationsStatus200Headers {
|
|
99
|
+
/** Indicates how long to wait before making a new request. */
|
|
100
|
+
"retry-after"?: string;
|
|
101
|
+
/** The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control. */
|
|
102
|
+
etag?: string;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Returns a list of batch requests submitted and the status for each request.
|
|
106
|
+
* This list only contains batch requests submitted by the user (based on the resource).
|
|
107
|
+
*
|
|
108
|
+
* If the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.
|
|
109
|
+
* The absence of a continuation token means that no additional pages are available.
|
|
110
|
+
*
|
|
111
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
112
|
+
*
|
|
113
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
114
|
+
* $skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time.
|
|
115
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
116
|
+
*
|
|
117
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
118
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
119
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled operations.
|
|
120
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
121
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
122
|
+
*
|
|
123
|
+
* The server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.
|
|
124
|
+
*
|
|
125
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
126
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
127
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
128
|
+
*/
|
|
129
|
+
export interface GetTranslationsStatus200Response extends HttpResponse {
|
|
130
|
+
status: "200";
|
|
131
|
+
body: TranslationsStatus;
|
|
132
|
+
headers: RawHttpHeaders & GetTranslationsStatus200Headers;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* Returns a list of batch requests submitted and the status for each request.
|
|
136
|
+
* This list only contains batch requests submitted by the user (based on the resource).
|
|
137
|
+
*
|
|
138
|
+
* If the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.
|
|
139
|
+
* The absence of a continuation token means that no additional pages are available.
|
|
140
|
+
*
|
|
141
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
142
|
+
*
|
|
143
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
144
|
+
* $skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time.
|
|
145
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
146
|
+
*
|
|
147
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
148
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
149
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled operations.
|
|
150
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
151
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
152
|
+
*
|
|
153
|
+
* The server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.
|
|
154
|
+
*
|
|
155
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
156
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
157
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
158
|
+
*/
|
|
159
|
+
export interface GetTranslationsStatus400Response extends HttpResponse {
|
|
160
|
+
status: "400";
|
|
161
|
+
body: TranslationErrorResponse;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* Returns a list of batch requests submitted and the status for each request.
|
|
165
|
+
* This list only contains batch requests submitted by the user (based on the resource).
|
|
166
|
+
*
|
|
167
|
+
* If the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.
|
|
168
|
+
* The absence of a continuation token means that no additional pages are available.
|
|
169
|
+
*
|
|
170
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
171
|
+
*
|
|
172
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
173
|
+
* $skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time.
|
|
174
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
175
|
+
*
|
|
176
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
177
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
178
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled operations.
|
|
179
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
180
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
181
|
+
*
|
|
182
|
+
* The server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.
|
|
183
|
+
*
|
|
184
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
185
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
186
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
187
|
+
*/
|
|
188
|
+
export interface GetTranslationsStatus401Response extends HttpResponse {
|
|
189
|
+
status: "401";
|
|
190
|
+
body: TranslationErrorResponse;
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* Returns a list of batch requests submitted and the status for each request.
|
|
194
|
+
* This list only contains batch requests submitted by the user (based on the resource).
|
|
195
|
+
*
|
|
196
|
+
* If the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.
|
|
197
|
+
* The absence of a continuation token means that no additional pages are available.
|
|
198
|
+
*
|
|
199
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
200
|
+
*
|
|
201
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
202
|
+
* $skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time.
|
|
203
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
204
|
+
*
|
|
205
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
206
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
207
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled operations.
|
|
208
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
209
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
210
|
+
*
|
|
211
|
+
* The server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.
|
|
212
|
+
*
|
|
213
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
214
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
215
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
216
|
+
*/
|
|
217
|
+
export interface GetTranslationsStatus429Response extends HttpResponse {
|
|
218
|
+
status: "429";
|
|
219
|
+
body: TranslationErrorResponse;
|
|
220
|
+
}
|
|
221
|
+
/**
|
|
222
|
+
* Returns a list of batch requests submitted and the status for each request.
|
|
223
|
+
* This list only contains batch requests submitted by the user (based on the resource).
|
|
224
|
+
*
|
|
225
|
+
* If the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.
|
|
226
|
+
* The absence of a continuation token means that no additional pages are available.
|
|
227
|
+
*
|
|
228
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
229
|
+
*
|
|
230
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
231
|
+
* $skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time.
|
|
232
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
233
|
+
*
|
|
234
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
235
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
236
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled operations.
|
|
237
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
238
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
239
|
+
*
|
|
240
|
+
* The server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.
|
|
241
|
+
*
|
|
242
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
243
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
244
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
245
|
+
*/
|
|
246
|
+
export interface GetTranslationsStatus500Response extends HttpResponse {
|
|
247
|
+
status: "500";
|
|
248
|
+
body: TranslationErrorResponse;
|
|
249
|
+
}
|
|
250
|
+
/**
|
|
251
|
+
* Returns a list of batch requests submitted and the status for each request.
|
|
252
|
+
* This list only contains batch requests submitted by the user (based on the resource).
|
|
253
|
+
*
|
|
254
|
+
* If the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.
|
|
255
|
+
* The absence of a continuation token means that no additional pages are available.
|
|
256
|
+
*
|
|
257
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
258
|
+
*
|
|
259
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
260
|
+
* $skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time.
|
|
261
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
262
|
+
*
|
|
263
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
264
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
265
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled operations.
|
|
266
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
267
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
268
|
+
*
|
|
269
|
+
* The server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.
|
|
270
|
+
*
|
|
271
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
272
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
273
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
274
|
+
*/
|
|
275
|
+
export interface GetTranslationsStatus503Response extends HttpResponse {
|
|
276
|
+
status: "503";
|
|
277
|
+
body: TranslationErrorResponse;
|
|
278
|
+
}
|
|
279
|
+
export interface GetDocumentStatus200Headers {
|
|
280
|
+
/** Indicates how long to wait before making a new request. */
|
|
281
|
+
"retry-after"?: string;
|
|
282
|
+
/** The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control. */
|
|
283
|
+
etag?: string;
|
|
284
|
+
}
|
|
285
|
+
/** Returns the translation status for a specific document based on the request Id and document Id. */
|
|
286
|
+
export interface GetDocumentStatus200Response extends HttpResponse {
|
|
287
|
+
status: "200";
|
|
288
|
+
body: DocumentStatus;
|
|
289
|
+
headers: RawHttpHeaders & GetDocumentStatus200Headers;
|
|
290
|
+
}
|
|
291
|
+
/** Returns the translation status for a specific document based on the request Id and document Id. */
|
|
292
|
+
export interface GetDocumentStatus401Response extends HttpResponse {
|
|
293
|
+
status: "401";
|
|
294
|
+
body: TranslationErrorResponse;
|
|
295
|
+
}
|
|
296
|
+
/** Returns the translation status for a specific document based on the request Id and document Id. */
|
|
297
|
+
export interface GetDocumentStatus404Response extends HttpResponse {
|
|
298
|
+
status: "404";
|
|
299
|
+
body: TranslationErrorResponse;
|
|
300
|
+
}
|
|
301
|
+
/** Returns the translation status for a specific document based on the request Id and document Id. */
|
|
302
|
+
export interface GetDocumentStatus429Response extends HttpResponse {
|
|
303
|
+
status: "429";
|
|
304
|
+
body: TranslationErrorResponse;
|
|
305
|
+
}
|
|
306
|
+
/** Returns the translation status for a specific document based on the request Id and document Id. */
|
|
307
|
+
export interface GetDocumentStatus500Response extends HttpResponse {
|
|
308
|
+
status: "500";
|
|
309
|
+
body: TranslationErrorResponse;
|
|
310
|
+
}
|
|
311
|
+
/** Returns the translation status for a specific document based on the request Id and document Id. */
|
|
312
|
+
export interface GetDocumentStatus503Response extends HttpResponse {
|
|
313
|
+
status: "503";
|
|
314
|
+
body: TranslationErrorResponse;
|
|
315
|
+
}
|
|
316
|
+
export interface GetTranslationStatus200Headers {
|
|
317
|
+
/** Indicates how long to wait before making a new request. */
|
|
318
|
+
"retry-after"?: string;
|
|
319
|
+
/** The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control. */
|
|
320
|
+
etag?: string;
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* Returns the status for a document translation request.
|
|
324
|
+
* The status includes the overall request status, as well as the status for documents that are being translated as part of that request.
|
|
325
|
+
*/
|
|
326
|
+
export interface GetTranslationStatus200Response extends HttpResponse {
|
|
327
|
+
status: "200";
|
|
328
|
+
body: TranslationStatus;
|
|
329
|
+
headers: RawHttpHeaders & GetTranslationStatus200Headers;
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* Returns the status for a document translation request.
|
|
333
|
+
* The status includes the overall request status, as well as the status for documents that are being translated as part of that request.
|
|
334
|
+
*/
|
|
335
|
+
export interface GetTranslationStatus401Response extends HttpResponse {
|
|
336
|
+
status: "401";
|
|
337
|
+
body: TranslationErrorResponse;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Returns the status for a document translation request.
|
|
341
|
+
* The status includes the overall request status, as well as the status for documents that are being translated as part of that request.
|
|
342
|
+
*/
|
|
343
|
+
export interface GetTranslationStatus404Response extends HttpResponse {
|
|
344
|
+
status: "404";
|
|
345
|
+
body: TranslationErrorResponse;
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
* Returns the status for a document translation request.
|
|
349
|
+
* The status includes the overall request status, as well as the status for documents that are being translated as part of that request.
|
|
350
|
+
*/
|
|
351
|
+
export interface GetTranslationStatus429Response extends HttpResponse {
|
|
352
|
+
status: "429";
|
|
353
|
+
body: TranslationErrorResponse;
|
|
354
|
+
}
|
|
355
|
+
/**
|
|
356
|
+
* Returns the status for a document translation request.
|
|
357
|
+
* The status includes the overall request status, as well as the status for documents that are being translated as part of that request.
|
|
358
|
+
*/
|
|
359
|
+
export interface GetTranslationStatus500Response extends HttpResponse {
|
|
360
|
+
status: "500";
|
|
361
|
+
body: TranslationErrorResponse;
|
|
362
|
+
}
|
|
363
|
+
/**
|
|
364
|
+
* Returns the status for a document translation request.
|
|
365
|
+
* The status includes the overall request status, as well as the status for documents that are being translated as part of that request.
|
|
366
|
+
*/
|
|
367
|
+
export interface GetTranslationStatus503Response extends HttpResponse {
|
|
368
|
+
status: "503";
|
|
369
|
+
body: TranslationErrorResponse;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* Cancel a currently processing or queued translation.
|
|
373
|
+
* Cancel a currently processing or queued translation.
|
|
374
|
+
* A translation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.
|
|
375
|
+
* All documents that have completed translation will not be cancelled and will be charged.
|
|
376
|
+
* All pending documents will be cancelled if possible.
|
|
377
|
+
*/
|
|
378
|
+
export interface CancelTranslation200Response extends HttpResponse {
|
|
379
|
+
status: "200";
|
|
380
|
+
body: TranslationStatus;
|
|
381
|
+
}
|
|
382
|
+
/**
|
|
383
|
+
* Cancel a currently processing or queued translation.
|
|
384
|
+
* Cancel a currently processing or queued translation.
|
|
385
|
+
* A translation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.
|
|
386
|
+
* All documents that have completed translation will not be cancelled and will be charged.
|
|
387
|
+
* All pending documents will be cancelled if possible.
|
|
388
|
+
*/
|
|
389
|
+
export interface CancelTranslation401Response extends HttpResponse {
|
|
390
|
+
status: "401";
|
|
391
|
+
body: TranslationErrorResponse;
|
|
392
|
+
}
|
|
393
|
+
/**
|
|
394
|
+
* Cancel a currently processing or queued translation.
|
|
395
|
+
* Cancel a currently processing or queued translation.
|
|
396
|
+
* A translation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.
|
|
397
|
+
* All documents that have completed translation will not be cancelled and will be charged.
|
|
398
|
+
* All pending documents will be cancelled if possible.
|
|
399
|
+
*/
|
|
400
|
+
export interface CancelTranslation404Response extends HttpResponse {
|
|
401
|
+
status: "404";
|
|
402
|
+
body: TranslationErrorResponse;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* Cancel a currently processing or queued translation.
|
|
406
|
+
* Cancel a currently processing or queued translation.
|
|
407
|
+
* A translation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.
|
|
408
|
+
* All documents that have completed translation will not be cancelled and will be charged.
|
|
409
|
+
* All pending documents will be cancelled if possible.
|
|
410
|
+
*/
|
|
411
|
+
export interface CancelTranslation429Response extends HttpResponse {
|
|
412
|
+
status: "429";
|
|
413
|
+
body: TranslationErrorResponse;
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
* Cancel a currently processing or queued translation.
|
|
417
|
+
* Cancel a currently processing or queued translation.
|
|
418
|
+
* A translation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.
|
|
419
|
+
* All documents that have completed translation will not be cancelled and will be charged.
|
|
420
|
+
* All pending documents will be cancelled if possible.
|
|
421
|
+
*/
|
|
422
|
+
export interface CancelTranslation500Response extends HttpResponse {
|
|
423
|
+
status: "500";
|
|
424
|
+
body: TranslationErrorResponse;
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* Cancel a currently processing or queued translation.
|
|
428
|
+
* Cancel a currently processing or queued translation.
|
|
429
|
+
* A translation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.
|
|
430
|
+
* All documents that have completed translation will not be cancelled and will be charged.
|
|
431
|
+
* All pending documents will be cancelled if possible.
|
|
432
|
+
*/
|
|
433
|
+
export interface CancelTranslation503Response extends HttpResponse {
|
|
434
|
+
status: "503";
|
|
435
|
+
body: TranslationErrorResponse;
|
|
436
|
+
}
|
|
437
|
+
export interface GetDocumentsStatus200Headers {
|
|
438
|
+
/** Indicates how long to wait before making a new request. */
|
|
439
|
+
"retry-after"?: string;
|
|
440
|
+
/** The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control. */
|
|
441
|
+
etag?: string;
|
|
442
|
+
}
|
|
443
|
+
/**
|
|
444
|
+
* Returns the status for all documents in a batch document translation request.
|
|
445
|
+
*
|
|
446
|
+
* If the number of documents in the response exceeds our paging limit, server-side paging is used.
|
|
447
|
+
* Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.
|
|
448
|
+
*
|
|
449
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
450
|
+
*
|
|
451
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
452
|
+
* $skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.
|
|
453
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
454
|
+
*
|
|
455
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
456
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
457
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents.
|
|
458
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
459
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
460
|
+
*
|
|
461
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
462
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
463
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
464
|
+
*/
|
|
465
|
+
export interface GetDocumentsStatus200Response extends HttpResponse {
|
|
466
|
+
status: "200";
|
|
467
|
+
body: DocumentsStatus;
|
|
468
|
+
headers: RawHttpHeaders & GetDocumentsStatus200Headers;
|
|
469
|
+
}
|
|
470
|
+
/**
|
|
471
|
+
* Returns the status for all documents in a batch document translation request.
|
|
472
|
+
*
|
|
473
|
+
* If the number of documents in the response exceeds our paging limit, server-side paging is used.
|
|
474
|
+
* Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.
|
|
475
|
+
*
|
|
476
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
477
|
+
*
|
|
478
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
479
|
+
* $skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.
|
|
480
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
481
|
+
*
|
|
482
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
483
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
484
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents.
|
|
485
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
486
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
487
|
+
*
|
|
488
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
489
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
490
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
491
|
+
*/
|
|
492
|
+
export interface GetDocumentsStatus400Response extends HttpResponse {
|
|
493
|
+
status: "400";
|
|
494
|
+
body: TranslationErrorResponse;
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* Returns the status for all documents in a batch document translation request.
|
|
498
|
+
*
|
|
499
|
+
* If the number of documents in the response exceeds our paging limit, server-side paging is used.
|
|
500
|
+
* Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.
|
|
501
|
+
*
|
|
502
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
503
|
+
*
|
|
504
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
505
|
+
* $skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.
|
|
506
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
507
|
+
*
|
|
508
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
509
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
510
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents.
|
|
511
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
512
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
513
|
+
*
|
|
514
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
515
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
516
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
517
|
+
*/
|
|
518
|
+
export interface GetDocumentsStatus401Response extends HttpResponse {
|
|
519
|
+
status: "401";
|
|
520
|
+
body: TranslationErrorResponse;
|
|
521
|
+
}
|
|
522
|
+
/**
|
|
523
|
+
* Returns the status for all documents in a batch document translation request.
|
|
524
|
+
*
|
|
525
|
+
* If the number of documents in the response exceeds our paging limit, server-side paging is used.
|
|
526
|
+
* Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.
|
|
527
|
+
*
|
|
528
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
529
|
+
*
|
|
530
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
531
|
+
* $skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.
|
|
532
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
533
|
+
*
|
|
534
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
535
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
536
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents.
|
|
537
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
538
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
539
|
+
*
|
|
540
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
541
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
542
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
543
|
+
*/
|
|
544
|
+
export interface GetDocumentsStatus404Response extends HttpResponse {
|
|
545
|
+
status: "404";
|
|
546
|
+
body: TranslationErrorResponse;
|
|
547
|
+
}
|
|
548
|
+
/**
|
|
549
|
+
* Returns the status for all documents in a batch document translation request.
|
|
550
|
+
*
|
|
551
|
+
* If the number of documents in the response exceeds our paging limit, server-side paging is used.
|
|
552
|
+
* Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.
|
|
553
|
+
*
|
|
554
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
555
|
+
*
|
|
556
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
557
|
+
* $skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.
|
|
558
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
559
|
+
*
|
|
560
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
561
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
562
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents.
|
|
563
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
564
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
565
|
+
*
|
|
566
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
567
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
568
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
569
|
+
*/
|
|
570
|
+
export interface GetDocumentsStatus429Response extends HttpResponse {
|
|
571
|
+
status: "429";
|
|
572
|
+
body: TranslationErrorResponse;
|
|
573
|
+
}
|
|
574
|
+
/**
|
|
575
|
+
* Returns the status for all documents in a batch document translation request.
|
|
576
|
+
*
|
|
577
|
+
* If the number of documents in the response exceeds our paging limit, server-side paging is used.
|
|
578
|
+
* Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.
|
|
579
|
+
*
|
|
580
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
581
|
+
*
|
|
582
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
583
|
+
* $skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.
|
|
584
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
585
|
+
*
|
|
586
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
587
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
588
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents.
|
|
589
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
590
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
591
|
+
*
|
|
592
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
593
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
594
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
595
|
+
*/
|
|
596
|
+
export interface GetDocumentsStatus500Response extends HttpResponse {
|
|
597
|
+
status: "500";
|
|
598
|
+
body: TranslationErrorResponse;
|
|
599
|
+
}
|
|
600
|
+
/**
|
|
601
|
+
* Returns the status for all documents in a batch document translation request.
|
|
602
|
+
*
|
|
603
|
+
* If the number of documents in the response exceeds our paging limit, server-side paging is used.
|
|
604
|
+
* Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.
|
|
605
|
+
*
|
|
606
|
+
* $top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.
|
|
607
|
+
*
|
|
608
|
+
* $top indicates the total number of records the user wants to be returned across all pages.
|
|
609
|
+
* $skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time.
|
|
610
|
+
* $maxpagesize is the maximum items returned in a page. If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
|
|
611
|
+
*
|
|
612
|
+
* $orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").
|
|
613
|
+
* The default sorting is descending by createdDateTimeUtc.
|
|
614
|
+
* Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents.
|
|
615
|
+
* createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.
|
|
616
|
+
* The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).
|
|
617
|
+
*
|
|
618
|
+
* When both $top and $skip are included, the server should first apply $skip and then $top on the collection.
|
|
619
|
+
* Note: If the server can't honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.
|
|
620
|
+
* This reduces the risk of the client making assumptions about the data returned.
|
|
621
|
+
*/
|
|
622
|
+
export interface GetDocumentsStatus503Response extends HttpResponse {
|
|
623
|
+
status: "503";
|
|
624
|
+
body: TranslationErrorResponse;
|
|
625
|
+
}
|
|
626
|
+
export interface GetSupportedDocumentFormats200Headers {
|
|
627
|
+
/** Indicates how long to wait before making a new request. */
|
|
628
|
+
"retry-after"?: string;
|
|
629
|
+
}
|
|
630
|
+
/**
|
|
631
|
+
* The list of supported document formats supported by the Document Translation service.
|
|
632
|
+
* The list includes the common file extension, as well as the content-type if using the upload API.
|
|
633
|
+
*/
|
|
634
|
+
export interface GetSupportedDocumentFormats200Response extends HttpResponse {
|
|
635
|
+
status: "200";
|
|
636
|
+
body: SupportedFileFormats;
|
|
637
|
+
headers: RawHttpHeaders & GetSupportedDocumentFormats200Headers;
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* The list of supported document formats supported by the Document Translation service.
|
|
641
|
+
* The list includes the common file extension, as well as the content-type if using the upload API.
|
|
642
|
+
*/
|
|
643
|
+
export interface GetSupportedDocumentFormats429Response extends HttpResponse {
|
|
644
|
+
status: "429";
|
|
645
|
+
body: TranslationErrorResponse;
|
|
646
|
+
}
|
|
647
|
+
/**
|
|
648
|
+
* The list of supported document formats supported by the Document Translation service.
|
|
649
|
+
* The list includes the common file extension, as well as the content-type if using the upload API.
|
|
650
|
+
*/
|
|
651
|
+
export interface GetSupportedDocumentFormats500Response extends HttpResponse {
|
|
652
|
+
status: "500";
|
|
653
|
+
body: TranslationErrorResponse;
|
|
654
|
+
}
|
|
655
|
+
/**
|
|
656
|
+
* The list of supported document formats supported by the Document Translation service.
|
|
657
|
+
* The list includes the common file extension, as well as the content-type if using the upload API.
|
|
658
|
+
*/
|
|
659
|
+
export interface GetSupportedDocumentFormats503Response extends HttpResponse {
|
|
660
|
+
status: "503";
|
|
661
|
+
body: TranslationErrorResponse;
|
|
662
|
+
}
|
|
663
|
+
export interface GetSupportedGlossaryFormats200Headers {
|
|
664
|
+
/** Indicates how long to wait before making a new request. */
|
|
665
|
+
"retry-after"?: string;
|
|
666
|
+
}
|
|
667
|
+
/**
|
|
668
|
+
* The list of supported glossary formats supported by the Document Translation service.
|
|
669
|
+
* The list includes the common file extension used.
|
|
670
|
+
*/
|
|
671
|
+
export interface GetSupportedGlossaryFormats200Response extends HttpResponse {
|
|
672
|
+
status: "200";
|
|
673
|
+
body: SupportedFileFormats;
|
|
674
|
+
headers: RawHttpHeaders & GetSupportedGlossaryFormats200Headers;
|
|
675
|
+
}
|
|
676
|
+
/**
|
|
677
|
+
* The list of supported glossary formats supported by the Document Translation service.
|
|
678
|
+
* The list includes the common file extension used.
|
|
679
|
+
*/
|
|
680
|
+
export interface GetSupportedGlossaryFormats429Response extends HttpResponse {
|
|
681
|
+
status: "429";
|
|
682
|
+
body: TranslationErrorResponse;
|
|
683
|
+
}
|
|
684
|
+
/**
|
|
685
|
+
* The list of supported glossary formats supported by the Document Translation service.
|
|
686
|
+
* The list includes the common file extension used.
|
|
687
|
+
*/
|
|
688
|
+
export interface GetSupportedGlossaryFormats500Response extends HttpResponse {
|
|
689
|
+
status: "500";
|
|
690
|
+
body: TranslationErrorResponse;
|
|
691
|
+
}
|
|
692
|
+
/**
|
|
693
|
+
* The list of supported glossary formats supported by the Document Translation service.
|
|
694
|
+
* The list includes the common file extension used.
|
|
695
|
+
*/
|
|
696
|
+
export interface GetSupportedGlossaryFormats503Response extends HttpResponse {
|
|
697
|
+
status: "503";
|
|
698
|
+
body: TranslationErrorResponse;
|
|
699
|
+
}
|
|
700
|
+
export interface GetSupportedStorageSources200Headers {
|
|
701
|
+
/** Indicates how long to wait before making a new request. */
|
|
702
|
+
"retry-after"?: string;
|
|
703
|
+
}
|
|
704
|
+
/** Returns a list of storage sources/options supported by the Document Translation service. */
|
|
705
|
+
export interface GetSupportedStorageSources200Response extends HttpResponse {
|
|
706
|
+
status: "200";
|
|
707
|
+
body: SupportedStorageSources;
|
|
708
|
+
headers: RawHttpHeaders & GetSupportedStorageSources200Headers;
|
|
709
|
+
}
|
|
710
|
+
/** Returns a list of storage sources/options supported by the Document Translation service. */
|
|
711
|
+
export interface GetSupportedStorageSources429Response extends HttpResponse {
|
|
712
|
+
status: "429";
|
|
713
|
+
body: TranslationErrorResponse;
|
|
714
|
+
}
|
|
715
|
+
/** Returns a list of storage sources/options supported by the Document Translation service. */
|
|
716
|
+
export interface GetSupportedStorageSources500Response extends HttpResponse {
|
|
717
|
+
status: "500";
|
|
718
|
+
body: TranslationErrorResponse;
|
|
719
|
+
}
|
|
720
|
+
/** Returns a list of storage sources/options supported by the Document Translation service. */
|
|
721
|
+
export interface GetSupportedStorageSources503Response extends HttpResponse {
|
|
722
|
+
status: "503";
|
|
723
|
+
body: TranslationErrorResponse;
|
|
724
|
+
}
|
|
725
|
+
//# sourceMappingURL=responses.d.ts.map
|