@maxim_mazurok/gapi.client.documentai-v1 0.1.20260309 → 0.1.20260601

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 (3) hide show
  1. package/index.d.ts +462 -180
  2. package/package.json +1 -1
  3. package/readme.md +12 -0
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: 20260309
12
+ // Revision: 20260601
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -41,7 +41,10 @@ declare namespace gapi.client {
41
41
  ruleId?: string;
42
42
  }
43
43
  interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule {
44
- alignmentType?: string;
44
+ alignmentType?:
45
+ | 'ALIGNMENT_TYPE_UNSPECIFIED'
46
+ | 'ALIGNMENT_TYPE_HORIZONTAL'
47
+ | 'ALIGNMENT_TYPE_VERTICAL';
45
48
  /** The tolerance to use when comparing coordinates. */
46
49
  tolerance?: number;
47
50
  }
@@ -83,7 +86,14 @@ declare namespace gapi.client {
83
86
  leftOperand?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation;
84
87
  rightOperand?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation;
85
88
  /** The relational operator to be applied to the operands. */
86
- validationOperator?: string;
89
+ validationOperator?:
90
+ | 'OPERATION_TYPE_UNSPECIFIED'
91
+ | 'OPERATION_TYPE_EQ'
92
+ | 'OPERATION_TYPE_NE'
93
+ | 'OPERATION_TYPE_LT'
94
+ | 'OPERATION_TYPE_LE'
95
+ | 'OPERATION_TYPE_GT'
96
+ | 'OPERATION_TYPE_GE';
87
97
  }
88
98
  interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation {
89
99
  /** A list of constants to be used as operands. */
@@ -93,7 +103,17 @@ declare namespace gapi.client {
93
103
  /** A list of recursive operations to be used as operands. */
94
104
  operations?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation[];
95
105
  /** The operation type to be applied to all the operands. */
96
- operationType?: string;
106
+ operationType?:
107
+ | 'OPERATION_TYPE_UNSPECIFIED'
108
+ | 'OPERATION_TYPE_SUM'
109
+ | 'OPERATION_TYPE_SUB'
110
+ | 'OPERATION_TYPE_MUL'
111
+ | 'OPERATION_TYPE_DIV'
112
+ | 'OPERATION_TYPE_MAX'
113
+ | 'OPERATION_TYPE_MIN'
114
+ | 'OPERATION_TYPE_ABS'
115
+ | 'OPERATION_TYPE_UNIQUE'
116
+ | 'OPERATION_TYPE_COUNT';
97
117
  }
98
118
  interface GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata {
99
119
  /** The basic metadata of the long-running operation. */
@@ -131,9 +151,17 @@ declare namespace gapi.client {
131
151
  /** The basic metadata of the long-running operation. */
132
152
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
133
153
  /** The destination dataset split type. */
134
- destDatasetType?: string;
154
+ destDatasetType?:
155
+ | 'DATASET_SPLIT_TYPE_UNSPECIFIED'
156
+ | 'DATASET_SPLIT_TRAIN'
157
+ | 'DATASET_SPLIT_TEST'
158
+ | 'DATASET_SPLIT_UNASSIGNED';
135
159
  /** The destination dataset split type. */
136
- destSplitType?: string;
160
+ destSplitType?:
161
+ | 'DATASET_SPLIT_TYPE_UNSPECIFIED'
162
+ | 'DATASET_SPLIT_TRAIN'
163
+ | 'DATASET_SPLIT_TEST'
164
+ | 'DATASET_SPLIT_UNASSIGNED';
137
165
  /** The list of response details of each document. */
138
166
  individualBatchMoveStatuses?: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus[];
139
167
  }
@@ -163,7 +191,13 @@ declare namespace gapi.client {
163
191
  /** A related resource to this operation. */
164
192
  resource?: string;
165
193
  /** The state of the operation. */
166
- state?: string;
194
+ state?:
195
+ | 'STATE_UNSPECIFIED'
196
+ | 'RUNNING'
197
+ | 'CANCELLING'
198
+ | 'SUCCEEDED'
199
+ | 'FAILED'
200
+ | 'CANCELLED';
167
201
  /** A message providing more details about the current state of processing. */
168
202
  stateMessage?: string;
169
203
  /** The last update time of the operation. */
@@ -251,11 +285,16 @@ declare namespace gapi.client {
251
285
  /** User defined name for the property. */
252
286
  displayName?: string;
253
287
  /** Specifies how the entity's value is obtained. */
254
- method?: string;
288
+ method?: 'METHOD_UNSPECIFIED' | 'EXTRACT' | 'DERIVE' | 'RELAXED_EXTRACT';
255
289
  /** The name of the property. Follows the same guidelines as the EntityType name. */
256
290
  name?: string;
257
291
  /** Occurrence type limits the number of instances an entity type appears in the document. */
258
- occurrenceType?: string;
292
+ occurrenceType?:
293
+ | 'OCCURRENCE_TYPE_UNSPECIFIED'
294
+ | 'OPTIONAL_ONCE'
295
+ | 'OPTIONAL_MULTIPLE'
296
+ | 'REQUIRED_ONCE'
297
+ | 'REQUIRED_MULTIPLE';
259
298
  /** Any additional metadata about the property can be added here. */
260
299
  propertyMetadata?: GoogleCloudDocumentaiUiv1beta3PropertyMetadata;
261
300
  /** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
@@ -350,7 +389,11 @@ declare namespace gapi.client {
350
389
  }
351
390
  interface GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat {
352
391
  /** The dataset split type. */
353
- splitType?: string;
392
+ splitType?:
393
+ | 'DATASET_SPLIT_TYPE_UNSPECIFIED'
394
+ | 'DATASET_SPLIT_TRAIN'
395
+ | 'DATASET_SPLIT_TEST'
396
+ | 'DATASET_SPLIT_UNASSIGNED';
354
397
  /** Total number of documents with the given dataset split type to be exported. */
355
398
  totalDocumentCount?: number;
356
399
  }
@@ -444,7 +487,15 @@ declare namespace gapi.client {
444
487
  /** Output only. Reserved for future use. */
445
488
  satisfiesPzs?: boolean;
446
489
  /** Output only. The state of the processor. */
447
- state?: string;
490
+ state?:
491
+ | 'STATE_UNSPECIFIED'
492
+ | 'ENABLED'
493
+ | 'DISABLED'
494
+ | 'ENABLING'
495
+ | 'DISABLING'
496
+ | 'CREATING'
497
+ | 'FAILED'
498
+ | 'DELETING';
448
499
  /** The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */
449
500
  type?: string;
450
501
  }
@@ -470,7 +521,10 @@ declare namespace gapi.client {
470
521
  /** Output only. The most recently invoked evaluation for the processor version. */
471
522
  latestEvaluation?: GoogleCloudDocumentaiUiv1beta3EvaluationReference;
472
523
  /** Output only. The model type of this processor version. */
473
- modelType?: string;
524
+ modelType?:
525
+ | 'MODEL_TYPE_UNSPECIFIED'
526
+ | 'MODEL_TYPE_GENERATIVE'
527
+ | 'MODEL_TYPE_CUSTOM';
474
528
  /** Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` */
475
529
  name?: string;
476
530
  /** Output only. Reserved for future use. */
@@ -480,7 +534,16 @@ declare namespace gapi.client {
480
534
  /** The schema of the processor version. Describes the output. */
481
535
  schema?: GoogleCloudDocumentaiUiv1beta3Schema;
482
536
  /** Output only. The state of the processor version. */
483
- state?: string;
537
+ state?:
538
+ | 'STATE_UNSPECIFIED'
539
+ | 'DEPLOYED'
540
+ | 'DEPLOYING'
541
+ | 'UNDEPLOYED'
542
+ | 'UNDEPLOYING'
543
+ | 'CREATING'
544
+ | 'DELETING'
545
+ | 'FAILED'
546
+ | 'IMPORTING';
484
547
  }
485
548
  interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias {
486
549
  /** The alias in the form of `processor_version` resource name. */
@@ -504,7 +567,10 @@ declare namespace gapi.client {
504
567
  /** The base processor version ID for the custom model. */
505
568
  baseProcessorVersionId?: string;
506
569
  /** The type of custom model created by the user. */
507
- customModelType?: string;
570
+ customModelType?:
571
+ | 'CUSTOM_MODEL_TYPE_UNSPECIFIED'
572
+ | 'VERSIONED_FOUNDATION'
573
+ | 'FINE_TUNED';
508
574
  }
509
575
  interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
510
576
  /** Whether fine tuning is allowed for this base processor version. */
@@ -538,7 +604,9 @@ declare namespace gapi.client {
538
604
  }
539
605
  interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus {
540
606
  /** The type of the inconsistency of the dataset. */
541
- datasetInconsistencyType?: string;
607
+ datasetInconsistencyType?:
608
+ | 'DATASET_INCONSISTENCY_TYPE_UNSPECIFIED'
609
+ | 'DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER';
542
610
  /** The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`. */
543
611
  status?: GoogleRpcStatus;
544
612
  }
@@ -546,7 +614,11 @@ declare namespace gapi.client {
546
614
  /** The document identifier. */
547
615
  documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
548
616
  /** The type of document inconsistency. */
549
- documentInconsistencyType?: string;
617
+ documentInconsistencyType?:
618
+ | 'DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED'
619
+ | 'DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO'
620
+ | 'DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA'
621
+ | 'DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE';
550
622
  /** The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`. */
551
623
  status?: GoogleRpcStatus;
552
624
  }
@@ -555,7 +627,11 @@ declare namespace gapi.client {
555
627
  /** Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
556
628
  latestProcessorVersion?: string;
557
629
  /** Reads the revision by the predefined case. */
558
- revisionCase?: string;
630
+ revisionCase?:
631
+ | 'REVISION_CASE_UNSPECIFIED'
632
+ | 'LATEST_HUMAN_REVIEW'
633
+ | 'LATEST_TIMESTAMP'
634
+ | 'BASE_OCR_REVISION';
559
635
  /** Reads the revision given by the id. */
560
636
  revisionId?: string;
561
637
  }
@@ -598,13 +674,18 @@ declare namespace gapi.client {
598
674
  /** If the entity type is hidden in the schema. This provides the functionality to temporally "disable" an entity without deleting it. */
599
675
  hide?: boolean;
600
676
  /** Specifies how the entity's value is obtained. */
601
- method?: string;
677
+ method?: 'METHOD_UNSPECIFIED' | 'EXTRACT' | 'DERIVE' | 'RELAXED_EXTRACT';
602
678
  /** Occurrence type limits the number of times an entity type appears in the document. */
603
- occurrenceType?: string;
679
+ occurrenceType?:
680
+ | 'OCCURRENCE_TYPE_UNSPECIFIED'
681
+ | 'OPTIONAL_ONCE'
682
+ | 'OPTIONAL_MULTIPLE'
683
+ | 'REQUIRED_ONCE'
684
+ | 'REQUIRED_MULTIPLE';
604
685
  /** 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. */
605
686
  properties?: GoogleCloudDocumentaiUiv1beta3SchemaEntityType[];
606
687
  /** Source of this entity type. */
607
- source?: string;
688
+ source?: 'SOURCE_UNSPECIFIED' | 'PREDEFINED' | 'USER_INPUT';
608
689
  /** 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. */
609
690
  type?: string;
610
691
  }
@@ -619,9 +700,9 @@ declare namespace gapi.client {
619
700
  interface GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse {}
620
701
  interface GoogleCloudDocumentaiUiv1beta3SummaryOptions {
621
702
  /** The format the summary should be in. */
622
- format?: string;
703
+ format?: 'FORMAT_UNSPECIFIED' | 'PARAGRAPH' | 'BULLETS';
623
704
  /** How long the summary should be. */
624
- length?: string;
705
+ length?: 'LENGTH_UNSPECIFIED' | 'BRIEF' | 'MODERATE' | 'COMPREHENSIVE';
625
706
  }
626
707
  interface GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata {
627
708
  /** The basic metadata of the long-running operation. */
@@ -686,7 +767,14 @@ declare namespace gapi.client {
686
767
  /** The list of response details of each document. */
687
768
  individualProcessStatuses?: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus[];
688
769
  /** The state of the current batch processing. */
689
- state?: string;
770
+ state?:
771
+ | 'STATE_UNSPECIFIED'
772
+ | 'WAITING'
773
+ | 'RUNNING'
774
+ | 'SUCCEEDED'
775
+ | 'CANCELLING'
776
+ | 'CANCELLED'
777
+ | 'FAILED';
690
778
  /** A message providing more details about the current state of processing. For example, the error message if the operation is failed. */
691
779
  stateMessage?: string;
692
780
  /** The last update time of the operation. */
@@ -738,7 +826,14 @@ declare namespace gapi.client {
738
826
  /** The list of response details of each document. */
739
827
  individualProcessStatuses?: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus[];
740
828
  /** The state of the current batch processing. */
741
- state?: string;
829
+ state?:
830
+ | 'STATE_UNSPECIFIED'
831
+ | 'WAITING'
832
+ | 'RUNNING'
833
+ | 'SUCCEEDED'
834
+ | 'CANCELLING'
835
+ | 'CANCELLED'
836
+ | 'FAILED';
742
837
  /** A message providing more details about the current state of processing. For example, the error message if the operation is failed. */
743
838
  stateMessage?: string;
744
839
  /** The last update time of the operation. */
@@ -763,7 +858,13 @@ declare namespace gapi.client {
763
858
  /** A related resource to this operation. */
764
859
  resource?: string;
765
860
  /** The state of the operation. */
766
- state?: string;
861
+ state?:
862
+ | 'STATE_UNSPECIFIED'
863
+ | 'RUNNING'
864
+ | 'CANCELLING'
865
+ | 'SUCCEEDED'
866
+ | 'FAILED'
867
+ | 'CANCELLED';
767
868
  /** A message providing more details about the current state of processing. */
768
869
  stateMessage?: string;
769
870
  /** The last update time of the operation. */
@@ -781,7 +882,11 @@ declare namespace gapi.client {
781
882
  /** Output only. Reserved for future use. */
782
883
  satisfiesPzs?: boolean;
783
884
  /** Required. State of the dataset. Ignored when updating dataset. */
784
- state?: string;
885
+ state?:
886
+ | 'STATE_UNSPECIFIED'
887
+ | 'UNINITIALIZED'
888
+ | 'INITIALIZING'
889
+ | 'INITIALIZED';
785
890
  /** Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed). */
786
891
  unmanagedDatasetConfig?: any;
787
892
  }
@@ -870,11 +975,16 @@ declare namespace gapi.client {
870
975
  /** User defined name for the property. */
871
976
  displayName?: string;
872
977
  /** Specifies how the entity's value is obtained. */
873
- method?: string;
978
+ method?: 'METHOD_UNSPECIFIED' | 'EXTRACT' | 'DERIVE' | 'RELAXED_EXTRACT';
874
979
  /** The name of the property. Follows the same guidelines as the EntityType name. */
875
980
  name?: string;
876
981
  /** Occurrence type limits the number of instances an entity type appears in the document. */
877
- occurrenceType?: string;
982
+ occurrenceType?:
983
+ | 'OCCURRENCE_TYPE_UNSPECIFIED'
984
+ | 'OPTIONAL_ONCE'
985
+ | 'OPTIONAL_MULTIPLE'
986
+ | 'REQUIRED_ONCE'
987
+ | 'REQUIRED_MULTIPLE';
878
988
  /** Any additional metadata about the property can be added here. */
879
989
  propertyMetadata?: GoogleCloudDocumentaiV1beta3PropertyMetadata;
880
990
  /** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
@@ -953,7 +1063,12 @@ declare namespace gapi.client {
953
1063
  /** 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. */
954
1064
  humanReviewOperation?: string;
955
1065
  /** The state of human review on the processing request. */
956
- state?: string;
1066
+ state?:
1067
+ | 'STATE_UNSPECIFIED'
1068
+ | 'SKIPPED'
1069
+ | 'VALIDATION_PASSED'
1070
+ | 'IN_PROGRESS'
1071
+ | 'ERROR';
957
1072
  /** A message providing more details about the human review state. */
958
1073
  stateMessage?: string;
959
1074
  }
@@ -1012,7 +1127,15 @@ declare namespace gapi.client {
1012
1127
  /** Output only. Reserved for future use. */
1013
1128
  satisfiesPzs?: boolean;
1014
1129
  /** Output only. The state of the processor. */
1015
- state?: string;
1130
+ state?:
1131
+ | 'STATE_UNSPECIFIED'
1132
+ | 'ENABLED'
1133
+ | 'DISABLED'
1134
+ | 'ENABLING'
1135
+ | 'DISABLING'
1136
+ | 'CREATING'
1137
+ | 'FAILED'
1138
+ | 'DELETING';
1016
1139
  /** The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */
1017
1140
  type?: string;
1018
1141
  }
@@ -1036,7 +1159,10 @@ declare namespace gapi.client {
1036
1159
  /** Output only. The most recently invoked evaluation for the processor version. */
1037
1160
  latestEvaluation?: GoogleCloudDocumentaiV1beta3EvaluationReference;
1038
1161
  /** Output only. The model type of this processor version. */
1039
- modelType?: string;
1162
+ modelType?:
1163
+ | 'MODEL_TYPE_UNSPECIFIED'
1164
+ | 'MODEL_TYPE_GENERATIVE'
1165
+ | 'MODEL_TYPE_CUSTOM';
1040
1166
  /** Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` */
1041
1167
  name?: string;
1042
1168
  /** Output only. Reserved for future use. */
@@ -1044,7 +1170,16 @@ declare namespace gapi.client {
1044
1170
  /** Output only. Reserved for future use. */
1045
1171
  satisfiesPzs?: boolean;
1046
1172
  /** Output only. The state of the processor version. */
1047
- state?: string;
1173
+ state?:
1174
+ | 'STATE_UNSPECIFIED'
1175
+ | 'DEPLOYED'
1176
+ | 'DEPLOYING'
1177
+ | 'UNDEPLOYED'
1178
+ | 'UNDEPLOYING'
1179
+ | 'CREATING'
1180
+ | 'DELETING'
1181
+ | 'FAILED'
1182
+ | 'IMPORTING';
1048
1183
  }
1049
1184
  interface GoogleCloudDocumentaiV1beta3ProcessorVersionAlias {
1050
1185
  /** The alias in the form of `processor_version` resource name. */
@@ -1068,7 +1203,10 @@ declare namespace gapi.client {
1068
1203
  /** The base processor version ID for the custom model. */
1069
1204
  baseProcessorVersionId?: string;
1070
1205
  /** The type of custom model created by the user. */
1071
- customModelType?: string;
1206
+ customModelType?:
1207
+ | 'CUSTOM_MODEL_TYPE_UNSPECIFIED'
1208
+ | 'VERSIONED_FOUNDATION'
1209
+ | 'FINE_TUNED';
1072
1210
  }
1073
1211
  interface GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
1074
1212
  /** Whether fine tuning is allowed for this base processor version. */
@@ -1090,7 +1228,13 @@ declare namespace gapi.client {
1090
1228
  /** The Crowd Compute question ID. */
1091
1229
  questionId?: string;
1092
1230
  /** Used only when Operation.done is false. */
1093
- state?: string;
1231
+ state?:
1232
+ | 'STATE_UNSPECIFIED'
1233
+ | 'RUNNING'
1234
+ | 'CANCELLING'
1235
+ | 'SUCCEEDED'
1236
+ | 'FAILED'
1237
+ | 'CANCELLED';
1094
1238
  /** A message providing more details about the current state of processing. For example, the error message if the operation is failed. */
1095
1239
  stateMessage?: string;
1096
1240
  /** The last update time of the operation. */
@@ -1102,13 +1246,17 @@ declare namespace gapi.client {
1102
1246
  /** The reason why the review is rejected by reviewer. */
1103
1247
  rejectionReason?: string;
1104
1248
  /** The state of the review operation. */
1105
- state?: string;
1249
+ state?: 'STATE_UNSPECIFIED' | 'REJECTED' | 'SUCCEEDED';
1106
1250
  }
1107
1251
  interface GoogleCloudDocumentaiV1beta3RevisionRef {
1108
1252
  /** Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
1109
1253
  latestProcessorVersion?: string;
1110
1254
  /** Reads the revision by the predefined case. */
1111
- revisionCase?: string;
1255
+ revisionCase?:
1256
+ | 'REVISION_CASE_UNSPECIFIED'
1257
+ | 'LATEST_HUMAN_REVIEW'
1258
+ | 'LATEST_TIMESTAMP'
1259
+ | 'BASE_OCR_REVISION';
1112
1260
  /** Reads the revision given by the id. */
1113
1261
  revisionId?: string;
1114
1262
  }
@@ -1119,9 +1267,9 @@ declare namespace gapi.client {
1119
1267
  interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {}
1120
1268
  interface GoogleCloudDocumentaiV1beta3SummaryOptions {
1121
1269
  /** The format the summary should be in. */
1122
- format?: string;
1270
+ format?: 'FORMAT_UNSPECIFIED' | 'PARAGRAPH' | 'BULLETS';
1123
1271
  /** How long the summary should be. */
1124
- length?: string;
1272
+ length?: 'LENGTH_UNSPECIFIED' | 'BRIEF' | 'MODERATE' | 'COMPREHENSIVE';
1125
1273
  }
1126
1274
  interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata {
1127
1275
  /** The basic metadata of the long-running operation. */
@@ -1170,7 +1318,13 @@ declare namespace gapi.client {
1170
1318
  /** A related resource to this operation. */
1171
1319
  resource?: string;
1172
1320
  /** The state of the operation. */
1173
- state?: string;
1321
+ state?:
1322
+ | 'STATE_UNSPECIFIED'
1323
+ | 'RUNNING'
1324
+ | 'CANCELLING'
1325
+ | 'SUCCEEDED'
1326
+ | 'FAILED'
1327
+ | 'CANCELLED';
1174
1328
  /** A message providing more details about the current state of processing. */
1175
1329
  stateMessage?: string;
1176
1330
  /** The last update time of the operation. */
@@ -1197,6 +1351,8 @@ declare namespace gapi.client {
1197
1351
  interface GoogleCloudDocumentaiV1DisableProcessorRequest {}
1198
1352
  interface GoogleCloudDocumentaiV1DisableProcessorResponse {}
1199
1353
  interface GoogleCloudDocumentaiV1Document {
1354
+ /** Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. */
1355
+ blobAssets?: GoogleCloudDocumentaiV1DocumentBlobAsset[];
1200
1356
  /** Document chunked based on chunking config. */
1201
1357
  chunkedDocument?: GoogleCloudDocumentaiV1DocumentChunkedDocument;
1202
1358
  /** Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */
@@ -1234,11 +1390,25 @@ declare namespace gapi.client {
1234
1390
  /** Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). */
1235
1391
  uri?: string;
1236
1392
  }
1393
+ interface GoogleCloudDocumentaiV1DocumentAnnotations {
1394
+ /** The description of the content with this annotation. */
1395
+ description?: string;
1396
+ }
1397
+ interface GoogleCloudDocumentaiV1DocumentBlobAsset {
1398
+ /** Optional. The id of the blob asset. */
1399
+ assetId?: string;
1400
+ /** Optional. The content of the blob asset, for example, image bytes. */
1401
+ content?: string;
1402
+ /** The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
1403
+ mimeType?: string;
1404
+ }
1237
1405
  interface GoogleCloudDocumentaiV1DocumentChunkedDocument {
1238
1406
  /** List of chunks. */
1239
1407
  chunks?: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk[];
1240
1408
  }
1241
1409
  interface GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk {
1410
+ /** Chunk fields inside this chunk. */
1411
+ chunkFields?: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField[];
1242
1412
  /** ID of the chunk. */
1243
1413
  chunkId?: string;
1244
1414
  /** Text content of the chunk. */
@@ -1252,6 +1422,12 @@ declare namespace gapi.client {
1252
1422
  /** Unused. */
1253
1423
  sourceBlockIds?: string[];
1254
1424
  }
1425
+ interface GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkField {
1426
+ /** The image chunk field in the chunk. */
1427
+ imageChunkField?: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField;
1428
+ /** The table chunk field in the chunk. */
1429
+ tableChunkField?: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField;
1430
+ }
1255
1431
  interface GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter {
1256
1432
  /** Page span of the footer. */
1257
1433
  pageSpan?: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan;
@@ -1270,6 +1446,20 @@ declare namespace gapi.client {
1270
1446
  /** Page where chunk starts in the document. */
1271
1447
  pageStart?: number;
1272
1448
  }
1449
+ interface GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField {
1450
+ /** Annotation of the image chunk field. */
1451
+ annotations?: GoogleCloudDocumentaiV1DocumentAnnotations;
1452
+ /** Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. */
1453
+ blobAssetId?: string;
1454
+ /** Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, */
1455
+ dataUri?: string;
1456
+ /** Optional. Google Cloud Storage uri of the image. */
1457
+ gcsUri?: string;
1458
+ }
1459
+ interface GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField {
1460
+ /** Annotation of the table chunk field. */
1461
+ annotations?: GoogleCloudDocumentaiV1DocumentAnnotations;
1462
+ }
1273
1463
  interface GoogleCloudDocumentaiV1DocumentDocumentLayout {
1274
1464
  /** List of blocks in the document. */
1275
1465
  blocks?: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[];
@@ -1279,6 +1469,8 @@ declare namespace gapi.client {
1279
1469
  blockId?: string;
1280
1470
  /** Identifies the bounding box for the block. */
1281
1471
  boundingBox?: GoogleCloudDocumentaiV1BoundingPoly;
1472
+ /** Block consisting of image content. */
1473
+ imageBlock?: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock;
1282
1474
  /** Block consisting of list content/structure. */
1283
1475
  listBlock?: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock;
1284
1476
  /** Page span of the block. */
@@ -1288,6 +1480,20 @@ declare namespace gapi.client {
1288
1480
  /** Block consisting of text content. */
1289
1481
  textBlock?: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock;
1290
1482
  }
1483
+ interface GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock {
1484
+ /** Annotation of the image block. */
1485
+ annotations?: GoogleCloudDocumentaiV1DocumentAnnotations;
1486
+ /** Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. */
1487
+ blobAssetId?: string;
1488
+ /** Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, */
1489
+ dataUri?: string;
1490
+ /** Optional. Google Cloud Storage uri of the image. */
1491
+ gcsUri?: string;
1492
+ /** Text extracted from the image using OCR or alt text describing the image. */
1493
+ imageText?: string;
1494
+ /** Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). */
1495
+ mimeType?: string;
1496
+ }
1291
1497
  interface GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock {
1292
1498
  /** List entries that constitute a list block. */
1293
1499
  listEntries?: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[];
@@ -1305,6 +1511,8 @@ declare namespace gapi.client {
1305
1511
  pageStart?: number;
1306
1512
  }
1307
1513
  interface GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock {
1514
+ /** Annotation of the table block. */
1515
+ annotations?: GoogleCloudDocumentaiV1DocumentAnnotations;
1308
1516
  /** Body rows containing main table content. */
1309
1517
  bodyRows?: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[];
1310
1518
  /** Table caption/title. */
@@ -1325,6 +1533,8 @@ declare namespace gapi.client {
1325
1533
  cells?: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[];
1326
1534
  }
1327
1535
  interface GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock {
1536
+ /** Annotation of the text block. */
1537
+ annotations?: GoogleCloudDocumentaiV1DocumentAnnotations;
1328
1538
  /** A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. */
1329
1539
  blocks?: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[];
1330
1540
  /** Text content stored in the block. */
@@ -1352,7 +1562,7 @@ declare namespace gapi.client {
1352
1562
  /** Optional. Text value of the entity, for example, `1600 Amphitheatre Pkwy`. */
1353
1563
  mentionText?: string;
1354
1564
  /** Optional. Specifies how the entity's value is obtained. */
1355
- method?: string;
1565
+ method?: 'METHOD_UNSPECIFIED' | 'EXTRACT' | 'DERIVE';
1356
1566
  /** Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (for example, address) is not supported for certain parsers. This field is also only populated for certain supported document types. */
1357
1567
  normalizedValue?: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue;
1358
1568
  /** Optional. Represents the provenance of this entity wrt. the location on the page where it was found. */
@@ -1412,7 +1622,12 @@ declare namespace gapi.client {
1412
1622
  /** The detailed information of the running the validation process using the entity from the document based on the validation rule. */
1413
1623
  validationDetails?: string;
1414
1624
  /** The result of the validation rule. */
1415
- validationResultType?: string;
1625
+ validationResultType?:
1626
+ | 'VALIDATION_RESULT_TYPE_UNSPECIFIED'
1627
+ | 'VALIDATION_RESULT_TYPE_VALID'
1628
+ | 'VALIDATION_RESULT_TYPE_INVALID'
1629
+ | 'VALIDATION_RESULT_TYPE_SKIPPED'
1630
+ | 'VALIDATION_RESULT_TYPE_NOT_APPLICABLE';
1416
1631
  }
1417
1632
  interface GoogleCloudDocumentaiV1DocumentOutputConfig {
1418
1633
  /** Output config to write the results to Cloud Storage. */
@@ -1480,7 +1695,15 @@ declare namespace gapi.client {
1480
1695
  /** Optional. Deprecated. Use PageRef.bounding_poly instead. */
1481
1696
  layoutId?: string;
1482
1697
  /** Optional. The type of the layout element that is being referenced if any. */
1483
- layoutType?: string;
1698
+ layoutType?:
1699
+ | 'LAYOUT_TYPE_UNSPECIFIED'
1700
+ | 'BLOCK'
1701
+ | 'PARAGRAPH'
1702
+ | 'LINE'
1703
+ | 'TOKEN'
1704
+ | 'VISUAL_ELEMENT'
1705
+ | 'TABLE'
1706
+ | 'FORM_FIELD';
1484
1707
  /** Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. */
1485
1708
  page?: string;
1486
1709
  }
@@ -1558,7 +1781,12 @@ declare namespace gapi.client {
1558
1781
  /** Confidence of the current Layout within context of the object this layout is for. For example, confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. */
1559
1782
  confidence?: number;
1560
1783
  /** Detected orientation for the Layout. */
1561
- orientation?: string;
1784
+ orientation?:
1785
+ | 'ORIENTATION_UNSPECIFIED'
1786
+ | 'PAGE_UP'
1787
+ | 'PAGE_RIGHT'
1788
+ | 'PAGE_DOWN'
1789
+ | 'PAGE_LEFT';
1562
1790
  /** Text anchor indexing into the Document.text. */
1563
1791
  textAnchor?: GoogleCloudDocumentaiV1DocumentTextAnchor;
1564
1792
  }
@@ -1634,7 +1862,7 @@ declare namespace gapi.client {
1634
1862
  }
1635
1863
  interface GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak {
1636
1864
  /** Detected break type. */
1637
- type?: string;
1865
+ type?: 'TYPE_UNSPECIFIED' | 'SPACE' | 'WIDE_SPACE' | 'HYPHEN';
1638
1866
  }
1639
1867
  interface GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo {
1640
1868
  /** Color of the background. */
@@ -1684,7 +1912,15 @@ declare namespace gapi.client {
1684
1912
  /** The index of the revision that produced this element. */
1685
1913
  revision?: number;
1686
1914
  /** The type of provenance operation. */
1687
- type?: string;
1915
+ type?:
1916
+ | 'OPERATION_TYPE_UNSPECIFIED'
1917
+ | 'ADD'
1918
+ | 'REMOVE'
1919
+ | 'UPDATE'
1920
+ | 'REPLACE'
1921
+ | 'EVAL_REQUESTED'
1922
+ | 'EVAL_APPROVED'
1923
+ | 'EVAL_SKIPPED';
1688
1924
  }
1689
1925
  interface GoogleCloudDocumentaiV1DocumentProvenanceParent {
1690
1926
  /** The id of the parent provenance. */
@@ -1752,11 +1988,16 @@ declare namespace gapi.client {
1752
1988
  /** User defined name for the property. */
1753
1989
  displayName?: string;
1754
1990
  /** Specifies how the entity's value is obtained. */
1755
- method?: string;
1991
+ method?: 'METHOD_UNSPECIFIED' | 'EXTRACT' | 'DERIVE' | 'RELAXED_EXTRACT';
1756
1992
  /** The name of the property. Follows the same guidelines as the EntityType name. */
1757
1993
  name?: string;
1758
1994
  /** Occurrence type limits the number of instances an entity type appears in the document. */
1759
- occurrenceType?: string;
1995
+ occurrenceType?:
1996
+ | 'OCCURRENCE_TYPE_UNSPECIFIED'
1997
+ | 'OPTIONAL_ONCE'
1998
+ | 'OPTIONAL_MULTIPLE'
1999
+ | 'REQUIRED_ONCE'
2000
+ | 'REQUIRED_MULTIPLE';
1760
2001
  /** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
1761
2002
  valueType?: string;
1762
2003
  }
@@ -1928,7 +2169,7 @@ declare namespace gapi.client {
1928
2169
  /** The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only. */
1929
2170
  estimatedCalibrationErrorExact?: number;
1930
2171
  /** The metrics type for the label. */
1931
- metricsType?: string;
2172
+ metricsType?: 'METRICS_TYPE_UNSPECIFIED' | 'AGGREGATE';
1932
2173
  }
1933
2174
  interface GoogleCloudDocumentaiV1EvaluationReference {
1934
2175
  /** An aggregate of the statistics for the evaluation with fuzzy matching on. */
@@ -1986,7 +2227,12 @@ declare namespace gapi.client {
1986
2227
  /** 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. */
1987
2228
  humanReviewOperation?: string;
1988
2229
  /** The state of human review on the processing request. */
1989
- state?: string;
2230
+ state?:
2231
+ | 'STATE_UNSPECIFIED'
2232
+ | 'SKIPPED'
2233
+ | 'VALIDATION_PASSED'
2234
+ | 'IN_PROGRESS'
2235
+ | 'ERROR';
1990
2236
  /** A message providing more details about the human review state. */
1991
2237
  stateMessage?: string;
1992
2238
  }
@@ -2132,7 +2378,15 @@ declare namespace gapi.client {
2132
2378
  /** Output only. Reserved for future use. */
2133
2379
  satisfiesPzs?: boolean;
2134
2380
  /** Output only. The state of the processor. */
2135
- state?: string;
2381
+ state?:
2382
+ | 'STATE_UNSPECIFIED'
2383
+ | 'ENABLED'
2384
+ | 'DISABLED'
2385
+ | 'ENABLING'
2386
+ | 'DISABLING'
2387
+ | 'CREATING'
2388
+ | 'FAILED'
2389
+ | 'DELETING';
2136
2390
  /** The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */
2137
2391
  type?: string;
2138
2392
  }
@@ -2144,7 +2398,15 @@ declare namespace gapi.client {
2144
2398
  /** The processor category, used by UI to group processor types. */
2145
2399
  category?: string;
2146
2400
  /** Launch stage of the processor type */
2147
- launchStage?: string;
2401
+ launchStage?:
2402
+ | 'LAUNCH_STAGE_UNSPECIFIED'
2403
+ | 'UNIMPLEMENTED'
2404
+ | 'PRELAUNCH'
2405
+ | 'EARLY_ACCESS'
2406
+ | 'ALPHA'
2407
+ | 'BETA'
2408
+ | 'GA'
2409
+ | 'DEPRECATED';
2148
2410
  /** The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}` */
2149
2411
  name?: string;
2150
2412
  /** A set of Cloud Storage URIs of sample documents for this processor. */
@@ -2176,7 +2438,10 @@ declare namespace gapi.client {
2176
2438
  /** Output only. The most recently invoked evaluation for the processor version. */
2177
2439
  latestEvaluation?: GoogleCloudDocumentaiV1EvaluationReference;
2178
2440
  /** Output only. The model type of this processor version. */
2179
- modelType?: string;
2441
+ modelType?:
2442
+ | 'MODEL_TYPE_UNSPECIFIED'
2443
+ | 'MODEL_TYPE_GENERATIVE'
2444
+ | 'MODEL_TYPE_CUSTOM';
2180
2445
  /** Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` */
2181
2446
  name?: string;
2182
2447
  /** Output only. Reserved for future use. */
@@ -2184,7 +2449,16 @@ declare namespace gapi.client {
2184
2449
  /** Output only. Reserved for future use. */
2185
2450
  satisfiesPzs?: boolean;
2186
2451
  /** Output only. The state of the processor version. */
2187
- state?: string;
2452
+ state?:
2453
+ | 'STATE_UNSPECIFIED'
2454
+ | 'DEPLOYED'
2455
+ | 'DEPLOYING'
2456
+ | 'UNDEPLOYED'
2457
+ | 'UNDEPLOYING'
2458
+ | 'CREATING'
2459
+ | 'DELETING'
2460
+ | 'FAILED'
2461
+ | 'IMPORTING';
2188
2462
  }
2189
2463
  interface GoogleCloudDocumentaiV1ProcessorVersionAlias {
2190
2464
  /** The alias in the form of `processor_version` resource name. */
@@ -2208,7 +2482,10 @@ declare namespace gapi.client {
2208
2482
  /** The base processor version ID for the custom model. */
2209
2483
  baseProcessorVersionId?: string;
2210
2484
  /** The type of custom model created by the user. */
2211
- customModelType?: string;
2485
+ customModelType?:
2486
+ | 'CUSTOM_MODEL_TYPE_UNSPECIFIED'
2487
+ | 'VERSIONED_FOUNDATION'
2488
+ | 'FINE_TUNED';
2212
2489
  }
2213
2490
  interface GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
2214
2491
  /** Whether fine tuning is allowed for this base processor version. */
@@ -2266,7 +2543,7 @@ declare namespace gapi.client {
2266
2543
  /** An inline document proto. */
2267
2544
  inlineDocument?: GoogleCloudDocumentaiV1Document;
2268
2545
  /** The priority of the human review task. */
2269
- priority?: string;
2546
+ priority?: 'DEFAULT' | 'URGENT';
2270
2547
  }
2271
2548
  interface GoogleCloudDocumentaiV1ReviewDocumentResponse {
2272
2549
  /** The Cloud Storage uri for the human reviewed document if the review is succeeded. */
@@ -2274,7 +2551,7 @@ declare namespace gapi.client {
2274
2551
  /** The reason why the review is rejected by reviewer. */
2275
2552
  rejectionReason?: string;
2276
2553
  /** The state of the review operation. */
2277
- state?: string;
2554
+ state?: 'STATE_UNSPECIFIED' | 'REJECTED' | 'SUCCEEDED';
2278
2555
  }
2279
2556
  interface GoogleCloudDocumentaiV1SchemaGenerationHistory {
2280
2557
  /** Required. Previous prompt-answers in a chronological order. */
@@ -2343,11 +2620,16 @@ declare namespace gapi.client {
2343
2620
  }
2344
2621
  interface GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions {
2345
2622
  /** Optional. Training method to use for CDE training. */
2346
- trainingMethod?: string;
2623
+ trainingMethod?:
2624
+ | 'TRAINING_METHOD_UNSPECIFIED'
2625
+ | 'MODEL_BASED'
2626
+ | 'TEMPLATE_BASED';
2347
2627
  }
2348
2628
  interface GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions {
2349
2629
  /** Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used. */
2350
2630
  learningRateMultiplier?: number;
2631
+ /** Optional. Resource name of a previously fine tuned version id to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. */
2632
+ previousFineTunedProcessorVersionName?: string;
2351
2633
  /** Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used. */
2352
2634
  trainSteps?: number;
2353
2635
  }
@@ -2416,7 +2698,7 @@ declare namespace gapi.client {
2416
2698
  /** The status code, which should be an enum value of google.rpc.Code. */
2417
2699
  code?: number;
2418
2700
  /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
2419
- details?: Array<{[P in string]: any}>;
2701
+ details?: {[P in string]: any}[];
2420
2702
  /** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
2421
2703
  message?: string;
2422
2704
  }
@@ -2500,11 +2782,11 @@ declare namespace gapi.client {
2500
2782
  /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
2501
2783
  delete(request?: {
2502
2784
  /** V1 error format. */
2503
- '$.xgafv'?: string;
2785
+ '$.xgafv'?: '1' | '2';
2504
2786
  /** OAuth access token. */
2505
2787
  access_token?: string;
2506
2788
  /** Data format for response. */
2507
- alt?: string;
2789
+ alt?: 'json' | 'media' | 'proto';
2508
2790
  /** JSONP */
2509
2791
  callback?: string;
2510
2792
  /** Selector specifying which fields to include in a partial response. */
@@ -2529,11 +2811,11 @@ declare namespace gapi.client {
2529
2811
  /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
2530
2812
  cancel(request?: {
2531
2813
  /** V1 error format. */
2532
- '$.xgafv'?: string;
2814
+ '$.xgafv'?: '1' | '2';
2533
2815
  /** OAuth access token. */
2534
2816
  access_token?: string;
2535
2817
  /** Data format for response. */
2536
- alt?: string;
2818
+ alt?: 'json' | 'media' | 'proto';
2537
2819
  /** JSONP */
2538
2820
  callback?: string;
2539
2821
  /** Selector specifying which fields to include in a partial response. */
@@ -2556,11 +2838,11 @@ declare namespace gapi.client {
2556
2838
  /** 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. */
2557
2839
  get(request?: {
2558
2840
  /** V1 error format. */
2559
- '$.xgafv'?: string;
2841
+ '$.xgafv'?: '1' | '2';
2560
2842
  /** OAuth access token. */
2561
2843
  access_token?: string;
2562
2844
  /** Data format for response. */
2563
- alt?: string;
2845
+ alt?: 'json' | 'media' | 'proto';
2564
2846
  /** JSONP */
2565
2847
  callback?: string;
2566
2848
  /** Selector specifying which fields to include in a partial response. */
@@ -2583,11 +2865,11 @@ declare namespace gapi.client {
2583
2865
  /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
2584
2866
  list(request?: {
2585
2867
  /** V1 error format. */
2586
- '$.xgafv'?: string;
2868
+ '$.xgafv'?: '1' | '2';
2587
2869
  /** OAuth access token. */
2588
2870
  access_token?: string;
2589
2871
  /** Data format for response. */
2590
- alt?: string;
2872
+ alt?: 'json' | 'media' | 'proto';
2591
2873
  /** JSONP */
2592
2874
  callback?: string;
2593
2875
  /** Selector specifying which fields to include in a partial response. */
@@ -2620,11 +2902,11 @@ declare namespace gapi.client {
2620
2902
  /** Send a document for Human Review. The input document should be processed by the specified processor. */
2621
2903
  reviewDocument(request: {
2622
2904
  /** V1 error format. */
2623
- '$.xgafv'?: string;
2905
+ '$.xgafv'?: '1' | '2';
2624
2906
  /** OAuth access token. */
2625
2907
  access_token?: string;
2626
2908
  /** Data format for response. */
2627
- alt?: string;
2909
+ alt?: 'json' | 'media' | 'proto';
2628
2910
  /** JSONP */
2629
2911
  callback?: string;
2630
2912
  /** Selector specifying which fields to include in a partial response. */
@@ -2649,11 +2931,11 @@ declare namespace gapi.client {
2649
2931
  reviewDocument(
2650
2932
  request: {
2651
2933
  /** V1 error format. */
2652
- '$.xgafv'?: string;
2934
+ '$.xgafv'?: '1' | '2';
2653
2935
  /** OAuth access token. */
2654
2936
  access_token?: string;
2655
2937
  /** Data format for response. */
2656
- alt?: string;
2938
+ alt?: 'json' | 'media' | 'proto';
2657
2939
  /** JSONP */
2658
2940
  callback?: string;
2659
2941
  /** Selector specifying which fields to include in a partial response. */
@@ -2680,11 +2962,11 @@ declare namespace gapi.client {
2680
2962
  /** Retrieves a specific evaluation. */
2681
2963
  get(request?: {
2682
2964
  /** V1 error format. */
2683
- '$.xgafv'?: string;
2965
+ '$.xgafv'?: '1' | '2';
2684
2966
  /** OAuth access token. */
2685
2967
  access_token?: string;
2686
2968
  /** Data format for response. */
2687
- alt?: string;
2969
+ alt?: 'json' | 'media' | 'proto';
2688
2970
  /** JSONP */
2689
2971
  callback?: string;
2690
2972
  /** Selector specifying which fields to include in a partial response. */
@@ -2707,11 +2989,11 @@ declare namespace gapi.client {
2707
2989
  /** Retrieves a set of evaluations for a given processor version. */
2708
2990
  list(request?: {
2709
2991
  /** V1 error format. */
2710
- '$.xgafv'?: string;
2992
+ '$.xgafv'?: '1' | '2';
2711
2993
  /** OAuth access token. */
2712
2994
  access_token?: string;
2713
2995
  /** Data format for response. */
2714
- alt?: string;
2996
+ alt?: 'json' | 'media' | 'proto';
2715
2997
  /** JSONP */
2716
2998
  callback?: string;
2717
2999
  /** Selector specifying which fields to include in a partial response. */
@@ -2740,11 +3022,11 @@ declare namespace gapi.client {
2740
3022
  /** LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. */
2741
3023
  batchProcess(request: {
2742
3024
  /** V1 error format. */
2743
- '$.xgafv'?: string;
3025
+ '$.xgafv'?: '1' | '2';
2744
3026
  /** OAuth access token. */
2745
3027
  access_token?: string;
2746
3028
  /** Data format for response. */
2747
- alt?: string;
3029
+ alt?: 'json' | 'media' | 'proto';
2748
3030
  /** JSONP */
2749
3031
  callback?: string;
2750
3032
  /** Selector specifying which fields to include in a partial response. */
@@ -2769,11 +3051,11 @@ declare namespace gapi.client {
2769
3051
  batchProcess(
2770
3052
  request: {
2771
3053
  /** V1 error format. */
2772
- '$.xgafv'?: string;
3054
+ '$.xgafv'?: '1' | '2';
2773
3055
  /** OAuth access token. */
2774
3056
  access_token?: string;
2775
3057
  /** Data format for response. */
2776
- alt?: string;
3058
+ alt?: 'json' | 'media' | 'proto';
2777
3059
  /** JSONP */
2778
3060
  callback?: string;
2779
3061
  /** Selector specifying which fields to include in a partial response. */
@@ -2798,11 +3080,11 @@ declare namespace gapi.client {
2798
3080
  /** Deletes the processor version, all artifacts under the processor version will be deleted. */
2799
3081
  delete(request?: {
2800
3082
  /** V1 error format. */
2801
- '$.xgafv'?: string;
3083
+ '$.xgafv'?: '1' | '2';
2802
3084
  /** OAuth access token. */
2803
3085
  access_token?: string;
2804
3086
  /** Data format for response. */
2805
- alt?: string;
3087
+ alt?: 'json' | 'media' | 'proto';
2806
3088
  /** JSONP */
2807
3089
  callback?: string;
2808
3090
  /** Selector specifying which fields to include in a partial response. */
@@ -2825,11 +3107,11 @@ declare namespace gapi.client {
2825
3107
  /** Deploys the processor version. */
2826
3108
  deploy(request: {
2827
3109
  /** V1 error format. */
2828
- '$.xgafv'?: string;
3110
+ '$.xgafv'?: '1' | '2';
2829
3111
  /** OAuth access token. */
2830
3112
  access_token?: string;
2831
3113
  /** Data format for response. */
2832
- alt?: string;
3114
+ alt?: 'json' | 'media' | 'proto';
2833
3115
  /** JSONP */
2834
3116
  callback?: string;
2835
3117
  /** Selector specifying which fields to include in a partial response. */
@@ -2854,11 +3136,11 @@ declare namespace gapi.client {
2854
3136
  deploy(
2855
3137
  request: {
2856
3138
  /** V1 error format. */
2857
- '$.xgafv'?: string;
3139
+ '$.xgafv'?: '1' | '2';
2858
3140
  /** OAuth access token. */
2859
3141
  access_token?: string;
2860
3142
  /** Data format for response. */
2861
- alt?: string;
3143
+ alt?: 'json' | 'media' | 'proto';
2862
3144
  /** JSONP */
2863
3145
  callback?: string;
2864
3146
  /** Selector specifying which fields to include in a partial response. */
@@ -2883,11 +3165,11 @@ declare namespace gapi.client {
2883
3165
  /** Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. */
2884
3166
  evaluateProcessorVersion(request: {
2885
3167
  /** V1 error format. */
2886
- '$.xgafv'?: string;
3168
+ '$.xgafv'?: '1' | '2';
2887
3169
  /** OAuth access token. */
2888
3170
  access_token?: string;
2889
3171
  /** Data format for response. */
2890
- alt?: string;
3172
+ alt?: 'json' | 'media' | 'proto';
2891
3173
  /** JSONP */
2892
3174
  callback?: string;
2893
3175
  /** Selector specifying which fields to include in a partial response. */
@@ -2912,11 +3194,11 @@ declare namespace gapi.client {
2912
3194
  evaluateProcessorVersion(
2913
3195
  request: {
2914
3196
  /** V1 error format. */
2915
- '$.xgafv'?: string;
3197
+ '$.xgafv'?: '1' | '2';
2916
3198
  /** OAuth access token. */
2917
3199
  access_token?: string;
2918
3200
  /** Data format for response. */
2919
- alt?: string;
3201
+ alt?: 'json' | 'media' | 'proto';
2920
3202
  /** JSONP */
2921
3203
  callback?: string;
2922
3204
  /** Selector specifying which fields to include in a partial response. */
@@ -2941,11 +3223,11 @@ declare namespace gapi.client {
2941
3223
  /** Gets a processor version detail. */
2942
3224
  get(request?: {
2943
3225
  /** V1 error format. */
2944
- '$.xgafv'?: string;
3226
+ '$.xgafv'?: '1' | '2';
2945
3227
  /** OAuth access token. */
2946
3228
  access_token?: string;
2947
3229
  /** Data format for response. */
2948
- alt?: string;
3230
+ alt?: 'json' | 'media' | 'proto';
2949
3231
  /** JSONP */
2950
3232
  callback?: string;
2951
3233
  /** Selector specifying which fields to include in a partial response. */
@@ -2968,11 +3250,11 @@ declare namespace gapi.client {
2968
3250
  /** Lists all versions of a processor. */
2969
3251
  list(request?: {
2970
3252
  /** V1 error format. */
2971
- '$.xgafv'?: string;
3253
+ '$.xgafv'?: '1' | '2';
2972
3254
  /** OAuth access token. */
2973
3255
  access_token?: string;
2974
3256
  /** Data format for response. */
2975
- alt?: string;
3257
+ alt?: 'json' | 'media' | 'proto';
2976
3258
  /** JSONP */
2977
3259
  callback?: string;
2978
3260
  /** Selector specifying which fields to include in a partial response. */
@@ -2999,11 +3281,11 @@ declare namespace gapi.client {
2999
3281
  /** Processes a single document. */
3000
3282
  process(request: {
3001
3283
  /** V1 error format. */
3002
- '$.xgafv'?: string;
3284
+ '$.xgafv'?: '1' | '2';
3003
3285
  /** OAuth access token. */
3004
3286
  access_token?: string;
3005
3287
  /** Data format for response. */
3006
- alt?: string;
3288
+ alt?: 'json' | 'media' | 'proto';
3007
3289
  /** JSONP */
3008
3290
  callback?: string;
3009
3291
  /** Selector specifying which fields to include in a partial response. */
@@ -3028,11 +3310,11 @@ declare namespace gapi.client {
3028
3310
  process(
3029
3311
  request: {
3030
3312
  /** V1 error format. */
3031
- '$.xgafv'?: string;
3313
+ '$.xgafv'?: '1' | '2';
3032
3314
  /** OAuth access token. */
3033
3315
  access_token?: string;
3034
3316
  /** Data format for response. */
3035
- alt?: string;
3317
+ alt?: 'json' | 'media' | 'proto';
3036
3318
  /** JSONP */
3037
3319
  callback?: string;
3038
3320
  /** Selector specifying which fields to include in a partial response. */
@@ -3057,11 +3339,11 @@ declare namespace gapi.client {
3057
3339
  /** Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata. */
3058
3340
  train(request: {
3059
3341
  /** V1 error format. */
3060
- '$.xgafv'?: string;
3342
+ '$.xgafv'?: '1' | '2';
3061
3343
  /** OAuth access token. */
3062
3344
  access_token?: string;
3063
3345
  /** Data format for response. */
3064
- alt?: string;
3346
+ alt?: 'json' | 'media' | 'proto';
3065
3347
  /** JSONP */
3066
3348
  callback?: string;
3067
3349
  /** Selector specifying which fields to include in a partial response. */
@@ -3086,11 +3368,11 @@ declare namespace gapi.client {
3086
3368
  train(
3087
3369
  request: {
3088
3370
  /** V1 error format. */
3089
- '$.xgafv'?: string;
3371
+ '$.xgafv'?: '1' | '2';
3090
3372
  /** OAuth access token. */
3091
3373
  access_token?: string;
3092
3374
  /** Data format for response. */
3093
- alt?: string;
3375
+ alt?: 'json' | 'media' | 'proto';
3094
3376
  /** JSONP */
3095
3377
  callback?: string;
3096
3378
  /** Selector specifying which fields to include in a partial response. */
@@ -3115,11 +3397,11 @@ declare namespace gapi.client {
3115
3397
  /** Undeploys the processor version. */
3116
3398
  undeploy(request: {
3117
3399
  /** V1 error format. */
3118
- '$.xgafv'?: string;
3400
+ '$.xgafv'?: '1' | '2';
3119
3401
  /** OAuth access token. */
3120
3402
  access_token?: string;
3121
3403
  /** Data format for response. */
3122
- alt?: string;
3404
+ alt?: 'json' | 'media' | 'proto';
3123
3405
  /** JSONP */
3124
3406
  callback?: string;
3125
3407
  /** Selector specifying which fields to include in a partial response. */
@@ -3144,11 +3426,11 @@ declare namespace gapi.client {
3144
3426
  undeploy(
3145
3427
  request: {
3146
3428
  /** V1 error format. */
3147
- '$.xgafv'?: string;
3429
+ '$.xgafv'?: '1' | '2';
3148
3430
  /** OAuth access token. */
3149
3431
  access_token?: string;
3150
3432
  /** Data format for response. */
3151
- alt?: string;
3433
+ alt?: 'json' | 'media' | 'proto';
3152
3434
  /** JSONP */
3153
3435
  callback?: string;
3154
3436
  /** Selector specifying which fields to include in a partial response. */
@@ -3176,11 +3458,11 @@ declare namespace gapi.client {
3176
3458
  /** LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. */
3177
3459
  batchProcess(request: {
3178
3460
  /** V1 error format. */
3179
- '$.xgafv'?: string;
3461
+ '$.xgafv'?: '1' | '2';
3180
3462
  /** OAuth access token. */
3181
3463
  access_token?: string;
3182
3464
  /** Data format for response. */
3183
- alt?: string;
3465
+ alt?: 'json' | 'media' | 'proto';
3184
3466
  /** JSONP */
3185
3467
  callback?: string;
3186
3468
  /** Selector specifying which fields to include in a partial response. */
@@ -3205,11 +3487,11 @@ declare namespace gapi.client {
3205
3487
  batchProcess(
3206
3488
  request: {
3207
3489
  /** V1 error format. */
3208
- '$.xgafv'?: string;
3490
+ '$.xgafv'?: '1' | '2';
3209
3491
  /** OAuth access token. */
3210
3492
  access_token?: string;
3211
3493
  /** Data format for response. */
3212
- alt?: string;
3494
+ alt?: 'json' | 'media' | 'proto';
3213
3495
  /** JSONP */
3214
3496
  callback?: string;
3215
3497
  /** Selector specifying which fields to include in a partial response. */
@@ -3234,11 +3516,11 @@ declare namespace gapi.client {
3234
3516
  /** 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. */
3235
3517
  create(request: {
3236
3518
  /** V1 error format. */
3237
- '$.xgafv'?: string;
3519
+ '$.xgafv'?: '1' | '2';
3238
3520
  /** OAuth access token. */
3239
3521
  access_token?: string;
3240
3522
  /** Data format for response. */
3241
- alt?: string;
3523
+ alt?: 'json' | 'media' | 'proto';
3242
3524
  /** JSONP */
3243
3525
  callback?: string;
3244
3526
  /** Selector specifying which fields to include in a partial response. */
@@ -3263,11 +3545,11 @@ declare namespace gapi.client {
3263
3545
  create(
3264
3546
  request: {
3265
3547
  /** V1 error format. */
3266
- '$.xgafv'?: string;
3548
+ '$.xgafv'?: '1' | '2';
3267
3549
  /** OAuth access token. */
3268
3550
  access_token?: string;
3269
3551
  /** Data format for response. */
3270
- alt?: string;
3552
+ alt?: 'json' | 'media' | 'proto';
3271
3553
  /** JSONP */
3272
3554
  callback?: string;
3273
3555
  /** Selector specifying which fields to include in a partial response. */
@@ -3292,11 +3574,11 @@ declare namespace gapi.client {
3292
3574
  /** Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. */
3293
3575
  delete(request?: {
3294
3576
  /** V1 error format. */
3295
- '$.xgafv'?: string;
3577
+ '$.xgafv'?: '1' | '2';
3296
3578
  /** OAuth access token. */
3297
3579
  access_token?: string;
3298
3580
  /** Data format for response. */
3299
- alt?: string;
3581
+ alt?: 'json' | 'media' | 'proto';
3300
3582
  /** JSONP */
3301
3583
  callback?: string;
3302
3584
  /** Selector specifying which fields to include in a partial response. */
@@ -3319,11 +3601,11 @@ declare namespace gapi.client {
3319
3601
  /** Disables a processor */
3320
3602
  disable(request: {
3321
3603
  /** V1 error format. */
3322
- '$.xgafv'?: string;
3604
+ '$.xgafv'?: '1' | '2';
3323
3605
  /** OAuth access token. */
3324
3606
  access_token?: string;
3325
3607
  /** Data format for response. */
3326
- alt?: string;
3608
+ alt?: 'json' | 'media' | 'proto';
3327
3609
  /** JSONP */
3328
3610
  callback?: string;
3329
3611
  /** Selector specifying which fields to include in a partial response. */
@@ -3348,11 +3630,11 @@ declare namespace gapi.client {
3348
3630
  disable(
3349
3631
  request: {
3350
3632
  /** V1 error format. */
3351
- '$.xgafv'?: string;
3633
+ '$.xgafv'?: '1' | '2';
3352
3634
  /** OAuth access token. */
3353
3635
  access_token?: string;
3354
3636
  /** Data format for response. */
3355
- alt?: string;
3637
+ alt?: 'json' | 'media' | 'proto';
3356
3638
  /** JSONP */
3357
3639
  callback?: string;
3358
3640
  /** Selector specifying which fields to include in a partial response. */
@@ -3377,11 +3659,11 @@ declare namespace gapi.client {
3377
3659
  /** Enables a processor */
3378
3660
  enable(request: {
3379
3661
  /** V1 error format. */
3380
- '$.xgafv'?: string;
3662
+ '$.xgafv'?: '1' | '2';
3381
3663
  /** OAuth access token. */
3382
3664
  access_token?: string;
3383
3665
  /** Data format for response. */
3384
- alt?: string;
3666
+ alt?: 'json' | 'media' | 'proto';
3385
3667
  /** JSONP */
3386
3668
  callback?: string;
3387
3669
  /** Selector specifying which fields to include in a partial response. */
@@ -3406,11 +3688,11 @@ declare namespace gapi.client {
3406
3688
  enable(
3407
3689
  request: {
3408
3690
  /** V1 error format. */
3409
- '$.xgafv'?: string;
3691
+ '$.xgafv'?: '1' | '2';
3410
3692
  /** OAuth access token. */
3411
3693
  access_token?: string;
3412
3694
  /** Data format for response. */
3413
- alt?: string;
3695
+ alt?: 'json' | 'media' | 'proto';
3414
3696
  /** JSONP */
3415
3697
  callback?: string;
3416
3698
  /** Selector specifying which fields to include in a partial response. */
@@ -3435,11 +3717,11 @@ declare namespace gapi.client {
3435
3717
  /** Gets a processor detail. */
3436
3718
  get(request?: {
3437
3719
  /** V1 error format. */
3438
- '$.xgafv'?: string;
3720
+ '$.xgafv'?: '1' | '2';
3439
3721
  /** OAuth access token. */
3440
3722
  access_token?: string;
3441
3723
  /** Data format for response. */
3442
- alt?: string;
3724
+ alt?: 'json' | 'media' | 'proto';
3443
3725
  /** JSONP */
3444
3726
  callback?: string;
3445
3727
  /** Selector specifying which fields to include in a partial response. */
@@ -3462,11 +3744,11 @@ declare namespace gapi.client {
3462
3744
  /** Lists all processors which belong to this project. */
3463
3745
  list(request?: {
3464
3746
  /** V1 error format. */
3465
- '$.xgafv'?: string;
3747
+ '$.xgafv'?: '1' | '2';
3466
3748
  /** OAuth access token. */
3467
3749
  access_token?: string;
3468
3750
  /** Data format for response. */
3469
- alt?: string;
3751
+ alt?: 'json' | 'media' | 'proto';
3470
3752
  /** JSONP */
3471
3753
  callback?: string;
3472
3754
  /** Selector specifying which fields to include in a partial response. */
@@ -3493,11 +3775,11 @@ declare namespace gapi.client {
3493
3775
  /** Processes a single document. */
3494
3776
  process(request: {
3495
3777
  /** V1 error format. */
3496
- '$.xgafv'?: string;
3778
+ '$.xgafv'?: '1' | '2';
3497
3779
  /** OAuth access token. */
3498
3780
  access_token?: string;
3499
3781
  /** Data format for response. */
3500
- alt?: string;
3782
+ alt?: 'json' | 'media' | 'proto';
3501
3783
  /** JSONP */
3502
3784
  callback?: string;
3503
3785
  /** Selector specifying which fields to include in a partial response. */
@@ -3522,11 +3804,11 @@ declare namespace gapi.client {
3522
3804
  process(
3523
3805
  request: {
3524
3806
  /** V1 error format. */
3525
- '$.xgafv'?: string;
3807
+ '$.xgafv'?: '1' | '2';
3526
3808
  /** OAuth access token. */
3527
3809
  access_token?: string;
3528
3810
  /** Data format for response. */
3529
- alt?: string;
3811
+ alt?: 'json' | 'media' | 'proto';
3530
3812
  /** JSONP */
3531
3813
  callback?: string;
3532
3814
  /** Selector specifying which fields to include in a partial response. */
@@ -3551,11 +3833,11 @@ declare namespace gapi.client {
3551
3833
  /** Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments. */
3552
3834
  setDefaultProcessorVersion(request: {
3553
3835
  /** V1 error format. */
3554
- '$.xgafv'?: string;
3836
+ '$.xgafv'?: '1' | '2';
3555
3837
  /** OAuth access token. */
3556
3838
  access_token?: string;
3557
3839
  /** Data format for response. */
3558
- alt?: string;
3840
+ alt?: 'json' | 'media' | 'proto';
3559
3841
  /** JSONP */
3560
3842
  callback?: string;
3561
3843
  /** Selector specifying which fields to include in a partial response. */
@@ -3580,11 +3862,11 @@ declare namespace gapi.client {
3580
3862
  setDefaultProcessorVersion(
3581
3863
  request: {
3582
3864
  /** V1 error format. */
3583
- '$.xgafv'?: string;
3865
+ '$.xgafv'?: '1' | '2';
3584
3866
  /** OAuth access token. */
3585
3867
  access_token?: string;
3586
3868
  /** Data format for response. */
3587
- alt?: string;
3869
+ alt?: 'json' | 'media' | 'proto';
3588
3870
  /** JSONP */
3589
3871
  callback?: string;
3590
3872
  /** Selector specifying which fields to include in a partial response. */
@@ -3613,11 +3895,11 @@ declare namespace gapi.client {
3613
3895
  /** Gets a processor type detail. */
3614
3896
  get(request?: {
3615
3897
  /** V1 error format. */
3616
- '$.xgafv'?: string;
3898
+ '$.xgafv'?: '1' | '2';
3617
3899
  /** OAuth access token. */
3618
3900
  access_token?: string;
3619
3901
  /** Data format for response. */
3620
- alt?: string;
3902
+ alt?: 'json' | 'media' | 'proto';
3621
3903
  /** JSONP */
3622
3904
  callback?: string;
3623
3905
  /** Selector specifying which fields to include in a partial response. */
@@ -3640,11 +3922,11 @@ declare namespace gapi.client {
3640
3922
  /** Lists the processor types that exist. */
3641
3923
  list(request?: {
3642
3924
  /** V1 error format. */
3643
- '$.xgafv'?: string;
3925
+ '$.xgafv'?: '1' | '2';
3644
3926
  /** OAuth access token. */
3645
3927
  access_token?: string;
3646
3928
  /** Data format for response. */
3647
- alt?: string;
3929
+ alt?: 'json' | 'media' | 'proto';
3648
3930
  /** JSONP */
3649
3931
  callback?: string;
3650
3932
  /** Selector specifying which fields to include in a partial response. */
@@ -3673,11 +3955,11 @@ declare namespace gapi.client {
3673
3955
  /** Creates a schema version. */
3674
3956
  create(request: {
3675
3957
  /** V1 error format. */
3676
- '$.xgafv'?: string;
3958
+ '$.xgafv'?: '1' | '2';
3677
3959
  /** OAuth access token. */
3678
3960
  access_token?: string;
3679
3961
  /** Data format for response. */
3680
- alt?: string;
3962
+ alt?: 'json' | 'media' | 'proto';
3681
3963
  /** JSONP */
3682
3964
  callback?: string;
3683
3965
  /** Selector specifying which fields to include in a partial response. */
@@ -3702,11 +3984,11 @@ declare namespace gapi.client {
3702
3984
  create(
3703
3985
  request: {
3704
3986
  /** V1 error format. */
3705
- '$.xgafv'?: string;
3987
+ '$.xgafv'?: '1' | '2';
3706
3988
  /** OAuth access token. */
3707
3989
  access_token?: string;
3708
3990
  /** Data format for response. */
3709
- alt?: string;
3991
+ alt?: 'json' | 'media' | 'proto';
3710
3992
  /** JSONP */
3711
3993
  callback?: string;
3712
3994
  /** Selector specifying which fields to include in a partial response. */
@@ -3731,11 +4013,11 @@ declare namespace gapi.client {
3731
4013
  /** Deletes a schema version. */
3732
4014
  delete(request?: {
3733
4015
  /** V1 error format. */
3734
- '$.xgafv'?: string;
4016
+ '$.xgafv'?: '1' | '2';
3735
4017
  /** OAuth access token. */
3736
4018
  access_token?: string;
3737
4019
  /** Data format for response. */
3738
- alt?: string;
4020
+ alt?: 'json' | 'media' | 'proto';
3739
4021
  /** JSONP */
3740
4022
  callback?: string;
3741
4023
  /** Selector specifying which fields to include in a partial response. */
@@ -3758,11 +4040,11 @@ declare namespace gapi.client {
3758
4040
  /** Generates a schema version. */
3759
4041
  generate(request: {
3760
4042
  /** V1 error format. */
3761
- '$.xgafv'?: string;
4043
+ '$.xgafv'?: '1' | '2';
3762
4044
  /** OAuth access token. */
3763
4045
  access_token?: string;
3764
4046
  /** Data format for response. */
3765
- alt?: string;
4047
+ alt?: 'json' | 'media' | 'proto';
3766
4048
  /** JSONP */
3767
4049
  callback?: string;
3768
4050
  /** Selector specifying which fields to include in a partial response. */
@@ -3787,11 +4069,11 @@ declare namespace gapi.client {
3787
4069
  generate(
3788
4070
  request: {
3789
4071
  /** V1 error format. */
3790
- '$.xgafv'?: string;
4072
+ '$.xgafv'?: '1' | '2';
3791
4073
  /** OAuth access token. */
3792
4074
  access_token?: string;
3793
4075
  /** Data format for response. */
3794
- alt?: string;
4076
+ alt?: 'json' | 'media' | 'proto';
3795
4077
  /** JSONP */
3796
4078
  callback?: string;
3797
4079
  /** Selector specifying which fields to include in a partial response. */
@@ -3816,11 +4098,11 @@ declare namespace gapi.client {
3816
4098
  /** Gets a schema version. */
3817
4099
  get(request?: {
3818
4100
  /** V1 error format. */
3819
- '$.xgafv'?: string;
4101
+ '$.xgafv'?: '1' | '2';
3820
4102
  /** OAuth access token. */
3821
4103
  access_token?: string;
3822
4104
  /** Data format for response. */
3823
- alt?: string;
4105
+ alt?: 'json' | 'media' | 'proto';
3824
4106
  /** JSONP */
3825
4107
  callback?: string;
3826
4108
  /** Selector specifying which fields to include in a partial response. */
@@ -3843,11 +4125,11 @@ declare namespace gapi.client {
3843
4125
  /** Lists SchemaVersions. */
3844
4126
  list(request?: {
3845
4127
  /** V1 error format. */
3846
- '$.xgafv'?: string;
4128
+ '$.xgafv'?: '1' | '2';
3847
4129
  /** OAuth access token. */
3848
4130
  access_token?: string;
3849
4131
  /** Data format for response. */
3850
- alt?: string;
4132
+ alt?: 'json' | 'media' | 'proto';
3851
4133
  /** JSONP */
3852
4134
  callback?: string;
3853
4135
  /** Selector specifying which fields to include in a partial response. */
@@ -3874,11 +4156,11 @@ declare namespace gapi.client {
3874
4156
  /** Updates a schema version. Editable fields are: - `display_name` - `labels` */
3875
4157
  patch(request: {
3876
4158
  /** V1 error format. */
3877
- '$.xgafv'?: string;
4159
+ '$.xgafv'?: '1' | '2';
3878
4160
  /** OAuth access token. */
3879
4161
  access_token?: string;
3880
4162
  /** Data format for response. */
3881
- alt?: string;
4163
+ alt?: 'json' | 'media' | 'proto';
3882
4164
  /** JSONP */
3883
4165
  callback?: string;
3884
4166
  /** Selector specifying which fields to include in a partial response. */
@@ -3905,11 +4187,11 @@ declare namespace gapi.client {
3905
4187
  patch(
3906
4188
  request: {
3907
4189
  /** V1 error format. */
3908
- '$.xgafv'?: string;
4190
+ '$.xgafv'?: '1' | '2';
3909
4191
  /** OAuth access token. */
3910
4192
  access_token?: string;
3911
4193
  /** Data format for response. */
3912
- alt?: string;
4194
+ alt?: 'json' | 'media' | 'proto';
3913
4195
  /** JSONP */
3914
4196
  callback?: string;
3915
4197
  /** Selector specifying which fields to include in a partial response. */
@@ -3938,11 +4220,11 @@ declare namespace gapi.client {
3938
4220
  /** Creates a schema. */
3939
4221
  create(request: {
3940
4222
  /** V1 error format. */
3941
- '$.xgafv'?: string;
4223
+ '$.xgafv'?: '1' | '2';
3942
4224
  /** OAuth access token. */
3943
4225
  access_token?: string;
3944
4226
  /** Data format for response. */
3945
- alt?: string;
4227
+ alt?: 'json' | 'media' | 'proto';
3946
4228
  /** JSONP */
3947
4229
  callback?: string;
3948
4230
  /** Selector specifying which fields to include in a partial response. */
@@ -3967,11 +4249,11 @@ declare namespace gapi.client {
3967
4249
  create(
3968
4250
  request: {
3969
4251
  /** V1 error format. */
3970
- '$.xgafv'?: string;
4252
+ '$.xgafv'?: '1' | '2';
3971
4253
  /** OAuth access token. */
3972
4254
  access_token?: string;
3973
4255
  /** Data format for response. */
3974
- alt?: string;
4256
+ alt?: 'json' | 'media' | 'proto';
3975
4257
  /** JSONP */
3976
4258
  callback?: string;
3977
4259
  /** Selector specifying which fields to include in a partial response. */
@@ -3996,11 +4278,11 @@ declare namespace gapi.client {
3996
4278
  /** Deletes a schema. */
3997
4279
  delete(request?: {
3998
4280
  /** V1 error format. */
3999
- '$.xgafv'?: string;
4281
+ '$.xgafv'?: '1' | '2';
4000
4282
  /** OAuth access token. */
4001
4283
  access_token?: string;
4002
4284
  /** Data format for response. */
4003
- alt?: string;
4285
+ alt?: 'json' | 'media' | 'proto';
4004
4286
  /** JSONP */
4005
4287
  callback?: string;
4006
4288
  /** Selector specifying which fields to include in a partial response. */
@@ -4025,11 +4307,11 @@ declare namespace gapi.client {
4025
4307
  /** Gets a schema. */
4026
4308
  get(request?: {
4027
4309
  /** V1 error format. */
4028
- '$.xgafv'?: string;
4310
+ '$.xgafv'?: '1' | '2';
4029
4311
  /** OAuth access token. */
4030
4312
  access_token?: string;
4031
4313
  /** Data format for response. */
4032
- alt?: string;
4314
+ alt?: 'json' | 'media' | 'proto';
4033
4315
  /** JSONP */
4034
4316
  callback?: string;
4035
4317
  /** Selector specifying which fields to include in a partial response. */
@@ -4052,11 +4334,11 @@ declare namespace gapi.client {
4052
4334
  /** Lists Schemas. */
4053
4335
  list(request?: {
4054
4336
  /** V1 error format. */
4055
- '$.xgafv'?: string;
4337
+ '$.xgafv'?: '1' | '2';
4056
4338
  /** OAuth access token. */
4057
4339
  access_token?: string;
4058
4340
  /** Data format for response. */
4059
- alt?: string;
4341
+ alt?: 'json' | 'media' | 'proto';
4060
4342
  /** JSONP */
4061
4343
  callback?: string;
4062
4344
  /** Selector specifying which fields to include in a partial response. */
@@ -4083,11 +4365,11 @@ declare namespace gapi.client {
4083
4365
  /** Updates a schema. Editable fields are: - `display_name` - `labels` */
4084
4366
  patch(request: {
4085
4367
  /** V1 error format. */
4086
- '$.xgafv'?: string;
4368
+ '$.xgafv'?: '1' | '2';
4087
4369
  /** OAuth access token. */
4088
4370
  access_token?: string;
4089
4371
  /** Data format for response. */
4090
- alt?: string;
4372
+ alt?: 'json' | 'media' | 'proto';
4091
4373
  /** JSONP */
4092
4374
  callback?: string;
4093
4375
  /** Selector specifying which fields to include in a partial response. */
@@ -4114,11 +4396,11 @@ declare namespace gapi.client {
4114
4396
  patch(
4115
4397
  request: {
4116
4398
  /** V1 error format. */
4117
- '$.xgafv'?: string;
4399
+ '$.xgafv'?: '1' | '2';
4118
4400
  /** OAuth access token. */
4119
4401
  access_token?: string;
4120
4402
  /** Data format for response. */
4121
- alt?: string;
4403
+ alt?: 'json' | 'media' | 'proto';
4122
4404
  /** JSONP */
4123
4405
  callback?: string;
4124
4406
  /** Selector specifying which fields to include in a partial response. */
@@ -4148,11 +4430,11 @@ declare namespace gapi.client {
4148
4430
  /** Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated. */
4149
4431
  fetchProcessorTypes(request?: {
4150
4432
  /** V1 error format. */
4151
- '$.xgafv'?: string;
4433
+ '$.xgafv'?: '1' | '2';
4152
4434
  /** OAuth access token. */
4153
4435
  access_token?: string;
4154
4436
  /** Data format for response. */
4155
- alt?: string;
4437
+ alt?: 'json' | 'media' | 'proto';
4156
4438
  /** JSONP */
4157
4439
  callback?: string;
4158
4440
  /** Selector specifying which fields to include in a partial response. */
@@ -4175,11 +4457,11 @@ declare namespace gapi.client {
4175
4457
  /** Gets information about a location. */
4176
4458
  get(request?: {
4177
4459
  /** V1 error format. */
4178
- '$.xgafv'?: string;
4460
+ '$.xgafv'?: '1' | '2';
4179
4461
  /** OAuth access token. */
4180
4462
  access_token?: string;
4181
4463
  /** Data format for response. */
4182
- alt?: string;
4464
+ alt?: 'json' | 'media' | 'proto';
4183
4465
  /** JSONP */
4184
4466
  callback?: string;
4185
4467
  /** Selector specifying which fields to include in a partial response. */
@@ -4199,17 +4481,17 @@ declare namespace gapi.client {
4199
4481
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4200
4482
  uploadType?: string;
4201
4483
  }): Request<GoogleCloudLocationLocation>;
4202
- /** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
4484
+ /** Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. */
4203
4485
  list(request?: {
4204
4486
  /** V1 error format. */
4205
- '$.xgafv'?: string;
4487
+ '$.xgafv'?: '1' | '2';
4206
4488
  /** OAuth access token. */
4207
4489
  access_token?: string;
4208
4490
  /** Data format for response. */
4209
- alt?: string;
4491
+ alt?: 'json' | 'media' | 'proto';
4210
4492
  /** JSONP */
4211
4493
  callback?: string;
4212
- /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
4494
+ /** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
4213
4495
  extraLocationTypes?: string | string[];
4214
4496
  /** Selector specifying which fields to include in a partial response. */
4215
4497
  fields?: string;
@@ -4243,11 +4525,11 @@ declare namespace gapi.client {
4243
4525
  /** 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. */
4244
4526
  get(request?: {
4245
4527
  /** V1 error format. */
4246
- '$.xgafv'?: string;
4528
+ '$.xgafv'?: '1' | '2';
4247
4529
  /** OAuth access token. */
4248
4530
  access_token?: string;
4249
4531
  /** Data format for response. */
4250
- alt?: string;
4532
+ alt?: 'json' | 'media' | 'proto';
4251
4533
  /** JSONP */
4252
4534
  callback?: string;
4253
4535
  /** Selector specifying which fields to include in a partial response. */