@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20220808
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/index.d.ts +3361 -0
- package/package.json +20 -0
- package/readme.md +68 -0
- package/tests.ts +5048 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,3361 @@
|
|
|
1
|
+
/* Type definitions for non-npm package Cloud Document AI API v1beta3 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/document-ai/docs/
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
// TypeScript Version: 2.8
|
|
8
|
+
|
|
9
|
+
// IMPORTANT
|
|
10
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
11
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
12
|
+
// Generated from: https://documentai.googleapis.com/$discovery/rest?version=v1beta3
|
|
13
|
+
// Revision: 20220808
|
|
14
|
+
|
|
15
|
+
/// <reference types="gapi.client" />
|
|
16
|
+
|
|
17
|
+
declare namespace gapi.client {
|
|
18
|
+
/** Load Cloud Document AI API v1beta3 */
|
|
19
|
+
function load(urlOrObject: "https://documentai.googleapis.com/$discovery/rest?version=v1beta3"): Promise<void>;
|
|
20
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
21
|
+
function load(name: "documentai", version: "v1beta3"): Promise<void>;
|
|
22
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
23
|
+
function load(name: "documentai", version: "v1beta3", callback: () => any): void;
|
|
24
|
+
|
|
25
|
+
namespace documentai {
|
|
26
|
+
interface GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata {
|
|
27
|
+
/** The basic metadata of the long running operation. */
|
|
28
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
29
|
+
/** The list of response details of each document. */
|
|
30
|
+
individualBatchDeleteStatuses?: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus[];
|
|
31
|
+
}
|
|
32
|
+
interface GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus {
|
|
33
|
+
/** The document id of the document. */
|
|
34
|
+
documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
35
|
+
/** The status of deleting the document. */
|
|
36
|
+
status?: GoogleRpcStatus;
|
|
37
|
+
}
|
|
38
|
+
// tslint:disable-next-line:no-empty-interface
|
|
39
|
+
interface GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse {
|
|
40
|
+
}
|
|
41
|
+
interface GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata {
|
|
42
|
+
/** The basic metadata of the long running operation. */
|
|
43
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
44
|
+
/** The destination dataset split type. */
|
|
45
|
+
destDatasetType?: string;
|
|
46
|
+
/** The destination dataset split type. */
|
|
47
|
+
destSplitType?: string;
|
|
48
|
+
/** The list of response details of each document. */
|
|
49
|
+
individualBatchMoveStatuses?: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus[];
|
|
50
|
+
}
|
|
51
|
+
interface GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus {
|
|
52
|
+
/** The document id of the document. */
|
|
53
|
+
documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
54
|
+
/** The status of moving the document. */
|
|
55
|
+
status?: GoogleRpcStatus;
|
|
56
|
+
}
|
|
57
|
+
// tslint:disable-next-line:no-empty-interface
|
|
58
|
+
interface GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse {
|
|
59
|
+
}
|
|
60
|
+
interface GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata {
|
|
61
|
+
/** The creation time of the operation. */
|
|
62
|
+
createTime?: string;
|
|
63
|
+
/** A related resource to this operation. */
|
|
64
|
+
resource?: string;
|
|
65
|
+
/** The state of the operation. */
|
|
66
|
+
state?: string;
|
|
67
|
+
/** A message providing more details about the current state of processing. */
|
|
68
|
+
stateMessage?: string;
|
|
69
|
+
/** The last update time of the operation. */
|
|
70
|
+
updateTime?: string;
|
|
71
|
+
}
|
|
72
|
+
interface GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata {
|
|
73
|
+
/** The basic metadata of the long running operation. */
|
|
74
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
75
|
+
}
|
|
76
|
+
interface GoogleCloudDocumentaiUiv1beta3DeleteDataLabelingJobOperationMetadata {
|
|
77
|
+
/** The basic metadata of the long running operation. */
|
|
78
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
79
|
+
}
|
|
80
|
+
interface GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata {
|
|
81
|
+
/** The basic metadata of the long running operation. */
|
|
82
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
83
|
+
}
|
|
84
|
+
interface GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata {
|
|
85
|
+
/** The basic metadata of the long running operation. */
|
|
86
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
87
|
+
}
|
|
88
|
+
interface GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata {
|
|
89
|
+
/** The basic metadata of the long running operation. */
|
|
90
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
91
|
+
}
|
|
92
|
+
interface GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata {
|
|
93
|
+
/** The basic metadata of the long running operation. */
|
|
94
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
95
|
+
}
|
|
96
|
+
// tslint:disable-next-line:no-empty-interface
|
|
97
|
+
interface GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse {
|
|
98
|
+
}
|
|
99
|
+
interface GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata {
|
|
100
|
+
/** The basic metadata of the long running operation. */
|
|
101
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
102
|
+
}
|
|
103
|
+
// tslint:disable-next-line:no-empty-interface
|
|
104
|
+
interface GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse {
|
|
105
|
+
}
|
|
106
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentId {
|
|
107
|
+
gcsManagedDocId?: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId;
|
|
108
|
+
/** Points to a specific revision of the document if set. */
|
|
109
|
+
revisionReference?: GoogleCloudDocumentaiUiv1beta3RevisionReference;
|
|
110
|
+
}
|
|
111
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId {
|
|
112
|
+
/** Optional. Id of the document (indexed) managed by Content Warehouse. */
|
|
113
|
+
cwDocId?: string;
|
|
114
|
+
/** Required. The Cloud Storage uri where the actual document is stored. */
|
|
115
|
+
gcsUri?: string;
|
|
116
|
+
}
|
|
117
|
+
interface GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata {
|
|
118
|
+
/** The basic metadata of the long running operation. */
|
|
119
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
120
|
+
}
|
|
121
|
+
// tslint:disable-next-line:no-empty-interface
|
|
122
|
+
interface GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse {
|
|
123
|
+
}
|
|
124
|
+
interface GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata {
|
|
125
|
+
/** The basic metadata of the long running operation. */
|
|
126
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
127
|
+
}
|
|
128
|
+
interface GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse {
|
|
129
|
+
/** The resource name of the created evaluation. */
|
|
130
|
+
evaluation?: string;
|
|
131
|
+
}
|
|
132
|
+
interface GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata {
|
|
133
|
+
/** The common metadata about the operation. */
|
|
134
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
135
|
+
}
|
|
136
|
+
interface GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse {
|
|
137
|
+
/** The Cloud Storage URI containing the output artifacts. */
|
|
138
|
+
gcsUri?: string;
|
|
139
|
+
}
|
|
140
|
+
interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata {
|
|
141
|
+
/** The basic metadata of the long running operation. */
|
|
142
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
143
|
+
/** The list of response details of each document. */
|
|
144
|
+
individualImportStatuses?: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus[];
|
|
145
|
+
/** Total number of the documents that are qualified for importing. */
|
|
146
|
+
totalDocumentCount?: number;
|
|
147
|
+
}
|
|
148
|
+
interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus {
|
|
149
|
+
/** The source Cloud Storage URI of the document. */
|
|
150
|
+
inputGcsSource?: string;
|
|
151
|
+
/** The output_gcs_destination of the processed document if it was successful, otherwise empty. */
|
|
152
|
+
outputGcsDestination?: string;
|
|
153
|
+
/** The status of the importing of the document. */
|
|
154
|
+
status?: GoogleRpcStatus;
|
|
155
|
+
}
|
|
156
|
+
// tslint:disable-next-line:no-empty-interface
|
|
157
|
+
interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse {
|
|
158
|
+
}
|
|
159
|
+
interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata {
|
|
160
|
+
/** The basic metadata of the long running operation. */
|
|
161
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
162
|
+
/** Returns the newly added document Cloud Storage prefix if the documents are founded in Cloud Storage while not in Document Service storage. */
|
|
163
|
+
newlyAddedDocuments?: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument[];
|
|
164
|
+
}
|
|
165
|
+
interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument {
|
|
166
|
+
/** The prefix of cloud storage, identifies the destination document which should be updated by resync pipeline. */
|
|
167
|
+
destinationPrefix?: string;
|
|
168
|
+
/** The prefix of cloud storage, identifies the original document which should be updated by resync pipeline. */
|
|
169
|
+
sourcePrefix?: string;
|
|
170
|
+
/** The final status of the documents which should be updated by resync pipeline. */
|
|
171
|
+
status?: GoogleRpcStatus;
|
|
172
|
+
}
|
|
173
|
+
// tslint:disable-next-line:no-empty-interface
|
|
174
|
+
interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse {
|
|
175
|
+
}
|
|
176
|
+
interface GoogleCloudDocumentaiUiv1beta3RevisionReference {
|
|
177
|
+
/** Read the revision generated by the processor version, returns error if it does not exist. */
|
|
178
|
+
latestProcessorVersion?: string;
|
|
179
|
+
/** Read the revision by the predefined case. */
|
|
180
|
+
revisionCase?: string;
|
|
181
|
+
/** Read the revision given by the id, returns error if it does not exist. */
|
|
182
|
+
revisionId?: string;
|
|
183
|
+
}
|
|
184
|
+
interface GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata {
|
|
185
|
+
/** The basic metadata of the long running operation. */
|
|
186
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
187
|
+
}
|
|
188
|
+
// tslint:disable-next-line:no-empty-interface
|
|
189
|
+
interface GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse {
|
|
190
|
+
}
|
|
191
|
+
interface GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata {
|
|
192
|
+
/** The basic metadata of the long running operation. */
|
|
193
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
194
|
+
/** The test dataset validation information. */
|
|
195
|
+
testDatasetValidation?: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation;
|
|
196
|
+
/** The training dataset validation information. */
|
|
197
|
+
trainingDatasetValidation?: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation;
|
|
198
|
+
}
|
|
199
|
+
interface GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation {
|
|
200
|
+
/** The total number of dataset errors. */
|
|
201
|
+
datasetErrorCount?: number;
|
|
202
|
+
/** Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. */
|
|
203
|
+
datasetErrors?: GoogleRpcStatus[];
|
|
204
|
+
/** The total number of document errors. */
|
|
205
|
+
documentErrorCount?: number;
|
|
206
|
+
/** Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. */
|
|
207
|
+
documentErrors?: GoogleRpcStatus[];
|
|
208
|
+
}
|
|
209
|
+
interface GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse {
|
|
210
|
+
/** The resource name of the processor version produced by training. */
|
|
211
|
+
processorVersion?: string;
|
|
212
|
+
}
|
|
213
|
+
interface GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata {
|
|
214
|
+
/** The basic metadata of the long running operation. */
|
|
215
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
216
|
+
}
|
|
217
|
+
// tslint:disable-next-line:no-empty-interface
|
|
218
|
+
interface GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse {
|
|
219
|
+
}
|
|
220
|
+
interface GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata {
|
|
221
|
+
/** The basic metadata of the long running operation. */
|
|
222
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
223
|
+
}
|
|
224
|
+
interface GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata {
|
|
225
|
+
/** The basic metadata of the long running operation. */
|
|
226
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
227
|
+
}
|
|
228
|
+
interface GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata {
|
|
229
|
+
/** The basic metadata of the long running operation. */
|
|
230
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
231
|
+
}
|
|
232
|
+
interface GoogleCloudDocumentaiV1alpha1AnalyzeHitlDataMetadata {
|
|
233
|
+
/** The basic metadata of the long running operation. */
|
|
234
|
+
commonMetadata?: GoogleCloudDocumentaiV1alpha1CommonOperationMetadata;
|
|
235
|
+
}
|
|
236
|
+
interface GoogleCloudDocumentaiV1alpha1CommonOperationMetadata {
|
|
237
|
+
/** The creation time of the operation. */
|
|
238
|
+
createTime?: string;
|
|
239
|
+
/** A related resource to this operation. */
|
|
240
|
+
resource?: string;
|
|
241
|
+
/** The state of the operation. */
|
|
242
|
+
state?: string;
|
|
243
|
+
/** A message providing more details about the current state of processing. */
|
|
244
|
+
stateMessage?: string;
|
|
245
|
+
/** The last update time of the operation. */
|
|
246
|
+
updateTime?: string;
|
|
247
|
+
}
|
|
248
|
+
interface GoogleCloudDocumentaiV1BatchProcessMetadata {
|
|
249
|
+
/** The creation time of the operation. */
|
|
250
|
+
createTime?: string;
|
|
251
|
+
/** The list of response details of each document. */
|
|
252
|
+
individualProcessStatuses?: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus[];
|
|
253
|
+
/** The state of the current batch processing. */
|
|
254
|
+
state?: string;
|
|
255
|
+
/** A message providing more details about the current state of processing. For example, the error message if the operation is failed. */
|
|
256
|
+
stateMessage?: string;
|
|
257
|
+
/** The last update time of the operation. */
|
|
258
|
+
updateTime?: string;
|
|
259
|
+
}
|
|
260
|
+
interface GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus {
|
|
261
|
+
/** The status of human review on the processed document. */
|
|
262
|
+
humanReviewStatus?: GoogleCloudDocumentaiV1HumanReviewStatus;
|
|
263
|
+
/**
|
|
264
|
+
* The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since
|
|
265
|
+
* a user can move or change that document during the process.
|
|
266
|
+
*/
|
|
267
|
+
inputGcsSource?: string;
|
|
268
|
+
/** The output_gcs_destination (in the request as `output_gcs_destination`) of the processed document if it was successful, otherwise empty. */
|
|
269
|
+
outputGcsDestination?: string;
|
|
270
|
+
/** The status processing the document. */
|
|
271
|
+
status?: GoogleRpcStatus;
|
|
272
|
+
}
|
|
273
|
+
// tslint:disable-next-line:no-empty-interface
|
|
274
|
+
interface GoogleCloudDocumentaiV1BatchProcessResponse {
|
|
275
|
+
}
|
|
276
|
+
interface GoogleCloudDocumentaiV1beta1Barcode {
|
|
277
|
+
/**
|
|
278
|
+
* Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF:
|
|
279
|
+
* ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1
|
|
280
|
+
* DataBar code type.
|
|
281
|
+
*/
|
|
282
|
+
format?: string;
|
|
283
|
+
/** Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. */
|
|
284
|
+
rawValue?: string;
|
|
285
|
+
/**
|
|
286
|
+
* Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier.
|
|
287
|
+
* PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event.
|
|
288
|
+
* DRIVER_LICENSE: Driver's license.
|
|
289
|
+
*/
|
|
290
|
+
valueFormat?: string;
|
|
291
|
+
}
|
|
292
|
+
interface GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse {
|
|
293
|
+
/** Responses for each individual document. */
|
|
294
|
+
responses?: GoogleCloudDocumentaiV1beta1ProcessDocumentResponse[];
|
|
295
|
+
}
|
|
296
|
+
interface GoogleCloudDocumentaiV1beta1BoundingPoly {
|
|
297
|
+
/** The bounding polygon normalized vertices. */
|
|
298
|
+
normalizedVertices?: GoogleCloudDocumentaiV1beta1NormalizedVertex[];
|
|
299
|
+
/** The bounding polygon vertices. */
|
|
300
|
+
vertices?: GoogleCloudDocumentaiV1beta1Vertex[];
|
|
301
|
+
}
|
|
302
|
+
interface GoogleCloudDocumentaiV1beta1Document {
|
|
303
|
+
/**
|
|
304
|
+
* Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations
|
|
305
|
+
* use base64.
|
|
306
|
+
*/
|
|
307
|
+
content?: string;
|
|
308
|
+
/** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
|
|
309
|
+
entities?: GoogleCloudDocumentaiV1beta1DocumentEntity[];
|
|
310
|
+
/** Placeholder. Relationship among Document.entities. */
|
|
311
|
+
entityRelations?: GoogleCloudDocumentaiV1beta1DocumentEntityRelation[];
|
|
312
|
+
/** Any error that occurred while processing this document. */
|
|
313
|
+
error?: GoogleRpcStatus;
|
|
314
|
+
/** An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
315
|
+
mimeType?: string;
|
|
316
|
+
/** Visual page layout for the Document. */
|
|
317
|
+
pages?: GoogleCloudDocumentaiV1beta1DocumentPage[];
|
|
318
|
+
/** Placeholder. Revision history of this document. */
|
|
319
|
+
revisions?: GoogleCloudDocumentaiV1beta1DocumentRevision[];
|
|
320
|
+
/** Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. */
|
|
321
|
+
shardInfo?: GoogleCloudDocumentaiV1beta1DocumentShardInfo;
|
|
322
|
+
/** Optional. UTF-8 encoded text in reading order from the document. */
|
|
323
|
+
text?: string;
|
|
324
|
+
/**
|
|
325
|
+
* Placeholder. A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap
|
|
326
|
+
* with each other.
|
|
327
|
+
*/
|
|
328
|
+
textChanges?: GoogleCloudDocumentaiV1beta1DocumentTextChange[];
|
|
329
|
+
/** Placeholder. Styles for the Document.text. */
|
|
330
|
+
textStyles?: GoogleCloudDocumentaiV1beta1DocumentStyle[];
|
|
331
|
+
/**
|
|
332
|
+
* Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request
|
|
333
|
+
* URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
|
|
334
|
+
*/
|
|
335
|
+
uri?: string;
|
|
336
|
+
}
|
|
337
|
+
interface GoogleCloudDocumentaiV1beta1DocumentEntity {
|
|
338
|
+
/** Optional. Confidence of detected Schema entity. Range [0, 1]. */
|
|
339
|
+
confidence?: number;
|
|
340
|
+
/** Optional. Canonical id. This will be a unique value in the entity list for this document. */
|
|
341
|
+
id?: string;
|
|
342
|
+
/** Optional. Deprecated. Use `id` field instead. */
|
|
343
|
+
mentionId?: string;
|
|
344
|
+
/** Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. */
|
|
345
|
+
mentionText?: string;
|
|
346
|
+
/**
|
|
347
|
+
* Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a
|
|
348
|
+
* false negative. A non-present entity should have an empty mention_text and text_anchor.
|
|
349
|
+
*/
|
|
350
|
+
nonPresent?: boolean;
|
|
351
|
+
/**
|
|
352
|
+
* Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only
|
|
353
|
+
* populated for certain supported document types.
|
|
354
|
+
*/
|
|
355
|
+
normalizedValue?: GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue;
|
|
356
|
+
/** Optional. Represents the provenance of this entity wrt. the location on the page where it was found. */
|
|
357
|
+
pageAnchor?: GoogleCloudDocumentaiV1beta1DocumentPageAnchor;
|
|
358
|
+
/** Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. */
|
|
359
|
+
properties?: GoogleCloudDocumentaiV1beta1DocumentEntity[];
|
|
360
|
+
/** Optional. The history of this annotation. */
|
|
361
|
+
provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
|
|
362
|
+
/** Optional. Whether the entity will be redacted for de-identification purposes. */
|
|
363
|
+
redacted?: boolean;
|
|
364
|
+
/** Optional. Provenance of the entity. Text anchor indexing into the Document.text. */
|
|
365
|
+
textAnchor?: GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
|
|
366
|
+
/** Required. Entity type from a schema e.g. `Address`. */
|
|
367
|
+
type?: string;
|
|
368
|
+
}
|
|
369
|
+
interface GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue {
|
|
370
|
+
/** Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto */
|
|
371
|
+
addressValue?: GoogleTypePostalAddress;
|
|
372
|
+
/** Boolean value. Can be used for entities with binary values, or for checkboxes. */
|
|
373
|
+
booleanValue?: boolean;
|
|
374
|
+
/** DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto */
|
|
375
|
+
datetimeValue?: GoogleTypeDateTime;
|
|
376
|
+
/** Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto */
|
|
377
|
+
dateValue?: GoogleTypeDate;
|
|
378
|
+
/** Float value. */
|
|
379
|
+
floatValue?: number;
|
|
380
|
+
/** Integer value. */
|
|
381
|
+
integerValue?: number;
|
|
382
|
+
/** Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */
|
|
383
|
+
moneyValue?: GoogleTypeMoney;
|
|
384
|
+
/**
|
|
385
|
+
* Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of
|
|
386
|
+
* `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. -
|
|
387
|
+
* Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601
|
|
388
|
+
* text format.
|
|
389
|
+
*/
|
|
390
|
+
text?: string;
|
|
391
|
+
}
|
|
392
|
+
interface GoogleCloudDocumentaiV1beta1DocumentEntityRelation {
|
|
393
|
+
/** Object entity id. */
|
|
394
|
+
objectId?: string;
|
|
395
|
+
/** Relationship description. */
|
|
396
|
+
relation?: string;
|
|
397
|
+
/** Subject entity id. */
|
|
398
|
+
subjectId?: string;
|
|
399
|
+
}
|
|
400
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPage {
|
|
401
|
+
/** A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. */
|
|
402
|
+
blocks?: GoogleCloudDocumentaiV1beta1DocumentPageBlock[];
|
|
403
|
+
/** A list of detected barcodes. */
|
|
404
|
+
detectedBarcodes?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode[];
|
|
405
|
+
/** A list of detected languages together with confidence. */
|
|
406
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
407
|
+
/** Physical dimension of the page. */
|
|
408
|
+
dimension?: GoogleCloudDocumentaiV1beta1DocumentPageDimension;
|
|
409
|
+
/** A list of visually detected form fields on the page. */
|
|
410
|
+
formFields?: GoogleCloudDocumentaiV1beta1DocumentPageFormField[];
|
|
411
|
+
/** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
|
|
412
|
+
image?: GoogleCloudDocumentaiV1beta1DocumentPageImage;
|
|
413
|
+
/** Layout for the page. */
|
|
414
|
+
layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
415
|
+
/** A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. */
|
|
416
|
+
lines?: GoogleCloudDocumentaiV1beta1DocumentPageLine[];
|
|
417
|
+
/** 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. */
|
|
418
|
+
pageNumber?: number;
|
|
419
|
+
/** A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. */
|
|
420
|
+
paragraphs?: GoogleCloudDocumentaiV1beta1DocumentPageParagraph[];
|
|
421
|
+
/** The history of this page. */
|
|
422
|
+
provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
|
|
423
|
+
/** A list of visually detected symbols on the page. */
|
|
424
|
+
symbols?: GoogleCloudDocumentaiV1beta1DocumentPageSymbol[];
|
|
425
|
+
/** A list of visually detected tables on the page. */
|
|
426
|
+
tables?: GoogleCloudDocumentaiV1beta1DocumentPageTable[];
|
|
427
|
+
/** A list of visually detected tokens on the page. */
|
|
428
|
+
tokens?: GoogleCloudDocumentaiV1beta1DocumentPageToken[];
|
|
429
|
+
/** Transformation matrices that were applied to the original document image to produce Page.image. */
|
|
430
|
+
transforms?: GoogleCloudDocumentaiV1beta1DocumentPageMatrix[];
|
|
431
|
+
/** A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. */
|
|
432
|
+
visualElements?: GoogleCloudDocumentaiV1beta1DocumentPageVisualElement[];
|
|
433
|
+
}
|
|
434
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageAnchor {
|
|
435
|
+
/** One or more references to visual page elements */
|
|
436
|
+
pageRefs?: GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef[];
|
|
437
|
+
}
|
|
438
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef {
|
|
439
|
+
/** Optional. Identifies the bounding polygon of a layout element on the page. */
|
|
440
|
+
boundingPoly?: GoogleCloudDocumentaiV1beta1BoundingPoly;
|
|
441
|
+
/** Optional. Confidence of detected page element, if applicable. Range [0, 1]. */
|
|
442
|
+
confidence?: number;
|
|
443
|
+
/** Optional. Deprecated. Use PageRef.bounding_poly instead. */
|
|
444
|
+
layoutId?: string;
|
|
445
|
+
/** Optional. The type of the layout element that is being referenced if any. */
|
|
446
|
+
layoutType?: string;
|
|
447
|
+
/**
|
|
448
|
+
* Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See
|
|
449
|
+
* https://developers.google.com/protocol-buffers/docs/proto3#json.
|
|
450
|
+
*/
|
|
451
|
+
page?: string;
|
|
452
|
+
}
|
|
453
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageBlock {
|
|
454
|
+
/** A list of detected languages together with confidence. */
|
|
455
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
456
|
+
/** Layout for Block. */
|
|
457
|
+
layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
458
|
+
/** The history of this annotation. */
|
|
459
|
+
provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
|
|
460
|
+
}
|
|
461
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode {
|
|
462
|
+
/** Detailed barcode information of the DetectedBarcode. */
|
|
463
|
+
barcode?: GoogleCloudDocumentaiV1beta1Barcode;
|
|
464
|
+
/** Layout for DetectedBarcode. */
|
|
465
|
+
layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
466
|
+
}
|
|
467
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage {
|
|
468
|
+
/** Confidence of detected language. Range [0, 1]. */
|
|
469
|
+
confidence?: number;
|
|
470
|
+
/** The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
|
|
471
|
+
languageCode?: string;
|
|
472
|
+
}
|
|
473
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageDimension {
|
|
474
|
+
/** Page height. */
|
|
475
|
+
height?: number;
|
|
476
|
+
/** Dimension unit. */
|
|
477
|
+
unit?: string;
|
|
478
|
+
/** Page width. */
|
|
479
|
+
width?: number;
|
|
480
|
+
}
|
|
481
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageFormField {
|
|
482
|
+
/** Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. */
|
|
483
|
+
correctedKeyText?: string;
|
|
484
|
+
/** Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. */
|
|
485
|
+
correctedValueText?: string;
|
|
486
|
+
/** Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. */
|
|
487
|
+
fieldName?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
488
|
+
/** Layout for the FormField value. */
|
|
489
|
+
fieldValue?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
490
|
+
/** A list of detected languages for name together with confidence. */
|
|
491
|
+
nameDetectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
492
|
+
/** The history of this annotation. */
|
|
493
|
+
provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
|
|
494
|
+
/** A list of detected languages for value together with confidence. */
|
|
495
|
+
valueDetectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
496
|
+
/**
|
|
497
|
+
* If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - "unfilled_checkbox" -
|
|
498
|
+
* "filled_checkbox"
|
|
499
|
+
*/
|
|
500
|
+
valueType?: string;
|
|
501
|
+
}
|
|
502
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageImage {
|
|
503
|
+
/** Raw byte content of the image. */
|
|
504
|
+
content?: string;
|
|
505
|
+
/** Height of the image in pixels. */
|
|
506
|
+
height?: number;
|
|
507
|
+
/** Encoding mime type for the image. */
|
|
508
|
+
mimeType?: string;
|
|
509
|
+
/** Width of the image in pixels. */
|
|
510
|
+
width?: number;
|
|
511
|
+
}
|
|
512
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageLayout {
|
|
513
|
+
/** The bounding polygon for the Layout. */
|
|
514
|
+
boundingPoly?: GoogleCloudDocumentaiV1beta1BoundingPoly;
|
|
515
|
+
/**
|
|
516
|
+
* Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context.
|
|
517
|
+
* Range [0, 1].
|
|
518
|
+
*/
|
|
519
|
+
confidence?: number;
|
|
520
|
+
/** Detected orientation for the Layout. */
|
|
521
|
+
orientation?: string;
|
|
522
|
+
/** Text anchor indexing into the Document.text. */
|
|
523
|
+
textAnchor?: GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
|
|
524
|
+
}
|
|
525
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageLine {
|
|
526
|
+
/** A list of detected languages together with confidence. */
|
|
527
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
528
|
+
/** Layout for Line. */
|
|
529
|
+
layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
530
|
+
/** The history of this annotation. */
|
|
531
|
+
provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
|
|
532
|
+
}
|
|
533
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageMatrix {
|
|
534
|
+
/** Number of columns in the matrix. */
|
|
535
|
+
cols?: number;
|
|
536
|
+
/** The matrix data. */
|
|
537
|
+
data?: string;
|
|
538
|
+
/** Number of rows in the matrix. */
|
|
539
|
+
rows?: number;
|
|
540
|
+
/**
|
|
541
|
+
* This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to
|
|
542
|
+
* https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
|
|
543
|
+
*/
|
|
544
|
+
type?: number;
|
|
545
|
+
}
|
|
546
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageParagraph {
|
|
547
|
+
/** A list of detected languages together with confidence. */
|
|
548
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
549
|
+
/** Layout for Paragraph. */
|
|
550
|
+
layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
551
|
+
/** The history of this annotation. */
|
|
552
|
+
provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
|
|
553
|
+
}
|
|
554
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageSymbol {
|
|
555
|
+
/** A list of detected languages together with confidence. */
|
|
556
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
557
|
+
/** Layout for Symbol. */
|
|
558
|
+
layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
559
|
+
}
|
|
560
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageTable {
|
|
561
|
+
/** Body rows of the table. */
|
|
562
|
+
bodyRows?: GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow[];
|
|
563
|
+
/** A list of detected languages together with confidence. */
|
|
564
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
565
|
+
/** Header rows of the table. */
|
|
566
|
+
headerRows?: GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow[];
|
|
567
|
+
/** Layout for Table. */
|
|
568
|
+
layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
569
|
+
}
|
|
570
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell {
|
|
571
|
+
/** How many columns this cell spans. */
|
|
572
|
+
colSpan?: number;
|
|
573
|
+
/** A list of detected languages together with confidence. */
|
|
574
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
575
|
+
/** Layout for TableCell. */
|
|
576
|
+
layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
577
|
+
/** How many rows this cell spans. */
|
|
578
|
+
rowSpan?: number;
|
|
579
|
+
}
|
|
580
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow {
|
|
581
|
+
/** Cells that make up this row. */
|
|
582
|
+
cells?: GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell[];
|
|
583
|
+
}
|
|
584
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageToken {
|
|
585
|
+
/** Detected break at the end of a Token. */
|
|
586
|
+
detectedBreak?: GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak;
|
|
587
|
+
/** A list of detected languages together with confidence. */
|
|
588
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
589
|
+
/** Layout for Token. */
|
|
590
|
+
layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
591
|
+
/** The history of this annotation. */
|
|
592
|
+
provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
|
|
593
|
+
}
|
|
594
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak {
|
|
595
|
+
/** Detected break type. */
|
|
596
|
+
type?: string;
|
|
597
|
+
}
|
|
598
|
+
interface GoogleCloudDocumentaiV1beta1DocumentPageVisualElement {
|
|
599
|
+
/** A list of detected languages together with confidence. */
|
|
600
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
601
|
+
/** Layout for VisualElement. */
|
|
602
|
+
layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
|
|
603
|
+
/** Type of the VisualElement. */
|
|
604
|
+
type?: string;
|
|
605
|
+
}
|
|
606
|
+
interface GoogleCloudDocumentaiV1beta1DocumentProvenance {
|
|
607
|
+
/** The Id of this operation. Needs to be unique within the scope of the revision. */
|
|
608
|
+
id?: number;
|
|
609
|
+
/** References to the original elements that are replaced. */
|
|
610
|
+
parents?: GoogleCloudDocumentaiV1beta1DocumentProvenanceParent[];
|
|
611
|
+
/** The index of the revision that produced this element. */
|
|
612
|
+
revision?: number;
|
|
613
|
+
/** The type of provenance operation. */
|
|
614
|
+
type?: string;
|
|
615
|
+
}
|
|
616
|
+
interface GoogleCloudDocumentaiV1beta1DocumentProvenanceParent {
|
|
617
|
+
/** The id of the parent provenance. */
|
|
618
|
+
id?: number;
|
|
619
|
+
/** The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. */
|
|
620
|
+
index?: number;
|
|
621
|
+
/** The index of the index into current revision's parent_ids list. */
|
|
622
|
+
revision?: number;
|
|
623
|
+
}
|
|
624
|
+
interface GoogleCloudDocumentaiV1beta1DocumentRevision {
|
|
625
|
+
/** If the change was made by a person specify the name or id of that person. */
|
|
626
|
+
agent?: string;
|
|
627
|
+
/** The time that the revision was created. */
|
|
628
|
+
createTime?: string;
|
|
629
|
+
/** Human Review information of this revision. */
|
|
630
|
+
humanReview?: GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview;
|
|
631
|
+
/** Id of the revision. Unique within the context of the document. */
|
|
632
|
+
id?: string;
|
|
633
|
+
/** The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. */
|
|
634
|
+
parent?: number[];
|
|
635
|
+
/**
|
|
636
|
+
* The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index
|
|
637
|
+
* into this field.
|
|
638
|
+
*/
|
|
639
|
+
parentIds?: string[];
|
|
640
|
+
/** If the annotation was made by processor identify the processor by its resource name. */
|
|
641
|
+
processor?: string;
|
|
642
|
+
}
|
|
643
|
+
interface GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview {
|
|
644
|
+
/** Human review state. e.g. `requested`, `succeeded`, `rejected`. */
|
|
645
|
+
state?: string;
|
|
646
|
+
/** A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. */
|
|
647
|
+
stateMessage?: string;
|
|
648
|
+
}
|
|
649
|
+
interface GoogleCloudDocumentaiV1beta1DocumentShardInfo {
|
|
650
|
+
/** Total number of shards. */
|
|
651
|
+
shardCount?: string;
|
|
652
|
+
/** The 0-based index of this shard. */
|
|
653
|
+
shardIndex?: string;
|
|
654
|
+
/** The index of the first character in Document.text in the overall document global text. */
|
|
655
|
+
textOffset?: string;
|
|
656
|
+
}
|
|
657
|
+
interface GoogleCloudDocumentaiV1beta1DocumentStyle {
|
|
658
|
+
/** Text background color. */
|
|
659
|
+
backgroundColor?: GoogleTypeColor;
|
|
660
|
+
/** Text color. */
|
|
661
|
+
color?: GoogleTypeColor;
|
|
662
|
+
/** Font size. */
|
|
663
|
+
fontSize?: GoogleCloudDocumentaiV1beta1DocumentStyleFontSize;
|
|
664
|
+
/** Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp */
|
|
665
|
+
fontWeight?: string;
|
|
666
|
+
/** Text anchor indexing into the Document.text. */
|
|
667
|
+
textAnchor?: GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
|
|
668
|
+
/** Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp */
|
|
669
|
+
textDecoration?: string;
|
|
670
|
+
/** Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp */
|
|
671
|
+
textStyle?: string;
|
|
672
|
+
}
|
|
673
|
+
interface GoogleCloudDocumentaiV1beta1DocumentStyleFontSize {
|
|
674
|
+
/** Font size for the text. */
|
|
675
|
+
size?: number;
|
|
676
|
+
/** Unit for the font size. Follows CSS naming (in, px, pt, etc.). */
|
|
677
|
+
unit?: string;
|
|
678
|
+
}
|
|
679
|
+
interface GoogleCloudDocumentaiV1beta1DocumentTextAnchor {
|
|
680
|
+
/** Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. */
|
|
681
|
+
content?: string;
|
|
682
|
+
/** The text segments from the Document.text. */
|
|
683
|
+
textSegments?: GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment[];
|
|
684
|
+
}
|
|
685
|
+
interface GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment {
|
|
686
|
+
/** TextSegment half open end UTF-8 char index in the Document.text. */
|
|
687
|
+
endIndex?: string;
|
|
688
|
+
/** TextSegment start UTF-8 char index in the Document.text. */
|
|
689
|
+
startIndex?: string;
|
|
690
|
+
}
|
|
691
|
+
interface GoogleCloudDocumentaiV1beta1DocumentTextChange {
|
|
692
|
+
/** The text that replaces the text identified in the `text_anchor`. */
|
|
693
|
+
changedText?: string;
|
|
694
|
+
/** The history of this annotation. */
|
|
695
|
+
provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance[];
|
|
696
|
+
/**
|
|
697
|
+
* Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text
|
|
698
|
+
* segment are the same, the text change is inserted before that index.
|
|
699
|
+
*/
|
|
700
|
+
textAnchor?: GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
|
|
701
|
+
}
|
|
702
|
+
interface GoogleCloudDocumentaiV1beta1GcsDestination {
|
|
703
|
+
uri?: string;
|
|
704
|
+
}
|
|
705
|
+
interface GoogleCloudDocumentaiV1beta1GcsSource {
|
|
706
|
+
uri?: string;
|
|
707
|
+
}
|
|
708
|
+
interface GoogleCloudDocumentaiV1beta1InputConfig {
|
|
709
|
+
/** The Google Cloud Storage location to read the input from. This must be a single file. */
|
|
710
|
+
gcsSource?: GoogleCloudDocumentaiV1beta1GcsSource;
|
|
711
|
+
/**
|
|
712
|
+
* Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with
|
|
713
|
+
* ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.
|
|
714
|
+
*/
|
|
715
|
+
mimeType?: string;
|
|
716
|
+
}
|
|
717
|
+
interface GoogleCloudDocumentaiV1beta1NormalizedVertex {
|
|
718
|
+
/** X coordinate. */
|
|
719
|
+
x?: number;
|
|
720
|
+
/** Y coordinate (starts from the top of the image). */
|
|
721
|
+
y?: number;
|
|
722
|
+
}
|
|
723
|
+
interface GoogleCloudDocumentaiV1beta1OperationMetadata {
|
|
724
|
+
/** The creation time of the operation. */
|
|
725
|
+
createTime?: string;
|
|
726
|
+
/** The state of the current batch processing. */
|
|
727
|
+
state?: string;
|
|
728
|
+
/** A message providing more details about the current state of processing. */
|
|
729
|
+
stateMessage?: string;
|
|
730
|
+
/** The last update time of the operation. */
|
|
731
|
+
updateTime?: string;
|
|
732
|
+
}
|
|
733
|
+
interface GoogleCloudDocumentaiV1beta1OutputConfig {
|
|
734
|
+
/** The Google Cloud Storage location to write the output to. */
|
|
735
|
+
gcsDestination?: GoogleCloudDocumentaiV1beta1GcsDestination;
|
|
736
|
+
/**
|
|
737
|
+
* The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example,
|
|
738
|
+
* for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under
|
|
739
|
+
* the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50:
|
|
740
|
+
* pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json
|
|
741
|
+
*/
|
|
742
|
+
pagesPerShard?: number;
|
|
743
|
+
}
|
|
744
|
+
interface GoogleCloudDocumentaiV1beta1ProcessDocumentResponse {
|
|
745
|
+
/** Information about the input file. This is the same as the corresponding input config in the request. */
|
|
746
|
+
inputConfig?: GoogleCloudDocumentaiV1beta1InputConfig;
|
|
747
|
+
/** The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects. */
|
|
748
|
+
outputConfig?: GoogleCloudDocumentaiV1beta1OutputConfig;
|
|
749
|
+
}
|
|
750
|
+
interface GoogleCloudDocumentaiV1beta1Vertex {
|
|
751
|
+
/** X coordinate. */
|
|
752
|
+
x?: number;
|
|
753
|
+
/** Y coordinate (starts from the top of the image). */
|
|
754
|
+
y?: number;
|
|
755
|
+
}
|
|
756
|
+
interface GoogleCloudDocumentaiV1beta2Barcode {
|
|
757
|
+
/**
|
|
758
|
+
* Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF:
|
|
759
|
+
* ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1
|
|
760
|
+
* DataBar code type.
|
|
761
|
+
*/
|
|
762
|
+
format?: string;
|
|
763
|
+
/** Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. */
|
|
764
|
+
rawValue?: string;
|
|
765
|
+
/**
|
|
766
|
+
* Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier.
|
|
767
|
+
* PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event.
|
|
768
|
+
* DRIVER_LICENSE: Driver's license.
|
|
769
|
+
*/
|
|
770
|
+
valueFormat?: string;
|
|
771
|
+
}
|
|
772
|
+
interface GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse {
|
|
773
|
+
/** Responses for each individual document. */
|
|
774
|
+
responses?: GoogleCloudDocumentaiV1beta2ProcessDocumentResponse[];
|
|
775
|
+
}
|
|
776
|
+
interface GoogleCloudDocumentaiV1beta2BoundingPoly {
|
|
777
|
+
/** The bounding polygon normalized vertices. */
|
|
778
|
+
normalizedVertices?: GoogleCloudDocumentaiV1beta2NormalizedVertex[];
|
|
779
|
+
/** The bounding polygon vertices. */
|
|
780
|
+
vertices?: GoogleCloudDocumentaiV1beta2Vertex[];
|
|
781
|
+
}
|
|
782
|
+
interface GoogleCloudDocumentaiV1beta2Document {
|
|
783
|
+
/**
|
|
784
|
+
* Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations
|
|
785
|
+
* use base64.
|
|
786
|
+
*/
|
|
787
|
+
content?: string;
|
|
788
|
+
/** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
|
|
789
|
+
entities?: GoogleCloudDocumentaiV1beta2DocumentEntity[];
|
|
790
|
+
/** Placeholder. Relationship among Document.entities. */
|
|
791
|
+
entityRelations?: GoogleCloudDocumentaiV1beta2DocumentEntityRelation[];
|
|
792
|
+
/** Any error that occurred while processing this document. */
|
|
793
|
+
error?: GoogleRpcStatus;
|
|
794
|
+
/** Labels for this document. */
|
|
795
|
+
labels?: GoogleCloudDocumentaiV1beta2DocumentLabel[];
|
|
796
|
+
/** An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
797
|
+
mimeType?: string;
|
|
798
|
+
/** Visual page layout for the Document. */
|
|
799
|
+
pages?: GoogleCloudDocumentaiV1beta2DocumentPage[];
|
|
800
|
+
/** Placeholder. Revision history of this document. */
|
|
801
|
+
revisions?: GoogleCloudDocumentaiV1beta2DocumentRevision[];
|
|
802
|
+
/** Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. */
|
|
803
|
+
shardInfo?: GoogleCloudDocumentaiV1beta2DocumentShardInfo;
|
|
804
|
+
/** Optional. UTF-8 encoded text in reading order from the document. */
|
|
805
|
+
text?: string;
|
|
806
|
+
/**
|
|
807
|
+
* Placeholder. A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap
|
|
808
|
+
* with each other.
|
|
809
|
+
*/
|
|
810
|
+
textChanges?: GoogleCloudDocumentaiV1beta2DocumentTextChange[];
|
|
811
|
+
/** Placeholder. Styles for the Document.text. */
|
|
812
|
+
textStyles?: GoogleCloudDocumentaiV1beta2DocumentStyle[];
|
|
813
|
+
/**
|
|
814
|
+
* Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request
|
|
815
|
+
* URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
|
|
816
|
+
*/
|
|
817
|
+
uri?: string;
|
|
818
|
+
}
|
|
819
|
+
interface GoogleCloudDocumentaiV1beta2DocumentEntity {
|
|
820
|
+
/** Optional. Confidence of detected Schema entity. Range [0, 1]. */
|
|
821
|
+
confidence?: number;
|
|
822
|
+
/** Optional. Canonical id. This will be a unique value in the entity list for this document. */
|
|
823
|
+
id?: string;
|
|
824
|
+
/** Optional. Deprecated. Use `id` field instead. */
|
|
825
|
+
mentionId?: string;
|
|
826
|
+
/** Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. */
|
|
827
|
+
mentionText?: string;
|
|
828
|
+
/**
|
|
829
|
+
* Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a
|
|
830
|
+
* false negative. A non-present entity should have an empty mention_text and text_anchor.
|
|
831
|
+
*/
|
|
832
|
+
nonPresent?: boolean;
|
|
833
|
+
/**
|
|
834
|
+
* Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only
|
|
835
|
+
* populated for certain supported document types.
|
|
836
|
+
*/
|
|
837
|
+
normalizedValue?: GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue;
|
|
838
|
+
/** Optional. Represents the provenance of this entity wrt. the location on the page where it was found. */
|
|
839
|
+
pageAnchor?: GoogleCloudDocumentaiV1beta2DocumentPageAnchor;
|
|
840
|
+
/** Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. */
|
|
841
|
+
properties?: GoogleCloudDocumentaiV1beta2DocumentEntity[];
|
|
842
|
+
/** Optional. The history of this annotation. */
|
|
843
|
+
provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
|
|
844
|
+
/** Optional. Whether the entity will be redacted for de-identification purposes. */
|
|
845
|
+
redacted?: boolean;
|
|
846
|
+
/** Optional. Provenance of the entity. Text anchor indexing into the Document.text. */
|
|
847
|
+
textAnchor?: GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
|
|
848
|
+
/** Required. Entity type from a schema e.g. `Address`. */
|
|
849
|
+
type?: string;
|
|
850
|
+
}
|
|
851
|
+
interface GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue {
|
|
852
|
+
/** Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto */
|
|
853
|
+
addressValue?: GoogleTypePostalAddress;
|
|
854
|
+
/** Boolean value. Can be used for entities with binary values, or for checkboxes. */
|
|
855
|
+
booleanValue?: boolean;
|
|
856
|
+
/** DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto */
|
|
857
|
+
datetimeValue?: GoogleTypeDateTime;
|
|
858
|
+
/** Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto */
|
|
859
|
+
dateValue?: GoogleTypeDate;
|
|
860
|
+
/** Float value. */
|
|
861
|
+
floatValue?: number;
|
|
862
|
+
/** Integer value. */
|
|
863
|
+
integerValue?: number;
|
|
864
|
+
/** Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */
|
|
865
|
+
moneyValue?: GoogleTypeMoney;
|
|
866
|
+
/**
|
|
867
|
+
* Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of
|
|
868
|
+
* `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. -
|
|
869
|
+
* Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601
|
|
870
|
+
* text format.
|
|
871
|
+
*/
|
|
872
|
+
text?: string;
|
|
873
|
+
}
|
|
874
|
+
interface GoogleCloudDocumentaiV1beta2DocumentEntityRelation {
|
|
875
|
+
/** Object entity id. */
|
|
876
|
+
objectId?: string;
|
|
877
|
+
/** Relationship description. */
|
|
878
|
+
relation?: string;
|
|
879
|
+
/** Subject entity id. */
|
|
880
|
+
subjectId?: string;
|
|
881
|
+
}
|
|
882
|
+
interface GoogleCloudDocumentaiV1beta2DocumentLabel {
|
|
883
|
+
/** Label is generated AutoML model. This field stores the full resource name of the AutoML model. Format: `projects/{project-id}/locations/{location-id}/models/{model-id}` */
|
|
884
|
+
automlModel?: string;
|
|
885
|
+
/** Confidence score between 0 and 1 for label assignment. */
|
|
886
|
+
confidence?: number;
|
|
887
|
+
/** Name of the label. When the label is generated from AutoML Text Classification model, this field represents the name of the category. */
|
|
888
|
+
name?: string;
|
|
889
|
+
}
|
|
890
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPage {
|
|
891
|
+
/** A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. */
|
|
892
|
+
blocks?: GoogleCloudDocumentaiV1beta2DocumentPageBlock[];
|
|
893
|
+
/** A list of detected barcodes. */
|
|
894
|
+
detectedBarcodes?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode[];
|
|
895
|
+
/** A list of detected languages together with confidence. */
|
|
896
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
897
|
+
/** Physical dimension of the page. */
|
|
898
|
+
dimension?: GoogleCloudDocumentaiV1beta2DocumentPageDimension;
|
|
899
|
+
/** A list of visually detected form fields on the page. */
|
|
900
|
+
formFields?: GoogleCloudDocumentaiV1beta2DocumentPageFormField[];
|
|
901
|
+
/** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
|
|
902
|
+
image?: GoogleCloudDocumentaiV1beta2DocumentPageImage;
|
|
903
|
+
/** Layout for the page. */
|
|
904
|
+
layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
905
|
+
/** A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. */
|
|
906
|
+
lines?: GoogleCloudDocumentaiV1beta2DocumentPageLine[];
|
|
907
|
+
/** 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. */
|
|
908
|
+
pageNumber?: number;
|
|
909
|
+
/** A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. */
|
|
910
|
+
paragraphs?: GoogleCloudDocumentaiV1beta2DocumentPageParagraph[];
|
|
911
|
+
/** The history of this page. */
|
|
912
|
+
provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
|
|
913
|
+
/** A list of visually detected symbols on the page. */
|
|
914
|
+
symbols?: GoogleCloudDocumentaiV1beta2DocumentPageSymbol[];
|
|
915
|
+
/** A list of visually detected tables on the page. */
|
|
916
|
+
tables?: GoogleCloudDocumentaiV1beta2DocumentPageTable[];
|
|
917
|
+
/** A list of visually detected tokens on the page. */
|
|
918
|
+
tokens?: GoogleCloudDocumentaiV1beta2DocumentPageToken[];
|
|
919
|
+
/** Transformation matrices that were applied to the original document image to produce Page.image. */
|
|
920
|
+
transforms?: GoogleCloudDocumentaiV1beta2DocumentPageMatrix[];
|
|
921
|
+
/** A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. */
|
|
922
|
+
visualElements?: GoogleCloudDocumentaiV1beta2DocumentPageVisualElement[];
|
|
923
|
+
}
|
|
924
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageAnchor {
|
|
925
|
+
/** One or more references to visual page elements */
|
|
926
|
+
pageRefs?: GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef[];
|
|
927
|
+
}
|
|
928
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef {
|
|
929
|
+
/** Optional. Identifies the bounding polygon of a layout element on the page. */
|
|
930
|
+
boundingPoly?: GoogleCloudDocumentaiV1beta2BoundingPoly;
|
|
931
|
+
/** Optional. Confidence of detected page element, if applicable. Range [0, 1]. */
|
|
932
|
+
confidence?: number;
|
|
933
|
+
/** Optional. Deprecated. Use PageRef.bounding_poly instead. */
|
|
934
|
+
layoutId?: string;
|
|
935
|
+
/** Optional. The type of the layout element that is being referenced if any. */
|
|
936
|
+
layoutType?: string;
|
|
937
|
+
/**
|
|
938
|
+
* Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See
|
|
939
|
+
* https://developers.google.com/protocol-buffers/docs/proto3#json.
|
|
940
|
+
*/
|
|
941
|
+
page?: string;
|
|
942
|
+
}
|
|
943
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageBlock {
|
|
944
|
+
/** A list of detected languages together with confidence. */
|
|
945
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
946
|
+
/** Layout for Block. */
|
|
947
|
+
layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
948
|
+
/** The history of this annotation. */
|
|
949
|
+
provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
|
|
950
|
+
}
|
|
951
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode {
|
|
952
|
+
/** Detailed barcode information of the DetectedBarcode. */
|
|
953
|
+
barcode?: GoogleCloudDocumentaiV1beta2Barcode;
|
|
954
|
+
/** Layout for DetectedBarcode. */
|
|
955
|
+
layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
956
|
+
}
|
|
957
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage {
|
|
958
|
+
/** Confidence of detected language. Range [0, 1]. */
|
|
959
|
+
confidence?: number;
|
|
960
|
+
/** The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
|
|
961
|
+
languageCode?: string;
|
|
962
|
+
}
|
|
963
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageDimension {
|
|
964
|
+
/** Page height. */
|
|
965
|
+
height?: number;
|
|
966
|
+
/** Dimension unit. */
|
|
967
|
+
unit?: string;
|
|
968
|
+
/** Page width. */
|
|
969
|
+
width?: number;
|
|
970
|
+
}
|
|
971
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageFormField {
|
|
972
|
+
/** Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. */
|
|
973
|
+
correctedKeyText?: string;
|
|
974
|
+
/** Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. */
|
|
975
|
+
correctedValueText?: string;
|
|
976
|
+
/** Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. */
|
|
977
|
+
fieldName?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
978
|
+
/** Layout for the FormField value. */
|
|
979
|
+
fieldValue?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
980
|
+
/** A list of detected languages for name together with confidence. */
|
|
981
|
+
nameDetectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
982
|
+
/** The history of this annotation. */
|
|
983
|
+
provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
|
|
984
|
+
/** A list of detected languages for value together with confidence. */
|
|
985
|
+
valueDetectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
986
|
+
/**
|
|
987
|
+
* If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - "unfilled_checkbox" -
|
|
988
|
+
* "filled_checkbox"
|
|
989
|
+
*/
|
|
990
|
+
valueType?: string;
|
|
991
|
+
}
|
|
992
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageImage {
|
|
993
|
+
/** Raw byte content of the image. */
|
|
994
|
+
content?: string;
|
|
995
|
+
/** Height of the image in pixels. */
|
|
996
|
+
height?: number;
|
|
997
|
+
/** Encoding mime type for the image. */
|
|
998
|
+
mimeType?: string;
|
|
999
|
+
/** Width of the image in pixels. */
|
|
1000
|
+
width?: number;
|
|
1001
|
+
}
|
|
1002
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageLayout {
|
|
1003
|
+
/** The bounding polygon for the Layout. */
|
|
1004
|
+
boundingPoly?: GoogleCloudDocumentaiV1beta2BoundingPoly;
|
|
1005
|
+
/**
|
|
1006
|
+
* Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context.
|
|
1007
|
+
* Range [0, 1].
|
|
1008
|
+
*/
|
|
1009
|
+
confidence?: number;
|
|
1010
|
+
/** Detected orientation for the Layout. */
|
|
1011
|
+
orientation?: string;
|
|
1012
|
+
/** Text anchor indexing into the Document.text. */
|
|
1013
|
+
textAnchor?: GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
|
|
1014
|
+
}
|
|
1015
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageLine {
|
|
1016
|
+
/** A list of detected languages together with confidence. */
|
|
1017
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
1018
|
+
/** Layout for Line. */
|
|
1019
|
+
layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
1020
|
+
/** The history of this annotation. */
|
|
1021
|
+
provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
|
|
1022
|
+
}
|
|
1023
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageMatrix {
|
|
1024
|
+
/** Number of columns in the matrix. */
|
|
1025
|
+
cols?: number;
|
|
1026
|
+
/** The matrix data. */
|
|
1027
|
+
data?: string;
|
|
1028
|
+
/** Number of rows in the matrix. */
|
|
1029
|
+
rows?: number;
|
|
1030
|
+
/**
|
|
1031
|
+
* This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to
|
|
1032
|
+
* https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
|
|
1033
|
+
*/
|
|
1034
|
+
type?: number;
|
|
1035
|
+
}
|
|
1036
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageParagraph {
|
|
1037
|
+
/** A list of detected languages together with confidence. */
|
|
1038
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
1039
|
+
/** Layout for Paragraph. */
|
|
1040
|
+
layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
1041
|
+
/** The history of this annotation. */
|
|
1042
|
+
provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
|
|
1043
|
+
}
|
|
1044
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageSymbol {
|
|
1045
|
+
/** A list of detected languages together with confidence. */
|
|
1046
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
1047
|
+
/** Layout for Symbol. */
|
|
1048
|
+
layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
1049
|
+
}
|
|
1050
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageTable {
|
|
1051
|
+
/** Body rows of the table. */
|
|
1052
|
+
bodyRows?: GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow[];
|
|
1053
|
+
/** A list of detected languages together with confidence. */
|
|
1054
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
1055
|
+
/** Header rows of the table. */
|
|
1056
|
+
headerRows?: GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow[];
|
|
1057
|
+
/** Layout for Table. */
|
|
1058
|
+
layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
1059
|
+
}
|
|
1060
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell {
|
|
1061
|
+
/** How many columns this cell spans. */
|
|
1062
|
+
colSpan?: number;
|
|
1063
|
+
/** A list of detected languages together with confidence. */
|
|
1064
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
1065
|
+
/** Layout for TableCell. */
|
|
1066
|
+
layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
1067
|
+
/** How many rows this cell spans. */
|
|
1068
|
+
rowSpan?: number;
|
|
1069
|
+
}
|
|
1070
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow {
|
|
1071
|
+
/** Cells that make up this row. */
|
|
1072
|
+
cells?: GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell[];
|
|
1073
|
+
}
|
|
1074
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageToken {
|
|
1075
|
+
/** Detected break at the end of a Token. */
|
|
1076
|
+
detectedBreak?: GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak;
|
|
1077
|
+
/** A list of detected languages together with confidence. */
|
|
1078
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
1079
|
+
/** Layout for Token. */
|
|
1080
|
+
layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
1081
|
+
/** The history of this annotation. */
|
|
1082
|
+
provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
|
|
1083
|
+
}
|
|
1084
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak {
|
|
1085
|
+
/** Detected break type. */
|
|
1086
|
+
type?: string;
|
|
1087
|
+
}
|
|
1088
|
+
interface GoogleCloudDocumentaiV1beta2DocumentPageVisualElement {
|
|
1089
|
+
/** A list of detected languages together with confidence. */
|
|
1090
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
1091
|
+
/** Layout for VisualElement. */
|
|
1092
|
+
layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
|
|
1093
|
+
/** Type of the VisualElement. */
|
|
1094
|
+
type?: string;
|
|
1095
|
+
}
|
|
1096
|
+
interface GoogleCloudDocumentaiV1beta2DocumentProvenance {
|
|
1097
|
+
/** The Id of this operation. Needs to be unique within the scope of the revision. */
|
|
1098
|
+
id?: number;
|
|
1099
|
+
/** References to the original elements that are replaced. */
|
|
1100
|
+
parents?: GoogleCloudDocumentaiV1beta2DocumentProvenanceParent[];
|
|
1101
|
+
/** The index of the revision that produced this element. */
|
|
1102
|
+
revision?: number;
|
|
1103
|
+
/** The type of provenance operation. */
|
|
1104
|
+
type?: string;
|
|
1105
|
+
}
|
|
1106
|
+
interface GoogleCloudDocumentaiV1beta2DocumentProvenanceParent {
|
|
1107
|
+
/** The id of the parent provenance. */
|
|
1108
|
+
id?: number;
|
|
1109
|
+
/** The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. */
|
|
1110
|
+
index?: number;
|
|
1111
|
+
/** The index of the index into current revision's parent_ids list. */
|
|
1112
|
+
revision?: number;
|
|
1113
|
+
}
|
|
1114
|
+
interface GoogleCloudDocumentaiV1beta2DocumentRevision {
|
|
1115
|
+
/** If the change was made by a person specify the name or id of that person. */
|
|
1116
|
+
agent?: string;
|
|
1117
|
+
/** The time that the revision was created. */
|
|
1118
|
+
createTime?: string;
|
|
1119
|
+
/** Human Review information of this revision. */
|
|
1120
|
+
humanReview?: GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview;
|
|
1121
|
+
/** Id of the revision. Unique within the context of the document. */
|
|
1122
|
+
id?: string;
|
|
1123
|
+
/** The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. */
|
|
1124
|
+
parent?: number[];
|
|
1125
|
+
/**
|
|
1126
|
+
* The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index
|
|
1127
|
+
* into this field.
|
|
1128
|
+
*/
|
|
1129
|
+
parentIds?: string[];
|
|
1130
|
+
/** If the annotation was made by processor identify the processor by its resource name. */
|
|
1131
|
+
processor?: string;
|
|
1132
|
+
}
|
|
1133
|
+
interface GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview {
|
|
1134
|
+
/** Human review state. e.g. `requested`, `succeeded`, `rejected`. */
|
|
1135
|
+
state?: string;
|
|
1136
|
+
/** A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. */
|
|
1137
|
+
stateMessage?: string;
|
|
1138
|
+
}
|
|
1139
|
+
interface GoogleCloudDocumentaiV1beta2DocumentShardInfo {
|
|
1140
|
+
/** Total number of shards. */
|
|
1141
|
+
shardCount?: string;
|
|
1142
|
+
/** The 0-based index of this shard. */
|
|
1143
|
+
shardIndex?: string;
|
|
1144
|
+
/** The index of the first character in Document.text in the overall document global text. */
|
|
1145
|
+
textOffset?: string;
|
|
1146
|
+
}
|
|
1147
|
+
interface GoogleCloudDocumentaiV1beta2DocumentStyle {
|
|
1148
|
+
/** Text background color. */
|
|
1149
|
+
backgroundColor?: GoogleTypeColor;
|
|
1150
|
+
/** Text color. */
|
|
1151
|
+
color?: GoogleTypeColor;
|
|
1152
|
+
/** Font size. */
|
|
1153
|
+
fontSize?: GoogleCloudDocumentaiV1beta2DocumentStyleFontSize;
|
|
1154
|
+
/** Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp */
|
|
1155
|
+
fontWeight?: string;
|
|
1156
|
+
/** Text anchor indexing into the Document.text. */
|
|
1157
|
+
textAnchor?: GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
|
|
1158
|
+
/** Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp */
|
|
1159
|
+
textDecoration?: string;
|
|
1160
|
+
/** Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp */
|
|
1161
|
+
textStyle?: string;
|
|
1162
|
+
}
|
|
1163
|
+
interface GoogleCloudDocumentaiV1beta2DocumentStyleFontSize {
|
|
1164
|
+
/** Font size for the text. */
|
|
1165
|
+
size?: number;
|
|
1166
|
+
/** Unit for the font size. Follows CSS naming (in, px, pt, etc.). */
|
|
1167
|
+
unit?: string;
|
|
1168
|
+
}
|
|
1169
|
+
interface GoogleCloudDocumentaiV1beta2DocumentTextAnchor {
|
|
1170
|
+
/** Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. */
|
|
1171
|
+
content?: string;
|
|
1172
|
+
/** The text segments from the Document.text. */
|
|
1173
|
+
textSegments?: GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment[];
|
|
1174
|
+
}
|
|
1175
|
+
interface GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment {
|
|
1176
|
+
/** TextSegment half open end UTF-8 char index in the Document.text. */
|
|
1177
|
+
endIndex?: string;
|
|
1178
|
+
/** TextSegment start UTF-8 char index in the Document.text. */
|
|
1179
|
+
startIndex?: string;
|
|
1180
|
+
}
|
|
1181
|
+
interface GoogleCloudDocumentaiV1beta2DocumentTextChange {
|
|
1182
|
+
/** The text that replaces the text identified in the `text_anchor`. */
|
|
1183
|
+
changedText?: string;
|
|
1184
|
+
/** The history of this annotation. */
|
|
1185
|
+
provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance[];
|
|
1186
|
+
/**
|
|
1187
|
+
* Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text
|
|
1188
|
+
* segment are the same, the text change is inserted before that index.
|
|
1189
|
+
*/
|
|
1190
|
+
textAnchor?: GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
|
|
1191
|
+
}
|
|
1192
|
+
interface GoogleCloudDocumentaiV1beta2GcsDestination {
|
|
1193
|
+
uri?: string;
|
|
1194
|
+
}
|
|
1195
|
+
interface GoogleCloudDocumentaiV1beta2GcsSource {
|
|
1196
|
+
uri?: string;
|
|
1197
|
+
}
|
|
1198
|
+
interface GoogleCloudDocumentaiV1beta2InputConfig {
|
|
1199
|
+
/**
|
|
1200
|
+
* Content in bytes, represented as a stream of bytes. Note: As with all `bytes` fields, proto buffer messages use a pure binary representation, whereas JSON representations use
|
|
1201
|
+
* base64. This field only works for synchronous ProcessDocument method.
|
|
1202
|
+
*/
|
|
1203
|
+
contents?: string;
|
|
1204
|
+
/** The Google Cloud Storage location to read the input from. This must be a single file. */
|
|
1205
|
+
gcsSource?: GoogleCloudDocumentaiV1beta2GcsSource;
|
|
1206
|
+
/**
|
|
1207
|
+
* Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with
|
|
1208
|
+
* ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.
|
|
1209
|
+
*/
|
|
1210
|
+
mimeType?: string;
|
|
1211
|
+
}
|
|
1212
|
+
interface GoogleCloudDocumentaiV1beta2NormalizedVertex {
|
|
1213
|
+
/** X coordinate. */
|
|
1214
|
+
x?: number;
|
|
1215
|
+
/** Y coordinate (starts from the top of the image). */
|
|
1216
|
+
y?: number;
|
|
1217
|
+
}
|
|
1218
|
+
interface GoogleCloudDocumentaiV1beta2OperationMetadata {
|
|
1219
|
+
/** The creation time of the operation. */
|
|
1220
|
+
createTime?: string;
|
|
1221
|
+
/** The state of the current batch processing. */
|
|
1222
|
+
state?: string;
|
|
1223
|
+
/** A message providing more details about the current state of processing. */
|
|
1224
|
+
stateMessage?: string;
|
|
1225
|
+
/** The last update time of the operation. */
|
|
1226
|
+
updateTime?: string;
|
|
1227
|
+
}
|
|
1228
|
+
interface GoogleCloudDocumentaiV1beta2OutputConfig {
|
|
1229
|
+
/** The Google Cloud Storage location to write the output to. */
|
|
1230
|
+
gcsDestination?: GoogleCloudDocumentaiV1beta2GcsDestination;
|
|
1231
|
+
/**
|
|
1232
|
+
* The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example,
|
|
1233
|
+
* for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under
|
|
1234
|
+
* the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50:
|
|
1235
|
+
* pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json
|
|
1236
|
+
*/
|
|
1237
|
+
pagesPerShard?: number;
|
|
1238
|
+
}
|
|
1239
|
+
interface GoogleCloudDocumentaiV1beta2ProcessDocumentResponse {
|
|
1240
|
+
/** Information about the input file. This is the same as the corresponding input config in the request. */
|
|
1241
|
+
inputConfig?: GoogleCloudDocumentaiV1beta2InputConfig;
|
|
1242
|
+
/** The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects. */
|
|
1243
|
+
outputConfig?: GoogleCloudDocumentaiV1beta2OutputConfig;
|
|
1244
|
+
}
|
|
1245
|
+
interface GoogleCloudDocumentaiV1beta2Vertex {
|
|
1246
|
+
/** X coordinate. */
|
|
1247
|
+
x?: number;
|
|
1248
|
+
/** Y coordinate (starts from the top of the image). */
|
|
1249
|
+
y?: number;
|
|
1250
|
+
}
|
|
1251
|
+
interface GoogleCloudDocumentaiV1beta3Barcode {
|
|
1252
|
+
/**
|
|
1253
|
+
* Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF:
|
|
1254
|
+
* ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1
|
|
1255
|
+
* DataBar code type.
|
|
1256
|
+
*/
|
|
1257
|
+
format?: string;
|
|
1258
|
+
/** Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. */
|
|
1259
|
+
rawValue?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier.
|
|
1262
|
+
* PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event.
|
|
1263
|
+
* DRIVER_LICENSE: Driver's license.
|
|
1264
|
+
*/
|
|
1265
|
+
valueFormat?: string;
|
|
1266
|
+
}
|
|
1267
|
+
interface GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig {
|
|
1268
|
+
/** The set of documents individually specified on Cloud Storage. */
|
|
1269
|
+
gcsDocuments?: GoogleCloudDocumentaiV1beta3GcsDocuments;
|
|
1270
|
+
/** The set of documents that match the specified Cloud Storage [gcs_prefix]. */
|
|
1271
|
+
gcsPrefix?: GoogleCloudDocumentaiV1beta3GcsPrefix;
|
|
1272
|
+
}
|
|
1273
|
+
interface GoogleCloudDocumentaiV1beta3BatchProcessMetadata {
|
|
1274
|
+
/** The creation time of the operation. */
|
|
1275
|
+
createTime?: string;
|
|
1276
|
+
/** The list of response details of each document. */
|
|
1277
|
+
individualProcessStatuses?: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus[];
|
|
1278
|
+
/** The state of the current batch processing. */
|
|
1279
|
+
state?: string;
|
|
1280
|
+
/** A message providing more details about the current state of processing. For example, the error message if the operation is failed. */
|
|
1281
|
+
stateMessage?: string;
|
|
1282
|
+
/** The last update time of the operation. */
|
|
1283
|
+
updateTime?: string;
|
|
1284
|
+
}
|
|
1285
|
+
interface GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus {
|
|
1286
|
+
/**
|
|
1287
|
+
* The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as
|
|
1288
|
+
* the long running operation returned by ReviewDocument method.
|
|
1289
|
+
*/
|
|
1290
|
+
humanReviewOperation?: string;
|
|
1291
|
+
/** The status of human review on the processed document. */
|
|
1292
|
+
humanReviewStatus?: GoogleCloudDocumentaiV1beta3HumanReviewStatus;
|
|
1293
|
+
/**
|
|
1294
|
+
* The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since
|
|
1295
|
+
* a user can move or change that document during the process.
|
|
1296
|
+
*/
|
|
1297
|
+
inputGcsSource?: string;
|
|
1298
|
+
/** The output_gcs_destination (in the request as `output_gcs_destination`) of the processed document if it was successful, otherwise empty. */
|
|
1299
|
+
outputGcsDestination?: string;
|
|
1300
|
+
/** The status processing the document. */
|
|
1301
|
+
status?: GoogleRpcStatus;
|
|
1302
|
+
}
|
|
1303
|
+
interface GoogleCloudDocumentaiV1beta3BatchProcessRequest {
|
|
1304
|
+
/** The overall output config for batch process. */
|
|
1305
|
+
documentOutputConfig?: GoogleCloudDocumentaiV1beta3DocumentOutputConfig;
|
|
1306
|
+
/** The input config for each single document in the batch process. */
|
|
1307
|
+
inputConfigs?: GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig[];
|
|
1308
|
+
/** The input documents for batch process. */
|
|
1309
|
+
inputDocuments?: GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
|
|
1310
|
+
/** The overall output config for batch process. */
|
|
1311
|
+
outputConfig?: GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig;
|
|
1312
|
+
/** Whether Human Review feature should be skipped for this request. Default to false. */
|
|
1313
|
+
skipHumanReview?: boolean;
|
|
1314
|
+
}
|
|
1315
|
+
interface GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig {
|
|
1316
|
+
/** The Cloud Storage location as the source of the document. */
|
|
1317
|
+
gcsSource?: string;
|
|
1318
|
+
/**
|
|
1319
|
+
* Mimetype of the input. If the input is a raw document, the supported mimetypes are application/pdf, image/tiff, and image/gif. If the input is a [Document] proto, the type should be
|
|
1320
|
+
* application/json.
|
|
1321
|
+
*/
|
|
1322
|
+
mimeType?: string;
|
|
1323
|
+
}
|
|
1324
|
+
interface GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig {
|
|
1325
|
+
/** The output Cloud Storage directory to put the processed documents. */
|
|
1326
|
+
gcsDestination?: string;
|
|
1327
|
+
}
|
|
1328
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1329
|
+
interface GoogleCloudDocumentaiV1beta3BatchProcessResponse {
|
|
1330
|
+
}
|
|
1331
|
+
interface GoogleCloudDocumentaiV1beta3BoundingPoly {
|
|
1332
|
+
/** The bounding polygon normalized vertices. */
|
|
1333
|
+
normalizedVertices?: GoogleCloudDocumentaiV1beta3NormalizedVertex[];
|
|
1334
|
+
/** The bounding polygon vertices. */
|
|
1335
|
+
vertices?: GoogleCloudDocumentaiV1beta3Vertex[];
|
|
1336
|
+
}
|
|
1337
|
+
interface GoogleCloudDocumentaiV1beta3CommonOperationMetadata {
|
|
1338
|
+
/** The creation time of the operation. */
|
|
1339
|
+
createTime?: string;
|
|
1340
|
+
/** A related resource to this operation. */
|
|
1341
|
+
resource?: string;
|
|
1342
|
+
/** The state of the operation. */
|
|
1343
|
+
state?: string;
|
|
1344
|
+
/** A message providing more details about the current state of processing. */
|
|
1345
|
+
stateMessage?: string;
|
|
1346
|
+
/** The last update time of the operation. */
|
|
1347
|
+
updateTime?: string;
|
|
1348
|
+
}
|
|
1349
|
+
interface GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata {
|
|
1350
|
+
/** The basic metadata of the long running operation. */
|
|
1351
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
1352
|
+
}
|
|
1353
|
+
interface GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata {
|
|
1354
|
+
/** The basic metadata of the long running operation. */
|
|
1355
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
1356
|
+
}
|
|
1357
|
+
interface GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata {
|
|
1358
|
+
/** The basic metadata of the long running operation. */
|
|
1359
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
1360
|
+
}
|
|
1361
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1362
|
+
interface GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest {
|
|
1363
|
+
}
|
|
1364
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1365
|
+
interface GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse {
|
|
1366
|
+
}
|
|
1367
|
+
interface GoogleCloudDocumentaiV1beta3DisableProcessorMetadata {
|
|
1368
|
+
/** The basic metadata of the long running operation. */
|
|
1369
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
1370
|
+
}
|
|
1371
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1372
|
+
interface GoogleCloudDocumentaiV1beta3DisableProcessorRequest {
|
|
1373
|
+
}
|
|
1374
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1375
|
+
interface GoogleCloudDocumentaiV1beta3DisableProcessorResponse {
|
|
1376
|
+
}
|
|
1377
|
+
interface GoogleCloudDocumentaiV1beta3Document {
|
|
1378
|
+
/**
|
|
1379
|
+
* Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations
|
|
1380
|
+
* use base64.
|
|
1381
|
+
*/
|
|
1382
|
+
content?: string;
|
|
1383
|
+
/** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
|
|
1384
|
+
entities?: GoogleCloudDocumentaiV1beta3DocumentEntity[];
|
|
1385
|
+
/** Placeholder. Relationship among Document.entities. */
|
|
1386
|
+
entityRelations?: GoogleCloudDocumentaiV1beta3DocumentEntityRelation[];
|
|
1387
|
+
/** Any error that occurred while processing this document. */
|
|
1388
|
+
error?: GoogleRpcStatus;
|
|
1389
|
+
/** An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml. */
|
|
1390
|
+
mimeType?: string;
|
|
1391
|
+
/** Visual page layout for the Document. */
|
|
1392
|
+
pages?: GoogleCloudDocumentaiV1beta3DocumentPage[];
|
|
1393
|
+
/** Placeholder. Revision history of this document. */
|
|
1394
|
+
revisions?: GoogleCloudDocumentaiV1beta3DocumentRevision[];
|
|
1395
|
+
/** Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. */
|
|
1396
|
+
shardInfo?: GoogleCloudDocumentaiV1beta3DocumentShardInfo;
|
|
1397
|
+
/** Optional. UTF-8 encoded text in reading order from the document. */
|
|
1398
|
+
text?: string;
|
|
1399
|
+
/**
|
|
1400
|
+
* Placeholder. A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap
|
|
1401
|
+
* with each other.
|
|
1402
|
+
*/
|
|
1403
|
+
textChanges?: GoogleCloudDocumentaiV1beta3DocumentTextChange[];
|
|
1404
|
+
/** Placeholder. Styles for the Document.text. */
|
|
1405
|
+
textStyles?: GoogleCloudDocumentaiV1beta3DocumentStyle[];
|
|
1406
|
+
/**
|
|
1407
|
+
* Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request
|
|
1408
|
+
* URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
|
|
1409
|
+
*/
|
|
1410
|
+
uri?: string;
|
|
1411
|
+
}
|
|
1412
|
+
interface GoogleCloudDocumentaiV1beta3DocumentEntity {
|
|
1413
|
+
/** Optional. Confidence of detected Schema entity. Range [0, 1]. */
|
|
1414
|
+
confidence?: number;
|
|
1415
|
+
/** Optional. Canonical id. This will be a unique value in the entity list for this document. */
|
|
1416
|
+
id?: string;
|
|
1417
|
+
/** Optional. Deprecated. Use `id` field instead. */
|
|
1418
|
+
mentionId?: string;
|
|
1419
|
+
/** Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. */
|
|
1420
|
+
mentionText?: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a
|
|
1423
|
+
* false negative. A non-present entity should have an empty mention_text and text_anchor.
|
|
1424
|
+
*/
|
|
1425
|
+
nonPresent?: boolean;
|
|
1426
|
+
/**
|
|
1427
|
+
* Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only
|
|
1428
|
+
* populated for certain supported document types.
|
|
1429
|
+
*/
|
|
1430
|
+
normalizedValue?: GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue;
|
|
1431
|
+
/** Optional. Represents the provenance of this entity wrt. the location on the page where it was found. */
|
|
1432
|
+
pageAnchor?: GoogleCloudDocumentaiV1beta3DocumentPageAnchor;
|
|
1433
|
+
/** Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. */
|
|
1434
|
+
properties?: GoogleCloudDocumentaiV1beta3DocumentEntity[];
|
|
1435
|
+
/** Optional. The history of this annotation. */
|
|
1436
|
+
provenance?: GoogleCloudDocumentaiV1beta3DocumentProvenance;
|
|
1437
|
+
/** Optional. Whether the entity will be redacted for de-identification purposes. */
|
|
1438
|
+
redacted?: boolean;
|
|
1439
|
+
/** Optional. Provenance of the entity. Text anchor indexing into the Document.text. */
|
|
1440
|
+
textAnchor?: GoogleCloudDocumentaiV1beta3DocumentTextAnchor;
|
|
1441
|
+
/** Required. Entity type from a schema e.g. `Address`. */
|
|
1442
|
+
type?: string;
|
|
1443
|
+
}
|
|
1444
|
+
interface GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue {
|
|
1445
|
+
/** Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto */
|
|
1446
|
+
addressValue?: GoogleTypePostalAddress;
|
|
1447
|
+
/** Boolean value. Can be used for entities with binary values, or for checkboxes. */
|
|
1448
|
+
booleanValue?: boolean;
|
|
1449
|
+
/** DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto */
|
|
1450
|
+
datetimeValue?: GoogleTypeDateTime;
|
|
1451
|
+
/** Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto */
|
|
1452
|
+
dateValue?: GoogleTypeDate;
|
|
1453
|
+
/** Float value. */
|
|
1454
|
+
floatValue?: number;
|
|
1455
|
+
/** Integer value. */
|
|
1456
|
+
integerValue?: number;
|
|
1457
|
+
/** Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */
|
|
1458
|
+
moneyValue?: GoogleTypeMoney;
|
|
1459
|
+
/**
|
|
1460
|
+
* Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of
|
|
1461
|
+
* `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. -
|
|
1462
|
+
* Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601
|
|
1463
|
+
* text format.
|
|
1464
|
+
*/
|
|
1465
|
+
text?: string;
|
|
1466
|
+
}
|
|
1467
|
+
interface GoogleCloudDocumentaiV1beta3DocumentEntityRelation {
|
|
1468
|
+
/** Object entity id. */
|
|
1469
|
+
objectId?: string;
|
|
1470
|
+
/** Relationship description. */
|
|
1471
|
+
relation?: string;
|
|
1472
|
+
/** Subject entity id. */
|
|
1473
|
+
subjectId?: string;
|
|
1474
|
+
}
|
|
1475
|
+
interface GoogleCloudDocumentaiV1beta3DocumentOutputConfig {
|
|
1476
|
+
/** Output config to write the results to Cloud Storage. */
|
|
1477
|
+
gcsOutputConfig?: GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig;
|
|
1478
|
+
}
|
|
1479
|
+
interface GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig {
|
|
1480
|
+
/** The Cloud Storage uri (a directory) of the output. */
|
|
1481
|
+
gcsUri?: string;
|
|
1482
|
+
}
|
|
1483
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPage {
|
|
1484
|
+
/** A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. */
|
|
1485
|
+
blocks?: GoogleCloudDocumentaiV1beta3DocumentPageBlock[];
|
|
1486
|
+
/** A list of detected barcodes. */
|
|
1487
|
+
detectedBarcodes?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode[];
|
|
1488
|
+
/** A list of detected languages together with confidence. */
|
|
1489
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1490
|
+
/** Physical dimension of the page. */
|
|
1491
|
+
dimension?: GoogleCloudDocumentaiV1beta3DocumentPageDimension;
|
|
1492
|
+
/** A list of visually detected form fields on the page. */
|
|
1493
|
+
formFields?: GoogleCloudDocumentaiV1beta3DocumentPageFormField[];
|
|
1494
|
+
/** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
|
|
1495
|
+
image?: GoogleCloudDocumentaiV1beta3DocumentPageImage;
|
|
1496
|
+
/** Layout for the page. */
|
|
1497
|
+
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1498
|
+
/** A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. */
|
|
1499
|
+
lines?: GoogleCloudDocumentaiV1beta3DocumentPageLine[];
|
|
1500
|
+
/** 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. */
|
|
1501
|
+
pageNumber?: number;
|
|
1502
|
+
/** A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. */
|
|
1503
|
+
paragraphs?: GoogleCloudDocumentaiV1beta3DocumentPageParagraph[];
|
|
1504
|
+
/** The history of this page. */
|
|
1505
|
+
provenance?: GoogleCloudDocumentaiV1beta3DocumentProvenance;
|
|
1506
|
+
/** A list of visually detected symbols on the page. */
|
|
1507
|
+
symbols?: GoogleCloudDocumentaiV1beta3DocumentPageSymbol[];
|
|
1508
|
+
/** A list of visually detected tables on the page. */
|
|
1509
|
+
tables?: GoogleCloudDocumentaiV1beta3DocumentPageTable[];
|
|
1510
|
+
/** A list of visually detected tokens on the page. */
|
|
1511
|
+
tokens?: GoogleCloudDocumentaiV1beta3DocumentPageToken[];
|
|
1512
|
+
/** Transformation matrices that were applied to the original document image to produce Page.image. */
|
|
1513
|
+
transforms?: GoogleCloudDocumentaiV1beta3DocumentPageMatrix[];
|
|
1514
|
+
/** A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. */
|
|
1515
|
+
visualElements?: GoogleCloudDocumentaiV1beta3DocumentPageVisualElement[];
|
|
1516
|
+
}
|
|
1517
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageAnchor {
|
|
1518
|
+
/** One or more references to visual page elements */
|
|
1519
|
+
pageRefs?: GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef[];
|
|
1520
|
+
}
|
|
1521
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef {
|
|
1522
|
+
/** Optional. Identifies the bounding polygon of a layout element on the page. */
|
|
1523
|
+
boundingPoly?: GoogleCloudDocumentaiV1beta3BoundingPoly;
|
|
1524
|
+
/** Optional. Confidence of detected page element, if applicable. Range [0, 1]. */
|
|
1525
|
+
confidence?: number;
|
|
1526
|
+
/** Optional. Deprecated. Use PageRef.bounding_poly instead. */
|
|
1527
|
+
layoutId?: string;
|
|
1528
|
+
/** Optional. The type of the layout element that is being referenced if any. */
|
|
1529
|
+
layoutType?: string;
|
|
1530
|
+
/**
|
|
1531
|
+
* Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See
|
|
1532
|
+
* https://developers.google.com/protocol-buffers/docs/proto3#json.
|
|
1533
|
+
*/
|
|
1534
|
+
page?: string;
|
|
1535
|
+
}
|
|
1536
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageBlock {
|
|
1537
|
+
/** A list of detected languages together with confidence. */
|
|
1538
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1539
|
+
/** Layout for Block. */
|
|
1540
|
+
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1541
|
+
/** The history of this annotation. */
|
|
1542
|
+
provenance?: GoogleCloudDocumentaiV1beta3DocumentProvenance;
|
|
1543
|
+
}
|
|
1544
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode {
|
|
1545
|
+
/** Detailed barcode information of the DetectedBarcode. */
|
|
1546
|
+
barcode?: GoogleCloudDocumentaiV1beta3Barcode;
|
|
1547
|
+
/** Layout for DetectedBarcode. */
|
|
1548
|
+
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1549
|
+
}
|
|
1550
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage {
|
|
1551
|
+
/** Confidence of detected language. Range [0, 1]. */
|
|
1552
|
+
confidence?: number;
|
|
1553
|
+
/** The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
|
|
1554
|
+
languageCode?: string;
|
|
1555
|
+
}
|
|
1556
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageDimension {
|
|
1557
|
+
/** Page height. */
|
|
1558
|
+
height?: number;
|
|
1559
|
+
/** Dimension unit. */
|
|
1560
|
+
unit?: string;
|
|
1561
|
+
/** Page width. */
|
|
1562
|
+
width?: number;
|
|
1563
|
+
}
|
|
1564
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageFormField {
|
|
1565
|
+
/** Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. */
|
|
1566
|
+
correctedKeyText?: string;
|
|
1567
|
+
/** Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. */
|
|
1568
|
+
correctedValueText?: string;
|
|
1569
|
+
/** Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. */
|
|
1570
|
+
fieldName?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1571
|
+
/** Layout for the FormField value. */
|
|
1572
|
+
fieldValue?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1573
|
+
/** A list of detected languages for name together with confidence. */
|
|
1574
|
+
nameDetectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1575
|
+
/** The history of this annotation. */
|
|
1576
|
+
provenance?: GoogleCloudDocumentaiV1beta3DocumentProvenance;
|
|
1577
|
+
/** A list of detected languages for value together with confidence. */
|
|
1578
|
+
valueDetectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1579
|
+
/**
|
|
1580
|
+
* If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - "unfilled_checkbox" -
|
|
1581
|
+
* "filled_checkbox"
|
|
1582
|
+
*/
|
|
1583
|
+
valueType?: string;
|
|
1584
|
+
}
|
|
1585
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageImage {
|
|
1586
|
+
/** Raw byte content of the image. */
|
|
1587
|
+
content?: string;
|
|
1588
|
+
/** Height of the image in pixels. */
|
|
1589
|
+
height?: number;
|
|
1590
|
+
/** Encoding mime type for the image. */
|
|
1591
|
+
mimeType?: string;
|
|
1592
|
+
/** Width of the image in pixels. */
|
|
1593
|
+
width?: number;
|
|
1594
|
+
}
|
|
1595
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageLayout {
|
|
1596
|
+
/** The bounding polygon for the Layout. */
|
|
1597
|
+
boundingPoly?: GoogleCloudDocumentaiV1beta3BoundingPoly;
|
|
1598
|
+
/**
|
|
1599
|
+
* Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context.
|
|
1600
|
+
* Range [0, 1].
|
|
1601
|
+
*/
|
|
1602
|
+
confidence?: number;
|
|
1603
|
+
/** Detected orientation for the Layout. */
|
|
1604
|
+
orientation?: string;
|
|
1605
|
+
/** Text anchor indexing into the Document.text. */
|
|
1606
|
+
textAnchor?: GoogleCloudDocumentaiV1beta3DocumentTextAnchor;
|
|
1607
|
+
}
|
|
1608
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageLine {
|
|
1609
|
+
/** A list of detected languages together with confidence. */
|
|
1610
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1611
|
+
/** Layout for Line. */
|
|
1612
|
+
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1613
|
+
/** The history of this annotation. */
|
|
1614
|
+
provenance?: GoogleCloudDocumentaiV1beta3DocumentProvenance;
|
|
1615
|
+
}
|
|
1616
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageMatrix {
|
|
1617
|
+
/** Number of columns in the matrix. */
|
|
1618
|
+
cols?: number;
|
|
1619
|
+
/** The matrix data. */
|
|
1620
|
+
data?: string;
|
|
1621
|
+
/** Number of rows in the matrix. */
|
|
1622
|
+
rows?: number;
|
|
1623
|
+
/**
|
|
1624
|
+
* This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to
|
|
1625
|
+
* https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
|
|
1626
|
+
*/
|
|
1627
|
+
type?: number;
|
|
1628
|
+
}
|
|
1629
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageParagraph {
|
|
1630
|
+
/** A list of detected languages together with confidence. */
|
|
1631
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1632
|
+
/** Layout for Paragraph. */
|
|
1633
|
+
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1634
|
+
/** The history of this annotation. */
|
|
1635
|
+
provenance?: GoogleCloudDocumentaiV1beta3DocumentProvenance;
|
|
1636
|
+
}
|
|
1637
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageSymbol {
|
|
1638
|
+
/** A list of detected languages together with confidence. */
|
|
1639
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1640
|
+
/** Layout for Symbol. */
|
|
1641
|
+
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1642
|
+
}
|
|
1643
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageTable {
|
|
1644
|
+
/** Body rows of the table. */
|
|
1645
|
+
bodyRows?: GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow[];
|
|
1646
|
+
/** A list of detected languages together with confidence. */
|
|
1647
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1648
|
+
/** Header rows of the table. */
|
|
1649
|
+
headerRows?: GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow[];
|
|
1650
|
+
/** Layout for Table. */
|
|
1651
|
+
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1652
|
+
}
|
|
1653
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell {
|
|
1654
|
+
/** How many columns this cell spans. */
|
|
1655
|
+
colSpan?: number;
|
|
1656
|
+
/** A list of detected languages together with confidence. */
|
|
1657
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1658
|
+
/** Layout for TableCell. */
|
|
1659
|
+
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1660
|
+
/** How many rows this cell spans. */
|
|
1661
|
+
rowSpan?: number;
|
|
1662
|
+
}
|
|
1663
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow {
|
|
1664
|
+
/** Cells that make up this row. */
|
|
1665
|
+
cells?: GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell[];
|
|
1666
|
+
}
|
|
1667
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageToken {
|
|
1668
|
+
/** Detected break at the end of a Token. */
|
|
1669
|
+
detectedBreak?: GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak;
|
|
1670
|
+
/** A list of detected languages together with confidence. */
|
|
1671
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1672
|
+
/** Layout for Token. */
|
|
1673
|
+
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1674
|
+
/** The history of this annotation. */
|
|
1675
|
+
provenance?: GoogleCloudDocumentaiV1beta3DocumentProvenance;
|
|
1676
|
+
}
|
|
1677
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak {
|
|
1678
|
+
/** Detected break type. */
|
|
1679
|
+
type?: string;
|
|
1680
|
+
}
|
|
1681
|
+
interface GoogleCloudDocumentaiV1beta3DocumentPageVisualElement {
|
|
1682
|
+
/** A list of detected languages together with confidence. */
|
|
1683
|
+
detectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
|
|
1684
|
+
/** Layout for VisualElement. */
|
|
1685
|
+
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1686
|
+
/** Type of the VisualElement. */
|
|
1687
|
+
type?: string;
|
|
1688
|
+
}
|
|
1689
|
+
interface GoogleCloudDocumentaiV1beta3DocumentProvenance {
|
|
1690
|
+
/** The Id of this operation. Needs to be unique within the scope of the revision. */
|
|
1691
|
+
id?: number;
|
|
1692
|
+
/** References to the original elements that are replaced. */
|
|
1693
|
+
parents?: GoogleCloudDocumentaiV1beta3DocumentProvenanceParent[];
|
|
1694
|
+
/** The index of the revision that produced this element. */
|
|
1695
|
+
revision?: number;
|
|
1696
|
+
/** The type of provenance operation. */
|
|
1697
|
+
type?: string;
|
|
1698
|
+
}
|
|
1699
|
+
interface GoogleCloudDocumentaiV1beta3DocumentProvenanceParent {
|
|
1700
|
+
/** The id of the parent provenance. */
|
|
1701
|
+
id?: number;
|
|
1702
|
+
/** The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. */
|
|
1703
|
+
index?: number;
|
|
1704
|
+
/** The index of the index into current revision's parent_ids list. */
|
|
1705
|
+
revision?: number;
|
|
1706
|
+
}
|
|
1707
|
+
interface GoogleCloudDocumentaiV1beta3DocumentRevision {
|
|
1708
|
+
/** If the change was made by a person specify the name or id of that person. */
|
|
1709
|
+
agent?: string;
|
|
1710
|
+
/** The time that the revision was created. */
|
|
1711
|
+
createTime?: string;
|
|
1712
|
+
/** Human Review information of this revision. */
|
|
1713
|
+
humanReview?: GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview;
|
|
1714
|
+
/** Id of the revision. Unique within the context of the document. */
|
|
1715
|
+
id?: string;
|
|
1716
|
+
/** The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. */
|
|
1717
|
+
parent?: number[];
|
|
1718
|
+
/**
|
|
1719
|
+
* The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index
|
|
1720
|
+
* into this field.
|
|
1721
|
+
*/
|
|
1722
|
+
parentIds?: string[];
|
|
1723
|
+
/** If the annotation was made by processor identify the processor by its resource name. */
|
|
1724
|
+
processor?: string;
|
|
1725
|
+
}
|
|
1726
|
+
interface GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview {
|
|
1727
|
+
/** Human review state. e.g. `requested`, `succeeded`, `rejected`. */
|
|
1728
|
+
state?: string;
|
|
1729
|
+
/** A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. */
|
|
1730
|
+
stateMessage?: string;
|
|
1731
|
+
}
|
|
1732
|
+
interface GoogleCloudDocumentaiV1beta3DocumentSchema {
|
|
1733
|
+
/** Description of the schema. */
|
|
1734
|
+
description?: string;
|
|
1735
|
+
/** Display name to show to users. */
|
|
1736
|
+
displayName?: string;
|
|
1737
|
+
/** Entity types of the schema. */
|
|
1738
|
+
entityTypes?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType[];
|
|
1739
|
+
/** Metadata of the schema. */
|
|
1740
|
+
metadata?: GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata;
|
|
1741
|
+
}
|
|
1742
|
+
interface GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType {
|
|
1743
|
+
/** The entity type that this type is derived from. For now, one and only one should be set. */
|
|
1744
|
+
baseTypes?: string[];
|
|
1745
|
+
/** User defined name for the type. */
|
|
1746
|
+
displayName?: string;
|
|
1747
|
+
/**
|
|
1748
|
+
* If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the
|
|
1749
|
+
* `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
|
|
1750
|
+
*/
|
|
1751
|
+
enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
|
|
1752
|
+
/**
|
|
1753
|
+
* Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use snake_casing* - name matching
|
|
1754
|
+
* is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and
|
|
1755
|
+
* tooling can handle any ascii character) - The '/' is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be
|
|
1756
|
+
* honored for backward compatibility.
|
|
1757
|
+
*/
|
|
1758
|
+
name?: string;
|
|
1759
|
+
/** Describing the nested structure, or composition of an entity. */
|
|
1760
|
+
properties?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty[];
|
|
1761
|
+
}
|
|
1762
|
+
interface GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues {
|
|
1763
|
+
/** The individual values that this enum values type can include. */
|
|
1764
|
+
values?: string[];
|
|
1765
|
+
}
|
|
1766
|
+
interface GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty {
|
|
1767
|
+
/** The name of the property. Follows the same guidelines as the EntityType name. */
|
|
1768
|
+
name?: string;
|
|
1769
|
+
/** Occurrence type limits the number of instances an entity type appears in the document. */
|
|
1770
|
+
occurrenceType?: string;
|
|
1771
|
+
/** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
|
|
1772
|
+
valueType?: string;
|
|
1773
|
+
}
|
|
1774
|
+
interface GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata {
|
|
1775
|
+
/** If true, on a given page, there can be multiple `document` annotations covering it. */
|
|
1776
|
+
documentAllowMultipleLabels?: boolean;
|
|
1777
|
+
/** If true, a `document` entity type can be applied to subdocument ( splitting). Otherwise, it can only be applied to the entire document (classification). */
|
|
1778
|
+
documentSplitter?: boolean;
|
|
1779
|
+
/** If set, all the nested entities must be prefixed with the parents. */
|
|
1780
|
+
prefixedNamingOnProperties?: boolean;
|
|
1781
|
+
/**
|
|
1782
|
+
* If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be
|
|
1783
|
+
* checked.
|
|
1784
|
+
*/
|
|
1785
|
+
skipNamingValidation?: boolean;
|
|
1786
|
+
}
|
|
1787
|
+
interface GoogleCloudDocumentaiV1beta3DocumentShardInfo {
|
|
1788
|
+
/** Total number of shards. */
|
|
1789
|
+
shardCount?: string;
|
|
1790
|
+
/** The 0-based index of this shard. */
|
|
1791
|
+
shardIndex?: string;
|
|
1792
|
+
/** The index of the first character in Document.text in the overall document global text. */
|
|
1793
|
+
textOffset?: string;
|
|
1794
|
+
}
|
|
1795
|
+
interface GoogleCloudDocumentaiV1beta3DocumentStyle {
|
|
1796
|
+
/** Text background color. */
|
|
1797
|
+
backgroundColor?: GoogleTypeColor;
|
|
1798
|
+
/** Text color. */
|
|
1799
|
+
color?: GoogleTypeColor;
|
|
1800
|
+
/** Font size. */
|
|
1801
|
+
fontSize?: GoogleCloudDocumentaiV1beta3DocumentStyleFontSize;
|
|
1802
|
+
/** Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp */
|
|
1803
|
+
fontWeight?: string;
|
|
1804
|
+
/** Text anchor indexing into the Document.text. */
|
|
1805
|
+
textAnchor?: GoogleCloudDocumentaiV1beta3DocumentTextAnchor;
|
|
1806
|
+
/** Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp */
|
|
1807
|
+
textDecoration?: string;
|
|
1808
|
+
/** Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp */
|
|
1809
|
+
textStyle?: string;
|
|
1810
|
+
}
|
|
1811
|
+
interface GoogleCloudDocumentaiV1beta3DocumentStyleFontSize {
|
|
1812
|
+
/** Font size for the text. */
|
|
1813
|
+
size?: number;
|
|
1814
|
+
/** Unit for the font size. Follows CSS naming (in, px, pt, etc.). */
|
|
1815
|
+
unit?: string;
|
|
1816
|
+
}
|
|
1817
|
+
interface GoogleCloudDocumentaiV1beta3DocumentTextAnchor {
|
|
1818
|
+
/** Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. */
|
|
1819
|
+
content?: string;
|
|
1820
|
+
/** The text segments from the Document.text. */
|
|
1821
|
+
textSegments?: GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment[];
|
|
1822
|
+
}
|
|
1823
|
+
interface GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment {
|
|
1824
|
+
/** TextSegment half open end UTF-8 char index in the Document.text. */
|
|
1825
|
+
endIndex?: string;
|
|
1826
|
+
/** TextSegment start UTF-8 char index in the Document.text. */
|
|
1827
|
+
startIndex?: string;
|
|
1828
|
+
}
|
|
1829
|
+
interface GoogleCloudDocumentaiV1beta3DocumentTextChange {
|
|
1830
|
+
/** The text that replaces the text identified in the `text_anchor`. */
|
|
1831
|
+
changedText?: string;
|
|
1832
|
+
/** The history of this annotation. */
|
|
1833
|
+
provenance?: GoogleCloudDocumentaiV1beta3DocumentProvenance[];
|
|
1834
|
+
/**
|
|
1835
|
+
* Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text
|
|
1836
|
+
* segment are the same, the text change is inserted before that index.
|
|
1837
|
+
*/
|
|
1838
|
+
textAnchor?: GoogleCloudDocumentaiV1beta3DocumentTextAnchor;
|
|
1839
|
+
}
|
|
1840
|
+
interface GoogleCloudDocumentaiV1beta3EnableProcessorMetadata {
|
|
1841
|
+
/** The basic metadata of the long running operation. */
|
|
1842
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
1843
|
+
}
|
|
1844
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1845
|
+
interface GoogleCloudDocumentaiV1beta3EnableProcessorRequest {
|
|
1846
|
+
}
|
|
1847
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1848
|
+
interface GoogleCloudDocumentaiV1beta3EnableProcessorResponse {
|
|
1849
|
+
}
|
|
1850
|
+
interface GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse {
|
|
1851
|
+
/** The list of processor types. */
|
|
1852
|
+
processorTypes?: GoogleCloudDocumentaiV1beta3ProcessorType[];
|
|
1853
|
+
}
|
|
1854
|
+
interface GoogleCloudDocumentaiV1beta3GcsDocument {
|
|
1855
|
+
/** The Cloud Storage object uri. */
|
|
1856
|
+
gcsUri?: string;
|
|
1857
|
+
/** An IANA MIME type (RFC6838) of the content. */
|
|
1858
|
+
mimeType?: string;
|
|
1859
|
+
}
|
|
1860
|
+
interface GoogleCloudDocumentaiV1beta3GcsDocuments {
|
|
1861
|
+
/** The list of documents. */
|
|
1862
|
+
documents?: GoogleCloudDocumentaiV1beta3GcsDocument[];
|
|
1863
|
+
}
|
|
1864
|
+
interface GoogleCloudDocumentaiV1beta3GcsPrefix {
|
|
1865
|
+
/** The URI prefix. */
|
|
1866
|
+
gcsUriPrefix?: string;
|
|
1867
|
+
}
|
|
1868
|
+
interface GoogleCloudDocumentaiV1beta3HumanReviewStatus {
|
|
1869
|
+
/**
|
|
1870
|
+
* The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and
|
|
1871
|
+
* metadata as the long running operation returned by [ReviewDocument] method.
|
|
1872
|
+
*/
|
|
1873
|
+
humanReviewOperation?: string;
|
|
1874
|
+
/** The state of human review on the processing request. */
|
|
1875
|
+
state?: string;
|
|
1876
|
+
/** A message providing more details about the human review state. */
|
|
1877
|
+
stateMessage?: string;
|
|
1878
|
+
}
|
|
1879
|
+
interface GoogleCloudDocumentaiV1beta3ListProcessorsResponse {
|
|
1880
|
+
/** Points to the next processor, otherwise empty. */
|
|
1881
|
+
nextPageToken?: string;
|
|
1882
|
+
/** The list of processors. */
|
|
1883
|
+
processors?: GoogleCloudDocumentaiV1beta3Processor[];
|
|
1884
|
+
}
|
|
1885
|
+
interface GoogleCloudDocumentaiV1beta3ListProcessorTypesResponse {
|
|
1886
|
+
/** Points to the next page, otherwise empty. */
|
|
1887
|
+
nextPageToken?: string;
|
|
1888
|
+
/** The processor types. */
|
|
1889
|
+
processorTypes?: GoogleCloudDocumentaiV1beta3ProcessorType[];
|
|
1890
|
+
}
|
|
1891
|
+
interface GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse {
|
|
1892
|
+
/** Points to the next processor, otherwise empty. */
|
|
1893
|
+
nextPageToken?: string;
|
|
1894
|
+
/** The list of processors. */
|
|
1895
|
+
processorVersions?: GoogleCloudDocumentaiV1beta3ProcessorVersion[];
|
|
1896
|
+
}
|
|
1897
|
+
interface GoogleCloudDocumentaiV1beta3NormalizedVertex {
|
|
1898
|
+
/** X coordinate. */
|
|
1899
|
+
x?: number;
|
|
1900
|
+
/** Y coordinate (starts from the top of the image). */
|
|
1901
|
+
y?: number;
|
|
1902
|
+
}
|
|
1903
|
+
interface GoogleCloudDocumentaiV1beta3Processor {
|
|
1904
|
+
/** The time the processor was created. */
|
|
1905
|
+
createTime?: string;
|
|
1906
|
+
/** The default processor version. */
|
|
1907
|
+
defaultProcessorVersion?: string;
|
|
1908
|
+
/** The display name of the processor. */
|
|
1909
|
+
displayName?: string;
|
|
1910
|
+
/** The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management. */
|
|
1911
|
+
kmsKeyName?: string;
|
|
1912
|
+
/** Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` */
|
|
1913
|
+
name?: string;
|
|
1914
|
+
/** Output only. Immutable. The http endpoint that can be called to invoke processing. */
|
|
1915
|
+
processEndpoint?: string;
|
|
1916
|
+
/** Output only. The state of the processor. */
|
|
1917
|
+
state?: string;
|
|
1918
|
+
/** The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc. To get a list of processors types, see FetchProcessorTypes. */
|
|
1919
|
+
type?: string;
|
|
1920
|
+
}
|
|
1921
|
+
interface GoogleCloudDocumentaiV1beta3ProcessorType {
|
|
1922
|
+
/** Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access. */
|
|
1923
|
+
allowCreation?: boolean;
|
|
1924
|
+
/** The locations in which this processor is available. */
|
|
1925
|
+
availableLocations?: GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo[];
|
|
1926
|
+
/** The processor category, used by UI to group processor types. */
|
|
1927
|
+
category?: string;
|
|
1928
|
+
/** Launch stage of the processor type */
|
|
1929
|
+
launchStage?: string;
|
|
1930
|
+
/** The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type} */
|
|
1931
|
+
name?: string;
|
|
1932
|
+
/** The type of the processor, e.g., "invoice_parsing". */
|
|
1933
|
+
type?: string;
|
|
1934
|
+
}
|
|
1935
|
+
interface GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo {
|
|
1936
|
+
/** The location id, currently must be one of [us, eu]. */
|
|
1937
|
+
locationId?: string;
|
|
1938
|
+
}
|
|
1939
|
+
interface GoogleCloudDocumentaiV1beta3ProcessorVersion {
|
|
1940
|
+
/** The time the processor version was created. */
|
|
1941
|
+
createTime?: string;
|
|
1942
|
+
/** If set, information about the eventual deprecation of this version. */
|
|
1943
|
+
deprecationInfo?: GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo;
|
|
1944
|
+
/** The display name of the processor version. */
|
|
1945
|
+
displayName?: string;
|
|
1946
|
+
/** Denotes that this ProcessorVersion is managed by google. */
|
|
1947
|
+
googleManaged?: boolean;
|
|
1948
|
+
/** The KMS key name used for encryption. */
|
|
1949
|
+
kmsKeyName?: string;
|
|
1950
|
+
/** The KMS key version with which data is encrypted. */
|
|
1951
|
+
kmsKeyVersionName?: string;
|
|
1952
|
+
/** The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` */
|
|
1953
|
+
name?: string;
|
|
1954
|
+
/** The state of the processor version. */
|
|
1955
|
+
state?: string;
|
|
1956
|
+
}
|
|
1957
|
+
interface GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo {
|
|
1958
|
+
/** The time at which this processor version will be deprecated. */
|
|
1959
|
+
deprecationTime?: string;
|
|
1960
|
+
/** If set, the processor version that will be used as a replacement. */
|
|
1961
|
+
replacementProcessorVersion?: string;
|
|
1962
|
+
}
|
|
1963
|
+
interface GoogleCloudDocumentaiV1beta3ProcessRequest {
|
|
1964
|
+
/** The document payload, the [content] and [mime_type] fields must be set. */
|
|
1965
|
+
document?: GoogleCloudDocumentaiV1beta3Document;
|
|
1966
|
+
/** Specifies which fields to include in ProcessResponse's document. */
|
|
1967
|
+
fieldMask?: string;
|
|
1968
|
+
/** An inline document proto. */
|
|
1969
|
+
inlineDocument?: GoogleCloudDocumentaiV1beta3Document;
|
|
1970
|
+
/** A raw document content (bytes). */
|
|
1971
|
+
rawDocument?: GoogleCloudDocumentaiV1beta3RawDocument;
|
|
1972
|
+
/** Whether Human Review feature should be skipped for this request. Default to false. */
|
|
1973
|
+
skipHumanReview?: boolean;
|
|
1974
|
+
}
|
|
1975
|
+
interface GoogleCloudDocumentaiV1beta3ProcessResponse {
|
|
1976
|
+
/** The document payload, will populate fields based on the processor's behavior. */
|
|
1977
|
+
document?: GoogleCloudDocumentaiV1beta3Document;
|
|
1978
|
+
/**
|
|
1979
|
+
* The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as
|
|
1980
|
+
* the long running operation returned by ReviewDocument method.
|
|
1981
|
+
*/
|
|
1982
|
+
humanReviewOperation?: string;
|
|
1983
|
+
/** The status of human review on the processed document. */
|
|
1984
|
+
humanReviewStatus?: GoogleCloudDocumentaiV1beta3HumanReviewStatus;
|
|
1985
|
+
}
|
|
1986
|
+
interface GoogleCloudDocumentaiV1beta3RawDocument {
|
|
1987
|
+
/** Inline document content. */
|
|
1988
|
+
content?: string;
|
|
1989
|
+
/** An IANA MIME type (RFC6838) indicating the nature and format of the [content]. */
|
|
1990
|
+
mimeType?: string;
|
|
1991
|
+
}
|
|
1992
|
+
interface GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata {
|
|
1993
|
+
/** The basic metadata of the long running operation. */
|
|
1994
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
1995
|
+
/** The creation time of the operation. */
|
|
1996
|
+
createTime?: string;
|
|
1997
|
+
/** The Crowd Compute question ID. */
|
|
1998
|
+
questionId?: string;
|
|
1999
|
+
/** Used only when Operation.done is false. */
|
|
2000
|
+
state?: string;
|
|
2001
|
+
/** A message providing more details about the current state of processing. For example, the error message if the operation is failed. */
|
|
2002
|
+
stateMessage?: string;
|
|
2003
|
+
/** The last update time of the operation. */
|
|
2004
|
+
updateTime?: string;
|
|
2005
|
+
}
|
|
2006
|
+
interface GoogleCloudDocumentaiV1beta3ReviewDocumentRequest {
|
|
2007
|
+
/** The document that needs human review. */
|
|
2008
|
+
document?: GoogleCloudDocumentaiV1beta3Document;
|
|
2009
|
+
/** The document schema of the human review task. */
|
|
2010
|
+
documentSchema?: GoogleCloudDocumentaiV1beta3DocumentSchema;
|
|
2011
|
+
/** Whether the validation should be performed on the ad-hoc review request. */
|
|
2012
|
+
enableSchemaValidation?: boolean;
|
|
2013
|
+
/** An inline document proto. */
|
|
2014
|
+
inlineDocument?: GoogleCloudDocumentaiV1beta3Document;
|
|
2015
|
+
/** The priority of the human review task. */
|
|
2016
|
+
priority?: string;
|
|
2017
|
+
}
|
|
2018
|
+
interface GoogleCloudDocumentaiV1beta3ReviewDocumentResponse {
|
|
2019
|
+
/** The Cloud Storage uri for the human reviewed document if the review is succeeded. */
|
|
2020
|
+
gcsDestination?: string;
|
|
2021
|
+
/** The reason why the review is rejected by reviewer. */
|
|
2022
|
+
rejectionReason?: string;
|
|
2023
|
+
/** The state of the review operation. */
|
|
2024
|
+
state?: string;
|
|
2025
|
+
}
|
|
2026
|
+
interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata {
|
|
2027
|
+
/** The basic metadata of the long running operation. */
|
|
2028
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
2029
|
+
}
|
|
2030
|
+
interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest {
|
|
2031
|
+
/** Required. The resource name of child ProcessorVersion to use as default. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` */
|
|
2032
|
+
defaultProcessorVersion?: string;
|
|
2033
|
+
}
|
|
2034
|
+
// tslint:disable-next-line:no-empty-interface
|
|
2035
|
+
interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {
|
|
2036
|
+
}
|
|
2037
|
+
interface GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata {
|
|
2038
|
+
/** The basic metadata of the long running operation. */
|
|
2039
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
2040
|
+
}
|
|
2041
|
+
// tslint:disable-next-line:no-empty-interface
|
|
2042
|
+
interface GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest {
|
|
2043
|
+
}
|
|
2044
|
+
// tslint:disable-next-line:no-empty-interface
|
|
2045
|
+
interface GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse {
|
|
2046
|
+
}
|
|
2047
|
+
interface GoogleCloudDocumentaiV1beta3Vertex {
|
|
2048
|
+
/** X coordinate. */
|
|
2049
|
+
x?: number;
|
|
2050
|
+
/** Y coordinate (starts from the top of the image). */
|
|
2051
|
+
y?: number;
|
|
2052
|
+
}
|
|
2053
|
+
interface GoogleCloudDocumentaiV1CommonOperationMetadata {
|
|
2054
|
+
/** The creation time of the operation. */
|
|
2055
|
+
createTime?: string;
|
|
2056
|
+
/** A related resource to this operation. */
|
|
2057
|
+
resource?: string;
|
|
2058
|
+
/** The state of the operation. */
|
|
2059
|
+
state?: string;
|
|
2060
|
+
/** A message providing more details about the current state of processing. */
|
|
2061
|
+
stateMessage?: string;
|
|
2062
|
+
/** The last update time of the operation. */
|
|
2063
|
+
updateTime?: string;
|
|
2064
|
+
}
|
|
2065
|
+
interface GoogleCloudDocumentaiV1DeleteProcessorMetadata {
|
|
2066
|
+
/** The basic metadata of the long running operation. */
|
|
2067
|
+
commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
|
|
2068
|
+
}
|
|
2069
|
+
interface GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata {
|
|
2070
|
+
/** The basic metadata of the long running operation. */
|
|
2071
|
+
commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
|
|
2072
|
+
}
|
|
2073
|
+
interface GoogleCloudDocumentaiV1DeployProcessorVersionMetadata {
|
|
2074
|
+
/** The basic metadata of the long running operation. */
|
|
2075
|
+
commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
|
|
2076
|
+
}
|
|
2077
|
+
// tslint:disable-next-line:no-empty-interface
|
|
2078
|
+
interface GoogleCloudDocumentaiV1DeployProcessorVersionResponse {
|
|
2079
|
+
}
|
|
2080
|
+
interface GoogleCloudDocumentaiV1DisableProcessorMetadata {
|
|
2081
|
+
/** The basic metadata of the long running operation. */
|
|
2082
|
+
commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
|
|
2083
|
+
}
|
|
2084
|
+
// tslint:disable-next-line:no-empty-interface
|
|
2085
|
+
interface GoogleCloudDocumentaiV1DisableProcessorResponse {
|
|
2086
|
+
}
|
|
2087
|
+
interface GoogleCloudDocumentaiV1EnableProcessorMetadata {
|
|
2088
|
+
/** The basic metadata of the long running operation. */
|
|
2089
|
+
commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
|
|
2090
|
+
}
|
|
2091
|
+
// tslint:disable-next-line:no-empty-interface
|
|
2092
|
+
interface GoogleCloudDocumentaiV1EnableProcessorResponse {
|
|
2093
|
+
}
|
|
2094
|
+
interface GoogleCloudDocumentaiV1HumanReviewStatus {
|
|
2095
|
+
/**
|
|
2096
|
+
* The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and
|
|
2097
|
+
* metadata as the long running operation returned by [ReviewDocument] method.
|
|
2098
|
+
*/
|
|
2099
|
+
humanReviewOperation?: string;
|
|
2100
|
+
/** The state of human review on the processing request. */
|
|
2101
|
+
state?: string;
|
|
2102
|
+
/** A message providing more details about the human review state. */
|
|
2103
|
+
stateMessage?: string;
|
|
2104
|
+
}
|
|
2105
|
+
interface GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata {
|
|
2106
|
+
/** The basic metadata of the long running operation. */
|
|
2107
|
+
commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
|
|
2108
|
+
/** The Crowd Compute question ID. */
|
|
2109
|
+
questionId?: string;
|
|
2110
|
+
}
|
|
2111
|
+
interface GoogleCloudDocumentaiV1ReviewDocumentResponse {
|
|
2112
|
+
/** The Cloud Storage uri for the human reviewed document if the review is succeeded. */
|
|
2113
|
+
gcsDestination?: string;
|
|
2114
|
+
/** The reason why the review is rejected by reviewer. */
|
|
2115
|
+
rejectionReason?: string;
|
|
2116
|
+
/** The state of the review operation. */
|
|
2117
|
+
state?: string;
|
|
2118
|
+
}
|
|
2119
|
+
interface GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata {
|
|
2120
|
+
/** The basic metadata of the long running operation. */
|
|
2121
|
+
commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
|
|
2122
|
+
}
|
|
2123
|
+
// tslint:disable-next-line:no-empty-interface
|
|
2124
|
+
interface GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse {
|
|
2125
|
+
}
|
|
2126
|
+
interface GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata {
|
|
2127
|
+
/** The basic metadata of the long running operation. */
|
|
2128
|
+
commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
|
|
2129
|
+
}
|
|
2130
|
+
// tslint:disable-next-line:no-empty-interface
|
|
2131
|
+
interface GoogleCloudDocumentaiV1UndeployProcessorVersionResponse {
|
|
2132
|
+
}
|
|
2133
|
+
interface GoogleCloudLocationListLocationsResponse {
|
|
2134
|
+
/** A list of locations that matches the specified filter in the request. */
|
|
2135
|
+
locations?: GoogleCloudLocationLocation[];
|
|
2136
|
+
/** The standard List next-page token. */
|
|
2137
|
+
nextPageToken?: string;
|
|
2138
|
+
}
|
|
2139
|
+
interface GoogleCloudLocationLocation {
|
|
2140
|
+
/** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
|
|
2141
|
+
displayName?: string;
|
|
2142
|
+
/** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
|
|
2143
|
+
labels?: { [P in string]: string };
|
|
2144
|
+
/** The canonical id for this location. For example: `"us-east1"`. */
|
|
2145
|
+
locationId?: string;
|
|
2146
|
+
/** Service-specific metadata. For example the available capacity at the given location. */
|
|
2147
|
+
metadata?: { [P in string]: any };
|
|
2148
|
+
/** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
|
|
2149
|
+
name?: string;
|
|
2150
|
+
}
|
|
2151
|
+
interface GoogleLongrunningListOperationsResponse {
|
|
2152
|
+
/** The standard List next-page token. */
|
|
2153
|
+
nextPageToken?: string;
|
|
2154
|
+
/** A list of operations that matches the specified filter in the request. */
|
|
2155
|
+
operations?: GoogleLongrunningOperation[];
|
|
2156
|
+
}
|
|
2157
|
+
interface GoogleLongrunningOperation {
|
|
2158
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
2159
|
+
done?: boolean;
|
|
2160
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
2161
|
+
error?: GoogleRpcStatus;
|
|
2162
|
+
/**
|
|
2163
|
+
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
|
|
2164
|
+
* metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
|
2165
|
+
*/
|
|
2166
|
+
metadata?: { [P in string]: any };
|
|
2167
|
+
/**
|
|
2168
|
+
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
|
|
2169
|
+
* with `operations/{unique_id}`.
|
|
2170
|
+
*/
|
|
2171
|
+
name?: string;
|
|
2172
|
+
/**
|
|
2173
|
+
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
|
|
2174
|
+
* original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
|
|
2175
|
+
* original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
2176
|
+
*/
|
|
2177
|
+
response?: { [P in string]: any };
|
|
2178
|
+
}
|
|
2179
|
+
// tslint:disable-next-line:no-empty-interface
|
|
2180
|
+
interface GoogleProtobufEmpty {
|
|
2181
|
+
}
|
|
2182
|
+
interface GoogleRpcStatus {
|
|
2183
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
2184
|
+
code?: number;
|
|
2185
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
2186
|
+
details?: Array<{ [P in string]: any }>;
|
|
2187
|
+
/**
|
|
2188
|
+
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
|
|
2189
|
+
* client.
|
|
2190
|
+
*/
|
|
2191
|
+
message?: string;
|
|
2192
|
+
}
|
|
2193
|
+
interface GoogleTypeColor {
|
|
2194
|
+
/**
|
|
2195
|
+
* The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) *
|
|
2196
|
+
* (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message
|
|
2197
|
+
* rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color
|
|
2198
|
+
* (as if the alpha value had been explicitly given a value of 1.0).
|
|
2199
|
+
*/
|
|
2200
|
+
alpha?: number;
|
|
2201
|
+
/** The amount of blue in the color as a value in the interval [0, 1]. */
|
|
2202
|
+
blue?: number;
|
|
2203
|
+
/** The amount of green in the color as a value in the interval [0, 1]. */
|
|
2204
|
+
green?: number;
|
|
2205
|
+
/** The amount of red in the color as a value in the interval [0, 1]. */
|
|
2206
|
+
red?: number;
|
|
2207
|
+
}
|
|
2208
|
+
interface GoogleTypeDate {
|
|
2209
|
+
/** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
|
|
2210
|
+
day?: number;
|
|
2211
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
2212
|
+
month?: number;
|
|
2213
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
2214
|
+
year?: number;
|
|
2215
|
+
}
|
|
2216
|
+
interface GoogleTypeDateTime {
|
|
2217
|
+
/** Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. */
|
|
2218
|
+
day?: number;
|
|
2219
|
+
/** Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. */
|
|
2220
|
+
hours?: number;
|
|
2221
|
+
/** Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. */
|
|
2222
|
+
minutes?: number;
|
|
2223
|
+
/** Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. */
|
|
2224
|
+
month?: number;
|
|
2225
|
+
/** Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. */
|
|
2226
|
+
nanos?: number;
|
|
2227
|
+
/** Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. */
|
|
2228
|
+
seconds?: number;
|
|
2229
|
+
/** Time zone. */
|
|
2230
|
+
timeZone?: GoogleTypeTimeZone;
|
|
2231
|
+
/** UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. */
|
|
2232
|
+
utcOffset?: string;
|
|
2233
|
+
/** Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. */
|
|
2234
|
+
year?: number;
|
|
2235
|
+
}
|
|
2236
|
+
interface GoogleTypeMoney {
|
|
2237
|
+
/** The three-letter currency code defined in ISO 4217. */
|
|
2238
|
+
currencyCode?: string;
|
|
2239
|
+
/**
|
|
2240
|
+
* Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units`
|
|
2241
|
+
* is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and
|
|
2242
|
+
* `nanos`=-750,000,000.
|
|
2243
|
+
*/
|
|
2244
|
+
nanos?: number;
|
|
2245
|
+
/** The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */
|
|
2246
|
+
units?: string;
|
|
2247
|
+
}
|
|
2248
|
+
interface GoogleTypePostalAddress {
|
|
2249
|
+
/**
|
|
2250
|
+
* Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a
|
|
2251
|
+
* single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In
|
|
2252
|
+
* places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the
|
|
2253
|
+
* most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining
|
|
2254
|
+
* information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of
|
|
2255
|
+
* the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to
|
|
2256
|
+
* handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
|
|
2257
|
+
*/
|
|
2258
|
+
addressLines?: string[];
|
|
2259
|
+
/**
|
|
2260
|
+
* Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture.
|
|
2261
|
+
* Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal
|
|
2262
|
+
* addresses. E.g. in Switzerland this should be left unpopulated.
|
|
2263
|
+
*/
|
|
2264
|
+
administrativeArea?: string;
|
|
2265
|
+
/**
|
|
2266
|
+
* Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the
|
|
2267
|
+
* address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never
|
|
2268
|
+
* affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples:
|
|
2269
|
+
* "zh-Hant", "ja", "ja-Latn", "en".
|
|
2270
|
+
*/
|
|
2271
|
+
languageCode?: string;
|
|
2272
|
+
/**
|
|
2273
|
+
* Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do
|
|
2274
|
+
* not fit into this structure well, leave locality empty and use address_lines.
|
|
2275
|
+
*/
|
|
2276
|
+
locality?: string;
|
|
2277
|
+
/** Optional. The name of the organization at the address. */
|
|
2278
|
+
organization?: string;
|
|
2279
|
+
/**
|
|
2280
|
+
* Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts
|
|
2281
|
+
* of the address (e.g. state/zip validation in the U.S.A.).
|
|
2282
|
+
*/
|
|
2283
|
+
postalCode?: string;
|
|
2284
|
+
/** Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. */
|
|
2285
|
+
recipients?: string[];
|
|
2286
|
+
/**
|
|
2287
|
+
* Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and
|
|
2288
|
+
* https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
|
|
2289
|
+
*/
|
|
2290
|
+
regionCode?: string;
|
|
2291
|
+
/** The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. */
|
|
2292
|
+
revision?: number;
|
|
2293
|
+
/**
|
|
2294
|
+
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number
|
|
2295
|
+
* (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
|
|
2296
|
+
*/
|
|
2297
|
+
sortingCode?: string;
|
|
2298
|
+
/** Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. */
|
|
2299
|
+
sublocality?: string;
|
|
2300
|
+
}
|
|
2301
|
+
interface GoogleTypeTimeZone {
|
|
2302
|
+
/** IANA Time Zone Database time zone, e.g. "America/New_York". */
|
|
2303
|
+
id?: string;
|
|
2304
|
+
/** Optional. IANA Time Zone Database version number, e.g. "2019a". */
|
|
2305
|
+
version?: string;
|
|
2306
|
+
}
|
|
2307
|
+
interface OperationsResource {
|
|
2308
|
+
/**
|
|
2309
|
+
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support
|
|
2310
|
+
* this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
|
|
2311
|
+
* operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
|
|
2312
|
+
* google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
2313
|
+
*/
|
|
2314
|
+
cancel(request?: {
|
|
2315
|
+
/** V1 error format. */
|
|
2316
|
+
"$.xgafv"?: string;
|
|
2317
|
+
/** OAuth access token. */
|
|
2318
|
+
access_token?: string;
|
|
2319
|
+
/** Data format for response. */
|
|
2320
|
+
alt?: string;
|
|
2321
|
+
/** JSONP */
|
|
2322
|
+
callback?: string;
|
|
2323
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2324
|
+
fields?: string;
|
|
2325
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2326
|
+
key?: string;
|
|
2327
|
+
/** The name of the operation resource to be cancelled. */
|
|
2328
|
+
name: string;
|
|
2329
|
+
/** OAuth 2.0 token for the current user. */
|
|
2330
|
+
oauth_token?: string;
|
|
2331
|
+
/** Returns response with indentations and line breaks. */
|
|
2332
|
+
prettyPrint?: boolean;
|
|
2333
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2334
|
+
quotaUser?: string;
|
|
2335
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2336
|
+
upload_protocol?: string;
|
|
2337
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2338
|
+
uploadType?: string;
|
|
2339
|
+
}): Request<{}>;
|
|
2340
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
2341
|
+
get(request?: {
|
|
2342
|
+
/** V1 error format. */
|
|
2343
|
+
"$.xgafv"?: string;
|
|
2344
|
+
/** OAuth access token. */
|
|
2345
|
+
access_token?: string;
|
|
2346
|
+
/** Data format for response. */
|
|
2347
|
+
alt?: string;
|
|
2348
|
+
/** JSONP */
|
|
2349
|
+
callback?: string;
|
|
2350
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2351
|
+
fields?: string;
|
|
2352
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2353
|
+
key?: string;
|
|
2354
|
+
/** The name of the operation resource. */
|
|
2355
|
+
name: string;
|
|
2356
|
+
/** OAuth 2.0 token for the current user. */
|
|
2357
|
+
oauth_token?: string;
|
|
2358
|
+
/** Returns response with indentations and line breaks. */
|
|
2359
|
+
prettyPrint?: boolean;
|
|
2360
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2361
|
+
quotaUser?: string;
|
|
2362
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2363
|
+
upload_protocol?: string;
|
|
2364
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2365
|
+
uploadType?: string;
|
|
2366
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2367
|
+
/**
|
|
2368
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
|
|
2369
|
+
* to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as
|
|
2370
|
+
* `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
|
|
2371
|
+
* ensure the name binding is the parent resource, without the operations collection id.
|
|
2372
|
+
*/
|
|
2373
|
+
list(request?: {
|
|
2374
|
+
/** V1 error format. */
|
|
2375
|
+
"$.xgafv"?: string;
|
|
2376
|
+
/** OAuth access token. */
|
|
2377
|
+
access_token?: string;
|
|
2378
|
+
/** Data format for response. */
|
|
2379
|
+
alt?: string;
|
|
2380
|
+
/** JSONP */
|
|
2381
|
+
callback?: string;
|
|
2382
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2383
|
+
fields?: string;
|
|
2384
|
+
/** The standard list filter. */
|
|
2385
|
+
filter?: string;
|
|
2386
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2387
|
+
key?: string;
|
|
2388
|
+
/** The name of the operation's parent resource. */
|
|
2389
|
+
name: string;
|
|
2390
|
+
/** OAuth 2.0 token for the current user. */
|
|
2391
|
+
oauth_token?: string;
|
|
2392
|
+
/** The standard list page size. */
|
|
2393
|
+
pageSize?: number;
|
|
2394
|
+
/** The standard list page token. */
|
|
2395
|
+
pageToken?: string;
|
|
2396
|
+
/** Returns response with indentations and line breaks. */
|
|
2397
|
+
prettyPrint?: boolean;
|
|
2398
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2399
|
+
quotaUser?: string;
|
|
2400
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2401
|
+
upload_protocol?: string;
|
|
2402
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2403
|
+
uploadType?: string;
|
|
2404
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
2405
|
+
}
|
|
2406
|
+
interface HumanReviewConfigResource {
|
|
2407
|
+
/** Send a document for Human Review. The input document should be processed by the specified processor. */
|
|
2408
|
+
reviewDocument(request: {
|
|
2409
|
+
/** V1 error format. */
|
|
2410
|
+
"$.xgafv"?: string;
|
|
2411
|
+
/** OAuth access token. */
|
|
2412
|
+
access_token?: string;
|
|
2413
|
+
/** Data format for response. */
|
|
2414
|
+
alt?: string;
|
|
2415
|
+
/** JSONP */
|
|
2416
|
+
callback?: string;
|
|
2417
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2418
|
+
fields?: string;
|
|
2419
|
+
/** Required. The resource name of the HumanReviewConfig that the document will be reviewed with. */
|
|
2420
|
+
humanReviewConfig: string;
|
|
2421
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2422
|
+
key?: string;
|
|
2423
|
+
/** OAuth 2.0 token for the current user. */
|
|
2424
|
+
oauth_token?: string;
|
|
2425
|
+
/** Returns response with indentations and line breaks. */
|
|
2426
|
+
prettyPrint?: boolean;
|
|
2427
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2428
|
+
quotaUser?: string;
|
|
2429
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2430
|
+
upload_protocol?: string;
|
|
2431
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2432
|
+
uploadType?: string;
|
|
2433
|
+
/** Request body */
|
|
2434
|
+
resource: GoogleCloudDocumentaiV1beta3ReviewDocumentRequest;
|
|
2435
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2436
|
+
reviewDocument(request: {
|
|
2437
|
+
/** V1 error format. */
|
|
2438
|
+
"$.xgafv"?: string;
|
|
2439
|
+
/** OAuth access token. */
|
|
2440
|
+
access_token?: string;
|
|
2441
|
+
/** Data format for response. */
|
|
2442
|
+
alt?: string;
|
|
2443
|
+
/** JSONP */
|
|
2444
|
+
callback?: string;
|
|
2445
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2446
|
+
fields?: string;
|
|
2447
|
+
/** Required. The resource name of the HumanReviewConfig that the document will be reviewed with. */
|
|
2448
|
+
humanReviewConfig: string;
|
|
2449
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2450
|
+
key?: string;
|
|
2451
|
+
/** OAuth 2.0 token for the current user. */
|
|
2452
|
+
oauth_token?: string;
|
|
2453
|
+
/** Returns response with indentations and line breaks. */
|
|
2454
|
+
prettyPrint?: boolean;
|
|
2455
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2456
|
+
quotaUser?: string;
|
|
2457
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2458
|
+
upload_protocol?: string;
|
|
2459
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2460
|
+
uploadType?: string;
|
|
2461
|
+
},
|
|
2462
|
+
body: GoogleCloudDocumentaiV1beta3ReviewDocumentRequest): Request<GoogleLongrunningOperation>;
|
|
2463
|
+
}
|
|
2464
|
+
interface ProcessorVersionsResource {
|
|
2465
|
+
/** LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. */
|
|
2466
|
+
batchProcess(request: {
|
|
2467
|
+
/** V1 error format. */
|
|
2468
|
+
"$.xgafv"?: string;
|
|
2469
|
+
/** OAuth access token. */
|
|
2470
|
+
access_token?: string;
|
|
2471
|
+
/** Data format for response. */
|
|
2472
|
+
alt?: string;
|
|
2473
|
+
/** JSONP */
|
|
2474
|
+
callback?: string;
|
|
2475
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2476
|
+
fields?: string;
|
|
2477
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2478
|
+
key?: string;
|
|
2479
|
+
/**
|
|
2480
|
+
* Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or
|
|
2481
|
+
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
|
2482
|
+
*/
|
|
2483
|
+
name: string;
|
|
2484
|
+
/** OAuth 2.0 token for the current user. */
|
|
2485
|
+
oauth_token?: string;
|
|
2486
|
+
/** Returns response with indentations and line breaks. */
|
|
2487
|
+
prettyPrint?: boolean;
|
|
2488
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2489
|
+
quotaUser?: string;
|
|
2490
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2491
|
+
upload_protocol?: string;
|
|
2492
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2493
|
+
uploadType?: string;
|
|
2494
|
+
/** Request body */
|
|
2495
|
+
resource: GoogleCloudDocumentaiV1beta3BatchProcessRequest;
|
|
2496
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2497
|
+
batchProcess(request: {
|
|
2498
|
+
/** V1 error format. */
|
|
2499
|
+
"$.xgafv"?: string;
|
|
2500
|
+
/** OAuth access token. */
|
|
2501
|
+
access_token?: string;
|
|
2502
|
+
/** Data format for response. */
|
|
2503
|
+
alt?: string;
|
|
2504
|
+
/** JSONP */
|
|
2505
|
+
callback?: string;
|
|
2506
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2507
|
+
fields?: string;
|
|
2508
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2509
|
+
key?: string;
|
|
2510
|
+
/**
|
|
2511
|
+
* Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or
|
|
2512
|
+
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
|
2513
|
+
*/
|
|
2514
|
+
name: string;
|
|
2515
|
+
/** OAuth 2.0 token for the current user. */
|
|
2516
|
+
oauth_token?: string;
|
|
2517
|
+
/** Returns response with indentations and line breaks. */
|
|
2518
|
+
prettyPrint?: boolean;
|
|
2519
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2520
|
+
quotaUser?: string;
|
|
2521
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2522
|
+
upload_protocol?: string;
|
|
2523
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2524
|
+
uploadType?: string;
|
|
2525
|
+
},
|
|
2526
|
+
body: GoogleCloudDocumentaiV1beta3BatchProcessRequest): Request<GoogleLongrunningOperation>;
|
|
2527
|
+
/** Deletes the processor version, all artifacts under the processor version will be deleted. */
|
|
2528
|
+
delete(request?: {
|
|
2529
|
+
/** V1 error format. */
|
|
2530
|
+
"$.xgafv"?: string;
|
|
2531
|
+
/** OAuth access token. */
|
|
2532
|
+
access_token?: string;
|
|
2533
|
+
/** Data format for response. */
|
|
2534
|
+
alt?: string;
|
|
2535
|
+
/** JSONP */
|
|
2536
|
+
callback?: string;
|
|
2537
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2538
|
+
fields?: string;
|
|
2539
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2540
|
+
key?: string;
|
|
2541
|
+
/** Required. The processor version resource name to be deleted. */
|
|
2542
|
+
name: string;
|
|
2543
|
+
/** OAuth 2.0 token for the current user. */
|
|
2544
|
+
oauth_token?: string;
|
|
2545
|
+
/** Returns response with indentations and line breaks. */
|
|
2546
|
+
prettyPrint?: boolean;
|
|
2547
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2548
|
+
quotaUser?: string;
|
|
2549
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2550
|
+
upload_protocol?: string;
|
|
2551
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2552
|
+
uploadType?: string;
|
|
2553
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2554
|
+
/** Deploys the processor version. */
|
|
2555
|
+
deploy(request: {
|
|
2556
|
+
/** V1 error format. */
|
|
2557
|
+
"$.xgafv"?: string;
|
|
2558
|
+
/** OAuth access token. */
|
|
2559
|
+
access_token?: string;
|
|
2560
|
+
/** Data format for response. */
|
|
2561
|
+
alt?: string;
|
|
2562
|
+
/** JSONP */
|
|
2563
|
+
callback?: string;
|
|
2564
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2565
|
+
fields?: string;
|
|
2566
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2567
|
+
key?: string;
|
|
2568
|
+
/** Required. The processor version resource name to be deployed. */
|
|
2569
|
+
name: string;
|
|
2570
|
+
/** OAuth 2.0 token for the current user. */
|
|
2571
|
+
oauth_token?: string;
|
|
2572
|
+
/** Returns response with indentations and line breaks. */
|
|
2573
|
+
prettyPrint?: boolean;
|
|
2574
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2575
|
+
quotaUser?: string;
|
|
2576
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2577
|
+
upload_protocol?: string;
|
|
2578
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2579
|
+
uploadType?: string;
|
|
2580
|
+
/** Request body */
|
|
2581
|
+
resource: GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest;
|
|
2582
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2583
|
+
deploy(request: {
|
|
2584
|
+
/** V1 error format. */
|
|
2585
|
+
"$.xgafv"?: string;
|
|
2586
|
+
/** OAuth access token. */
|
|
2587
|
+
access_token?: string;
|
|
2588
|
+
/** Data format for response. */
|
|
2589
|
+
alt?: string;
|
|
2590
|
+
/** JSONP */
|
|
2591
|
+
callback?: string;
|
|
2592
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2593
|
+
fields?: string;
|
|
2594
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2595
|
+
key?: string;
|
|
2596
|
+
/** Required. The processor version resource name to be deployed. */
|
|
2597
|
+
name: string;
|
|
2598
|
+
/** OAuth 2.0 token for the current user. */
|
|
2599
|
+
oauth_token?: string;
|
|
2600
|
+
/** Returns response with indentations and line breaks. */
|
|
2601
|
+
prettyPrint?: boolean;
|
|
2602
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2603
|
+
quotaUser?: string;
|
|
2604
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2605
|
+
upload_protocol?: string;
|
|
2606
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2607
|
+
uploadType?: string;
|
|
2608
|
+
},
|
|
2609
|
+
body: GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest): Request<GoogleLongrunningOperation>;
|
|
2610
|
+
/** Gets a processor version detail. */
|
|
2611
|
+
get(request?: {
|
|
2612
|
+
/** V1 error format. */
|
|
2613
|
+
"$.xgafv"?: string;
|
|
2614
|
+
/** OAuth access token. */
|
|
2615
|
+
access_token?: string;
|
|
2616
|
+
/** Data format for response. */
|
|
2617
|
+
alt?: string;
|
|
2618
|
+
/** JSONP */
|
|
2619
|
+
callback?: string;
|
|
2620
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2621
|
+
fields?: string;
|
|
2622
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2623
|
+
key?: string;
|
|
2624
|
+
/** Required. The processor resource name. */
|
|
2625
|
+
name: string;
|
|
2626
|
+
/** OAuth 2.0 token for the current user. */
|
|
2627
|
+
oauth_token?: string;
|
|
2628
|
+
/** Returns response with indentations and line breaks. */
|
|
2629
|
+
prettyPrint?: boolean;
|
|
2630
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2631
|
+
quotaUser?: string;
|
|
2632
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2633
|
+
upload_protocol?: string;
|
|
2634
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2635
|
+
uploadType?: string;
|
|
2636
|
+
}): Request<GoogleCloudDocumentaiV1beta3ProcessorVersion>;
|
|
2637
|
+
/** Lists all versions of a processor. */
|
|
2638
|
+
list(request?: {
|
|
2639
|
+
/** V1 error format. */
|
|
2640
|
+
"$.xgafv"?: string;
|
|
2641
|
+
/** OAuth access token. */
|
|
2642
|
+
access_token?: string;
|
|
2643
|
+
/** Data format for response. */
|
|
2644
|
+
alt?: string;
|
|
2645
|
+
/** JSONP */
|
|
2646
|
+
callback?: string;
|
|
2647
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2648
|
+
fields?: string;
|
|
2649
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2650
|
+
key?: string;
|
|
2651
|
+
/** OAuth 2.0 token for the current user. */
|
|
2652
|
+
oauth_token?: string;
|
|
2653
|
+
/**
|
|
2654
|
+
* The maximum number of processor versions to return. If unspecified, at most 10 processor versions will be returned. The maximum value is 20; values above 20 will be coerced to
|
|
2655
|
+
* 20.
|
|
2656
|
+
*/
|
|
2657
|
+
pageSize?: number;
|
|
2658
|
+
/** We will return the processor versions sorted by creation time. The page token will point to the next processor version. */
|
|
2659
|
+
pageToken?: string;
|
|
2660
|
+
/** Required. The parent (project, location and processor) to list all versions. Format: `projects/{project}/locations/{location}/processors/{processor}` */
|
|
2661
|
+
parent: string;
|
|
2662
|
+
/** Returns response with indentations and line breaks. */
|
|
2663
|
+
prettyPrint?: boolean;
|
|
2664
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2665
|
+
quotaUser?: string;
|
|
2666
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2667
|
+
upload_protocol?: string;
|
|
2668
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2669
|
+
uploadType?: string;
|
|
2670
|
+
}): Request<GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse>;
|
|
2671
|
+
/** Processes a single document. */
|
|
2672
|
+
process(request: {
|
|
2673
|
+
/** V1 error format. */
|
|
2674
|
+
"$.xgafv"?: string;
|
|
2675
|
+
/** OAuth access token. */
|
|
2676
|
+
access_token?: string;
|
|
2677
|
+
/** Data format for response. */
|
|
2678
|
+
alt?: string;
|
|
2679
|
+
/** JSONP */
|
|
2680
|
+
callback?: string;
|
|
2681
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2682
|
+
fields?: string;
|
|
2683
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2684
|
+
key?: string;
|
|
2685
|
+
/**
|
|
2686
|
+
* Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format:
|
|
2687
|
+
* `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
|
2688
|
+
*/
|
|
2689
|
+
name: string;
|
|
2690
|
+
/** OAuth 2.0 token for the current user. */
|
|
2691
|
+
oauth_token?: string;
|
|
2692
|
+
/** Returns response with indentations and line breaks. */
|
|
2693
|
+
prettyPrint?: boolean;
|
|
2694
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2695
|
+
quotaUser?: string;
|
|
2696
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2697
|
+
upload_protocol?: string;
|
|
2698
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2699
|
+
uploadType?: string;
|
|
2700
|
+
/** Request body */
|
|
2701
|
+
resource: GoogleCloudDocumentaiV1beta3ProcessRequest;
|
|
2702
|
+
}): Request<GoogleCloudDocumentaiV1beta3ProcessResponse>;
|
|
2703
|
+
process(request: {
|
|
2704
|
+
/** V1 error format. */
|
|
2705
|
+
"$.xgafv"?: string;
|
|
2706
|
+
/** OAuth access token. */
|
|
2707
|
+
access_token?: string;
|
|
2708
|
+
/** Data format for response. */
|
|
2709
|
+
alt?: string;
|
|
2710
|
+
/** JSONP */
|
|
2711
|
+
callback?: string;
|
|
2712
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2713
|
+
fields?: string;
|
|
2714
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2715
|
+
key?: string;
|
|
2716
|
+
/**
|
|
2717
|
+
* Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format:
|
|
2718
|
+
* `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
|
2719
|
+
*/
|
|
2720
|
+
name: string;
|
|
2721
|
+
/** OAuth 2.0 token for the current user. */
|
|
2722
|
+
oauth_token?: string;
|
|
2723
|
+
/** Returns response with indentations and line breaks. */
|
|
2724
|
+
prettyPrint?: boolean;
|
|
2725
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2726
|
+
quotaUser?: string;
|
|
2727
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2728
|
+
upload_protocol?: string;
|
|
2729
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2730
|
+
uploadType?: string;
|
|
2731
|
+
},
|
|
2732
|
+
body: GoogleCloudDocumentaiV1beta3ProcessRequest): Request<GoogleCloudDocumentaiV1beta3ProcessResponse>;
|
|
2733
|
+
/** Undeploys the processor version. */
|
|
2734
|
+
undeploy(request: {
|
|
2735
|
+
/** V1 error format. */
|
|
2736
|
+
"$.xgafv"?: string;
|
|
2737
|
+
/** OAuth access token. */
|
|
2738
|
+
access_token?: string;
|
|
2739
|
+
/** Data format for response. */
|
|
2740
|
+
alt?: string;
|
|
2741
|
+
/** JSONP */
|
|
2742
|
+
callback?: string;
|
|
2743
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2744
|
+
fields?: string;
|
|
2745
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2746
|
+
key?: string;
|
|
2747
|
+
/** Required. The processor version resource name to be undeployed. */
|
|
2748
|
+
name: string;
|
|
2749
|
+
/** OAuth 2.0 token for the current user. */
|
|
2750
|
+
oauth_token?: string;
|
|
2751
|
+
/** Returns response with indentations and line breaks. */
|
|
2752
|
+
prettyPrint?: boolean;
|
|
2753
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2754
|
+
quotaUser?: string;
|
|
2755
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2756
|
+
upload_protocol?: string;
|
|
2757
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2758
|
+
uploadType?: string;
|
|
2759
|
+
/** Request body */
|
|
2760
|
+
resource: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest;
|
|
2761
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2762
|
+
undeploy(request: {
|
|
2763
|
+
/** V1 error format. */
|
|
2764
|
+
"$.xgafv"?: string;
|
|
2765
|
+
/** OAuth access token. */
|
|
2766
|
+
access_token?: string;
|
|
2767
|
+
/** Data format for response. */
|
|
2768
|
+
alt?: string;
|
|
2769
|
+
/** JSONP */
|
|
2770
|
+
callback?: string;
|
|
2771
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2772
|
+
fields?: string;
|
|
2773
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2774
|
+
key?: string;
|
|
2775
|
+
/** Required. The processor version resource name to be undeployed. */
|
|
2776
|
+
name: string;
|
|
2777
|
+
/** OAuth 2.0 token for the current user. */
|
|
2778
|
+
oauth_token?: string;
|
|
2779
|
+
/** Returns response with indentations and line breaks. */
|
|
2780
|
+
prettyPrint?: boolean;
|
|
2781
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2782
|
+
quotaUser?: string;
|
|
2783
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2784
|
+
upload_protocol?: string;
|
|
2785
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2786
|
+
uploadType?: string;
|
|
2787
|
+
},
|
|
2788
|
+
body: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest): Request<GoogleLongrunningOperation>;
|
|
2789
|
+
}
|
|
2790
|
+
interface ProcessorsResource {
|
|
2791
|
+
/** LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. */
|
|
2792
|
+
batchProcess(request: {
|
|
2793
|
+
/** V1 error format. */
|
|
2794
|
+
"$.xgafv"?: string;
|
|
2795
|
+
/** OAuth access token. */
|
|
2796
|
+
access_token?: string;
|
|
2797
|
+
/** Data format for response. */
|
|
2798
|
+
alt?: string;
|
|
2799
|
+
/** JSONP */
|
|
2800
|
+
callback?: string;
|
|
2801
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2802
|
+
fields?: string;
|
|
2803
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2804
|
+
key?: string;
|
|
2805
|
+
/**
|
|
2806
|
+
* Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or
|
|
2807
|
+
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
|
2808
|
+
*/
|
|
2809
|
+
name: string;
|
|
2810
|
+
/** OAuth 2.0 token for the current user. */
|
|
2811
|
+
oauth_token?: string;
|
|
2812
|
+
/** Returns response with indentations and line breaks. */
|
|
2813
|
+
prettyPrint?: boolean;
|
|
2814
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2815
|
+
quotaUser?: string;
|
|
2816
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2817
|
+
upload_protocol?: string;
|
|
2818
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2819
|
+
uploadType?: string;
|
|
2820
|
+
/** Request body */
|
|
2821
|
+
resource: GoogleCloudDocumentaiV1beta3BatchProcessRequest;
|
|
2822
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2823
|
+
batchProcess(request: {
|
|
2824
|
+
/** V1 error format. */
|
|
2825
|
+
"$.xgafv"?: string;
|
|
2826
|
+
/** OAuth access token. */
|
|
2827
|
+
access_token?: string;
|
|
2828
|
+
/** Data format for response. */
|
|
2829
|
+
alt?: string;
|
|
2830
|
+
/** JSONP */
|
|
2831
|
+
callback?: string;
|
|
2832
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2833
|
+
fields?: string;
|
|
2834
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2835
|
+
key?: string;
|
|
2836
|
+
/**
|
|
2837
|
+
* Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or
|
|
2838
|
+
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
|
2839
|
+
*/
|
|
2840
|
+
name: string;
|
|
2841
|
+
/** OAuth 2.0 token for the current user. */
|
|
2842
|
+
oauth_token?: string;
|
|
2843
|
+
/** Returns response with indentations and line breaks. */
|
|
2844
|
+
prettyPrint?: boolean;
|
|
2845
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2846
|
+
quotaUser?: string;
|
|
2847
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2848
|
+
upload_protocol?: string;
|
|
2849
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2850
|
+
uploadType?: string;
|
|
2851
|
+
},
|
|
2852
|
+
body: GoogleCloudDocumentaiV1beta3BatchProcessRequest): Request<GoogleLongrunningOperation>;
|
|
2853
|
+
/** Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation. */
|
|
2854
|
+
create(request: {
|
|
2855
|
+
/** V1 error format. */
|
|
2856
|
+
"$.xgafv"?: string;
|
|
2857
|
+
/** OAuth access token. */
|
|
2858
|
+
access_token?: string;
|
|
2859
|
+
/** Data format for response. */
|
|
2860
|
+
alt?: string;
|
|
2861
|
+
/** JSONP */
|
|
2862
|
+
callback?: string;
|
|
2863
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2864
|
+
fields?: string;
|
|
2865
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2866
|
+
key?: string;
|
|
2867
|
+
/** OAuth 2.0 token for the current user. */
|
|
2868
|
+
oauth_token?: string;
|
|
2869
|
+
/** Required. The parent (project and location) under which to create the processor. Format: `projects/{project}/locations/{location}` */
|
|
2870
|
+
parent: string;
|
|
2871
|
+
/** Returns response with indentations and line breaks. */
|
|
2872
|
+
prettyPrint?: boolean;
|
|
2873
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2874
|
+
quotaUser?: string;
|
|
2875
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2876
|
+
upload_protocol?: string;
|
|
2877
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2878
|
+
uploadType?: string;
|
|
2879
|
+
/** Request body */
|
|
2880
|
+
resource: GoogleCloudDocumentaiV1beta3Processor;
|
|
2881
|
+
}): Request<GoogleCloudDocumentaiV1beta3Processor>;
|
|
2882
|
+
create(request: {
|
|
2883
|
+
/** V1 error format. */
|
|
2884
|
+
"$.xgafv"?: string;
|
|
2885
|
+
/** OAuth access token. */
|
|
2886
|
+
access_token?: string;
|
|
2887
|
+
/** Data format for response. */
|
|
2888
|
+
alt?: string;
|
|
2889
|
+
/** JSONP */
|
|
2890
|
+
callback?: string;
|
|
2891
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2892
|
+
fields?: string;
|
|
2893
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2894
|
+
key?: string;
|
|
2895
|
+
/** OAuth 2.0 token for the current user. */
|
|
2896
|
+
oauth_token?: string;
|
|
2897
|
+
/** Required. The parent (project and location) under which to create the processor. Format: `projects/{project}/locations/{location}` */
|
|
2898
|
+
parent: string;
|
|
2899
|
+
/** Returns response with indentations and line breaks. */
|
|
2900
|
+
prettyPrint?: boolean;
|
|
2901
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2902
|
+
quotaUser?: string;
|
|
2903
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2904
|
+
upload_protocol?: string;
|
|
2905
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2906
|
+
uploadType?: string;
|
|
2907
|
+
},
|
|
2908
|
+
body: GoogleCloudDocumentaiV1beta3Processor): Request<GoogleCloudDocumentaiV1beta3Processor>;
|
|
2909
|
+
/** Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. */
|
|
2910
|
+
delete(request?: {
|
|
2911
|
+
/** V1 error format. */
|
|
2912
|
+
"$.xgafv"?: string;
|
|
2913
|
+
/** OAuth access token. */
|
|
2914
|
+
access_token?: string;
|
|
2915
|
+
/** Data format for response. */
|
|
2916
|
+
alt?: string;
|
|
2917
|
+
/** JSONP */
|
|
2918
|
+
callback?: string;
|
|
2919
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2920
|
+
fields?: string;
|
|
2921
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2922
|
+
key?: string;
|
|
2923
|
+
/** Required. The processor resource name to be deleted. */
|
|
2924
|
+
name: string;
|
|
2925
|
+
/** OAuth 2.0 token for the current user. */
|
|
2926
|
+
oauth_token?: string;
|
|
2927
|
+
/** Returns response with indentations and line breaks. */
|
|
2928
|
+
prettyPrint?: boolean;
|
|
2929
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2930
|
+
quotaUser?: string;
|
|
2931
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2932
|
+
upload_protocol?: string;
|
|
2933
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2934
|
+
uploadType?: string;
|
|
2935
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2936
|
+
/** Disables a processor */
|
|
2937
|
+
disable(request: {
|
|
2938
|
+
/** V1 error format. */
|
|
2939
|
+
"$.xgafv"?: string;
|
|
2940
|
+
/** OAuth access token. */
|
|
2941
|
+
access_token?: string;
|
|
2942
|
+
/** Data format for response. */
|
|
2943
|
+
alt?: string;
|
|
2944
|
+
/** JSONP */
|
|
2945
|
+
callback?: string;
|
|
2946
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2947
|
+
fields?: string;
|
|
2948
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2949
|
+
key?: string;
|
|
2950
|
+
/** Required. The processor resource name to be disabled. */
|
|
2951
|
+
name: string;
|
|
2952
|
+
/** OAuth 2.0 token for the current user. */
|
|
2953
|
+
oauth_token?: string;
|
|
2954
|
+
/** Returns response with indentations and line breaks. */
|
|
2955
|
+
prettyPrint?: boolean;
|
|
2956
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2957
|
+
quotaUser?: string;
|
|
2958
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2959
|
+
upload_protocol?: string;
|
|
2960
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2961
|
+
uploadType?: string;
|
|
2962
|
+
/** Request body */
|
|
2963
|
+
resource: GoogleCloudDocumentaiV1beta3DisableProcessorRequest;
|
|
2964
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2965
|
+
disable(request: {
|
|
2966
|
+
/** V1 error format. */
|
|
2967
|
+
"$.xgafv"?: string;
|
|
2968
|
+
/** OAuth access token. */
|
|
2969
|
+
access_token?: string;
|
|
2970
|
+
/** Data format for response. */
|
|
2971
|
+
alt?: string;
|
|
2972
|
+
/** JSONP */
|
|
2973
|
+
callback?: string;
|
|
2974
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2975
|
+
fields?: string;
|
|
2976
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2977
|
+
key?: string;
|
|
2978
|
+
/** Required. The processor resource name to be disabled. */
|
|
2979
|
+
name: string;
|
|
2980
|
+
/** OAuth 2.0 token for the current user. */
|
|
2981
|
+
oauth_token?: string;
|
|
2982
|
+
/** Returns response with indentations and line breaks. */
|
|
2983
|
+
prettyPrint?: boolean;
|
|
2984
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2985
|
+
quotaUser?: string;
|
|
2986
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2987
|
+
upload_protocol?: string;
|
|
2988
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2989
|
+
uploadType?: string;
|
|
2990
|
+
},
|
|
2991
|
+
body: GoogleCloudDocumentaiV1beta3DisableProcessorRequest): Request<GoogleLongrunningOperation>;
|
|
2992
|
+
/** Enables a processor */
|
|
2993
|
+
enable(request: {
|
|
2994
|
+
/** V1 error format. */
|
|
2995
|
+
"$.xgafv"?: string;
|
|
2996
|
+
/** OAuth access token. */
|
|
2997
|
+
access_token?: string;
|
|
2998
|
+
/** Data format for response. */
|
|
2999
|
+
alt?: string;
|
|
3000
|
+
/** JSONP */
|
|
3001
|
+
callback?: string;
|
|
3002
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3003
|
+
fields?: string;
|
|
3004
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3005
|
+
key?: string;
|
|
3006
|
+
/** Required. The processor resource name to be enabled. */
|
|
3007
|
+
name: string;
|
|
3008
|
+
/** OAuth 2.0 token for the current user. */
|
|
3009
|
+
oauth_token?: string;
|
|
3010
|
+
/** Returns response with indentations and line breaks. */
|
|
3011
|
+
prettyPrint?: boolean;
|
|
3012
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3013
|
+
quotaUser?: string;
|
|
3014
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3015
|
+
upload_protocol?: string;
|
|
3016
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3017
|
+
uploadType?: string;
|
|
3018
|
+
/** Request body */
|
|
3019
|
+
resource: GoogleCloudDocumentaiV1beta3EnableProcessorRequest;
|
|
3020
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3021
|
+
enable(request: {
|
|
3022
|
+
/** V1 error format. */
|
|
3023
|
+
"$.xgafv"?: string;
|
|
3024
|
+
/** OAuth access token. */
|
|
3025
|
+
access_token?: string;
|
|
3026
|
+
/** Data format for response. */
|
|
3027
|
+
alt?: string;
|
|
3028
|
+
/** JSONP */
|
|
3029
|
+
callback?: string;
|
|
3030
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3031
|
+
fields?: string;
|
|
3032
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3033
|
+
key?: string;
|
|
3034
|
+
/** Required. The processor resource name to be enabled. */
|
|
3035
|
+
name: string;
|
|
3036
|
+
/** OAuth 2.0 token for the current user. */
|
|
3037
|
+
oauth_token?: string;
|
|
3038
|
+
/** Returns response with indentations and line breaks. */
|
|
3039
|
+
prettyPrint?: boolean;
|
|
3040
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3041
|
+
quotaUser?: string;
|
|
3042
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3043
|
+
upload_protocol?: string;
|
|
3044
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3045
|
+
uploadType?: string;
|
|
3046
|
+
},
|
|
3047
|
+
body: GoogleCloudDocumentaiV1beta3EnableProcessorRequest): Request<GoogleLongrunningOperation>;
|
|
3048
|
+
/** Gets a processor detail. */
|
|
3049
|
+
get(request?: {
|
|
3050
|
+
/** V1 error format. */
|
|
3051
|
+
"$.xgafv"?: string;
|
|
3052
|
+
/** OAuth access token. */
|
|
3053
|
+
access_token?: string;
|
|
3054
|
+
/** Data format for response. */
|
|
3055
|
+
alt?: string;
|
|
3056
|
+
/** JSONP */
|
|
3057
|
+
callback?: string;
|
|
3058
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3059
|
+
fields?: string;
|
|
3060
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3061
|
+
key?: string;
|
|
3062
|
+
/** Required. The processor resource name. */
|
|
3063
|
+
name: string;
|
|
3064
|
+
/** OAuth 2.0 token for the current user. */
|
|
3065
|
+
oauth_token?: string;
|
|
3066
|
+
/** Returns response with indentations and line breaks. */
|
|
3067
|
+
prettyPrint?: boolean;
|
|
3068
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3069
|
+
quotaUser?: string;
|
|
3070
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3071
|
+
upload_protocol?: string;
|
|
3072
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3073
|
+
uploadType?: string;
|
|
3074
|
+
}): Request<GoogleCloudDocumentaiV1beta3Processor>;
|
|
3075
|
+
/** Lists all processors which belong to this project. */
|
|
3076
|
+
list(request?: {
|
|
3077
|
+
/** V1 error format. */
|
|
3078
|
+
"$.xgafv"?: string;
|
|
3079
|
+
/** OAuth access token. */
|
|
3080
|
+
access_token?: string;
|
|
3081
|
+
/** Data format for response. */
|
|
3082
|
+
alt?: string;
|
|
3083
|
+
/** JSONP */
|
|
3084
|
+
callback?: string;
|
|
3085
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3086
|
+
fields?: string;
|
|
3087
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3088
|
+
key?: string;
|
|
3089
|
+
/** OAuth 2.0 token for the current user. */
|
|
3090
|
+
oauth_token?: string;
|
|
3091
|
+
/** The maximum number of processors to return. If unspecified, at most 50 processors will be returned. The maximum value is 100; values above 100 will be coerced to 100. */
|
|
3092
|
+
pageSize?: number;
|
|
3093
|
+
/** We will return the processors sorted by creation time. The page token will point to the next processor. */
|
|
3094
|
+
pageToken?: string;
|
|
3095
|
+
/** Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project}/locations/{location}` */
|
|
3096
|
+
parent: string;
|
|
3097
|
+
/** Returns response with indentations and line breaks. */
|
|
3098
|
+
prettyPrint?: boolean;
|
|
3099
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3100
|
+
quotaUser?: string;
|
|
3101
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3102
|
+
upload_protocol?: string;
|
|
3103
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3104
|
+
uploadType?: string;
|
|
3105
|
+
}): Request<GoogleCloudDocumentaiV1beta3ListProcessorsResponse>;
|
|
3106
|
+
/** Processes a single document. */
|
|
3107
|
+
process(request: {
|
|
3108
|
+
/** V1 error format. */
|
|
3109
|
+
"$.xgafv"?: string;
|
|
3110
|
+
/** OAuth access token. */
|
|
3111
|
+
access_token?: string;
|
|
3112
|
+
/** Data format for response. */
|
|
3113
|
+
alt?: string;
|
|
3114
|
+
/** JSONP */
|
|
3115
|
+
callback?: string;
|
|
3116
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3117
|
+
fields?: string;
|
|
3118
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3119
|
+
key?: string;
|
|
3120
|
+
/**
|
|
3121
|
+
* Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format:
|
|
3122
|
+
* `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
|
3123
|
+
*/
|
|
3124
|
+
name: string;
|
|
3125
|
+
/** OAuth 2.0 token for the current user. */
|
|
3126
|
+
oauth_token?: string;
|
|
3127
|
+
/** Returns response with indentations and line breaks. */
|
|
3128
|
+
prettyPrint?: boolean;
|
|
3129
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3130
|
+
quotaUser?: string;
|
|
3131
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3132
|
+
upload_protocol?: string;
|
|
3133
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3134
|
+
uploadType?: string;
|
|
3135
|
+
/** Request body */
|
|
3136
|
+
resource: GoogleCloudDocumentaiV1beta3ProcessRequest;
|
|
3137
|
+
}): Request<GoogleCloudDocumentaiV1beta3ProcessResponse>;
|
|
3138
|
+
process(request: {
|
|
3139
|
+
/** V1 error format. */
|
|
3140
|
+
"$.xgafv"?: string;
|
|
3141
|
+
/** OAuth access token. */
|
|
3142
|
+
access_token?: string;
|
|
3143
|
+
/** Data format for response. */
|
|
3144
|
+
alt?: string;
|
|
3145
|
+
/** JSONP */
|
|
3146
|
+
callback?: string;
|
|
3147
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3148
|
+
fields?: string;
|
|
3149
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3150
|
+
key?: string;
|
|
3151
|
+
/**
|
|
3152
|
+
* Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format:
|
|
3153
|
+
* `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
|
|
3154
|
+
*/
|
|
3155
|
+
name: string;
|
|
3156
|
+
/** OAuth 2.0 token for the current user. */
|
|
3157
|
+
oauth_token?: string;
|
|
3158
|
+
/** Returns response with indentations and line breaks. */
|
|
3159
|
+
prettyPrint?: boolean;
|
|
3160
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3161
|
+
quotaUser?: string;
|
|
3162
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3163
|
+
upload_protocol?: string;
|
|
3164
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3165
|
+
uploadType?: string;
|
|
3166
|
+
},
|
|
3167
|
+
body: GoogleCloudDocumentaiV1beta3ProcessRequest): Request<GoogleCloudDocumentaiV1beta3ProcessResponse>;
|
|
3168
|
+
/** Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments. */
|
|
3169
|
+
setDefaultProcessorVersion(request: {
|
|
3170
|
+
/** V1 error format. */
|
|
3171
|
+
"$.xgafv"?: string;
|
|
3172
|
+
/** OAuth access token. */
|
|
3173
|
+
access_token?: string;
|
|
3174
|
+
/** Data format for response. */
|
|
3175
|
+
alt?: string;
|
|
3176
|
+
/** JSONP */
|
|
3177
|
+
callback?: string;
|
|
3178
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3179
|
+
fields?: string;
|
|
3180
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3181
|
+
key?: string;
|
|
3182
|
+
/** OAuth 2.0 token for the current user. */
|
|
3183
|
+
oauth_token?: string;
|
|
3184
|
+
/** Returns response with indentations and line breaks. */
|
|
3185
|
+
prettyPrint?: boolean;
|
|
3186
|
+
/** Required. The resource name of the Processor to change default version. */
|
|
3187
|
+
processor: string;
|
|
3188
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3189
|
+
quotaUser?: string;
|
|
3190
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3191
|
+
upload_protocol?: string;
|
|
3192
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3193
|
+
uploadType?: string;
|
|
3194
|
+
/** Request body */
|
|
3195
|
+
resource: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest;
|
|
3196
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3197
|
+
setDefaultProcessorVersion(request: {
|
|
3198
|
+
/** V1 error format. */
|
|
3199
|
+
"$.xgafv"?: string;
|
|
3200
|
+
/** OAuth access token. */
|
|
3201
|
+
access_token?: string;
|
|
3202
|
+
/** Data format for response. */
|
|
3203
|
+
alt?: string;
|
|
3204
|
+
/** JSONP */
|
|
3205
|
+
callback?: string;
|
|
3206
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3207
|
+
fields?: string;
|
|
3208
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3209
|
+
key?: string;
|
|
3210
|
+
/** OAuth 2.0 token for the current user. */
|
|
3211
|
+
oauth_token?: string;
|
|
3212
|
+
/** Returns response with indentations and line breaks. */
|
|
3213
|
+
prettyPrint?: boolean;
|
|
3214
|
+
/** Required. The resource name of the Processor to change default version. */
|
|
3215
|
+
processor: string;
|
|
3216
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3217
|
+
quotaUser?: string;
|
|
3218
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3219
|
+
upload_protocol?: string;
|
|
3220
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3221
|
+
uploadType?: string;
|
|
3222
|
+
},
|
|
3223
|
+
body: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest): Request<GoogleLongrunningOperation>;
|
|
3224
|
+
humanReviewConfig: HumanReviewConfigResource;
|
|
3225
|
+
processorVersions: ProcessorVersionsResource;
|
|
3226
|
+
}
|
|
3227
|
+
interface ProcessorTypesResource {
|
|
3228
|
+
/** Lists the processor types that exist. */
|
|
3229
|
+
list(request?: {
|
|
3230
|
+
/** V1 error format. */
|
|
3231
|
+
"$.xgafv"?: string;
|
|
3232
|
+
/** OAuth access token. */
|
|
3233
|
+
access_token?: string;
|
|
3234
|
+
/** Data format for response. */
|
|
3235
|
+
alt?: string;
|
|
3236
|
+
/** JSONP */
|
|
3237
|
+
callback?: string;
|
|
3238
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3239
|
+
fields?: string;
|
|
3240
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3241
|
+
key?: string;
|
|
3242
|
+
/** OAuth 2.0 token for the current user. */
|
|
3243
|
+
oauth_token?: string;
|
|
3244
|
+
/** The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500; values above 500 will be coerced to 500. */
|
|
3245
|
+
pageSize?: number;
|
|
3246
|
+
/** Used to retrieve the next page of results, empty if at the end of the list. */
|
|
3247
|
+
pageToken?: string;
|
|
3248
|
+
/** Required. The location of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}` */
|
|
3249
|
+
parent: string;
|
|
3250
|
+
/** Returns response with indentations and line breaks. */
|
|
3251
|
+
prettyPrint?: boolean;
|
|
3252
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3253
|
+
quotaUser?: string;
|
|
3254
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3255
|
+
upload_protocol?: string;
|
|
3256
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3257
|
+
uploadType?: string;
|
|
3258
|
+
}): Request<GoogleCloudDocumentaiV1beta3ListProcessorTypesResponse>;
|
|
3259
|
+
}
|
|
3260
|
+
interface LocationsResource {
|
|
3261
|
+
/** Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated. */
|
|
3262
|
+
fetchProcessorTypes(request?: {
|
|
3263
|
+
/** V1 error format. */
|
|
3264
|
+
"$.xgafv"?: string;
|
|
3265
|
+
/** OAuth access token. */
|
|
3266
|
+
access_token?: string;
|
|
3267
|
+
/** Data format for response. */
|
|
3268
|
+
alt?: string;
|
|
3269
|
+
/** JSONP */
|
|
3270
|
+
callback?: string;
|
|
3271
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3272
|
+
fields?: string;
|
|
3273
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3274
|
+
key?: string;
|
|
3275
|
+
/** OAuth 2.0 token for the current user. */
|
|
3276
|
+
oauth_token?: string;
|
|
3277
|
+
/** Required. The project of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}` */
|
|
3278
|
+
parent: string;
|
|
3279
|
+
/** Returns response with indentations and line breaks. */
|
|
3280
|
+
prettyPrint?: boolean;
|
|
3281
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3282
|
+
quotaUser?: string;
|
|
3283
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3284
|
+
upload_protocol?: string;
|
|
3285
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3286
|
+
uploadType?: string;
|
|
3287
|
+
}): Request<GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse>;
|
|
3288
|
+
/** Gets information about a location. */
|
|
3289
|
+
get(request?: {
|
|
3290
|
+
/** V1 error format. */
|
|
3291
|
+
"$.xgafv"?: string;
|
|
3292
|
+
/** OAuth access token. */
|
|
3293
|
+
access_token?: string;
|
|
3294
|
+
/** Data format for response. */
|
|
3295
|
+
alt?: string;
|
|
3296
|
+
/** JSONP */
|
|
3297
|
+
callback?: string;
|
|
3298
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3299
|
+
fields?: string;
|
|
3300
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3301
|
+
key?: string;
|
|
3302
|
+
/** Resource name for the location. */
|
|
3303
|
+
name: string;
|
|
3304
|
+
/** OAuth 2.0 token for the current user. */
|
|
3305
|
+
oauth_token?: string;
|
|
3306
|
+
/** Returns response with indentations and line breaks. */
|
|
3307
|
+
prettyPrint?: boolean;
|
|
3308
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3309
|
+
quotaUser?: string;
|
|
3310
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3311
|
+
upload_protocol?: string;
|
|
3312
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3313
|
+
uploadType?: string;
|
|
3314
|
+
}): Request<GoogleCloudLocationLocation>;
|
|
3315
|
+
/** Lists information about the supported locations for this service. */
|
|
3316
|
+
list(request?: {
|
|
3317
|
+
/** V1 error format. */
|
|
3318
|
+
"$.xgafv"?: string;
|
|
3319
|
+
/** OAuth access token. */
|
|
3320
|
+
access_token?: string;
|
|
3321
|
+
/** Data format for response. */
|
|
3322
|
+
alt?: string;
|
|
3323
|
+
/** JSONP */
|
|
3324
|
+
callback?: string;
|
|
3325
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3326
|
+
fields?: string;
|
|
3327
|
+
/**
|
|
3328
|
+
* A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in
|
|
3329
|
+
* [AIP-160](https://google.aip.dev/160).
|
|
3330
|
+
*/
|
|
3331
|
+
filter?: string;
|
|
3332
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3333
|
+
key?: string;
|
|
3334
|
+
/** The resource that owns the locations collection, if applicable. */
|
|
3335
|
+
name: string;
|
|
3336
|
+
/** OAuth 2.0 token for the current user. */
|
|
3337
|
+
oauth_token?: string;
|
|
3338
|
+
/** The maximum number of results to return. If not set, the service selects a default. */
|
|
3339
|
+
pageSize?: number;
|
|
3340
|
+
/** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
|
|
3341
|
+
pageToken?: string;
|
|
3342
|
+
/** Returns response with indentations and line breaks. */
|
|
3343
|
+
prettyPrint?: boolean;
|
|
3344
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3345
|
+
quotaUser?: string;
|
|
3346
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3347
|
+
upload_protocol?: string;
|
|
3348
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3349
|
+
uploadType?: string;
|
|
3350
|
+
}): Request<GoogleCloudLocationListLocationsResponse>;
|
|
3351
|
+
operations: OperationsResource;
|
|
3352
|
+
processors: ProcessorsResource;
|
|
3353
|
+
processorTypes: ProcessorTypesResource;
|
|
3354
|
+
}
|
|
3355
|
+
interface ProjectsResource {
|
|
3356
|
+
locations: LocationsResource;
|
|
3357
|
+
}
|
|
3358
|
+
|
|
3359
|
+
const projects: ProjectsResource;
|
|
3360
|
+
}
|
|
3361
|
+
}
|