@maxim_mazurok/gapi.client.documentai-v1 0.1.20250929 → 0.1.20251030

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.
Files changed (2) hide show
  1. package/index.d.ts +1178 -100
  2. 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: 20250929
12
+ // Revision: 20251030
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -37,6 +37,8 @@ declare namespace gapi.client {
37
37
  formValidation?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation;
38
38
  /** Name of the validation rule. */
39
39
  name?: string;
40
+ /** Unique identifier of the rule. Optional. */
41
+ ruleId?: string;
40
42
  }
41
43
  interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule {
42
44
  alignmentType?: string;
@@ -211,11 +213,81 @@ declare namespace gapi.client {
211
213
  /** Required. The id of the document. */
212
214
  docId?: string;
213
215
  }
216
+ interface GoogleCloudDocumentaiUiv1beta3DocumentSchema {
217
+ /** Description of the schema. */
218
+ description?: string;
219
+ /** Display name to show to users. */
220
+ displayName?: string;
221
+ /** Entity types of the schema. */
222
+ entityTypes?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType[];
223
+ /** Metadata of the schema. */
224
+ metadata?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata;
225
+ }
226
+ interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType {
227
+ /** The entity type that this type is derived from. For now, one and only one should be set. */
228
+ baseTypes?: string[];
229
+ /** The description of the entity type. Could be used to provide more information about the entity type for model calls. */
230
+ description?: string;
231
+ /** User defined name for the type. */
232
+ displayName?: string;
233
+ /** Metadata for the entity type. */
234
+ entityTypeMetadata?: GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata;
235
+ /** 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. */
236
+ enumValues?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues;
237
+ /** 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. */
238
+ name?: string;
239
+ /** Description the nested structure, or composition of an entity. */
240
+ properties?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty[];
241
+ }
242
+ interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues {
243
+ /** The individual values that this enum values type can include. */
244
+ values?: string[];
245
+ }
246
+ interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty {
247
+ /** The description of the property. Could be used to provide more information about the property for model calls. */
248
+ description?: string;
249
+ /** User defined name for the property. */
250
+ displayName?: string;
251
+ /** Specifies how the entity's value is obtained. */
252
+ method?: string;
253
+ /** The name of the property. Follows the same guidelines as the EntityType name. */
254
+ name?: string;
255
+ /** Occurrence type limits the number of instances an entity type appears in the document. */
256
+ occurrenceType?: string;
257
+ /** Any additional metadata about the property can be added here. */
258
+ propertyMetadata?: GoogleCloudDocumentaiUiv1beta3PropertyMetadata;
259
+ /** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
260
+ valueType?: string;
261
+ }
262
+ interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata {
263
+ /** If true, on a given page, there can be multiple `document` annotations covering it. */
264
+ documentAllowMultipleLabels?: boolean;
265
+ /** If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */
266
+ documentSplitter?: boolean;
267
+ /** If set, all the nested entities must be prefixed with the parents. */
268
+ prefixedNamingOnProperties?: boolean;
269
+ /** 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. */
270
+ skipNamingValidation?: boolean;
271
+ }
214
272
  interface GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata {
215
273
  /** The basic metadata of the long-running operation. */
216
274
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
217
275
  }
218
276
  interface GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse {}
277
+ interface GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata {
278
+ /** Field tier metadata on the property */
279
+ fieldTierMetadata?: GoogleCloudDocumentaiUiv1beta3FieldTierMetadata;
280
+ /** Human review labeling config on the entity. */
281
+ humanReviewLabelingMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata;
282
+ /** Human review config on the entity. */
283
+ humanReviewMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata;
284
+ /** Whether the entity type should be considered inactive. */
285
+ inactive?: boolean;
286
+ /** Schema editability metadata on the entity. */
287
+ schemaEditabilityMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata;
288
+ /** Schema inference metadata on the entity. */
289
+ schemaInferenceMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata;
290
+ }
219
291
  interface GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata {
220
292
  /** The basic metadata of the long-running operation. */
221
293
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
@@ -224,6 +296,40 @@ declare namespace gapi.client {
224
296
  /** The resource name of the created evaluation. */
225
297
  evaluation?: string;
226
298
  }
299
+ interface GoogleCloudDocumentaiUiv1beta3EvaluationMetrics {
300
+ /** The calculated f1 score. */
301
+ f1Score?: number;
302
+ /** The amount of false negatives. */
303
+ falseNegativesCount?: number;
304
+ /** The amount of false positives. */
305
+ falsePositivesCount?: number;
306
+ /** The amount of documents with a ground truth occurrence. */
307
+ groundTruthDocumentCount?: number;
308
+ /** The amount of occurrences in ground truth documents. */
309
+ groundTruthOccurrencesCount?: number;
310
+ /** The calculated precision. */
311
+ precision?: number;
312
+ /** The amount of documents with a predicted occurrence. */
313
+ predictedDocumentCount?: number;
314
+ /** The amount of occurrences in predicted documents. */
315
+ predictedOccurrencesCount?: number;
316
+ /** The calculated recall. */
317
+ recall?: number;
318
+ /** The amount of documents that had an occurrence of this label. */
319
+ totalDocumentsCount?: number;
320
+ /** The amount of true positives. */
321
+ truePositivesCount?: number;
322
+ }
323
+ interface GoogleCloudDocumentaiUiv1beta3EvaluationReference {
324
+ /** An aggregate of the statistics for the evaluation with fuzzy matching on. */
325
+ aggregateMetrics?: GoogleCloudDocumentaiUiv1beta3EvaluationMetrics;
326
+ /** An aggregate of the statistics for the evaluation with fuzzy matching off. */
327
+ aggregateMetricsExact?: GoogleCloudDocumentaiUiv1beta3EvaluationMetrics;
328
+ /** The resource name of the evaluation. */
329
+ evaluation?: string;
330
+ /** The resource name of the Long Running Operation for the evaluation. */
331
+ operation?: string;
332
+ }
227
333
  interface GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata {
228
334
  /** The basic metadata of the long-running operation. */
229
335
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
@@ -255,6 +361,30 @@ declare namespace gapi.client {
255
361
  /** The Cloud Storage URI containing the output artifacts. */
256
362
  gcsUri?: string;
257
363
  }
364
+ interface GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata {
365
+ /** Entity query config. */
366
+ entityQuery?: GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery;
367
+ /** Summary options config. */
368
+ summaryOptions?: GoogleCloudDocumentaiUiv1beta3SummaryOptions;
369
+ }
370
+ interface GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery {
371
+ /** The original entity query inputed by the user. */
372
+ userEntityQuery?: string;
373
+ }
374
+ interface GoogleCloudDocumentaiUiv1beta3FieldTierMetadata {
375
+ /** 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. */
376
+ tierLevel?: number;
377
+ }
378
+ interface GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata {
379
+ /** Whether to enable normalization editing. */
380
+ enableNormalizationEditing?: boolean;
381
+ }
382
+ interface GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata {
383
+ /** The confidence threshold if human review validation is enabled. */
384
+ confidenceThreshold?: number;
385
+ /** Whether to enable human review validation. */
386
+ enableValidation?: boolean;
387
+ }
258
388
  interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata {
259
389
  /** The basic metadata of the long-running operation. */
260
390
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
@@ -290,6 +420,112 @@ declare namespace gapi.client {
290
420
  /** The destination processor version name. */
291
421
  processorVersion?: string;
292
422
  }
423
+ interface GoogleCloudDocumentaiUiv1beta3Processor {
424
+ /** 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} */
425
+ activeSchemaVersion?: string;
426
+ /** Output only. The time the processor was created. */
427
+ createTime?: string;
428
+ /** The default processor version. */
429
+ defaultProcessorVersion?: string;
430
+ /** The display name of the processor. */
431
+ displayName?: string;
432
+ /** The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */
433
+ kmsKeyName?: string;
434
+ /** Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` */
435
+ name?: string;
436
+ /** Output only. Immutable. The http endpoint that can be called to invoke processing. */
437
+ processEndpoint?: string;
438
+ /** Output only. The processor version aliases. */
439
+ processorVersionAliases?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias[];
440
+ /** Output only. Reserved for future use. */
441
+ satisfiesPzi?: boolean;
442
+ /** Output only. Reserved for future use. */
443
+ satisfiesPzs?: boolean;
444
+ /** Output only. The state of the processor. */
445
+ state?: string;
446
+ /** The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */
447
+ type?: string;
448
+ }
449
+ interface GoogleCloudDocumentaiUiv1beta3ProcessorVersion {
450
+ /** Output only. The time the processor version was created. */
451
+ createTime?: string;
452
+ /** Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed. */
453
+ deploymentAllowed?: boolean;
454
+ /** Output only. If set, information about the eventual deprecation of this version. */
455
+ deprecationInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo;
456
+ /** The display name of the processor version. */
457
+ displayName?: string;
458
+ /** Output only. The schema of the processor version. Describes the output. */
459
+ documentSchema?: GoogleCloudDocumentaiUiv1beta3DocumentSchema;
460
+ /** Output only. Information about Generative AI model-based processor versions. */
461
+ genAiModelInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo;
462
+ /** Output only. Denotes that this `ProcessorVersion` is managed by Google. */
463
+ googleManaged?: boolean;
464
+ /** Output only. The KMS key name used for encryption. */
465
+ kmsKeyName?: string;
466
+ /** Output only. The KMS key version with which data is encrypted. */
467
+ kmsKeyVersionName?: string;
468
+ /** Output only. The most recently invoked evaluation for the processor version. */
469
+ latestEvaluation?: GoogleCloudDocumentaiUiv1beta3EvaluationReference;
470
+ /** Output only. The model type of this processor version. */
471
+ modelType?: string;
472
+ /** Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` */
473
+ name?: string;
474
+ /** Output only. Reserved for future use. */
475
+ satisfiesPzi?: boolean;
476
+ /** Output only. Reserved for future use. */
477
+ satisfiesPzs?: boolean;
478
+ /** The schema of the processor version. Describes the output. */
479
+ schema?: GoogleCloudDocumentaiUiv1beta3Schema;
480
+ /** Output only. The state of the processor version. */
481
+ state?: string;
482
+ }
483
+ interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias {
484
+ /** The alias in the form of `processor_version` resource name. */
485
+ alias?: string;
486
+ /** The resource name of aliased processor version. */
487
+ processorVersion?: string;
488
+ }
489
+ interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo {
490
+ /** The time at which this processor version will be deprecated. */
491
+ deprecationTime?: string;
492
+ /** If set, the processor version that will be used as a replacement. */
493
+ replacementProcessorVersion?: string;
494
+ }
495
+ interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo {
496
+ /** Information for a custom Generative AI model created by the user. */
497
+ customGenAiModelInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo;
498
+ /** Information for a pretrained Google-managed foundation model. */
499
+ foundationGenAiModelInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo;
500
+ }
501
+ interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo {
502
+ /** The base processor version ID for the custom model. */
503
+ baseProcessorVersionId?: string;
504
+ /** The type of custom model created by the user. */
505
+ customModelType?: string;
506
+ }
507
+ interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
508
+ /** Whether finetuning is allowed for this base processor version. */
509
+ finetuningAllowed?: boolean;
510
+ /** The minimum number of labeled documents in the training dataset required for finetuning. */
511
+ minTrainLabeledDocuments?: number;
512
+ }
513
+ interface GoogleCloudDocumentaiUiv1beta3PropertyMetadata {
514
+ /** Field extraction metadata on the property. */
515
+ fieldExtractionMetadata?: GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata;
516
+ /** Field tier metadata on the property */
517
+ fieldTierMetadata?: GoogleCloudDocumentaiUiv1beta3FieldTierMetadata;
518
+ /** Human review labeling config on the property. */
519
+ humanReviewLabelingMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata;
520
+ /** Human review validation config on the property. */
521
+ humanReviewMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata;
522
+ /** Whether the property should be considered as "inactive". */
523
+ inactive?: boolean;
524
+ /** Schema editability metadata on the property. */
525
+ schemaEditabilityMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata;
526
+ /** Schema inference metadata on the property. */
527
+ schemaInferenceMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata;
528
+ }
293
529
  interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata {
294
530
  /** The basic metadata of the long-running operation. */
295
531
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
@@ -337,11 +573,54 @@ declare namespace gapi.client {
337
573
  /** An internal identifier for document. */
338
574
  documentId?: string;
339
575
  }
576
+ interface GoogleCloudDocumentaiUiv1beta3Schema {
577
+ /** Description of the schema. */
578
+ description?: string;
579
+ /** Display name to show to users. */
580
+ displayName?: string;
581
+ /** Entity types of the schema. */
582
+ entityTypes?: GoogleCloudDocumentaiUiv1beta3SchemaEntityType[];
583
+ }
584
+ interface GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata {
585
+ /** Explicit flag that controls whether the label is editable. */
586
+ editable?: boolean;
587
+ /** Full resource name of processor versions that contain this label. e.g. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
588
+ processorVersions?: string[];
589
+ }
590
+ interface GoogleCloudDocumentaiUiv1beta3SchemaEntityType {
591
+ baseType?: string;
592
+ /** Description of the entity type. */
593
+ description?: string;
594
+ /** If specified, lists all the possible values for this entity. */
595
+ enumValues?: string[];
596
+ /** If the entity type is hidden in the schema. This provides the functionality to temporally "disable" an entity without deleting it. */
597
+ hide?: boolean;
598
+ /** Specifies how the entity's value is obtained. */
599
+ method?: string;
600
+ /** Occurrence type limits the number of times an entity type appears in the document. */
601
+ occurrenceType?: string;
602
+ /** 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. */
603
+ properties?: GoogleCloudDocumentaiUiv1beta3SchemaEntityType[];
604
+ /** Source of this entity type. */
605
+ source?: string;
606
+ /** 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. */
607
+ type?: string;
608
+ }
609
+ interface GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata {
610
+ /** True if is inferred by schema inference. */
611
+ inferred?: boolean;
612
+ }
340
613
  interface GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata {
341
614
  /** The basic metadata of the long-running operation. */
342
615
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
343
616
  }
344
617
  interface GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse {}
618
+ interface GoogleCloudDocumentaiUiv1beta3SummaryOptions {
619
+ /** The format the summary should be in. */
620
+ format?: string;
621
+ /** How long the summary should be. */
622
+ length?: string;
623
+ }
345
624
  interface GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata {
346
625
  /** The basic metadata of the long-running operation. */
347
626
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
@@ -381,6 +660,10 @@ declare namespace gapi.client {
381
660
  /** The basic metadata of the long-running operation. */
382
661
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
383
662
  }
663
+ interface GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata {
664
+ /** The basic metadata for the long-running operation. */
665
+ commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
666
+ }
384
667
  interface GoogleCloudDocumentaiV1Barcode {
385
668
  /** 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. */
386
669
  format?: string;
@@ -550,11 +833,71 @@ declare namespace gapi.client {
550
833
  /** Required. The id of the document. */
551
834
  docId?: string;
552
835
  }
836
+ interface GoogleCloudDocumentaiV1beta3DocumentSchema {
837
+ /** Description of the schema. */
838
+ description?: string;
839
+ /** Display name to show to users. */
840
+ displayName?: string;
841
+ /** Entity types of the schema. */
842
+ entityTypes?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType[];
843
+ /** Metadata of the schema. */
844
+ metadata?: GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata;
845
+ }
846
+ interface GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType {
847
+ /** The entity type that this type is derived from. For now, one and only one should be set. */
848
+ baseTypes?: string[];
849
+ /** The description of the entity type. Could be used to provide more information about the entity type for model calls. */
850
+ description?: string;
851
+ /** User defined name for the type. */
852
+ displayName?: string;
853
+ /** Metadata for the entity type. */
854
+ entityTypeMetadata?: GoogleCloudDocumentaiV1beta3EntityTypeMetadata;
855
+ /** 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. */
856
+ enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
857
+ /** 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. */
858
+ name?: string;
859
+ /** Description the nested structure, or composition of an entity. */
860
+ properties?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty[];
861
+ }
862
+ interface GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues {
863
+ /** The individual values that this enum values type can include. */
864
+ values?: string[];
865
+ }
866
+ interface GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty {
867
+ /** The description of the property. Could be used to provide more information about the property for model calls. */
868
+ description?: string;
869
+ /** User defined name for the property. */
870
+ displayName?: string;
871
+ /** Specifies how the entity's value is obtained. */
872
+ method?: string;
873
+ /** The name of the property. Follows the same guidelines as the EntityType name. */
874
+ name?: string;
875
+ /** Occurrence type limits the number of instances an entity type appears in the document. */
876
+ occurrenceType?: string;
877
+ /** Any additional metadata about the property can be added here. */
878
+ propertyMetadata?: GoogleCloudDocumentaiV1beta3PropertyMetadata;
879
+ /** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
880
+ valueType?: string;
881
+ }
882
+ interface GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata {
883
+ /** If true, on a given page, there can be multiple `document` annotations covering it. */
884
+ documentAllowMultipleLabels?: boolean;
885
+ /** If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */
886
+ documentSplitter?: boolean;
887
+ /** If set, all the nested entities must be prefixed with the parents. */
888
+ prefixedNamingOnProperties?: boolean;
889
+ /** 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. */
890
+ skipNamingValidation?: boolean;
891
+ }
553
892
  interface GoogleCloudDocumentaiV1beta3EnableProcessorMetadata {
554
893
  /** The basic metadata of the long-running operation. */
555
894
  commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
556
895
  }
557
896
  interface GoogleCloudDocumentaiV1beta3EnableProcessorResponse {}
897
+ interface GoogleCloudDocumentaiV1beta3EntityTypeMetadata {
898
+ /** Whether the entity type should be considered inactive. */
899
+ inactive?: boolean;
900
+ }
558
901
  interface GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata {
559
902
  /** The basic metadata of the long-running operation. */
560
903
  commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
@@ -563,6 +906,44 @@ declare namespace gapi.client {
563
906
  /** The resource name of the created evaluation. */
564
907
  evaluation?: string;
565
908
  }
909
+ interface GoogleCloudDocumentaiV1beta3EvaluationMetrics {
910
+ /** The calculated f1 score. */
911
+ f1Score?: number;
912
+ /** The amount of false negatives. */
913
+ falseNegativesCount?: number;
914
+ /** The amount of false positives. */
915
+ falsePositivesCount?: number;
916
+ /** The amount of documents with a ground truth occurrence. */
917
+ groundTruthDocumentCount?: number;
918
+ /** The amount of occurrences in ground truth documents. */
919
+ groundTruthOccurrencesCount?: number;
920
+ /** The calculated precision. */
921
+ precision?: number;
922
+ /** The amount of documents with a predicted occurrence. */
923
+ predictedDocumentCount?: number;
924
+ /** The amount of occurrences in predicted documents. */
925
+ predictedOccurrencesCount?: number;
926
+ /** The calculated recall. */
927
+ recall?: number;
928
+ /** The amount of documents that had an occurrence of this label. */
929
+ totalDocumentsCount?: number;
930
+ /** The amount of true positives. */
931
+ truePositivesCount?: number;
932
+ }
933
+ interface GoogleCloudDocumentaiV1beta3EvaluationReference {
934
+ /** An aggregate of the statistics for the evaluation with fuzzy matching on. */
935
+ aggregateMetrics?: GoogleCloudDocumentaiV1beta3EvaluationMetrics;
936
+ /** An aggregate of the statistics for the evaluation with fuzzy matching off. */
937
+ aggregateMetricsExact?: GoogleCloudDocumentaiV1beta3EvaluationMetrics;
938
+ /** The resource name of the evaluation. */
939
+ evaluation?: string;
940
+ /** The resource name of the Long Running Operation for the evaluation. */
941
+ operation?: string;
942
+ }
943
+ interface GoogleCloudDocumentaiV1beta3FieldExtractionMetadata {
944
+ /** Summary options config. */
945
+ summaryOptions?: GoogleCloudDocumentaiV1beta3SummaryOptions;
946
+ }
566
947
  interface GoogleCloudDocumentaiV1beta3GcsPrefix {
567
948
  /** The URI prefix. */
568
949
  gcsUriPrefix?: string;
@@ -608,22 +989,114 @@ declare namespace gapi.client {
608
989
  /** The destination processor version name. */
609
990
  processorVersion?: string;
610
991
  }
611
- interface GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata {
612
- /** The basic metadata of the long-running operation. */
613
- commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
614
- /** The creation time of the operation. */
992
+ interface GoogleCloudDocumentaiV1beta3Processor {
993
+ /** 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} */
994
+ activeSchemaVersion?: string;
995
+ /** Output only. The time the processor was created. */
615
996
  createTime?: string;
616
- /** The Crowd Compute question ID. */
617
- questionId?: string;
618
- /** Used only when Operation.done is false. */
619
- state?: string;
620
- /** A message providing more details about the current state of processing. For example, the error message if the operation is failed. */
621
- stateMessage?: string;
622
- /** The last update time of the operation. */
623
- updateTime?: string;
624
- }
625
- interface GoogleCloudDocumentaiV1beta3ReviewDocumentResponse {
626
- /** The Cloud Storage uri for the human reviewed document if the review is succeeded. */
997
+ /** The default processor version. */
998
+ defaultProcessorVersion?: string;
999
+ /** The display name of the processor. */
1000
+ displayName?: string;
1001
+ /** The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */
1002
+ kmsKeyName?: string;
1003
+ /** Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` */
1004
+ name?: string;
1005
+ /** Output only. Immutable. The http endpoint that can be called to invoke processing. */
1006
+ processEndpoint?: string;
1007
+ /** Output only. The processor version aliases. */
1008
+ processorVersionAliases?: GoogleCloudDocumentaiV1beta3ProcessorVersionAlias[];
1009
+ /** Output only. Reserved for future use. */
1010
+ satisfiesPzi?: boolean;
1011
+ /** Output only. Reserved for future use. */
1012
+ satisfiesPzs?: boolean;
1013
+ /** Output only. The state of the processor. */
1014
+ state?: string;
1015
+ /** The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */
1016
+ type?: string;
1017
+ }
1018
+ interface GoogleCloudDocumentaiV1beta3ProcessorVersion {
1019
+ /** Output only. The time the processor version was created. */
1020
+ createTime?: string;
1021
+ /** Output only. If set, information about the eventual deprecation of this version. */
1022
+ deprecationInfo?: GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo;
1023
+ /** The display name of the processor version. */
1024
+ displayName?: string;
1025
+ /** Output only. The schema of the processor version. Describes the output. */
1026
+ documentSchema?: GoogleCloudDocumentaiV1beta3DocumentSchema;
1027
+ /** Output only. Information about Generative AI model-based processor versions. */
1028
+ genAiModelInfo?: GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo;
1029
+ /** Output only. Denotes that this `ProcessorVersion` is managed by Google. */
1030
+ googleManaged?: boolean;
1031
+ /** Output only. The KMS key name used for encryption. */
1032
+ kmsKeyName?: string;
1033
+ /** Output only. The KMS key version with which data is encrypted. */
1034
+ kmsKeyVersionName?: string;
1035
+ /** Output only. The most recently invoked evaluation for the processor version. */
1036
+ latestEvaluation?: GoogleCloudDocumentaiV1beta3EvaluationReference;
1037
+ /** Output only. The model type of this processor version. */
1038
+ modelType?: string;
1039
+ /** Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` */
1040
+ name?: string;
1041
+ /** Output only. Reserved for future use. */
1042
+ satisfiesPzi?: boolean;
1043
+ /** Output only. Reserved for future use. */
1044
+ satisfiesPzs?: boolean;
1045
+ /** Output only. The state of the processor version. */
1046
+ state?: string;
1047
+ }
1048
+ interface GoogleCloudDocumentaiV1beta3ProcessorVersionAlias {
1049
+ /** The alias in the form of `processor_version` resource name. */
1050
+ alias?: string;
1051
+ /** The resource name of aliased processor version. */
1052
+ processorVersion?: string;
1053
+ }
1054
+ interface GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo {
1055
+ /** The time at which this processor version will be deprecated. */
1056
+ deprecationTime?: string;
1057
+ /** If set, the processor version that will be used as a replacement. */
1058
+ replacementProcessorVersion?: string;
1059
+ }
1060
+ interface GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo {
1061
+ /** Information for a custom Generative AI model created by the user. */
1062
+ customGenAiModelInfo?: GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo;
1063
+ /** Information for a pretrained Google-managed foundation model. */
1064
+ foundationGenAiModelInfo?: GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo;
1065
+ }
1066
+ interface GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo {
1067
+ /** The base processor version ID for the custom model. */
1068
+ baseProcessorVersionId?: string;
1069
+ /** The type of custom model created by the user. */
1070
+ customModelType?: string;
1071
+ }
1072
+ interface GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
1073
+ /** Whether finetuning is allowed for this base processor version. */
1074
+ finetuningAllowed?: boolean;
1075
+ /** The minimum number of labeled documents in the training dataset required for finetuning. */
1076
+ minTrainLabeledDocuments?: number;
1077
+ }
1078
+ interface GoogleCloudDocumentaiV1beta3PropertyMetadata {
1079
+ /** Field extraction metadata on the property. */
1080
+ fieldExtractionMetadata?: GoogleCloudDocumentaiV1beta3FieldExtractionMetadata;
1081
+ /** Whether the property should be considered as "inactive". */
1082
+ inactive?: boolean;
1083
+ }
1084
+ interface GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata {
1085
+ /** The basic metadata of the long-running operation. */
1086
+ commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
1087
+ /** The creation time of the operation. */
1088
+ createTime?: string;
1089
+ /** The Crowd Compute question ID. */
1090
+ questionId?: string;
1091
+ /** Used only when Operation.done is false. */
1092
+ state?: string;
1093
+ /** A message providing more details about the current state of processing. For example, the error message if the operation is failed. */
1094
+ stateMessage?: string;
1095
+ /** The last update time of the operation. */
1096
+ updateTime?: string;
1097
+ }
1098
+ interface GoogleCloudDocumentaiV1beta3ReviewDocumentResponse {
1099
+ /** The Cloud Storage uri for the human reviewed document if the review is succeeded. */
627
1100
  gcsDestination?: string;
628
1101
  /** The reason why the review is rejected by reviewer. */
629
1102
  rejectionReason?: string;
@@ -643,6 +1116,12 @@ declare namespace gapi.client {
643
1116
  commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
644
1117
  }
645
1118
  interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {}
1119
+ interface GoogleCloudDocumentaiV1beta3SummaryOptions {
1120
+ /** The format the summary should be in. */
1121
+ format?: string;
1122
+ /** How long the summary should be. */
1123
+ length?: string;
1124
+ }
646
1125
  interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata {
647
1126
  /** The basic metadata of the long-running operation. */
648
1127
  commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
@@ -674,6 +1153,10 @@ declare namespace gapi.client {
674
1153
  /** The basic metadata of the long-running operation. */
675
1154
  commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
676
1155
  }
1156
+ interface GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata {
1157
+ /** The basic metadata for the long-running operation. */
1158
+ commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
1159
+ }
677
1160
  interface GoogleCloudDocumentaiV1BoundingPoly {
678
1161
  /** The bounding polygon normalized vertices. */
679
1162
  normalizedVertices?: GoogleCloudDocumentaiV1NormalizedVertex[];
@@ -723,8 +1206,14 @@ declare namespace gapi.client {
723
1206
  documentLayout?: GoogleCloudDocumentaiV1DocumentDocumentLayout;
724
1207
  /** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
725
1208
  entities?: GoogleCloudDocumentaiV1DocumentEntity[];
1209
+ /** 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. */
1210
+ entitiesRevisionId?: string;
1211
+ /** 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. */
1212
+ entitiesRevisions?: GoogleCloudDocumentaiV1DocumentEntitiesRevision[];
726
1213
  /** Placeholder. Relationship among Document.entities. */
727
1214
  entityRelations?: GoogleCloudDocumentaiV1DocumentEntityRelation[];
1215
+ /** The entity validation output for the document. This is the validation output for `document.entities` field. */
1216
+ entityValidationOutput?: GoogleCloudDocumentaiV1DocumentEntityValidationOutput;
728
1217
  /** Any error that occurred while processing this document. */
729
1218
  error?: GoogleRpcStatus;
730
1219
  /** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
@@ -842,6 +1331,14 @@ declare namespace gapi.client {
842
1331
  /** Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. */
843
1332
  type?: string;
844
1333
  }
1334
+ interface GoogleCloudDocumentaiV1DocumentEntitiesRevision {
1335
+ /** The entities in this revision. */
1336
+ entities?: GoogleCloudDocumentaiV1DocumentEntity[];
1337
+ /** The entity validation output for this revision. */
1338
+ entityValidationOutput?: GoogleCloudDocumentaiV1DocumentEntityValidationOutput;
1339
+ /** The revision id. */
1340
+ revisionId?: string;
1341
+ }
845
1342
  interface GoogleCloudDocumentaiV1DocumentEntity {
846
1343
  /** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
847
1344
  confidence?: number;
@@ -883,6 +1380,7 @@ declare namespace gapi.client {
883
1380
  integerValue?: number;
884
1381
  /** Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */
885
1382
  moneyValue?: GoogleTypeMoney;
1383
+ /** A signature - a graphical representation of a person's name, often used to sign a document. */
886
1384
  signatureValue?: boolean;
887
1385
  /** 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. */
888
1386
  text?: string;
@@ -895,6 +1393,24 @@ declare namespace gapi.client {
895
1393
  /** Subject entity id. */
896
1394
  subjectId?: string;
897
1395
  }
1396
+ interface GoogleCloudDocumentaiV1DocumentEntityValidationOutput {
1397
+ /** The overall result of the validation, true if all applicable rules are valid. */
1398
+ passAllRules?: boolean;
1399
+ /** The result of each validation rule. */
1400
+ validationResults?: GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult[];
1401
+ }
1402
+ interface GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult {
1403
+ /** Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` */
1404
+ rule?: string;
1405
+ /** The description of the validation rule. */
1406
+ ruleDescription?: string;
1407
+ /** The display name of the validation rule. */
1408
+ ruleName?: string;
1409
+ /** The detailed information of the running the validation process using the entity from the document based on the validation rule. */
1410
+ validationDetails?: string;
1411
+ /** The result of the validation rule. */
1412
+ validationResultType?: string;
1413
+ }
898
1414
  interface GoogleCloudDocumentaiV1DocumentOutputConfig {
899
1415
  /** Output config to write the results to Cloud Storage. */
900
1416
  gcsOutputConfig?: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig;
@@ -1197,6 +1713,10 @@ declare namespace gapi.client {
1197
1713
  /** A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. */
1198
1714
  stateMessage?: string;
1199
1715
  }
1716
+ interface GoogleCloudDocumentaiV1Documents {
1717
+ /** The list of documents. */
1718
+ documents?: GoogleCloudDocumentaiV1Document[];
1719
+ }
1200
1720
  interface GoogleCloudDocumentaiV1DocumentSchema {
1201
1721
  /** Description of the schema. */
1202
1722
  description?: string;
@@ -1417,6 +1937,30 @@ declare namespace gapi.client {
1417
1937
  /** The URI prefix. */
1418
1938
  gcsUriPrefix?: string;
1419
1939
  }
1940
+ interface GoogleCloudDocumentaiV1GenerateSchemaVersionRequest {
1941
+ /** The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
1942
+ baseSchemaVersion?: string;
1943
+ /** The set of documents placed on Cloud Storage. */
1944
+ gcsDocuments?: GoogleCloudDocumentaiV1GcsDocuments;
1945
+ /** The common prefix of documents placed on Cloud Storage. */
1946
+ gcsPrefix?: GoogleCloudDocumentaiV1GcsPrefix;
1947
+ /** Optional. User specified parameters for the schema generation. */
1948
+ generateSchemaVersionParams?: GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams;
1949
+ /** The set of documents specified inline. */
1950
+ inlineDocuments?: GoogleCloudDocumentaiV1Documents;
1951
+ /** The set of raw documents. */
1952
+ rawDocuments?: GoogleCloudDocumentaiV1RawDocuments;
1953
+ }
1954
+ interface GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams {
1955
+ /** Optional. Previous prompt-answers in a chronological order. */
1956
+ history?: GoogleCloudDocumentaiV1SchemaGenerationHistory;
1957
+ /** Optional. The prompt used for the schema generation. */
1958
+ prompt?: string;
1959
+ }
1960
+ interface GoogleCloudDocumentaiV1GenerateSchemaVersionResponse {
1961
+ /** The schema version generated by the model. */
1962
+ schemaVersion?: GoogleCloudDocumentaiV1SchemaVersion;
1963
+ }
1420
1964
  interface GoogleCloudDocumentaiV1HumanReviewStatus {
1421
1965
  /** 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. */
1422
1966
  humanReviewOperation?: string;
@@ -1449,6 +1993,30 @@ declare namespace gapi.client {
1449
1993
  /** The list of processors. */
1450
1994
  processorVersions?: GoogleCloudDocumentaiV1ProcessorVersion[];
1451
1995
  }
1996
+ interface GoogleCloudDocumentaiV1ListSchemasResponse {
1997
+ /** Points to the next Schema, otherwise empty. */
1998
+ nextPageToken?: string;
1999
+ /** The list of Schemas. */
2000
+ schemas?: GoogleCloudDocumentaiV1NextSchema[];
2001
+ }
2002
+ interface GoogleCloudDocumentaiV1ListSchemaVersionsResponse {
2003
+ /** Points to the next SchemaVersion, otherwise empty. */
2004
+ nextPageToken?: string;
2005
+ /** The list of SchemaVersions. */
2006
+ schemaVersions?: GoogleCloudDocumentaiV1SchemaVersion[];
2007
+ }
2008
+ interface GoogleCloudDocumentaiV1NextSchema {
2009
+ /** Output only. The time when the Schema was created. */
2010
+ createTime?: string;
2011
+ /** Optional. The user-defined name of the Schema. */
2012
+ displayName?: string;
2013
+ /** Optional. The GCP labels for the Schema. */
2014
+ labels?: {[P in string]: string};
2015
+ /** Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
2016
+ name?: string;
2017
+ /** Output only. The time when the Schema was last updated. */
2018
+ updateTime?: string;
2019
+ }
1452
2020
  interface GoogleCloudDocumentaiV1NormalizedVertex {
1453
2021
  /** X coordinate. */
1454
2022
  x?: number;
@@ -1506,6 +2074,10 @@ declare namespace gapi.client {
1506
2074
  interface GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig {
1507
2075
  /** Optional. Config for chunking in layout parser processor. */
1508
2076
  chunkingConfig?: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig;
2077
+ /** Optional. Whether to include image annotations in layout parser response. */
2078
+ enableImageAnnotation?: boolean;
2079
+ /** Optional. Whether to include table annotations in layout parser response. */
2080
+ enableTableAnnotation?: boolean;
1509
2081
  /** Optional. Whether to include bounding boxes in layout parser processor response. */
1510
2082
  returnBoundingBoxes?: boolean;
1511
2083
  /** Optional. Whether to include images in layout parser processor response. */
@@ -1518,6 +2090,8 @@ declare namespace gapi.client {
1518
2090
  includeAncestorHeadings?: boolean;
1519
2091
  }
1520
2092
  interface GoogleCloudDocumentaiV1Processor {
2093
+ /** 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} */
2094
+ activeSchemaVersion?: string;
1521
2095
  /** Output only. The time the processor was created. */
1522
2096
  createTime?: string;
1523
2097
  /** The default processor version. */
@@ -1653,6 +2227,10 @@ declare namespace gapi.client {
1653
2227
  /** An IANA MIME type (RFC6838) indicating the nature and format of the content. */
1654
2228
  mimeType?: string;
1655
2229
  }
2230
+ interface GoogleCloudDocumentaiV1RawDocuments {
2231
+ /** Specifies raw document content and mime type. */
2232
+ documents?: GoogleCloudDocumentaiV1RawDocument[];
2233
+ }
1656
2234
  interface GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata {
1657
2235
  /** The basic metadata of the long-running operation. */
1658
2236
  commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
@@ -1677,6 +2255,30 @@ declare namespace gapi.client {
1677
2255
  /** The state of the review operation. */
1678
2256
  state?: string;
1679
2257
  }
2258
+ interface GoogleCloudDocumentaiV1SchemaGenerationHistory {
2259
+ /** Required. Previous prompt-answers in a chronological order. */
2260
+ iterations?: GoogleCloudDocumentaiV1SchemaGenerationIteration[];
2261
+ }
2262
+ interface GoogleCloudDocumentaiV1SchemaGenerationIteration {
2263
+ /** Optional. The previous schema version adjusted by the model. */
2264
+ adjustedSchema?: GoogleCloudDocumentaiV1SchemaVersion;
2265
+ /** Required. The schema version generated by the model. */
2266
+ generatedSchema?: GoogleCloudDocumentaiV1SchemaVersion;
2267
+ /** Optional. The prompt used for the iteration. */
2268
+ prompt?: string;
2269
+ }
2270
+ interface GoogleCloudDocumentaiV1SchemaVersion {
2271
+ /** Output only. The time when the SchemaVersion was created. */
2272
+ createTime?: string;
2273
+ /** Optional. The user-defined name of the SchemaVersion. */
2274
+ displayName?: string;
2275
+ /** Optional. The GCP labels for the SchemaVersion. */
2276
+ labels?: {[P in string]: string};
2277
+ /** Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
2278
+ name?: string;
2279
+ /** Required. The schema of the SchemaVersion. */
2280
+ schema?: GoogleCloudDocumentaiV1DocumentSchema;
2281
+ }
1680
2282
  interface GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata {
1681
2283
  /** The basic metadata of the long-running operation. */
1682
2284
  commonMetadata?: GoogleCloudDocumentaiV1CommonOperationMetadata;
@@ -2564,7 +3166,324 @@ declare namespace gapi.client {
2564
3166
  fields?: string;
2565
3167
  /** 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. */
2566
3168
  key?: string;
2567
- /** Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
3169
+ /** Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
3170
+ name: string;
3171
+ /** OAuth 2.0 token for the current user. */
3172
+ oauth_token?: string;
3173
+ /** Returns response with indentations and line breaks. */
3174
+ prettyPrint?: boolean;
3175
+ /** 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. */
3176
+ quotaUser?: string;
3177
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3178
+ upload_protocol?: string;
3179
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3180
+ uploadType?: string;
3181
+ /** Request body */
3182
+ resource: GoogleCloudDocumentaiV1BatchProcessRequest;
3183
+ }): Request<GoogleLongrunningOperation>;
3184
+ batchProcess(
3185
+ request: {
3186
+ /** V1 error format. */
3187
+ '$.xgafv'?: string;
3188
+ /** OAuth access token. */
3189
+ access_token?: string;
3190
+ /** Data format for response. */
3191
+ alt?: string;
3192
+ /** JSONP */
3193
+ callback?: string;
3194
+ /** Selector specifying which fields to include in a partial response. */
3195
+ fields?: string;
3196
+ /** 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. */
3197
+ key?: string;
3198
+ /** Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
3199
+ name: string;
3200
+ /** OAuth 2.0 token for the current user. */
3201
+ oauth_token?: string;
3202
+ /** Returns response with indentations and line breaks. */
3203
+ prettyPrint?: boolean;
3204
+ /** 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. */
3205
+ quotaUser?: string;
3206
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3207
+ upload_protocol?: string;
3208
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3209
+ uploadType?: string;
3210
+ },
3211
+ body: GoogleCloudDocumentaiV1BatchProcessRequest,
3212
+ ): Request<GoogleLongrunningOperation>;
3213
+ /** Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default after its creation. Note that this method requires the `documentai.processors.create` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project. */
3214
+ create(request: {
3215
+ /** V1 error format. */
3216
+ '$.xgafv'?: string;
3217
+ /** OAuth access token. */
3218
+ access_token?: string;
3219
+ /** Data format for response. */
3220
+ alt?: string;
3221
+ /** JSONP */
3222
+ callback?: string;
3223
+ /** Selector specifying which fields to include in a partial response. */
3224
+ fields?: string;
3225
+ /** 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. */
3226
+ key?: string;
3227
+ /** OAuth 2.0 token for the current user. */
3228
+ oauth_token?: string;
3229
+ /** Required. The parent (project and location) under which to create the processor. Format: `projects/{project}/locations/{location}` */
3230
+ parent: string;
3231
+ /** Returns response with indentations and line breaks. */
3232
+ prettyPrint?: boolean;
3233
+ /** 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. */
3234
+ quotaUser?: string;
3235
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3236
+ upload_protocol?: string;
3237
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3238
+ uploadType?: string;
3239
+ /** Request body */
3240
+ resource: GoogleCloudDocumentaiV1Processor;
3241
+ }): Request<GoogleCloudDocumentaiV1Processor>;
3242
+ create(
3243
+ request: {
3244
+ /** V1 error format. */
3245
+ '$.xgafv'?: string;
3246
+ /** OAuth access token. */
3247
+ access_token?: string;
3248
+ /** Data format for response. */
3249
+ alt?: string;
3250
+ /** JSONP */
3251
+ callback?: string;
3252
+ /** Selector specifying which fields to include in a partial response. */
3253
+ fields?: string;
3254
+ /** 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. */
3255
+ key?: string;
3256
+ /** OAuth 2.0 token for the current user. */
3257
+ oauth_token?: string;
3258
+ /** Required. The parent (project and location) under which to create the processor. Format: `projects/{project}/locations/{location}` */
3259
+ parent: string;
3260
+ /** Returns response with indentations and line breaks. */
3261
+ prettyPrint?: boolean;
3262
+ /** 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. */
3263
+ quotaUser?: string;
3264
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3265
+ upload_protocol?: string;
3266
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3267
+ uploadType?: string;
3268
+ },
3269
+ body: GoogleCloudDocumentaiV1Processor,
3270
+ ): Request<GoogleCloudDocumentaiV1Processor>;
3271
+ /** Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. */
3272
+ delete(request?: {
3273
+ /** V1 error format. */
3274
+ '$.xgafv'?: string;
3275
+ /** OAuth access token. */
3276
+ access_token?: string;
3277
+ /** Data format for response. */
3278
+ alt?: string;
3279
+ /** JSONP */
3280
+ callback?: string;
3281
+ /** Selector specifying which fields to include in a partial response. */
3282
+ fields?: string;
3283
+ /** 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. */
3284
+ key?: string;
3285
+ /** Required. The processor resource name to be deleted. */
3286
+ name: string;
3287
+ /** OAuth 2.0 token for the current user. */
3288
+ oauth_token?: string;
3289
+ /** Returns response with indentations and line breaks. */
3290
+ prettyPrint?: boolean;
3291
+ /** 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. */
3292
+ quotaUser?: string;
3293
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3294
+ upload_protocol?: string;
3295
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3296
+ uploadType?: string;
3297
+ }): Request<GoogleLongrunningOperation>;
3298
+ /** Disables a processor */
3299
+ disable(request: {
3300
+ /** V1 error format. */
3301
+ '$.xgafv'?: string;
3302
+ /** OAuth access token. */
3303
+ access_token?: string;
3304
+ /** Data format for response. */
3305
+ alt?: string;
3306
+ /** JSONP */
3307
+ callback?: string;
3308
+ /** Selector specifying which fields to include in a partial response. */
3309
+ fields?: string;
3310
+ /** 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. */
3311
+ key?: string;
3312
+ /** Required. The processor resource name to be disabled. */
3313
+ name: string;
3314
+ /** OAuth 2.0 token for the current user. */
3315
+ oauth_token?: string;
3316
+ /** Returns response with indentations and line breaks. */
3317
+ prettyPrint?: boolean;
3318
+ /** 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. */
3319
+ quotaUser?: string;
3320
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3321
+ upload_protocol?: string;
3322
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3323
+ uploadType?: string;
3324
+ /** Request body */
3325
+ resource: GoogleCloudDocumentaiV1DisableProcessorRequest;
3326
+ }): Request<GoogleLongrunningOperation>;
3327
+ disable(
3328
+ request: {
3329
+ /** V1 error format. */
3330
+ '$.xgafv'?: string;
3331
+ /** OAuth access token. */
3332
+ access_token?: string;
3333
+ /** Data format for response. */
3334
+ alt?: string;
3335
+ /** JSONP */
3336
+ callback?: string;
3337
+ /** Selector specifying which fields to include in a partial response. */
3338
+ fields?: string;
3339
+ /** 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. */
3340
+ key?: string;
3341
+ /** Required. The processor resource name to be disabled. */
3342
+ name: string;
3343
+ /** OAuth 2.0 token for the current user. */
3344
+ oauth_token?: string;
3345
+ /** Returns response with indentations and line breaks. */
3346
+ prettyPrint?: boolean;
3347
+ /** 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. */
3348
+ quotaUser?: string;
3349
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3350
+ upload_protocol?: string;
3351
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3352
+ uploadType?: string;
3353
+ },
3354
+ body: GoogleCloudDocumentaiV1DisableProcessorRequest,
3355
+ ): Request<GoogleLongrunningOperation>;
3356
+ /** Enables a processor */
3357
+ enable(request: {
3358
+ /** V1 error format. */
3359
+ '$.xgafv'?: string;
3360
+ /** OAuth access token. */
3361
+ access_token?: string;
3362
+ /** Data format for response. */
3363
+ alt?: string;
3364
+ /** JSONP */
3365
+ callback?: string;
3366
+ /** Selector specifying which fields to include in a partial response. */
3367
+ fields?: string;
3368
+ /** 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. */
3369
+ key?: string;
3370
+ /** Required. The processor resource name to be enabled. */
3371
+ name: string;
3372
+ /** OAuth 2.0 token for the current user. */
3373
+ oauth_token?: string;
3374
+ /** Returns response with indentations and line breaks. */
3375
+ prettyPrint?: boolean;
3376
+ /** 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. */
3377
+ quotaUser?: string;
3378
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3379
+ upload_protocol?: string;
3380
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3381
+ uploadType?: string;
3382
+ /** Request body */
3383
+ resource: GoogleCloudDocumentaiV1EnableProcessorRequest;
3384
+ }): Request<GoogleLongrunningOperation>;
3385
+ enable(
3386
+ request: {
3387
+ /** V1 error format. */
3388
+ '$.xgafv'?: string;
3389
+ /** OAuth access token. */
3390
+ access_token?: string;
3391
+ /** Data format for response. */
3392
+ alt?: string;
3393
+ /** JSONP */
3394
+ callback?: string;
3395
+ /** Selector specifying which fields to include in a partial response. */
3396
+ fields?: string;
3397
+ /** 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. */
3398
+ key?: string;
3399
+ /** Required. The processor resource name to be enabled. */
3400
+ name: string;
3401
+ /** OAuth 2.0 token for the current user. */
3402
+ oauth_token?: string;
3403
+ /** Returns response with indentations and line breaks. */
3404
+ prettyPrint?: boolean;
3405
+ /** 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. */
3406
+ quotaUser?: string;
3407
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3408
+ upload_protocol?: string;
3409
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3410
+ uploadType?: string;
3411
+ },
3412
+ body: GoogleCloudDocumentaiV1EnableProcessorRequest,
3413
+ ): Request<GoogleLongrunningOperation>;
3414
+ /** Gets a processor detail. */
3415
+ get(request?: {
3416
+ /** V1 error format. */
3417
+ '$.xgafv'?: string;
3418
+ /** OAuth access token. */
3419
+ access_token?: string;
3420
+ /** Data format for response. */
3421
+ alt?: string;
3422
+ /** JSONP */
3423
+ callback?: string;
3424
+ /** Selector specifying which fields to include in a partial response. */
3425
+ fields?: string;
3426
+ /** 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. */
3427
+ key?: string;
3428
+ /** Required. The processor resource name. */
3429
+ name: string;
3430
+ /** OAuth 2.0 token for the current user. */
3431
+ oauth_token?: string;
3432
+ /** Returns response with indentations and line breaks. */
3433
+ prettyPrint?: boolean;
3434
+ /** 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. */
3435
+ quotaUser?: string;
3436
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3437
+ upload_protocol?: string;
3438
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3439
+ uploadType?: string;
3440
+ }): Request<GoogleCloudDocumentaiV1Processor>;
3441
+ /** Lists all processors which belong to this project. */
3442
+ list(request?: {
3443
+ /** V1 error format. */
3444
+ '$.xgafv'?: string;
3445
+ /** OAuth access token. */
3446
+ access_token?: string;
3447
+ /** Data format for response. */
3448
+ alt?: string;
3449
+ /** JSONP */
3450
+ callback?: string;
3451
+ /** Selector specifying which fields to include in a partial response. */
3452
+ fields?: string;
3453
+ /** 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. */
3454
+ key?: string;
3455
+ /** OAuth 2.0 token for the current user. */
3456
+ oauth_token?: string;
3457
+ /** 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`. */
3458
+ pageSize?: number;
3459
+ /** We will return the processors sorted by creation time. The page token will point to the next processor. */
3460
+ pageToken?: string;
3461
+ /** Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project}/locations/{location}` */
3462
+ parent: string;
3463
+ /** Returns response with indentations and line breaks. */
3464
+ prettyPrint?: boolean;
3465
+ /** 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. */
3466
+ quotaUser?: string;
3467
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3468
+ upload_protocol?: string;
3469
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3470
+ uploadType?: string;
3471
+ }): Request<GoogleCloudDocumentaiV1ListProcessorsResponse>;
3472
+ /** Processes a single document. */
3473
+ process(request: {
3474
+ /** V1 error format. */
3475
+ '$.xgafv'?: string;
3476
+ /** OAuth access token. */
3477
+ access_token?: string;
3478
+ /** Data format for response. */
3479
+ alt?: string;
3480
+ /** JSONP */
3481
+ callback?: string;
3482
+ /** Selector specifying which fields to include in a partial response. */
3483
+ fields?: string;
3484
+ /** 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. */
3485
+ key?: string;
3486
+ /** 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: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
2568
3487
  name: string;
2569
3488
  /** OAuth 2.0 token for the current user. */
2570
3489
  oauth_token?: string;
@@ -2577,9 +3496,9 @@ declare namespace gapi.client {
2577
3496
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2578
3497
  uploadType?: string;
2579
3498
  /** Request body */
2580
- resource: GoogleCloudDocumentaiV1BatchProcessRequest;
2581
- }): Request<GoogleLongrunningOperation>;
2582
- batchProcess(
3499
+ resource: GoogleCloudDocumentaiV1ProcessRequest;
3500
+ }): Request<GoogleCloudDocumentaiV1ProcessResponse>;
3501
+ process(
2583
3502
  request: {
2584
3503
  /** V1 error format. */
2585
3504
  '$.xgafv'?: string;
@@ -2593,7 +3512,7 @@ declare namespace gapi.client {
2593
3512
  fields?: string;
2594
3513
  /** 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
3514
  key?: string;
2596
- /** Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
3515
+ /** 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: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
2597
3516
  name: string;
2598
3517
  /** OAuth 2.0 token for the current user. */
2599
3518
  oauth_token?: string;
@@ -2606,10 +3525,10 @@ declare namespace gapi.client {
2606
3525
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2607
3526
  uploadType?: string;
2608
3527
  },
2609
- body: GoogleCloudDocumentaiV1BatchProcessRequest,
2610
- ): Request<GoogleLongrunningOperation>;
2611
- /** Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default after its creation. Note that this method requires the `documentai.processors.create` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project. */
2612
- create(request: {
3528
+ body: GoogleCloudDocumentaiV1ProcessRequest,
3529
+ ): Request<GoogleCloudDocumentaiV1ProcessResponse>;
3530
+ /** Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments. */
3531
+ setDefaultProcessorVersion(request: {
2613
3532
  /** V1 error format. */
2614
3533
  '$.xgafv'?: string;
2615
3534
  /** OAuth access token. */
@@ -2624,10 +3543,10 @@ declare namespace gapi.client {
2624
3543
  key?: string;
2625
3544
  /** OAuth 2.0 token for the current user. */
2626
3545
  oauth_token?: string;
2627
- /** Required. The parent (project and location) under which to create the processor. Format: `projects/{project}/locations/{location}` */
2628
- parent: string;
2629
3546
  /** Returns response with indentations and line breaks. */
2630
3547
  prettyPrint?: boolean;
3548
+ /** Required. The resource name of the Processor to change default version. */
3549
+ processor: string;
2631
3550
  /** 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. */
2632
3551
  quotaUser?: string;
2633
3552
  /** Upload protocol for media (e.g. "raw", "multipart"). */
@@ -2635,9 +3554,9 @@ declare namespace gapi.client {
2635
3554
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2636
3555
  uploadType?: string;
2637
3556
  /** Request body */
2638
- resource: GoogleCloudDocumentaiV1Processor;
2639
- }): Request<GoogleCloudDocumentaiV1Processor>;
2640
- create(
3557
+ resource: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest;
3558
+ }): Request<GoogleLongrunningOperation>;
3559
+ setDefaultProcessorVersion(
2641
3560
  request: {
2642
3561
  /** V1 error format. */
2643
3562
  '$.xgafv'?: string;
@@ -2653,10 +3572,10 @@ declare namespace gapi.client {
2653
3572
  key?: string;
2654
3573
  /** OAuth 2.0 token for the current user. */
2655
3574
  oauth_token?: string;
2656
- /** Required. The parent (project and location) under which to create the processor. Format: `projects/{project}/locations/{location}` */
2657
- parent: string;
2658
3575
  /** Returns response with indentations and line breaks. */
2659
3576
  prettyPrint?: boolean;
3577
+ /** Required. The resource name of the Processor to change default version. */
3578
+ processor: string;
2660
3579
  /** 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. */
2661
3580
  quotaUser?: string;
2662
3581
  /** Upload protocol for media (e.g. "raw", "multipart"). */
@@ -2664,10 +3583,14 @@ declare namespace gapi.client {
2664
3583
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2665
3584
  uploadType?: string;
2666
3585
  },
2667
- body: GoogleCloudDocumentaiV1Processor,
2668
- ): Request<GoogleCloudDocumentaiV1Processor>;
2669
- /** Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. */
2670
- delete(request?: {
3586
+ body: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest,
3587
+ ): Request<GoogleLongrunningOperation>;
3588
+ humanReviewConfig: HumanReviewConfigResource;
3589
+ processorVersions: ProcessorVersionsResource;
3590
+ }
3591
+ interface ProcessorTypesResource {
3592
+ /** Gets a processor type detail. */
3593
+ get(request?: {
2671
3594
  /** V1 error format. */
2672
3595
  '$.xgafv'?: string;
2673
3596
  /** OAuth access token. */
@@ -2680,7 +3603,7 @@ declare namespace gapi.client {
2680
3603
  fields?: string;
2681
3604
  /** 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. */
2682
3605
  key?: string;
2683
- /** Required. The processor resource name to be deleted. */
3606
+ /** Required. The processor type resource name. */
2684
3607
  name: string;
2685
3608
  /** OAuth 2.0 token for the current user. */
2686
3609
  oauth_token?: string;
@@ -2692,9 +3615,42 @@ declare namespace gapi.client {
2692
3615
  upload_protocol?: string;
2693
3616
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2694
3617
  uploadType?: string;
2695
- }): Request<GoogleLongrunningOperation>;
2696
- /** Disables a processor */
2697
- disable(request: {
3618
+ }): Request<GoogleCloudDocumentaiV1ProcessorType>;
3619
+ /** Lists the processor types that exist. */
3620
+ list(request?: {
3621
+ /** V1 error format. */
3622
+ '$.xgafv'?: string;
3623
+ /** OAuth access token. */
3624
+ access_token?: string;
3625
+ /** Data format for response. */
3626
+ alt?: string;
3627
+ /** JSONP */
3628
+ callback?: string;
3629
+ /** Selector specifying which fields to include in a partial response. */
3630
+ fields?: string;
3631
+ /** 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. */
3632
+ key?: string;
3633
+ /** OAuth 2.0 token for the current user. */
3634
+ oauth_token?: string;
3635
+ /** 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`. */
3636
+ pageSize?: number;
3637
+ /** Used to retrieve the next page of results, empty if at the end of the list. */
3638
+ pageToken?: string;
3639
+ /** Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`. */
3640
+ parent: string;
3641
+ /** Returns response with indentations and line breaks. */
3642
+ prettyPrint?: boolean;
3643
+ /** 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. */
3644
+ quotaUser?: string;
3645
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3646
+ upload_protocol?: string;
3647
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3648
+ uploadType?: string;
3649
+ }): Request<GoogleCloudDocumentaiV1ListProcessorTypesResponse>;
3650
+ }
3651
+ interface SchemaVersionsResource {
3652
+ /** Creates a schema version. */
3653
+ create(request: {
2698
3654
  /** V1 error format. */
2699
3655
  '$.xgafv'?: string;
2700
3656
  /** OAuth access token. */
@@ -2707,10 +3663,10 @@ declare namespace gapi.client {
2707
3663
  fields?: string;
2708
3664
  /** 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. */
2709
3665
  key?: string;
2710
- /** Required. The processor resource name to be disabled. */
2711
- name: string;
2712
3666
  /** OAuth 2.0 token for the current user. */
2713
3667
  oauth_token?: string;
3668
+ /** Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
3669
+ parent: string;
2714
3670
  /** Returns response with indentations and line breaks. */
2715
3671
  prettyPrint?: boolean;
2716
3672
  /** 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. */
@@ -2720,9 +3676,9 @@ declare namespace gapi.client {
2720
3676
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2721
3677
  uploadType?: string;
2722
3678
  /** Request body */
2723
- resource: GoogleCloudDocumentaiV1DisableProcessorRequest;
2724
- }): Request<GoogleLongrunningOperation>;
2725
- disable(
3679
+ resource: GoogleCloudDocumentaiV1SchemaVersion;
3680
+ }): Request<GoogleCloudDocumentaiV1SchemaVersion>;
3681
+ create(
2726
3682
  request: {
2727
3683
  /** V1 error format. */
2728
3684
  '$.xgafv'?: string;
@@ -2736,10 +3692,10 @@ declare namespace gapi.client {
2736
3692
  fields?: string;
2737
3693
  /** 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. */
2738
3694
  key?: string;
2739
- /** Required. The processor resource name to be disabled. */
2740
- name: string;
2741
3695
  /** OAuth 2.0 token for the current user. */
2742
3696
  oauth_token?: string;
3697
+ /** Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
3698
+ parent: string;
2743
3699
  /** Returns response with indentations and line breaks. */
2744
3700
  prettyPrint?: boolean;
2745
3701
  /** 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. */
@@ -2749,10 +3705,10 @@ declare namespace gapi.client {
2749
3705
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2750
3706
  uploadType?: string;
2751
3707
  },
2752
- body: GoogleCloudDocumentaiV1DisableProcessorRequest,
2753
- ): Request<GoogleLongrunningOperation>;
2754
- /** Enables a processor */
2755
- enable(request: {
3708
+ body: GoogleCloudDocumentaiV1SchemaVersion,
3709
+ ): Request<GoogleCloudDocumentaiV1SchemaVersion>;
3710
+ /** Deletes a schema version. */
3711
+ delete(request?: {
2756
3712
  /** V1 error format. */
2757
3713
  '$.xgafv'?: string;
2758
3714
  /** OAuth access token. */
@@ -2765,7 +3721,7 @@ declare namespace gapi.client {
2765
3721
  fields?: string;
2766
3722
  /** 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. */
2767
3723
  key?: string;
2768
- /** Required. The processor resource name to be enabled. */
3724
+ /** Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
2769
3725
  name: string;
2770
3726
  /** OAuth 2.0 token for the current user. */
2771
3727
  oauth_token?: string;
@@ -2777,10 +3733,37 @@ declare namespace gapi.client {
2777
3733
  upload_protocol?: string;
2778
3734
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2779
3735
  uploadType?: string;
2780
- /** Request body */
2781
- resource: GoogleCloudDocumentaiV1EnableProcessorRequest;
2782
3736
  }): Request<GoogleLongrunningOperation>;
2783
- enable(
3737
+ /** Generates a schema version. */
3738
+ generate(request: {
3739
+ /** V1 error format. */
3740
+ '$.xgafv'?: string;
3741
+ /** OAuth access token. */
3742
+ access_token?: string;
3743
+ /** Data format for response. */
3744
+ alt?: string;
3745
+ /** JSONP */
3746
+ callback?: string;
3747
+ /** Selector specifying which fields to include in a partial response. */
3748
+ fields?: string;
3749
+ /** 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. */
3750
+ key?: string;
3751
+ /** OAuth 2.0 token for the current user. */
3752
+ oauth_token?: string;
3753
+ /** Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
3754
+ parent: string;
3755
+ /** Returns response with indentations and line breaks. */
3756
+ prettyPrint?: boolean;
3757
+ /** 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. */
3758
+ quotaUser?: string;
3759
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3760
+ upload_protocol?: string;
3761
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3762
+ uploadType?: string;
3763
+ /** Request body */
3764
+ resource: GoogleCloudDocumentaiV1GenerateSchemaVersionRequest;
3765
+ }): Request<GoogleCloudDocumentaiV1GenerateSchemaVersionResponse>;
3766
+ generate(
2784
3767
  request: {
2785
3768
  /** V1 error format. */
2786
3769
  '$.xgafv'?: string;
@@ -2794,10 +3777,10 @@ declare namespace gapi.client {
2794
3777
  fields?: string;
2795
3778
  /** 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. */
2796
3779
  key?: string;
2797
- /** Required. The processor resource name to be enabled. */
2798
- name: string;
2799
3780
  /** OAuth 2.0 token for the current user. */
2800
3781
  oauth_token?: string;
3782
+ /** Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
3783
+ parent: string;
2801
3784
  /** Returns response with indentations and line breaks. */
2802
3785
  prettyPrint?: boolean;
2803
3786
  /** 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. */
@@ -2807,9 +3790,9 @@ declare namespace gapi.client {
2807
3790
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2808
3791
  uploadType?: string;
2809
3792
  },
2810
- body: GoogleCloudDocumentaiV1EnableProcessorRequest,
2811
- ): Request<GoogleLongrunningOperation>;
2812
- /** Gets a processor detail. */
3793
+ body: GoogleCloudDocumentaiV1GenerateSchemaVersionRequest,
3794
+ ): Request<GoogleCloudDocumentaiV1GenerateSchemaVersionResponse>;
3795
+ /** Gets a schema version. */
2813
3796
  get(request?: {
2814
3797
  /** V1 error format. */
2815
3798
  '$.xgafv'?: string;
@@ -2823,7 +3806,7 @@ declare namespace gapi.client {
2823
3806
  fields?: string;
2824
3807
  /** 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. */
2825
3808
  key?: string;
2826
- /** Required. The processor resource name. */
3809
+ /** Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
2827
3810
  name: string;
2828
3811
  /** OAuth 2.0 token for the current user. */
2829
3812
  oauth_token?: string;
@@ -2835,8 +3818,8 @@ declare namespace gapi.client {
2835
3818
  upload_protocol?: string;
2836
3819
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2837
3820
  uploadType?: string;
2838
- }): Request<GoogleCloudDocumentaiV1Processor>;
2839
- /** Lists all processors which belong to this project. */
3821
+ }): Request<GoogleCloudDocumentaiV1SchemaVersion>;
3822
+ /** Lists SchemaVersions. */
2840
3823
  list(request?: {
2841
3824
  /** V1 error format. */
2842
3825
  '$.xgafv'?: string;
@@ -2852,11 +3835,11 @@ declare namespace gapi.client {
2852
3835
  key?: string;
2853
3836
  /** OAuth 2.0 token for the current user. */
2854
3837
  oauth_token?: string;
2855
- /** 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`. */
3838
+ /** 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`. */
2856
3839
  pageSize?: number;
2857
- /** We will return the processors sorted by creation time. The page token will point to the next processor. */
3840
+ /** Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion. */
2858
3841
  pageToken?: string;
2859
- /** Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project}/locations/{location}` */
3842
+ /** Required. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
2860
3843
  parent: string;
2861
3844
  /** Returns response with indentations and line breaks. */
2862
3845
  prettyPrint?: boolean;
@@ -2866,9 +3849,9 @@ declare namespace gapi.client {
2866
3849
  upload_protocol?: string;
2867
3850
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2868
3851
  uploadType?: string;
2869
- }): Request<GoogleCloudDocumentaiV1ListProcessorsResponse>;
2870
- /** Processes a single document. */
2871
- process(request: {
3852
+ }): Request<GoogleCloudDocumentaiV1ListSchemaVersionsResponse>;
3853
+ /** Updates a schema version. Editable fields are: - `display_name` - `labels` */
3854
+ patch(request: {
2872
3855
  /** V1 error format. */
2873
3856
  '$.xgafv'?: string;
2874
3857
  /** OAuth access token. */
@@ -2881,7 +3864,7 @@ declare namespace gapi.client {
2881
3864
  fields?: string;
2882
3865
  /** 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. */
2883
3866
  key?: string;
2884
- /** 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: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
3867
+ /** Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
2885
3868
  name: string;
2886
3869
  /** OAuth 2.0 token for the current user. */
2887
3870
  oauth_token?: string;
@@ -2889,14 +3872,16 @@ declare namespace gapi.client {
2889
3872
  prettyPrint?: boolean;
2890
3873
  /** 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. */
2891
3874
  quotaUser?: string;
3875
+ /** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
3876
+ updateMask?: string;
2892
3877
  /** Upload protocol for media (e.g. "raw", "multipart"). */
2893
3878
  upload_protocol?: string;
2894
3879
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2895
3880
  uploadType?: string;
2896
3881
  /** Request body */
2897
- resource: GoogleCloudDocumentaiV1ProcessRequest;
2898
- }): Request<GoogleCloudDocumentaiV1ProcessResponse>;
2899
- process(
3882
+ resource: GoogleCloudDocumentaiV1SchemaVersion;
3883
+ }): Request<GoogleCloudDocumentaiV1SchemaVersion>;
3884
+ patch(
2900
3885
  request: {
2901
3886
  /** V1 error format. */
2902
3887
  '$.xgafv'?: string;
@@ -2910,7 +3895,7 @@ declare namespace gapi.client {
2910
3895
  fields?: string;
2911
3896
  /** 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. */
2912
3897
  key?: string;
2913
- /** 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: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
3898
+ /** Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
2914
3899
  name: string;
2915
3900
  /** OAuth 2.0 token for the current user. */
2916
3901
  oauth_token?: string;
@@ -2918,15 +3903,19 @@ declare namespace gapi.client {
2918
3903
  prettyPrint?: boolean;
2919
3904
  /** 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. */
2920
3905
  quotaUser?: string;
3906
+ /** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
3907
+ updateMask?: string;
2921
3908
  /** Upload protocol for media (e.g. "raw", "multipart"). */
2922
3909
  upload_protocol?: string;
2923
3910
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2924
3911
  uploadType?: string;
2925
3912
  },
2926
- body: GoogleCloudDocumentaiV1ProcessRequest,
2927
- ): Request<GoogleCloudDocumentaiV1ProcessResponse>;
2928
- /** Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments. */
2929
- setDefaultProcessorVersion(request: {
3913
+ body: GoogleCloudDocumentaiV1SchemaVersion,
3914
+ ): Request<GoogleCloudDocumentaiV1SchemaVersion>;
3915
+ }
3916
+ interface SchemasResource {
3917
+ /** Creates a schema. */
3918
+ create(request: {
2930
3919
  /** V1 error format. */
2931
3920
  '$.xgafv'?: string;
2932
3921
  /** OAuth access token. */
@@ -2941,10 +3930,10 @@ declare namespace gapi.client {
2941
3930
  key?: string;
2942
3931
  /** OAuth 2.0 token for the current user. */
2943
3932
  oauth_token?: string;
3933
+ /** Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}` */
3934
+ parent: string;
2944
3935
  /** Returns response with indentations and line breaks. */
2945
3936
  prettyPrint?: boolean;
2946
- /** Required. The resource name of the Processor to change default version. */
2947
- processor: string;
2948
3937
  /** 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. */
2949
3938
  quotaUser?: string;
2950
3939
  /** Upload protocol for media (e.g. "raw", "multipart"). */
@@ -2952,9 +3941,9 @@ declare namespace gapi.client {
2952
3941
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2953
3942
  uploadType?: string;
2954
3943
  /** Request body */
2955
- resource: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest;
2956
- }): Request<GoogleLongrunningOperation>;
2957
- setDefaultProcessorVersion(
3944
+ resource: GoogleCloudDocumentaiV1NextSchema;
3945
+ }): Request<GoogleCloudDocumentaiV1NextSchema>;
3946
+ create(
2958
3947
  request: {
2959
3948
  /** V1 error format. */
2960
3949
  '$.xgafv'?: string;
@@ -2970,10 +3959,10 @@ declare namespace gapi.client {
2970
3959
  key?: string;
2971
3960
  /** OAuth 2.0 token for the current user. */
2972
3961
  oauth_token?: string;
3962
+ /** Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}` */
3963
+ parent: string;
2973
3964
  /** Returns response with indentations and line breaks. */
2974
3965
  prettyPrint?: boolean;
2975
- /** Required. The resource name of the Processor to change default version. */
2976
- processor: string;
2977
3966
  /** 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. */
2978
3967
  quotaUser?: string;
2979
3968
  /** Upload protocol for media (e.g. "raw", "multipart"). */
@@ -2981,13 +3970,38 @@ declare namespace gapi.client {
2981
3970
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2982
3971
  uploadType?: string;
2983
3972
  },
2984
- body: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest,
2985
- ): Request<GoogleLongrunningOperation>;
2986
- humanReviewConfig: HumanReviewConfigResource;
2987
- processorVersions: ProcessorVersionsResource;
2988
- }
2989
- interface ProcessorTypesResource {
2990
- /** Gets a processor type detail. */
3973
+ body: GoogleCloudDocumentaiV1NextSchema,
3974
+ ): Request<GoogleCloudDocumentaiV1NextSchema>;
3975
+ /** Deletes a schema. */
3976
+ delete(request?: {
3977
+ /** V1 error format. */
3978
+ '$.xgafv'?: string;
3979
+ /** OAuth access token. */
3980
+ access_token?: string;
3981
+ /** Data format for response. */
3982
+ alt?: string;
3983
+ /** JSONP */
3984
+ callback?: string;
3985
+ /** Selector specifying which fields to include in a partial response. */
3986
+ fields?: string;
3987
+ /** 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.) */
3988
+ force?: boolean;
3989
+ /** 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. */
3990
+ key?: string;
3991
+ /** Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
3992
+ name: string;
3993
+ /** OAuth 2.0 token for the current user. */
3994
+ oauth_token?: string;
3995
+ /** Returns response with indentations and line breaks. */
3996
+ prettyPrint?: boolean;
3997
+ /** 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. */
3998
+ quotaUser?: string;
3999
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4000
+ upload_protocol?: string;
4001
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4002
+ uploadType?: string;
4003
+ }): Request<GoogleLongrunningOperation>;
4004
+ /** Gets a schema. */
2991
4005
  get(request?: {
2992
4006
  /** V1 error format. */
2993
4007
  '$.xgafv'?: string;
@@ -3001,7 +4015,7 @@ declare namespace gapi.client {
3001
4015
  fields?: string;
3002
4016
  /** 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. */
3003
4017
  key?: string;
3004
- /** Required. The processor type resource name. */
4018
+ /** Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
3005
4019
  name: string;
3006
4020
  /** OAuth 2.0 token for the current user. */
3007
4021
  oauth_token?: string;
@@ -3013,8 +4027,8 @@ declare namespace gapi.client {
3013
4027
  upload_protocol?: string;
3014
4028
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3015
4029
  uploadType?: string;
3016
- }): Request<GoogleCloudDocumentaiV1ProcessorType>;
3017
- /** Lists the processor types that exist. */
4030
+ }): Request<GoogleCloudDocumentaiV1NextSchema>;
4031
+ /** Lists Schemas. */
3018
4032
  list(request?: {
3019
4033
  /** V1 error format. */
3020
4034
  '$.xgafv'?: string;
@@ -3030,11 +4044,11 @@ declare namespace gapi.client {
3030
4044
  key?: string;
3031
4045
  /** OAuth 2.0 token for the current user. */
3032
4046
  oauth_token?: string;
3033
- /** 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`. */
4047
+ /** 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`. */
3034
4048
  pageSize?: number;
3035
- /** Used to retrieve the next page of results, empty if at the end of the list. */
4049
+ /** Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema. */
3036
4050
  pageToken?: string;
3037
- /** Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`. */
4051
+ /** Required. Format: `projects/{project}/locations/{location}` */
3038
4052
  parent: string;
3039
4053
  /** Returns response with indentations and line breaks. */
3040
4054
  prettyPrint?: boolean;
@@ -3044,7 +4058,70 @@ declare namespace gapi.client {
3044
4058
  upload_protocol?: string;
3045
4059
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3046
4060
  uploadType?: string;
3047
- }): Request<GoogleCloudDocumentaiV1ListProcessorTypesResponse>;
4061
+ }): Request<GoogleCloudDocumentaiV1ListSchemasResponse>;
4062
+ /** Updates a schema. Editable fields are: - `display_name` - `labels` */
4063
+ patch(request: {
4064
+ /** V1 error format. */
4065
+ '$.xgafv'?: string;
4066
+ /** OAuth access token. */
4067
+ access_token?: string;
4068
+ /** Data format for response. */
4069
+ alt?: string;
4070
+ /** JSONP */
4071
+ callback?: string;
4072
+ /** Selector specifying which fields to include in a partial response. */
4073
+ fields?: string;
4074
+ /** 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. */
4075
+ key?: string;
4076
+ /** Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
4077
+ name: string;
4078
+ /** OAuth 2.0 token for the current user. */
4079
+ oauth_token?: string;
4080
+ /** Returns response with indentations and line breaks. */
4081
+ prettyPrint?: boolean;
4082
+ /** 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. */
4083
+ quotaUser?: string;
4084
+ /** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
4085
+ updateMask?: string;
4086
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4087
+ upload_protocol?: string;
4088
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4089
+ uploadType?: string;
4090
+ /** Request body */
4091
+ resource: GoogleCloudDocumentaiV1NextSchema;
4092
+ }): Request<GoogleCloudDocumentaiV1NextSchema>;
4093
+ patch(
4094
+ request: {
4095
+ /** V1 error format. */
4096
+ '$.xgafv'?: string;
4097
+ /** OAuth access token. */
4098
+ access_token?: string;
4099
+ /** Data format for response. */
4100
+ alt?: string;
4101
+ /** JSONP */
4102
+ callback?: string;
4103
+ /** Selector specifying which fields to include in a partial response. */
4104
+ fields?: string;
4105
+ /** 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. */
4106
+ key?: string;
4107
+ /** Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
4108
+ name: string;
4109
+ /** OAuth 2.0 token for the current user. */
4110
+ oauth_token?: string;
4111
+ /** Returns response with indentations and line breaks. */
4112
+ prettyPrint?: boolean;
4113
+ /** 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. */
4114
+ quotaUser?: string;
4115
+ /** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
4116
+ updateMask?: string;
4117
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4118
+ upload_protocol?: string;
4119
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4120
+ uploadType?: string;
4121
+ },
4122
+ body: GoogleCloudDocumentaiV1NextSchema,
4123
+ ): Request<GoogleCloudDocumentaiV1NextSchema>;
4124
+ schemaVersions: SchemaVersionsResource;
3048
4125
  }
3049
4126
  interface LocationsResource {
3050
4127
  /** Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated. */
@@ -3111,7 +4188,7 @@ declare namespace gapi.client {
3111
4188
  alt?: string;
3112
4189
  /** JSONP */
3113
4190
  callback?: string;
3114
- /** Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */
4191
+ /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
3115
4192
  extraLocationTypes?: string | string[];
3116
4193
  /** Selector specifying which fields to include in a partial response. */
3117
4194
  fields?: string;
@@ -3139,6 +4216,7 @@ declare namespace gapi.client {
3139
4216
  operations: OperationsResource;
3140
4217
  processors: ProcessorsResource;
3141
4218
  processorTypes: ProcessorTypesResource;
4219
+ schemas: SchemasResource;
3142
4220
  }
3143
4221
  interface OperationsResource {
3144
4222
  /** 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. */