@maxim_mazurok/gapi.client.documentai-v1 0.1.20250922 → 0.1.20251020
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 +1113 -12
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://documentai.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20251020
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -28,17 +28,38 @@ declare namespace gapi.client {
|
|
|
28
28
|
validationRules?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule[];
|
|
29
29
|
}
|
|
30
30
|
interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule {
|
|
31
|
+
childAlignmentRule?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule;
|
|
31
32
|
/** Description of the validation rule. This has no use but for documentation */
|
|
32
33
|
description?: string;
|
|
34
|
+
entityAlignmentRule?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule;
|
|
33
35
|
fieldOccurrences?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences;
|
|
34
36
|
fieldRegex?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex;
|
|
35
37
|
formValidation?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation;
|
|
36
38
|
/** Name of the validation rule. */
|
|
37
39
|
name?: string;
|
|
38
40
|
}
|
|
41
|
+
interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule {
|
|
42
|
+
alignmentType?: string;
|
|
43
|
+
/** The tolerance to use when comparing coordinates. */
|
|
44
|
+
tolerance?: number;
|
|
45
|
+
}
|
|
46
|
+
interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule {
|
|
47
|
+
/** The alignment rule to apply to the child fields. */
|
|
48
|
+
alignmentRule?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule;
|
|
49
|
+
/** The child fields to be aligned within the parent field. */
|
|
50
|
+
childFields?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField[];
|
|
51
|
+
/** The full path of the parent field. */
|
|
52
|
+
parentField?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField;
|
|
53
|
+
}
|
|
39
54
|
interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant {
|
|
40
55
|
floatValue?: number;
|
|
41
56
|
}
|
|
57
|
+
interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule {
|
|
58
|
+
/** The alignment rule to apply to the fields. */
|
|
59
|
+
alignmentRule?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule;
|
|
60
|
+
/** The fields to be aligned. */
|
|
61
|
+
fields?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField[];
|
|
62
|
+
}
|
|
42
63
|
interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField {
|
|
43
64
|
/** Default value to use if the field is not present. If the field is missing and the default value is not set, the validation run as if the field is not present in the validation logic. */
|
|
44
65
|
defaultValue?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant;
|
|
@@ -190,11 +211,81 @@ declare namespace gapi.client {
|
|
|
190
211
|
/** Required. The id of the document. */
|
|
191
212
|
docId?: string;
|
|
192
213
|
}
|
|
214
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentSchema {
|
|
215
|
+
/** Description of the schema. */
|
|
216
|
+
description?: string;
|
|
217
|
+
/** Display name to show to users. */
|
|
218
|
+
displayName?: string;
|
|
219
|
+
/** Entity types of the schema. */
|
|
220
|
+
entityTypes?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType[];
|
|
221
|
+
/** Metadata of the schema. */
|
|
222
|
+
metadata?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata;
|
|
223
|
+
}
|
|
224
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType {
|
|
225
|
+
/** The entity type that this type is derived from. For now, one and only one should be set. */
|
|
226
|
+
baseTypes?: string[];
|
|
227
|
+
/** The description of the entity type. Could be used to provide more information about the entity type for model calls. */
|
|
228
|
+
description?: string;
|
|
229
|
+
/** User defined name for the type. */
|
|
230
|
+
displayName?: string;
|
|
231
|
+
/** Metadata for the entity type. */
|
|
232
|
+
entityTypeMetadata?: GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata;
|
|
233
|
+
/** 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 `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. */
|
|
234
|
+
enumValues?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues;
|
|
235
|
+
/** Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and 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 honored for backward compatibility. */
|
|
236
|
+
name?: string;
|
|
237
|
+
/** Description the nested structure, or composition of an entity. */
|
|
238
|
+
properties?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty[];
|
|
239
|
+
}
|
|
240
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues {
|
|
241
|
+
/** The individual values that this enum values type can include. */
|
|
242
|
+
values?: string[];
|
|
243
|
+
}
|
|
244
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty {
|
|
245
|
+
/** The description of the property. Could be used to provide more information about the property for model calls. */
|
|
246
|
+
description?: string;
|
|
247
|
+
/** User defined name for the property. */
|
|
248
|
+
displayName?: string;
|
|
249
|
+
/** Specifies how the entity's value is obtained. */
|
|
250
|
+
method?: string;
|
|
251
|
+
/** The name of the property. Follows the same guidelines as the EntityType name. */
|
|
252
|
+
name?: string;
|
|
253
|
+
/** Occurrence type limits the number of instances an entity type appears in the document. */
|
|
254
|
+
occurrenceType?: string;
|
|
255
|
+
/** Any additional metadata about the property can be added here. */
|
|
256
|
+
propertyMetadata?: GoogleCloudDocumentaiUiv1beta3PropertyMetadata;
|
|
257
|
+
/** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
|
|
258
|
+
valueType?: string;
|
|
259
|
+
}
|
|
260
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata {
|
|
261
|
+
/** If true, on a given page, there can be multiple `document` annotations covering it. */
|
|
262
|
+
documentAllowMultipleLabels?: boolean;
|
|
263
|
+
/** If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */
|
|
264
|
+
documentSplitter?: boolean;
|
|
265
|
+
/** If set, all the nested entities must be prefixed with the parents. */
|
|
266
|
+
prefixedNamingOnProperties?: boolean;
|
|
267
|
+
/** 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 checked. */
|
|
268
|
+
skipNamingValidation?: boolean;
|
|
269
|
+
}
|
|
193
270
|
interface GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata {
|
|
194
271
|
/** The basic metadata of the long-running operation. */
|
|
195
272
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
196
273
|
}
|
|
197
274
|
interface GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse {}
|
|
275
|
+
interface GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata {
|
|
276
|
+
/** Field tier metadata on the property */
|
|
277
|
+
fieldTierMetadata?: GoogleCloudDocumentaiUiv1beta3FieldTierMetadata;
|
|
278
|
+
/** Human review labeling config on the entity. */
|
|
279
|
+
humanReviewLabelingMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata;
|
|
280
|
+
/** Human review config on the entity. */
|
|
281
|
+
humanReviewMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata;
|
|
282
|
+
/** Whether the entity type should be considered inactive. */
|
|
283
|
+
inactive?: boolean;
|
|
284
|
+
/** Schema editability metadata on the entity. */
|
|
285
|
+
schemaEditabilityMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata;
|
|
286
|
+
/** Schema inference metadata on the entity. */
|
|
287
|
+
schemaInferenceMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata;
|
|
288
|
+
}
|
|
198
289
|
interface GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata {
|
|
199
290
|
/** The basic metadata of the long-running operation. */
|
|
200
291
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
@@ -203,6 +294,40 @@ declare namespace gapi.client {
|
|
|
203
294
|
/** The resource name of the created evaluation. */
|
|
204
295
|
evaluation?: string;
|
|
205
296
|
}
|
|
297
|
+
interface GoogleCloudDocumentaiUiv1beta3EvaluationMetrics {
|
|
298
|
+
/** The calculated f1 score. */
|
|
299
|
+
f1Score?: number;
|
|
300
|
+
/** The amount of false negatives. */
|
|
301
|
+
falseNegativesCount?: number;
|
|
302
|
+
/** The amount of false positives. */
|
|
303
|
+
falsePositivesCount?: number;
|
|
304
|
+
/** The amount of documents with a ground truth occurrence. */
|
|
305
|
+
groundTruthDocumentCount?: number;
|
|
306
|
+
/** The amount of occurrences in ground truth documents. */
|
|
307
|
+
groundTruthOccurrencesCount?: number;
|
|
308
|
+
/** The calculated precision. */
|
|
309
|
+
precision?: number;
|
|
310
|
+
/** The amount of documents with a predicted occurrence. */
|
|
311
|
+
predictedDocumentCount?: number;
|
|
312
|
+
/** The amount of occurrences in predicted documents. */
|
|
313
|
+
predictedOccurrencesCount?: number;
|
|
314
|
+
/** The calculated recall. */
|
|
315
|
+
recall?: number;
|
|
316
|
+
/** The amount of documents that had an occurrence of this label. */
|
|
317
|
+
totalDocumentsCount?: number;
|
|
318
|
+
/** The amount of true positives. */
|
|
319
|
+
truePositivesCount?: number;
|
|
320
|
+
}
|
|
321
|
+
interface GoogleCloudDocumentaiUiv1beta3EvaluationReference {
|
|
322
|
+
/** An aggregate of the statistics for the evaluation with fuzzy matching on. */
|
|
323
|
+
aggregateMetrics?: GoogleCloudDocumentaiUiv1beta3EvaluationMetrics;
|
|
324
|
+
/** An aggregate of the statistics for the evaluation with fuzzy matching off. */
|
|
325
|
+
aggregateMetricsExact?: GoogleCloudDocumentaiUiv1beta3EvaluationMetrics;
|
|
326
|
+
/** The resource name of the evaluation. */
|
|
327
|
+
evaluation?: string;
|
|
328
|
+
/** The resource name of the Long Running Operation for the evaluation. */
|
|
329
|
+
operation?: string;
|
|
330
|
+
}
|
|
206
331
|
interface GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata {
|
|
207
332
|
/** The basic metadata of the long-running operation. */
|
|
208
333
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
@@ -234,6 +359,30 @@ declare namespace gapi.client {
|
|
|
234
359
|
/** The Cloud Storage URI containing the output artifacts. */
|
|
235
360
|
gcsUri?: string;
|
|
236
361
|
}
|
|
362
|
+
interface GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata {
|
|
363
|
+
/** Entity query config. */
|
|
364
|
+
entityQuery?: GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery;
|
|
365
|
+
/** Summary options config. */
|
|
366
|
+
summaryOptions?: GoogleCloudDocumentaiUiv1beta3SummaryOptions;
|
|
367
|
+
}
|
|
368
|
+
interface GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery {
|
|
369
|
+
/** The original entity query inputed by the user. */
|
|
370
|
+
userEntityQuery?: string;
|
|
371
|
+
}
|
|
372
|
+
interface GoogleCloudDocumentaiUiv1beta3FieldTierMetadata {
|
|
373
|
+
/** Integer that indicates the tier of a property. e.g. Invoice has entities that are classified as tier 1 which is the most important, while tier 2 and tier 3 less so. This attribute can be used to filter schema attributes before running eval. e.g. compute F1 score for only tier 1 entities. If not present this attribute should be inferred as 1. */
|
|
374
|
+
tierLevel?: number;
|
|
375
|
+
}
|
|
376
|
+
interface GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata {
|
|
377
|
+
/** Whether to enable normalization editing. */
|
|
378
|
+
enableNormalizationEditing?: boolean;
|
|
379
|
+
}
|
|
380
|
+
interface GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata {
|
|
381
|
+
/** The confidence threshold if human review validation is enabled. */
|
|
382
|
+
confidenceThreshold?: number;
|
|
383
|
+
/** Whether to enable human review validation. */
|
|
384
|
+
enableValidation?: boolean;
|
|
385
|
+
}
|
|
237
386
|
interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata {
|
|
238
387
|
/** The basic metadata of the long-running operation. */
|
|
239
388
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
@@ -269,6 +418,112 @@ declare namespace gapi.client {
|
|
|
269
418
|
/** The destination processor version name. */
|
|
270
419
|
processorVersion?: string;
|
|
271
420
|
}
|
|
421
|
+
interface GoogleCloudDocumentaiUiv1beta3Processor {
|
|
422
|
+
/** Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} */
|
|
423
|
+
activeSchemaVersion?: string;
|
|
424
|
+
/** Output only. The time the processor was created. */
|
|
425
|
+
createTime?: string;
|
|
426
|
+
/** The default processor version. */
|
|
427
|
+
defaultProcessorVersion?: string;
|
|
428
|
+
/** The display name of the processor. */
|
|
429
|
+
displayName?: string;
|
|
430
|
+
/** The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */
|
|
431
|
+
kmsKeyName?: string;
|
|
432
|
+
/** Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` */
|
|
433
|
+
name?: string;
|
|
434
|
+
/** Output only. Immutable. The http endpoint that can be called to invoke processing. */
|
|
435
|
+
processEndpoint?: string;
|
|
436
|
+
/** Output only. The processor version aliases. */
|
|
437
|
+
processorVersionAliases?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias[];
|
|
438
|
+
/** Output only. Reserved for future use. */
|
|
439
|
+
satisfiesPzi?: boolean;
|
|
440
|
+
/** Output only. Reserved for future use. */
|
|
441
|
+
satisfiesPzs?: boolean;
|
|
442
|
+
/** Output only. The state of the processor. */
|
|
443
|
+
state?: string;
|
|
444
|
+
/** The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */
|
|
445
|
+
type?: string;
|
|
446
|
+
}
|
|
447
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersion {
|
|
448
|
+
/** Output only. The time the processor version was created. */
|
|
449
|
+
createTime?: string;
|
|
450
|
+
/** Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed. */
|
|
451
|
+
deploymentAllowed?: boolean;
|
|
452
|
+
/** Output only. If set, information about the eventual deprecation of this version. */
|
|
453
|
+
deprecationInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo;
|
|
454
|
+
/** The display name of the processor version. */
|
|
455
|
+
displayName?: string;
|
|
456
|
+
/** Output only. The schema of the processor version. Describes the output. */
|
|
457
|
+
documentSchema?: GoogleCloudDocumentaiUiv1beta3DocumentSchema;
|
|
458
|
+
/** Output only. Information about Generative AI model-based processor versions. */
|
|
459
|
+
genAiModelInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo;
|
|
460
|
+
/** Output only. Denotes that this `ProcessorVersion` is managed by Google. */
|
|
461
|
+
googleManaged?: boolean;
|
|
462
|
+
/** Output only. The KMS key name used for encryption. */
|
|
463
|
+
kmsKeyName?: string;
|
|
464
|
+
/** Output only. The KMS key version with which data is encrypted. */
|
|
465
|
+
kmsKeyVersionName?: string;
|
|
466
|
+
/** Output only. The most recently invoked evaluation for the processor version. */
|
|
467
|
+
latestEvaluation?: GoogleCloudDocumentaiUiv1beta3EvaluationReference;
|
|
468
|
+
/** Output only. The model type of this processor version. */
|
|
469
|
+
modelType?: string;
|
|
470
|
+
/** Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` */
|
|
471
|
+
name?: string;
|
|
472
|
+
/** Output only. Reserved for future use. */
|
|
473
|
+
satisfiesPzi?: boolean;
|
|
474
|
+
/** Output only. Reserved for future use. */
|
|
475
|
+
satisfiesPzs?: boolean;
|
|
476
|
+
/** The schema of the processor version. Describes the output. */
|
|
477
|
+
schema?: GoogleCloudDocumentaiUiv1beta3Schema;
|
|
478
|
+
/** Output only. The state of the processor version. */
|
|
479
|
+
state?: string;
|
|
480
|
+
}
|
|
481
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias {
|
|
482
|
+
/** The alias in the form of `processor_version` resource name. */
|
|
483
|
+
alias?: string;
|
|
484
|
+
/** The resource name of aliased processor version. */
|
|
485
|
+
processorVersion?: string;
|
|
486
|
+
}
|
|
487
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo {
|
|
488
|
+
/** The time at which this processor version will be deprecated. */
|
|
489
|
+
deprecationTime?: string;
|
|
490
|
+
/** If set, the processor version that will be used as a replacement. */
|
|
491
|
+
replacementProcessorVersion?: string;
|
|
492
|
+
}
|
|
493
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo {
|
|
494
|
+
/** Information for a custom Generative AI model created by the user. */
|
|
495
|
+
customGenAiModelInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo;
|
|
496
|
+
/** Information for a pretrained Google-managed foundation model. */
|
|
497
|
+
foundationGenAiModelInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo;
|
|
498
|
+
}
|
|
499
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo {
|
|
500
|
+
/** The base processor version ID for the custom model. */
|
|
501
|
+
baseProcessorVersionId?: string;
|
|
502
|
+
/** The type of custom model created by the user. */
|
|
503
|
+
customModelType?: string;
|
|
504
|
+
}
|
|
505
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
506
|
+
/** Whether finetuning is allowed for this base processor version. */
|
|
507
|
+
finetuningAllowed?: boolean;
|
|
508
|
+
/** The minimum number of labeled documents in the training dataset required for finetuning. */
|
|
509
|
+
minTrainLabeledDocuments?: number;
|
|
510
|
+
}
|
|
511
|
+
interface GoogleCloudDocumentaiUiv1beta3PropertyMetadata {
|
|
512
|
+
/** Field extraction metadata on the property. */
|
|
513
|
+
fieldExtractionMetadata?: GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata;
|
|
514
|
+
/** Field tier metadata on the property */
|
|
515
|
+
fieldTierMetadata?: GoogleCloudDocumentaiUiv1beta3FieldTierMetadata;
|
|
516
|
+
/** Human review labeling config on the property. */
|
|
517
|
+
humanReviewLabelingMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata;
|
|
518
|
+
/** Human review validation config on the property. */
|
|
519
|
+
humanReviewMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata;
|
|
520
|
+
/** Whether the property should be considered as "inactive". */
|
|
521
|
+
inactive?: boolean;
|
|
522
|
+
/** Schema editability metadata on the property. */
|
|
523
|
+
schemaEditabilityMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata;
|
|
524
|
+
/** Schema inference metadata on the property. */
|
|
525
|
+
schemaInferenceMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata;
|
|
526
|
+
}
|
|
272
527
|
interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata {
|
|
273
528
|
/** The basic metadata of the long-running operation. */
|
|
274
529
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
@@ -316,11 +571,54 @@ declare namespace gapi.client {
|
|
|
316
571
|
/** An internal identifier for document. */
|
|
317
572
|
documentId?: string;
|
|
318
573
|
}
|
|
574
|
+
interface GoogleCloudDocumentaiUiv1beta3Schema {
|
|
575
|
+
/** Description of the schema. */
|
|
576
|
+
description?: string;
|
|
577
|
+
/** Display name to show to users. */
|
|
578
|
+
displayName?: string;
|
|
579
|
+
/** Entity types of the schema. */
|
|
580
|
+
entityTypes?: GoogleCloudDocumentaiUiv1beta3SchemaEntityType[];
|
|
581
|
+
}
|
|
582
|
+
interface GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata {
|
|
583
|
+
/** Explicit flag that controls whether the label is editable. */
|
|
584
|
+
editable?: boolean;
|
|
585
|
+
/** Full resource name of processor versions that contain this label. e.g. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
|
|
586
|
+
processorVersions?: string[];
|
|
587
|
+
}
|
|
588
|
+
interface GoogleCloudDocumentaiUiv1beta3SchemaEntityType {
|
|
589
|
+
baseType?: string;
|
|
590
|
+
/** Description of the entity type. */
|
|
591
|
+
description?: string;
|
|
592
|
+
/** If specified, lists all the possible values for this entity. */
|
|
593
|
+
enumValues?: string[];
|
|
594
|
+
/** If the entity type is hidden in the schema. This provides the functionality to temporally "disable" an entity without deleting it. */
|
|
595
|
+
hide?: boolean;
|
|
596
|
+
/** Specifies how the entity's value is obtained. */
|
|
597
|
+
method?: string;
|
|
598
|
+
/** Occurrence type limits the number of times an entity type appears in the document. */
|
|
599
|
+
occurrenceType?: string;
|
|
600
|
+
/** Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType `ID`, which consists of EntityType `name` and `address`, with corresponding attributes, such as TEXT for both types and ONCE for occurrence types. */
|
|
601
|
+
properties?: GoogleCloudDocumentaiUiv1beta3SchemaEntityType[];
|
|
602
|
+
/** Source of this entity type. */
|
|
603
|
+
source?: string;
|
|
604
|
+
/** Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: "google", "DocumentAI" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., "line_item/amount") in which case each part (e.g., "line_item", "amount") must comply with the rules defined above. We recommend using the snake case ("snake_case") in entity type names. */
|
|
605
|
+
type?: string;
|
|
606
|
+
}
|
|
607
|
+
interface GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata {
|
|
608
|
+
/** True if is inferred by schema inference. */
|
|
609
|
+
inferred?: boolean;
|
|
610
|
+
}
|
|
319
611
|
interface GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata {
|
|
320
612
|
/** The basic metadata of the long-running operation. */
|
|
321
613
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
322
614
|
}
|
|
323
615
|
interface GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse {}
|
|
616
|
+
interface GoogleCloudDocumentaiUiv1beta3SummaryOptions {
|
|
617
|
+
/** The format the summary should be in. */
|
|
618
|
+
format?: string;
|
|
619
|
+
/** How long the summary should be. */
|
|
620
|
+
length?: string;
|
|
621
|
+
}
|
|
324
622
|
interface GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata {
|
|
325
623
|
/** The basic metadata of the long-running operation. */
|
|
326
624
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
@@ -360,6 +658,10 @@ declare namespace gapi.client {
|
|
|
360
658
|
/** The basic metadata of the long-running operation. */
|
|
361
659
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
362
660
|
}
|
|
661
|
+
interface GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata {
|
|
662
|
+
/** The basic metadata for the long-running operation. */
|
|
663
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
664
|
+
}
|
|
363
665
|
interface GoogleCloudDocumentaiV1Barcode {
|
|
364
666
|
/** 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`: 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 DataBar code type. */
|
|
365
667
|
format?: string;
|
|
@@ -529,11 +831,71 @@ declare namespace gapi.client {
|
|
|
529
831
|
/** Required. The id of the document. */
|
|
530
832
|
docId?: string;
|
|
531
833
|
}
|
|
834
|
+
interface GoogleCloudDocumentaiV1beta3DocumentSchema {
|
|
835
|
+
/** Description of the schema. */
|
|
836
|
+
description?: string;
|
|
837
|
+
/** Display name to show to users. */
|
|
838
|
+
displayName?: string;
|
|
839
|
+
/** Entity types of the schema. */
|
|
840
|
+
entityTypes?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType[];
|
|
841
|
+
/** Metadata of the schema. */
|
|
842
|
+
metadata?: GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata;
|
|
843
|
+
}
|
|
844
|
+
interface GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType {
|
|
845
|
+
/** The entity type that this type is derived from. For now, one and only one should be set. */
|
|
846
|
+
baseTypes?: string[];
|
|
847
|
+
/** The description of the entity type. Could be used to provide more information about the entity type for model calls. */
|
|
848
|
+
description?: string;
|
|
849
|
+
/** User defined name for the type. */
|
|
850
|
+
displayName?: string;
|
|
851
|
+
/** Metadata for the entity type. */
|
|
852
|
+
entityTypeMetadata?: GoogleCloudDocumentaiV1beta3EntityTypeMetadata;
|
|
853
|
+
/** 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 `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. */
|
|
854
|
+
enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
|
|
855
|
+
/** Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and 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 honored for backward compatibility. */
|
|
856
|
+
name?: string;
|
|
857
|
+
/** Description the nested structure, or composition of an entity. */
|
|
858
|
+
properties?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty[];
|
|
859
|
+
}
|
|
860
|
+
interface GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues {
|
|
861
|
+
/** The individual values that this enum values type can include. */
|
|
862
|
+
values?: string[];
|
|
863
|
+
}
|
|
864
|
+
interface GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty {
|
|
865
|
+
/** The description of the property. Could be used to provide more information about the property for model calls. */
|
|
866
|
+
description?: string;
|
|
867
|
+
/** User defined name for the property. */
|
|
868
|
+
displayName?: string;
|
|
869
|
+
/** Specifies how the entity's value is obtained. */
|
|
870
|
+
method?: string;
|
|
871
|
+
/** The name of the property. Follows the same guidelines as the EntityType name. */
|
|
872
|
+
name?: string;
|
|
873
|
+
/** Occurrence type limits the number of instances an entity type appears in the document. */
|
|
874
|
+
occurrenceType?: string;
|
|
875
|
+
/** Any additional metadata about the property can be added here. */
|
|
876
|
+
propertyMetadata?: GoogleCloudDocumentaiV1beta3PropertyMetadata;
|
|
877
|
+
/** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
|
|
878
|
+
valueType?: string;
|
|
879
|
+
}
|
|
880
|
+
interface GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata {
|
|
881
|
+
/** If true, on a given page, there can be multiple `document` annotations covering it. */
|
|
882
|
+
documentAllowMultipleLabels?: boolean;
|
|
883
|
+
/** If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */
|
|
884
|
+
documentSplitter?: boolean;
|
|
885
|
+
/** If set, all the nested entities must be prefixed with the parents. */
|
|
886
|
+
prefixedNamingOnProperties?: boolean;
|
|
887
|
+
/** 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 checked. */
|
|
888
|
+
skipNamingValidation?: boolean;
|
|
889
|
+
}
|
|
532
890
|
interface GoogleCloudDocumentaiV1beta3EnableProcessorMetadata {
|
|
533
891
|
/** The basic metadata of the long-running operation. */
|
|
534
892
|
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
535
893
|
}
|
|
536
894
|
interface GoogleCloudDocumentaiV1beta3EnableProcessorResponse {}
|
|
895
|
+
interface GoogleCloudDocumentaiV1beta3EntityTypeMetadata {
|
|
896
|
+
/** Whether the entity type should be considered inactive. */
|
|
897
|
+
inactive?: boolean;
|
|
898
|
+
}
|
|
537
899
|
interface GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata {
|
|
538
900
|
/** The basic metadata of the long-running operation. */
|
|
539
901
|
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
@@ -542,6 +904,44 @@ declare namespace gapi.client {
|
|
|
542
904
|
/** The resource name of the created evaluation. */
|
|
543
905
|
evaluation?: string;
|
|
544
906
|
}
|
|
907
|
+
interface GoogleCloudDocumentaiV1beta3EvaluationMetrics {
|
|
908
|
+
/** The calculated f1 score. */
|
|
909
|
+
f1Score?: number;
|
|
910
|
+
/** The amount of false negatives. */
|
|
911
|
+
falseNegativesCount?: number;
|
|
912
|
+
/** The amount of false positives. */
|
|
913
|
+
falsePositivesCount?: number;
|
|
914
|
+
/** The amount of documents with a ground truth occurrence. */
|
|
915
|
+
groundTruthDocumentCount?: number;
|
|
916
|
+
/** The amount of occurrences in ground truth documents. */
|
|
917
|
+
groundTruthOccurrencesCount?: number;
|
|
918
|
+
/** The calculated precision. */
|
|
919
|
+
precision?: number;
|
|
920
|
+
/** The amount of documents with a predicted occurrence. */
|
|
921
|
+
predictedDocumentCount?: number;
|
|
922
|
+
/** The amount of occurrences in predicted documents. */
|
|
923
|
+
predictedOccurrencesCount?: number;
|
|
924
|
+
/** The calculated recall. */
|
|
925
|
+
recall?: number;
|
|
926
|
+
/** The amount of documents that had an occurrence of this label. */
|
|
927
|
+
totalDocumentsCount?: number;
|
|
928
|
+
/** The amount of true positives. */
|
|
929
|
+
truePositivesCount?: number;
|
|
930
|
+
}
|
|
931
|
+
interface GoogleCloudDocumentaiV1beta3EvaluationReference {
|
|
932
|
+
/** An aggregate of the statistics for the evaluation with fuzzy matching on. */
|
|
933
|
+
aggregateMetrics?: GoogleCloudDocumentaiV1beta3EvaluationMetrics;
|
|
934
|
+
/** An aggregate of the statistics for the evaluation with fuzzy matching off. */
|
|
935
|
+
aggregateMetricsExact?: GoogleCloudDocumentaiV1beta3EvaluationMetrics;
|
|
936
|
+
/** The resource name of the evaluation. */
|
|
937
|
+
evaluation?: string;
|
|
938
|
+
/** The resource name of the Long Running Operation for the evaluation. */
|
|
939
|
+
operation?: string;
|
|
940
|
+
}
|
|
941
|
+
interface GoogleCloudDocumentaiV1beta3FieldExtractionMetadata {
|
|
942
|
+
/** Summary options config. */
|
|
943
|
+
summaryOptions?: GoogleCloudDocumentaiV1beta3SummaryOptions;
|
|
944
|
+
}
|
|
545
945
|
interface GoogleCloudDocumentaiV1beta3GcsPrefix {
|
|
546
946
|
/** The URI prefix. */
|
|
547
947
|
gcsUriPrefix?: string;
|
|
@@ -587,18 +987,110 @@ declare namespace gapi.client {
|
|
|
587
987
|
/** The destination processor version name. */
|
|
588
988
|
processorVersion?: string;
|
|
589
989
|
}
|
|
590
|
-
interface
|
|
591
|
-
/**
|
|
592
|
-
|
|
593
|
-
/** The
|
|
990
|
+
interface GoogleCloudDocumentaiV1beta3Processor {
|
|
991
|
+
/** Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} */
|
|
992
|
+
activeSchemaVersion?: string;
|
|
993
|
+
/** Output only. The time the processor was created. */
|
|
594
994
|
createTime?: string;
|
|
595
|
-
/** The
|
|
596
|
-
|
|
597
|
-
/**
|
|
598
|
-
|
|
599
|
-
/**
|
|
600
|
-
|
|
601
|
-
/** The
|
|
995
|
+
/** The default processor version. */
|
|
996
|
+
defaultProcessorVersion?: string;
|
|
997
|
+
/** The display name of the processor. */
|
|
998
|
+
displayName?: string;
|
|
999
|
+
/** The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */
|
|
1000
|
+
kmsKeyName?: string;
|
|
1001
|
+
/** Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` */
|
|
1002
|
+
name?: string;
|
|
1003
|
+
/** Output only. Immutable. The http endpoint that can be called to invoke processing. */
|
|
1004
|
+
processEndpoint?: string;
|
|
1005
|
+
/** Output only. The processor version aliases. */
|
|
1006
|
+
processorVersionAliases?: GoogleCloudDocumentaiV1beta3ProcessorVersionAlias[];
|
|
1007
|
+
/** Output only. Reserved for future use. */
|
|
1008
|
+
satisfiesPzi?: boolean;
|
|
1009
|
+
/** Output only. Reserved for future use. */
|
|
1010
|
+
satisfiesPzs?: boolean;
|
|
1011
|
+
/** Output only. The state of the processor. */
|
|
1012
|
+
state?: string;
|
|
1013
|
+
/** The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */
|
|
1014
|
+
type?: string;
|
|
1015
|
+
}
|
|
1016
|
+
interface GoogleCloudDocumentaiV1beta3ProcessorVersion {
|
|
1017
|
+
/** Output only. The time the processor version was created. */
|
|
1018
|
+
createTime?: string;
|
|
1019
|
+
/** Output only. If set, information about the eventual deprecation of this version. */
|
|
1020
|
+
deprecationInfo?: GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo;
|
|
1021
|
+
/** The display name of the processor version. */
|
|
1022
|
+
displayName?: string;
|
|
1023
|
+
/** Output only. The schema of the processor version. Describes the output. */
|
|
1024
|
+
documentSchema?: GoogleCloudDocumentaiV1beta3DocumentSchema;
|
|
1025
|
+
/** Output only. Information about Generative AI model-based processor versions. */
|
|
1026
|
+
genAiModelInfo?: GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo;
|
|
1027
|
+
/** Output only. Denotes that this `ProcessorVersion` is managed by Google. */
|
|
1028
|
+
googleManaged?: boolean;
|
|
1029
|
+
/** Output only. The KMS key name used for encryption. */
|
|
1030
|
+
kmsKeyName?: string;
|
|
1031
|
+
/** Output only. The KMS key version with which data is encrypted. */
|
|
1032
|
+
kmsKeyVersionName?: string;
|
|
1033
|
+
/** Output only. The most recently invoked evaluation for the processor version. */
|
|
1034
|
+
latestEvaluation?: GoogleCloudDocumentaiV1beta3EvaluationReference;
|
|
1035
|
+
/** Output only. The model type of this processor version. */
|
|
1036
|
+
modelType?: string;
|
|
1037
|
+
/** Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` */
|
|
1038
|
+
name?: string;
|
|
1039
|
+
/** Output only. Reserved for future use. */
|
|
1040
|
+
satisfiesPzi?: boolean;
|
|
1041
|
+
/** Output only. Reserved for future use. */
|
|
1042
|
+
satisfiesPzs?: boolean;
|
|
1043
|
+
/** Output only. The state of the processor version. */
|
|
1044
|
+
state?: string;
|
|
1045
|
+
}
|
|
1046
|
+
interface GoogleCloudDocumentaiV1beta3ProcessorVersionAlias {
|
|
1047
|
+
/** The alias in the form of `processor_version` resource name. */
|
|
1048
|
+
alias?: string;
|
|
1049
|
+
/** The resource name of aliased processor version. */
|
|
1050
|
+
processorVersion?: string;
|
|
1051
|
+
}
|
|
1052
|
+
interface GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo {
|
|
1053
|
+
/** The time at which this processor version will be deprecated. */
|
|
1054
|
+
deprecationTime?: string;
|
|
1055
|
+
/** If set, the processor version that will be used as a replacement. */
|
|
1056
|
+
replacementProcessorVersion?: string;
|
|
1057
|
+
}
|
|
1058
|
+
interface GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo {
|
|
1059
|
+
/** Information for a custom Generative AI model created by the user. */
|
|
1060
|
+
customGenAiModelInfo?: GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo;
|
|
1061
|
+
/** Information for a pretrained Google-managed foundation model. */
|
|
1062
|
+
foundationGenAiModelInfo?: GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo;
|
|
1063
|
+
}
|
|
1064
|
+
interface GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo {
|
|
1065
|
+
/** The base processor version ID for the custom model. */
|
|
1066
|
+
baseProcessorVersionId?: string;
|
|
1067
|
+
/** The type of custom model created by the user. */
|
|
1068
|
+
customModelType?: string;
|
|
1069
|
+
}
|
|
1070
|
+
interface GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
1071
|
+
/** Whether finetuning is allowed for this base processor version. */
|
|
1072
|
+
finetuningAllowed?: boolean;
|
|
1073
|
+
/** The minimum number of labeled documents in the training dataset required for finetuning. */
|
|
1074
|
+
minTrainLabeledDocuments?: number;
|
|
1075
|
+
}
|
|
1076
|
+
interface GoogleCloudDocumentaiV1beta3PropertyMetadata {
|
|
1077
|
+
/** Field extraction metadata on the property. */
|
|
1078
|
+
fieldExtractionMetadata?: GoogleCloudDocumentaiV1beta3FieldExtractionMetadata;
|
|
1079
|
+
/** Whether the property should be considered as "inactive". */
|
|
1080
|
+
inactive?: boolean;
|
|
1081
|
+
}
|
|
1082
|
+
interface GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata {
|
|
1083
|
+
/** The basic metadata of the long-running operation. */
|
|
1084
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
1085
|
+
/** The creation time of the operation. */
|
|
1086
|
+
createTime?: string;
|
|
1087
|
+
/** The Crowd Compute question ID. */
|
|
1088
|
+
questionId?: string;
|
|
1089
|
+
/** Used only when Operation.done is false. */
|
|
1090
|
+
state?: string;
|
|
1091
|
+
/** A message providing more details about the current state of processing. For example, the error message if the operation is failed. */
|
|
1092
|
+
stateMessage?: string;
|
|
1093
|
+
/** The last update time of the operation. */
|
|
602
1094
|
updateTime?: string;
|
|
603
1095
|
}
|
|
604
1096
|
interface GoogleCloudDocumentaiV1beta3ReviewDocumentResponse {
|
|
@@ -622,6 +1114,12 @@ declare namespace gapi.client {
|
|
|
622
1114
|
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
623
1115
|
}
|
|
624
1116
|
interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {}
|
|
1117
|
+
interface GoogleCloudDocumentaiV1beta3SummaryOptions {
|
|
1118
|
+
/** The format the summary should be in. */
|
|
1119
|
+
format?: string;
|
|
1120
|
+
/** How long the summary should be. */
|
|
1121
|
+
length?: string;
|
|
1122
|
+
}
|
|
625
1123
|
interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata {
|
|
626
1124
|
/** The basic metadata of the long-running operation. */
|
|
627
1125
|
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
@@ -653,6 +1151,10 @@ declare namespace gapi.client {
|
|
|
653
1151
|
/** The basic metadata of the long-running operation. */
|
|
654
1152
|
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
655
1153
|
}
|
|
1154
|
+
interface GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata {
|
|
1155
|
+
/** The basic metadata for the long-running operation. */
|
|
1156
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
1157
|
+
}
|
|
656
1158
|
interface GoogleCloudDocumentaiV1BoundingPoly {
|
|
657
1159
|
/** The bounding polygon normalized vertices. */
|
|
658
1160
|
normalizedVertices?: GoogleCloudDocumentaiV1NormalizedVertex[];
|
|
@@ -702,8 +1204,14 @@ declare namespace gapi.client {
|
|
|
702
1204
|
documentLayout?: GoogleCloudDocumentaiV1DocumentDocumentLayout;
|
|
703
1205
|
/** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
|
|
704
1206
|
entities?: GoogleCloudDocumentaiV1DocumentEntity[];
|
|
1207
|
+
/** The entity revision id that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. */
|
|
1208
|
+
entitiesRevisionId?: string;
|
|
1209
|
+
/** A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. */
|
|
1210
|
+
entitiesRevisions?: GoogleCloudDocumentaiV1DocumentEntitiesRevision[];
|
|
705
1211
|
/** Placeholder. Relationship among Document.entities. */
|
|
706
1212
|
entityRelations?: GoogleCloudDocumentaiV1DocumentEntityRelation[];
|
|
1213
|
+
/** The entity validation output for the document. This is the validation output for `document.entities` field. */
|
|
1214
|
+
entityValidationOutput?: GoogleCloudDocumentaiV1DocumentEntityValidationOutput;
|
|
707
1215
|
/** Any error that occurred while processing this document. */
|
|
708
1216
|
error?: GoogleRpcStatus;
|
|
709
1217
|
/** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
|
|
@@ -821,6 +1329,14 @@ declare namespace gapi.client {
|
|
|
821
1329
|
/** Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. */
|
|
822
1330
|
type?: string;
|
|
823
1331
|
}
|
|
1332
|
+
interface GoogleCloudDocumentaiV1DocumentEntitiesRevision {
|
|
1333
|
+
/** The entities in this revision. */
|
|
1334
|
+
entities?: GoogleCloudDocumentaiV1DocumentEntity[];
|
|
1335
|
+
/** The entity validation output for this revision. */
|
|
1336
|
+
entityValidationOutput?: GoogleCloudDocumentaiV1DocumentEntityValidationOutput;
|
|
1337
|
+
/** The revision id. */
|
|
1338
|
+
revisionId?: string;
|
|
1339
|
+
}
|
|
824
1340
|
interface GoogleCloudDocumentaiV1DocumentEntity {
|
|
825
1341
|
/** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
|
|
826
1342
|
confidence?: number;
|
|
@@ -862,6 +1378,7 @@ declare namespace gapi.client {
|
|
|
862
1378
|
integerValue?: number;
|
|
863
1379
|
/** Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */
|
|
864
1380
|
moneyValue?: GoogleTypeMoney;
|
|
1381
|
+
/** A signature - a graphical representation of a person's name, often used to sign a document. */
|
|
865
1382
|
signatureValue?: boolean;
|
|
866
1383
|
/** 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 `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - 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 text format. */
|
|
867
1384
|
text?: string;
|
|
@@ -874,6 +1391,24 @@ declare namespace gapi.client {
|
|
|
874
1391
|
/** Subject entity id. */
|
|
875
1392
|
subjectId?: string;
|
|
876
1393
|
}
|
|
1394
|
+
interface GoogleCloudDocumentaiV1DocumentEntityValidationOutput {
|
|
1395
|
+
/** The overall result of the validation, true if all applicable rules are valid. */
|
|
1396
|
+
passAllRules?: boolean;
|
|
1397
|
+
/** The result of each validation rule. */
|
|
1398
|
+
validationResults?: GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult[];
|
|
1399
|
+
}
|
|
1400
|
+
interface GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult {
|
|
1401
|
+
/** Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` */
|
|
1402
|
+
rule?: string;
|
|
1403
|
+
/** The description of the validation rule. */
|
|
1404
|
+
ruleDescription?: string;
|
|
1405
|
+
/** The display name of the validation rule. */
|
|
1406
|
+
ruleName?: string;
|
|
1407
|
+
/** The detailed information of the running the validation process using the entity from the document based on the validation rule. */
|
|
1408
|
+
validationDetails?: string;
|
|
1409
|
+
/** The result of the validation rule. */
|
|
1410
|
+
validationResultType?: string;
|
|
1411
|
+
}
|
|
877
1412
|
interface GoogleCloudDocumentaiV1DocumentOutputConfig {
|
|
878
1413
|
/** Output config to write the results to Cloud Storage. */
|
|
879
1414
|
gcsOutputConfig?: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig;
|
|
@@ -1176,6 +1711,10 @@ declare namespace gapi.client {
|
|
|
1176
1711
|
/** A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. */
|
|
1177
1712
|
stateMessage?: string;
|
|
1178
1713
|
}
|
|
1714
|
+
interface GoogleCloudDocumentaiV1Documents {
|
|
1715
|
+
/** The list of documents. */
|
|
1716
|
+
documents?: GoogleCloudDocumentaiV1Document[];
|
|
1717
|
+
}
|
|
1179
1718
|
interface GoogleCloudDocumentaiV1DocumentSchema {
|
|
1180
1719
|
/** Description of the schema. */
|
|
1181
1720
|
description?: string;
|
|
@@ -1396,6 +1935,30 @@ declare namespace gapi.client {
|
|
|
1396
1935
|
/** The URI prefix. */
|
|
1397
1936
|
gcsUriPrefix?: string;
|
|
1398
1937
|
}
|
|
1938
|
+
interface GoogleCloudDocumentaiV1GenerateSchemaVersionRequest {
|
|
1939
|
+
/** The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
1940
|
+
baseSchemaVersion?: string;
|
|
1941
|
+
/** The set of documents placed on Cloud Storage. */
|
|
1942
|
+
gcsDocuments?: GoogleCloudDocumentaiV1GcsDocuments;
|
|
1943
|
+
/** The common prefix of documents placed on Cloud Storage. */
|
|
1944
|
+
gcsPrefix?: GoogleCloudDocumentaiV1GcsPrefix;
|
|
1945
|
+
/** Optional. User specified parameters for the schema generation. */
|
|
1946
|
+
generateSchemaVersionParams?: GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams;
|
|
1947
|
+
/** The set of documents specified inline. */
|
|
1948
|
+
inlineDocuments?: GoogleCloudDocumentaiV1Documents;
|
|
1949
|
+
/** The set of raw documents. */
|
|
1950
|
+
rawDocuments?: GoogleCloudDocumentaiV1RawDocuments;
|
|
1951
|
+
}
|
|
1952
|
+
interface GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams {
|
|
1953
|
+
/** Optional. Previous prompt-answers in a chronological order. */
|
|
1954
|
+
history?: GoogleCloudDocumentaiV1SchemaGenerationHistory;
|
|
1955
|
+
/** Optional. The prompt used for the schema generation. */
|
|
1956
|
+
prompt?: string;
|
|
1957
|
+
}
|
|
1958
|
+
interface GoogleCloudDocumentaiV1GenerateSchemaVersionResponse {
|
|
1959
|
+
/** The schema version generated by the model. */
|
|
1960
|
+
schemaVersion?: GoogleCloudDocumentaiV1SchemaVersion;
|
|
1961
|
+
}
|
|
1399
1962
|
interface GoogleCloudDocumentaiV1HumanReviewStatus {
|
|
1400
1963
|
/** 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 metadata as the long-running operation returned by ReviewDocument. */
|
|
1401
1964
|
humanReviewOperation?: string;
|
|
@@ -1428,6 +1991,30 @@ declare namespace gapi.client {
|
|
|
1428
1991
|
/** The list of processors. */
|
|
1429
1992
|
processorVersions?: GoogleCloudDocumentaiV1ProcessorVersion[];
|
|
1430
1993
|
}
|
|
1994
|
+
interface GoogleCloudDocumentaiV1ListSchemasResponse {
|
|
1995
|
+
/** Points to the next Schema, otherwise empty. */
|
|
1996
|
+
nextPageToken?: string;
|
|
1997
|
+
/** The list of Schemas. */
|
|
1998
|
+
schemas?: GoogleCloudDocumentaiV1NextSchema[];
|
|
1999
|
+
}
|
|
2000
|
+
interface GoogleCloudDocumentaiV1ListSchemaVersionsResponse {
|
|
2001
|
+
/** Points to the next SchemaVersion, otherwise empty. */
|
|
2002
|
+
nextPageToken?: string;
|
|
2003
|
+
/** The list of SchemaVersions. */
|
|
2004
|
+
schemaVersions?: GoogleCloudDocumentaiV1SchemaVersion[];
|
|
2005
|
+
}
|
|
2006
|
+
interface GoogleCloudDocumentaiV1NextSchema {
|
|
2007
|
+
/** Output only. The time when the Schema was created. */
|
|
2008
|
+
createTime?: string;
|
|
2009
|
+
/** Optional. The user-defined name of the Schema. */
|
|
2010
|
+
displayName?: string;
|
|
2011
|
+
/** Optional. The GCP labels for the Schema. */
|
|
2012
|
+
labels?: {[P in string]: string};
|
|
2013
|
+
/** Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
2014
|
+
name?: string;
|
|
2015
|
+
/** Output only. The time when the Schema was last updated. */
|
|
2016
|
+
updateTime?: string;
|
|
2017
|
+
}
|
|
1431
2018
|
interface GoogleCloudDocumentaiV1NormalizedVertex {
|
|
1432
2019
|
/** X coordinate. */
|
|
1433
2020
|
x?: number;
|
|
@@ -1485,6 +2072,10 @@ declare namespace gapi.client {
|
|
|
1485
2072
|
interface GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig {
|
|
1486
2073
|
/** Optional. Config for chunking in layout parser processor. */
|
|
1487
2074
|
chunkingConfig?: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig;
|
|
2075
|
+
/** Optional. Whether to include image annotations in layout parser response. */
|
|
2076
|
+
enableImageAnnotation?: boolean;
|
|
2077
|
+
/** Optional. Whether to include table annotations in layout parser response. */
|
|
2078
|
+
enableTableAnnotation?: boolean;
|
|
1488
2079
|
/** Optional. Whether to include bounding boxes in layout parser processor response. */
|
|
1489
2080
|
returnBoundingBoxes?: boolean;
|
|
1490
2081
|
/** Optional. Whether to include images in layout parser processor response. */
|
|
@@ -1497,6 +2088,8 @@ declare namespace gapi.client {
|
|
|
1497
2088
|
includeAncestorHeadings?: boolean;
|
|
1498
2089
|
}
|
|
1499
2090
|
interface GoogleCloudDocumentaiV1Processor {
|
|
2091
|
+
/** Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} */
|
|
2092
|
+
activeSchemaVersion?: string;
|
|
1500
2093
|
/** Output only. The time the processor was created. */
|
|
1501
2094
|
createTime?: string;
|
|
1502
2095
|
/** The default processor version. */
|
|
@@ -1632,6 +2225,10 @@ declare namespace gapi.client {
|
|
|
1632
2225
|
/** An IANA MIME type (RFC6838) indicating the nature and format of the content. */
|
|
1633
2226
|
mimeType?: string;
|
|
1634
2227
|
}
|
|
2228
|
+
interface GoogleCloudDocumentaiV1RawDocuments {
|
|
2229
|
+
/** Specifies raw document content and mime type. */
|
|
2230
|
+
documents?: GoogleCloudDocumentaiV1RawDocument[];
|
|
2231
|
+
}
|
|
1635
2232
|
interface GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata {
|
|
1636
2233
|
/** The basic metadata of the long-running operation. */
|
|
1637
2234
|
commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
|
|
@@ -1656,6 +2253,30 @@ declare namespace gapi.client {
|
|
|
1656
2253
|
/** The state of the review operation. */
|
|
1657
2254
|
state?: string;
|
|
1658
2255
|
}
|
|
2256
|
+
interface GoogleCloudDocumentaiV1SchemaGenerationHistory {
|
|
2257
|
+
/** Required. Previous prompt-answers in a chronological order. */
|
|
2258
|
+
iterations?: GoogleCloudDocumentaiV1SchemaGenerationIteration[];
|
|
2259
|
+
}
|
|
2260
|
+
interface GoogleCloudDocumentaiV1SchemaGenerationIteration {
|
|
2261
|
+
/** Optional. The previous schema version adjusted by the model. */
|
|
2262
|
+
adjustedSchema?: GoogleCloudDocumentaiV1SchemaVersion;
|
|
2263
|
+
/** Required. The schema version generated by the model. */
|
|
2264
|
+
generatedSchema?: GoogleCloudDocumentaiV1SchemaVersion;
|
|
2265
|
+
/** Optional. The prompt used for the iteration. */
|
|
2266
|
+
prompt?: string;
|
|
2267
|
+
}
|
|
2268
|
+
interface GoogleCloudDocumentaiV1SchemaVersion {
|
|
2269
|
+
/** Output only. The time when the SchemaVersion was created. */
|
|
2270
|
+
createTime?: string;
|
|
2271
|
+
/** Optional. The user-defined name of the SchemaVersion. */
|
|
2272
|
+
displayName?: string;
|
|
2273
|
+
/** Optional. The GCP labels for the SchemaVersion. */
|
|
2274
|
+
labels?: {[P in string]: string};
|
|
2275
|
+
/** Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
2276
|
+
name?: string;
|
|
2277
|
+
/** Required. The schema of the SchemaVersion. */
|
|
2278
|
+
schema?: GoogleCloudDocumentaiV1DocumentSchema;
|
|
2279
|
+
}
|
|
1659
2280
|
interface GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata {
|
|
1660
2281
|
/** The basic metadata of the long-running operation. */
|
|
1661
2282
|
commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
|
|
@@ -1752,6 +2373,8 @@ declare namespace gapi.client {
|
|
|
1752
2373
|
nextPageToken?: string;
|
|
1753
2374
|
/** A list of operations that matches the specified filter in the request. */
|
|
1754
2375
|
operations?: GoogleLongrunningOperation[];
|
|
2376
|
+
/** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. */
|
|
2377
|
+
unreachable?: string[];
|
|
1755
2378
|
}
|
|
1756
2379
|
interface GoogleLongrunningOperation {
|
|
1757
2380
|
/** 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. */
|
|
@@ -1962,6 +2585,8 @@ declare namespace gapi.client {
|
|
|
1962
2585
|
prettyPrint?: boolean;
|
|
1963
2586
|
/** 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. */
|
|
1964
2587
|
quotaUser?: string;
|
|
2588
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
2589
|
+
returnPartialSuccess?: boolean;
|
|
1965
2590
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1966
2591
|
upload_protocol?: string;
|
|
1967
2592
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -3021,6 +3646,481 @@ declare namespace gapi.client {
|
|
|
3021
3646
|
uploadType?: string;
|
|
3022
3647
|
}): Request<GoogleCloudDocumentaiV1ListProcessorTypesResponse>;
|
|
3023
3648
|
}
|
|
3649
|
+
interface SchemaVersionsResource {
|
|
3650
|
+
/** Creates a schema version. */
|
|
3651
|
+
create(request: {
|
|
3652
|
+
/** V1 error format. */
|
|
3653
|
+
'$.xgafv'?: string;
|
|
3654
|
+
/** OAuth access token. */
|
|
3655
|
+
access_token?: string;
|
|
3656
|
+
/** Data format for response. */
|
|
3657
|
+
alt?: string;
|
|
3658
|
+
/** JSONP */
|
|
3659
|
+
callback?: string;
|
|
3660
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3661
|
+
fields?: string;
|
|
3662
|
+
/** 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. */
|
|
3663
|
+
key?: string;
|
|
3664
|
+
/** OAuth 2.0 token for the current user. */
|
|
3665
|
+
oauth_token?: string;
|
|
3666
|
+
/** Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
3667
|
+
parent: string;
|
|
3668
|
+
/** Returns response with indentations and line breaks. */
|
|
3669
|
+
prettyPrint?: boolean;
|
|
3670
|
+
/** 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. */
|
|
3671
|
+
quotaUser?: string;
|
|
3672
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3673
|
+
upload_protocol?: string;
|
|
3674
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3675
|
+
uploadType?: string;
|
|
3676
|
+
/** Request body */
|
|
3677
|
+
resource: GoogleCloudDocumentaiV1SchemaVersion;
|
|
3678
|
+
}): Request<GoogleCloudDocumentaiV1SchemaVersion>;
|
|
3679
|
+
create(
|
|
3680
|
+
request: {
|
|
3681
|
+
/** V1 error format. */
|
|
3682
|
+
'$.xgafv'?: string;
|
|
3683
|
+
/** OAuth access token. */
|
|
3684
|
+
access_token?: string;
|
|
3685
|
+
/** Data format for response. */
|
|
3686
|
+
alt?: string;
|
|
3687
|
+
/** JSONP */
|
|
3688
|
+
callback?: string;
|
|
3689
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3690
|
+
fields?: string;
|
|
3691
|
+
/** 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. */
|
|
3692
|
+
key?: string;
|
|
3693
|
+
/** OAuth 2.0 token for the current user. */
|
|
3694
|
+
oauth_token?: string;
|
|
3695
|
+
/** Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
3696
|
+
parent: string;
|
|
3697
|
+
/** Returns response with indentations and line breaks. */
|
|
3698
|
+
prettyPrint?: boolean;
|
|
3699
|
+
/** 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. */
|
|
3700
|
+
quotaUser?: string;
|
|
3701
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3702
|
+
upload_protocol?: string;
|
|
3703
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3704
|
+
uploadType?: string;
|
|
3705
|
+
},
|
|
3706
|
+
body: GoogleCloudDocumentaiV1SchemaVersion,
|
|
3707
|
+
): Request<GoogleCloudDocumentaiV1SchemaVersion>;
|
|
3708
|
+
/** Deletes a schema version. */
|
|
3709
|
+
delete(request?: {
|
|
3710
|
+
/** V1 error format. */
|
|
3711
|
+
'$.xgafv'?: string;
|
|
3712
|
+
/** OAuth access token. */
|
|
3713
|
+
access_token?: string;
|
|
3714
|
+
/** Data format for response. */
|
|
3715
|
+
alt?: string;
|
|
3716
|
+
/** JSONP */
|
|
3717
|
+
callback?: string;
|
|
3718
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3719
|
+
fields?: string;
|
|
3720
|
+
/** 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. */
|
|
3721
|
+
key?: string;
|
|
3722
|
+
/** Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
3723
|
+
name: string;
|
|
3724
|
+
/** OAuth 2.0 token for the current user. */
|
|
3725
|
+
oauth_token?: string;
|
|
3726
|
+
/** Returns response with indentations and line breaks. */
|
|
3727
|
+
prettyPrint?: boolean;
|
|
3728
|
+
/** 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. */
|
|
3729
|
+
quotaUser?: string;
|
|
3730
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3731
|
+
upload_protocol?: string;
|
|
3732
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3733
|
+
uploadType?: string;
|
|
3734
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3735
|
+
/** Generates a schema version. */
|
|
3736
|
+
generate(request: {
|
|
3737
|
+
/** V1 error format. */
|
|
3738
|
+
'$.xgafv'?: string;
|
|
3739
|
+
/** OAuth access token. */
|
|
3740
|
+
access_token?: string;
|
|
3741
|
+
/** Data format for response. */
|
|
3742
|
+
alt?: string;
|
|
3743
|
+
/** JSONP */
|
|
3744
|
+
callback?: string;
|
|
3745
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3746
|
+
fields?: string;
|
|
3747
|
+
/** 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. */
|
|
3748
|
+
key?: string;
|
|
3749
|
+
/** OAuth 2.0 token for the current user. */
|
|
3750
|
+
oauth_token?: string;
|
|
3751
|
+
/** Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
3752
|
+
parent: string;
|
|
3753
|
+
/** Returns response with indentations and line breaks. */
|
|
3754
|
+
prettyPrint?: boolean;
|
|
3755
|
+
/** 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. */
|
|
3756
|
+
quotaUser?: string;
|
|
3757
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3758
|
+
upload_protocol?: string;
|
|
3759
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3760
|
+
uploadType?: string;
|
|
3761
|
+
/** Request body */
|
|
3762
|
+
resource: GoogleCloudDocumentaiV1GenerateSchemaVersionRequest;
|
|
3763
|
+
}): Request<GoogleCloudDocumentaiV1GenerateSchemaVersionResponse>;
|
|
3764
|
+
generate(
|
|
3765
|
+
request: {
|
|
3766
|
+
/** V1 error format. */
|
|
3767
|
+
'$.xgafv'?: string;
|
|
3768
|
+
/** OAuth access token. */
|
|
3769
|
+
access_token?: string;
|
|
3770
|
+
/** Data format for response. */
|
|
3771
|
+
alt?: string;
|
|
3772
|
+
/** JSONP */
|
|
3773
|
+
callback?: string;
|
|
3774
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3775
|
+
fields?: string;
|
|
3776
|
+
/** 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. */
|
|
3777
|
+
key?: string;
|
|
3778
|
+
/** OAuth 2.0 token for the current user. */
|
|
3779
|
+
oauth_token?: string;
|
|
3780
|
+
/** Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
3781
|
+
parent: string;
|
|
3782
|
+
/** Returns response with indentations and line breaks. */
|
|
3783
|
+
prettyPrint?: boolean;
|
|
3784
|
+
/** 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. */
|
|
3785
|
+
quotaUser?: string;
|
|
3786
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3787
|
+
upload_protocol?: string;
|
|
3788
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3789
|
+
uploadType?: string;
|
|
3790
|
+
},
|
|
3791
|
+
body: GoogleCloudDocumentaiV1GenerateSchemaVersionRequest,
|
|
3792
|
+
): Request<GoogleCloudDocumentaiV1GenerateSchemaVersionResponse>;
|
|
3793
|
+
/** Gets a schema version. */
|
|
3794
|
+
get(request?: {
|
|
3795
|
+
/** V1 error format. */
|
|
3796
|
+
'$.xgafv'?: string;
|
|
3797
|
+
/** OAuth access token. */
|
|
3798
|
+
access_token?: string;
|
|
3799
|
+
/** Data format for response. */
|
|
3800
|
+
alt?: string;
|
|
3801
|
+
/** JSONP */
|
|
3802
|
+
callback?: string;
|
|
3803
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3804
|
+
fields?: string;
|
|
3805
|
+
/** 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. */
|
|
3806
|
+
key?: string;
|
|
3807
|
+
/** Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
3808
|
+
name: string;
|
|
3809
|
+
/** OAuth 2.0 token for the current user. */
|
|
3810
|
+
oauth_token?: string;
|
|
3811
|
+
/** Returns response with indentations and line breaks. */
|
|
3812
|
+
prettyPrint?: boolean;
|
|
3813
|
+
/** 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. */
|
|
3814
|
+
quotaUser?: string;
|
|
3815
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3816
|
+
upload_protocol?: string;
|
|
3817
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3818
|
+
uploadType?: string;
|
|
3819
|
+
}): Request<GoogleCloudDocumentaiV1SchemaVersion>;
|
|
3820
|
+
/** Lists SchemaVersions. */
|
|
3821
|
+
list(request?: {
|
|
3822
|
+
/** V1 error format. */
|
|
3823
|
+
'$.xgafv'?: string;
|
|
3824
|
+
/** OAuth access token. */
|
|
3825
|
+
access_token?: string;
|
|
3826
|
+
/** Data format for response. */
|
|
3827
|
+
alt?: string;
|
|
3828
|
+
/** JSONP */
|
|
3829
|
+
callback?: string;
|
|
3830
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3831
|
+
fields?: string;
|
|
3832
|
+
/** 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. */
|
|
3833
|
+
key?: string;
|
|
3834
|
+
/** OAuth 2.0 token for the current user. */
|
|
3835
|
+
oauth_token?: string;
|
|
3836
|
+
/** Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. */
|
|
3837
|
+
pageSize?: number;
|
|
3838
|
+
/** Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion. */
|
|
3839
|
+
pageToken?: string;
|
|
3840
|
+
/** Required. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
3841
|
+
parent: string;
|
|
3842
|
+
/** Returns response with indentations and line breaks. */
|
|
3843
|
+
prettyPrint?: boolean;
|
|
3844
|
+
/** 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. */
|
|
3845
|
+
quotaUser?: string;
|
|
3846
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3847
|
+
upload_protocol?: string;
|
|
3848
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3849
|
+
uploadType?: string;
|
|
3850
|
+
}): Request<GoogleCloudDocumentaiV1ListSchemaVersionsResponse>;
|
|
3851
|
+
/** Updates a schema version. Editable fields are: - `display_name` - `labels` */
|
|
3852
|
+
patch(request: {
|
|
3853
|
+
/** V1 error format. */
|
|
3854
|
+
'$.xgafv'?: string;
|
|
3855
|
+
/** OAuth access token. */
|
|
3856
|
+
access_token?: string;
|
|
3857
|
+
/** Data format for response. */
|
|
3858
|
+
alt?: string;
|
|
3859
|
+
/** JSONP */
|
|
3860
|
+
callback?: string;
|
|
3861
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3862
|
+
fields?: string;
|
|
3863
|
+
/** 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. */
|
|
3864
|
+
key?: string;
|
|
3865
|
+
/** Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
3866
|
+
name: string;
|
|
3867
|
+
/** OAuth 2.0 token for the current user. */
|
|
3868
|
+
oauth_token?: string;
|
|
3869
|
+
/** Returns response with indentations and line breaks. */
|
|
3870
|
+
prettyPrint?: boolean;
|
|
3871
|
+
/** 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. */
|
|
3872
|
+
quotaUser?: string;
|
|
3873
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
|
|
3874
|
+
updateMask?: string;
|
|
3875
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3876
|
+
upload_protocol?: string;
|
|
3877
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3878
|
+
uploadType?: string;
|
|
3879
|
+
/** Request body */
|
|
3880
|
+
resource: GoogleCloudDocumentaiV1SchemaVersion;
|
|
3881
|
+
}): Request<GoogleCloudDocumentaiV1SchemaVersion>;
|
|
3882
|
+
patch(
|
|
3883
|
+
request: {
|
|
3884
|
+
/** V1 error format. */
|
|
3885
|
+
'$.xgafv'?: string;
|
|
3886
|
+
/** OAuth access token. */
|
|
3887
|
+
access_token?: string;
|
|
3888
|
+
/** Data format for response. */
|
|
3889
|
+
alt?: string;
|
|
3890
|
+
/** JSONP */
|
|
3891
|
+
callback?: string;
|
|
3892
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3893
|
+
fields?: string;
|
|
3894
|
+
/** 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. */
|
|
3895
|
+
key?: string;
|
|
3896
|
+
/** Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
3897
|
+
name: string;
|
|
3898
|
+
/** OAuth 2.0 token for the current user. */
|
|
3899
|
+
oauth_token?: string;
|
|
3900
|
+
/** Returns response with indentations and line breaks. */
|
|
3901
|
+
prettyPrint?: boolean;
|
|
3902
|
+
/** 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. */
|
|
3903
|
+
quotaUser?: string;
|
|
3904
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
|
|
3905
|
+
updateMask?: string;
|
|
3906
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3907
|
+
upload_protocol?: string;
|
|
3908
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3909
|
+
uploadType?: string;
|
|
3910
|
+
},
|
|
3911
|
+
body: GoogleCloudDocumentaiV1SchemaVersion,
|
|
3912
|
+
): Request<GoogleCloudDocumentaiV1SchemaVersion>;
|
|
3913
|
+
}
|
|
3914
|
+
interface SchemasResource {
|
|
3915
|
+
/** Creates a schema. */
|
|
3916
|
+
create(request: {
|
|
3917
|
+
/** V1 error format. */
|
|
3918
|
+
'$.xgafv'?: string;
|
|
3919
|
+
/** OAuth access token. */
|
|
3920
|
+
access_token?: string;
|
|
3921
|
+
/** Data format for response. */
|
|
3922
|
+
alt?: string;
|
|
3923
|
+
/** JSONP */
|
|
3924
|
+
callback?: string;
|
|
3925
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3926
|
+
fields?: string;
|
|
3927
|
+
/** 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. */
|
|
3928
|
+
key?: string;
|
|
3929
|
+
/** OAuth 2.0 token for the current user. */
|
|
3930
|
+
oauth_token?: string;
|
|
3931
|
+
/** Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}` */
|
|
3932
|
+
parent: string;
|
|
3933
|
+
/** Returns response with indentations and line breaks. */
|
|
3934
|
+
prettyPrint?: boolean;
|
|
3935
|
+
/** 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. */
|
|
3936
|
+
quotaUser?: string;
|
|
3937
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3938
|
+
upload_protocol?: string;
|
|
3939
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3940
|
+
uploadType?: string;
|
|
3941
|
+
/** Request body */
|
|
3942
|
+
resource: GoogleCloudDocumentaiV1NextSchema;
|
|
3943
|
+
}): Request<GoogleCloudDocumentaiV1NextSchema>;
|
|
3944
|
+
create(
|
|
3945
|
+
request: {
|
|
3946
|
+
/** V1 error format. */
|
|
3947
|
+
'$.xgafv'?: string;
|
|
3948
|
+
/** OAuth access token. */
|
|
3949
|
+
access_token?: string;
|
|
3950
|
+
/** Data format for response. */
|
|
3951
|
+
alt?: string;
|
|
3952
|
+
/** JSONP */
|
|
3953
|
+
callback?: string;
|
|
3954
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3955
|
+
fields?: string;
|
|
3956
|
+
/** 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. */
|
|
3957
|
+
key?: string;
|
|
3958
|
+
/** OAuth 2.0 token for the current user. */
|
|
3959
|
+
oauth_token?: string;
|
|
3960
|
+
/** Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}` */
|
|
3961
|
+
parent: string;
|
|
3962
|
+
/** Returns response with indentations and line breaks. */
|
|
3963
|
+
prettyPrint?: boolean;
|
|
3964
|
+
/** 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. */
|
|
3965
|
+
quotaUser?: string;
|
|
3966
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3967
|
+
upload_protocol?: string;
|
|
3968
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3969
|
+
uploadType?: string;
|
|
3970
|
+
},
|
|
3971
|
+
body: GoogleCloudDocumentaiV1NextSchema,
|
|
3972
|
+
): Request<GoogleCloudDocumentaiV1NextSchema>;
|
|
3973
|
+
/** Deletes a schema. */
|
|
3974
|
+
delete(request?: {
|
|
3975
|
+
/** V1 error format. */
|
|
3976
|
+
'$.xgafv'?: string;
|
|
3977
|
+
/** OAuth access token. */
|
|
3978
|
+
access_token?: string;
|
|
3979
|
+
/** Data format for response. */
|
|
3980
|
+
alt?: string;
|
|
3981
|
+
/** JSONP */
|
|
3982
|
+
callback?: string;
|
|
3983
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3984
|
+
fields?: string;
|
|
3985
|
+
/** Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.) */
|
|
3986
|
+
force?: boolean;
|
|
3987
|
+
/** 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. */
|
|
3988
|
+
key?: string;
|
|
3989
|
+
/** Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
3990
|
+
name: string;
|
|
3991
|
+
/** OAuth 2.0 token for the current user. */
|
|
3992
|
+
oauth_token?: string;
|
|
3993
|
+
/** Returns response with indentations and line breaks. */
|
|
3994
|
+
prettyPrint?: boolean;
|
|
3995
|
+
/** 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. */
|
|
3996
|
+
quotaUser?: string;
|
|
3997
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3998
|
+
upload_protocol?: string;
|
|
3999
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4000
|
+
uploadType?: string;
|
|
4001
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4002
|
+
/** Gets a schema. */
|
|
4003
|
+
get(request?: {
|
|
4004
|
+
/** V1 error format. */
|
|
4005
|
+
'$.xgafv'?: string;
|
|
4006
|
+
/** OAuth access token. */
|
|
4007
|
+
access_token?: string;
|
|
4008
|
+
/** Data format for response. */
|
|
4009
|
+
alt?: string;
|
|
4010
|
+
/** JSONP */
|
|
4011
|
+
callback?: string;
|
|
4012
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4013
|
+
fields?: string;
|
|
4014
|
+
/** 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. */
|
|
4015
|
+
key?: string;
|
|
4016
|
+
/** Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4017
|
+
name: string;
|
|
4018
|
+
/** OAuth 2.0 token for the current user. */
|
|
4019
|
+
oauth_token?: string;
|
|
4020
|
+
/** Returns response with indentations and line breaks. */
|
|
4021
|
+
prettyPrint?: boolean;
|
|
4022
|
+
/** 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. */
|
|
4023
|
+
quotaUser?: string;
|
|
4024
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4025
|
+
upload_protocol?: string;
|
|
4026
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4027
|
+
uploadType?: string;
|
|
4028
|
+
}): Request<GoogleCloudDocumentaiV1NextSchema>;
|
|
4029
|
+
/** Lists Schemas. */
|
|
4030
|
+
list(request?: {
|
|
4031
|
+
/** V1 error format. */
|
|
4032
|
+
'$.xgafv'?: string;
|
|
4033
|
+
/** OAuth access token. */
|
|
4034
|
+
access_token?: string;
|
|
4035
|
+
/** Data format for response. */
|
|
4036
|
+
alt?: string;
|
|
4037
|
+
/** JSONP */
|
|
4038
|
+
callback?: string;
|
|
4039
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4040
|
+
fields?: string;
|
|
4041
|
+
/** 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. */
|
|
4042
|
+
key?: string;
|
|
4043
|
+
/** OAuth 2.0 token for the current user. */
|
|
4044
|
+
oauth_token?: string;
|
|
4045
|
+
/** Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. */
|
|
4046
|
+
pageSize?: number;
|
|
4047
|
+
/** Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema. */
|
|
4048
|
+
pageToken?: string;
|
|
4049
|
+
/** Required. Format: `projects/{project}/locations/{location}` */
|
|
4050
|
+
parent: string;
|
|
4051
|
+
/** Returns response with indentations and line breaks. */
|
|
4052
|
+
prettyPrint?: boolean;
|
|
4053
|
+
/** 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. */
|
|
4054
|
+
quotaUser?: string;
|
|
4055
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4056
|
+
upload_protocol?: string;
|
|
4057
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4058
|
+
uploadType?: string;
|
|
4059
|
+
}): Request<GoogleCloudDocumentaiV1ListSchemasResponse>;
|
|
4060
|
+
/** Updates a schema. Editable fields are: - `display_name` - `labels` */
|
|
4061
|
+
patch(request: {
|
|
4062
|
+
/** V1 error format. */
|
|
4063
|
+
'$.xgafv'?: string;
|
|
4064
|
+
/** OAuth access token. */
|
|
4065
|
+
access_token?: string;
|
|
4066
|
+
/** Data format for response. */
|
|
4067
|
+
alt?: string;
|
|
4068
|
+
/** JSONP */
|
|
4069
|
+
callback?: string;
|
|
4070
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4071
|
+
fields?: string;
|
|
4072
|
+
/** 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. */
|
|
4073
|
+
key?: string;
|
|
4074
|
+
/** Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4075
|
+
name: string;
|
|
4076
|
+
/** OAuth 2.0 token for the current user. */
|
|
4077
|
+
oauth_token?: string;
|
|
4078
|
+
/** Returns response with indentations and line breaks. */
|
|
4079
|
+
prettyPrint?: boolean;
|
|
4080
|
+
/** 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. */
|
|
4081
|
+
quotaUser?: string;
|
|
4082
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
|
|
4083
|
+
updateMask?: string;
|
|
4084
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4085
|
+
upload_protocol?: string;
|
|
4086
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4087
|
+
uploadType?: string;
|
|
4088
|
+
/** Request body */
|
|
4089
|
+
resource: GoogleCloudDocumentaiV1NextSchema;
|
|
4090
|
+
}): Request<GoogleCloudDocumentaiV1NextSchema>;
|
|
4091
|
+
patch(
|
|
4092
|
+
request: {
|
|
4093
|
+
/** V1 error format. */
|
|
4094
|
+
'$.xgafv'?: string;
|
|
4095
|
+
/** OAuth access token. */
|
|
4096
|
+
access_token?: string;
|
|
4097
|
+
/** Data format for response. */
|
|
4098
|
+
alt?: string;
|
|
4099
|
+
/** JSONP */
|
|
4100
|
+
callback?: string;
|
|
4101
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4102
|
+
fields?: string;
|
|
4103
|
+
/** 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. */
|
|
4104
|
+
key?: string;
|
|
4105
|
+
/** Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4106
|
+
name: string;
|
|
4107
|
+
/** OAuth 2.0 token for the current user. */
|
|
4108
|
+
oauth_token?: string;
|
|
4109
|
+
/** Returns response with indentations and line breaks. */
|
|
4110
|
+
prettyPrint?: boolean;
|
|
4111
|
+
/** 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. */
|
|
4112
|
+
quotaUser?: string;
|
|
4113
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
|
|
4114
|
+
updateMask?: string;
|
|
4115
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4116
|
+
upload_protocol?: string;
|
|
4117
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4118
|
+
uploadType?: string;
|
|
4119
|
+
},
|
|
4120
|
+
body: GoogleCloudDocumentaiV1NextSchema,
|
|
4121
|
+
): Request<GoogleCloudDocumentaiV1NextSchema>;
|
|
4122
|
+
schemaVersions: SchemaVersionsResource;
|
|
4123
|
+
}
|
|
3024
4124
|
interface LocationsResource {
|
|
3025
4125
|
/** Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated. */
|
|
3026
4126
|
fetchProcessorTypes(request?: {
|
|
@@ -3114,6 +4214,7 @@ declare namespace gapi.client {
|
|
|
3114
4214
|
operations: OperationsResource;
|
|
3115
4215
|
processors: ProcessorsResource;
|
|
3116
4216
|
processorTypes: ProcessorTypesResource;
|
|
4217
|
+
schemas: SchemasResource;
|
|
3117
4218
|
}
|
|
3118
4219
|
interface OperationsResource {
|
|
3119
4220
|
/** 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. */
|