@maxim_mazurok/gapi.client.documentai-v1beta3 0.1.20251013 → 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.
- package/index.d.ts +850 -3
- 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=v1beta3
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20251030
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -41,6 +41,8 @@ declare namespace gapi.client {
|
|
|
41
41
|
formValidation?: CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation;
|
|
42
42
|
/** Name of the validation rule. */
|
|
43
43
|
name?: string;
|
|
44
|
+
/** Unique identifier of the rule. Optional. */
|
|
45
|
+
ruleId?: string;
|
|
44
46
|
}
|
|
45
47
|
interface CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule {
|
|
46
48
|
alignmentType?: string;
|
|
@@ -215,11 +217,81 @@ declare namespace gapi.client {
|
|
|
215
217
|
/** Required. The id of the document. */
|
|
216
218
|
docId?: string;
|
|
217
219
|
}
|
|
220
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentSchema {
|
|
221
|
+
/** Description of the schema. */
|
|
222
|
+
description?: string;
|
|
223
|
+
/** Display name to show to users. */
|
|
224
|
+
displayName?: string;
|
|
225
|
+
/** Entity types of the schema. */
|
|
226
|
+
entityTypes?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType[];
|
|
227
|
+
/** Metadata of the schema. */
|
|
228
|
+
metadata?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata;
|
|
229
|
+
}
|
|
230
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType {
|
|
231
|
+
/** The entity type that this type is derived from. For now, one and only one should be set. */
|
|
232
|
+
baseTypes?: string[];
|
|
233
|
+
/** The description of the entity type. Could be used to provide more information about the entity type for model calls. */
|
|
234
|
+
description?: string;
|
|
235
|
+
/** User defined name for the type. */
|
|
236
|
+
displayName?: string;
|
|
237
|
+
/** Metadata for the entity type. */
|
|
238
|
+
entityTypeMetadata?: GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata;
|
|
239
|
+
/** 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. */
|
|
240
|
+
enumValues?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues;
|
|
241
|
+
/** 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. */
|
|
242
|
+
name?: string;
|
|
243
|
+
/** Description the nested structure, or composition of an entity. */
|
|
244
|
+
properties?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty[];
|
|
245
|
+
}
|
|
246
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues {
|
|
247
|
+
/** The individual values that this enum values type can include. */
|
|
248
|
+
values?: string[];
|
|
249
|
+
}
|
|
250
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty {
|
|
251
|
+
/** The description of the property. Could be used to provide more information about the property for model calls. */
|
|
252
|
+
description?: string;
|
|
253
|
+
/** User defined name for the property. */
|
|
254
|
+
displayName?: string;
|
|
255
|
+
/** Specifies how the entity's value is obtained. */
|
|
256
|
+
method?: string;
|
|
257
|
+
/** The name of the property. Follows the same guidelines as the EntityType name. */
|
|
258
|
+
name?: string;
|
|
259
|
+
/** Occurrence type limits the number of instances an entity type appears in the document. */
|
|
260
|
+
occurrenceType?: string;
|
|
261
|
+
/** Any additional metadata about the property can be added here. */
|
|
262
|
+
propertyMetadata?: GoogleCloudDocumentaiUiv1beta3PropertyMetadata;
|
|
263
|
+
/** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
|
|
264
|
+
valueType?: string;
|
|
265
|
+
}
|
|
266
|
+
interface GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata {
|
|
267
|
+
/** If true, on a given page, there can be multiple `document` annotations covering it. */
|
|
268
|
+
documentAllowMultipleLabels?: boolean;
|
|
269
|
+
/** If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */
|
|
270
|
+
documentSplitter?: boolean;
|
|
271
|
+
/** If set, all the nested entities must be prefixed with the parents. */
|
|
272
|
+
prefixedNamingOnProperties?: boolean;
|
|
273
|
+
/** 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. */
|
|
274
|
+
skipNamingValidation?: boolean;
|
|
275
|
+
}
|
|
218
276
|
interface GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata {
|
|
219
277
|
/** The basic metadata of the long-running operation. */
|
|
220
278
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
221
279
|
}
|
|
222
280
|
interface GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse {}
|
|
281
|
+
interface GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata {
|
|
282
|
+
/** Field tier metadata on the property */
|
|
283
|
+
fieldTierMetadata?: GoogleCloudDocumentaiUiv1beta3FieldTierMetadata;
|
|
284
|
+
/** Human review labeling config on the entity. */
|
|
285
|
+
humanReviewLabelingMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata;
|
|
286
|
+
/** Human review config on the entity. */
|
|
287
|
+
humanReviewMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata;
|
|
288
|
+
/** Whether the entity type should be considered inactive. */
|
|
289
|
+
inactive?: boolean;
|
|
290
|
+
/** Schema editability metadata on the entity. */
|
|
291
|
+
schemaEditabilityMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata;
|
|
292
|
+
/** Schema inference metadata on the entity. */
|
|
293
|
+
schemaInferenceMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata;
|
|
294
|
+
}
|
|
223
295
|
interface GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata {
|
|
224
296
|
/** The basic metadata of the long-running operation. */
|
|
225
297
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
@@ -228,6 +300,40 @@ declare namespace gapi.client {
|
|
|
228
300
|
/** The resource name of the created evaluation. */
|
|
229
301
|
evaluation?: string;
|
|
230
302
|
}
|
|
303
|
+
interface GoogleCloudDocumentaiUiv1beta3EvaluationMetrics {
|
|
304
|
+
/** The calculated f1 score. */
|
|
305
|
+
f1Score?: number;
|
|
306
|
+
/** The amount of false negatives. */
|
|
307
|
+
falseNegativesCount?: number;
|
|
308
|
+
/** The amount of false positives. */
|
|
309
|
+
falsePositivesCount?: number;
|
|
310
|
+
/** The amount of documents with a ground truth occurrence. */
|
|
311
|
+
groundTruthDocumentCount?: number;
|
|
312
|
+
/** The amount of occurrences in ground truth documents. */
|
|
313
|
+
groundTruthOccurrencesCount?: number;
|
|
314
|
+
/** The calculated precision. */
|
|
315
|
+
precision?: number;
|
|
316
|
+
/** The amount of documents with a predicted occurrence. */
|
|
317
|
+
predictedDocumentCount?: number;
|
|
318
|
+
/** The amount of occurrences in predicted documents. */
|
|
319
|
+
predictedOccurrencesCount?: number;
|
|
320
|
+
/** The calculated recall. */
|
|
321
|
+
recall?: number;
|
|
322
|
+
/** The amount of documents that had an occurrence of this label. */
|
|
323
|
+
totalDocumentsCount?: number;
|
|
324
|
+
/** The amount of true positives. */
|
|
325
|
+
truePositivesCount?: number;
|
|
326
|
+
}
|
|
327
|
+
interface GoogleCloudDocumentaiUiv1beta3EvaluationReference {
|
|
328
|
+
/** An aggregate of the statistics for the evaluation with fuzzy matching on. */
|
|
329
|
+
aggregateMetrics?: GoogleCloudDocumentaiUiv1beta3EvaluationMetrics;
|
|
330
|
+
/** An aggregate of the statistics for the evaluation with fuzzy matching off. */
|
|
331
|
+
aggregateMetricsExact?: GoogleCloudDocumentaiUiv1beta3EvaluationMetrics;
|
|
332
|
+
/** The resource name of the evaluation. */
|
|
333
|
+
evaluation?: string;
|
|
334
|
+
/** The resource name of the Long Running Operation for the evaluation. */
|
|
335
|
+
operation?: string;
|
|
336
|
+
}
|
|
231
337
|
interface GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata {
|
|
232
338
|
/** The basic metadata of the long-running operation. */
|
|
233
339
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
@@ -259,6 +365,30 @@ declare namespace gapi.client {
|
|
|
259
365
|
/** The Cloud Storage URI containing the output artifacts. */
|
|
260
366
|
gcsUri?: string;
|
|
261
367
|
}
|
|
368
|
+
interface GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata {
|
|
369
|
+
/** Entity query config. */
|
|
370
|
+
entityQuery?: GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery;
|
|
371
|
+
/** Summary options config. */
|
|
372
|
+
summaryOptions?: GoogleCloudDocumentaiUiv1beta3SummaryOptions;
|
|
373
|
+
}
|
|
374
|
+
interface GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery {
|
|
375
|
+
/** The original entity query inputed by the user. */
|
|
376
|
+
userEntityQuery?: string;
|
|
377
|
+
}
|
|
378
|
+
interface GoogleCloudDocumentaiUiv1beta3FieldTierMetadata {
|
|
379
|
+
/** 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. */
|
|
380
|
+
tierLevel?: number;
|
|
381
|
+
}
|
|
382
|
+
interface GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata {
|
|
383
|
+
/** Whether to enable normalization editing. */
|
|
384
|
+
enableNormalizationEditing?: boolean;
|
|
385
|
+
}
|
|
386
|
+
interface GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata {
|
|
387
|
+
/** The confidence threshold if human review validation is enabled. */
|
|
388
|
+
confidenceThreshold?: number;
|
|
389
|
+
/** Whether to enable human review validation. */
|
|
390
|
+
enableValidation?: boolean;
|
|
391
|
+
}
|
|
262
392
|
interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata {
|
|
263
393
|
/** The basic metadata of the long-running operation. */
|
|
264
394
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
@@ -294,6 +424,112 @@ declare namespace gapi.client {
|
|
|
294
424
|
/** The destination processor version name. */
|
|
295
425
|
processorVersion?: string;
|
|
296
426
|
}
|
|
427
|
+
interface GoogleCloudDocumentaiUiv1beta3Processor {
|
|
428
|
+
/** 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} */
|
|
429
|
+
activeSchemaVersion?: string;
|
|
430
|
+
/** Output only. The time the processor was created. */
|
|
431
|
+
createTime?: string;
|
|
432
|
+
/** The default processor version. */
|
|
433
|
+
defaultProcessorVersion?: string;
|
|
434
|
+
/** The display name of the processor. */
|
|
435
|
+
displayName?: string;
|
|
436
|
+
/** The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */
|
|
437
|
+
kmsKeyName?: string;
|
|
438
|
+
/** Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` */
|
|
439
|
+
name?: string;
|
|
440
|
+
/** Output only. Immutable. The http endpoint that can be called to invoke processing. */
|
|
441
|
+
processEndpoint?: string;
|
|
442
|
+
/** Output only. The processor version aliases. */
|
|
443
|
+
processorVersionAliases?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias[];
|
|
444
|
+
/** Output only. Reserved for future use. */
|
|
445
|
+
satisfiesPzi?: boolean;
|
|
446
|
+
/** Output only. Reserved for future use. */
|
|
447
|
+
satisfiesPzs?: boolean;
|
|
448
|
+
/** Output only. The state of the processor. */
|
|
449
|
+
state?: string;
|
|
450
|
+
/** The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */
|
|
451
|
+
type?: string;
|
|
452
|
+
}
|
|
453
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersion {
|
|
454
|
+
/** Output only. The time the processor version was created. */
|
|
455
|
+
createTime?: string;
|
|
456
|
+
/** Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed. */
|
|
457
|
+
deploymentAllowed?: boolean;
|
|
458
|
+
/** Output only. If set, information about the eventual deprecation of this version. */
|
|
459
|
+
deprecationInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo;
|
|
460
|
+
/** The display name of the processor version. */
|
|
461
|
+
displayName?: string;
|
|
462
|
+
/** Output only. The schema of the processor version. Describes the output. */
|
|
463
|
+
documentSchema?: GoogleCloudDocumentaiUiv1beta3DocumentSchema;
|
|
464
|
+
/** Output only. Information about Generative AI model-based processor versions. */
|
|
465
|
+
genAiModelInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo;
|
|
466
|
+
/** Output only. Denotes that this `ProcessorVersion` is managed by Google. */
|
|
467
|
+
googleManaged?: boolean;
|
|
468
|
+
/** Output only. The KMS key name used for encryption. */
|
|
469
|
+
kmsKeyName?: string;
|
|
470
|
+
/** Output only. The KMS key version with which data is encrypted. */
|
|
471
|
+
kmsKeyVersionName?: string;
|
|
472
|
+
/** Output only. The most recently invoked evaluation for the processor version. */
|
|
473
|
+
latestEvaluation?: GoogleCloudDocumentaiUiv1beta3EvaluationReference;
|
|
474
|
+
/** Output only. The model type of this processor version. */
|
|
475
|
+
modelType?: string;
|
|
476
|
+
/** Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` */
|
|
477
|
+
name?: string;
|
|
478
|
+
/** Output only. Reserved for future use. */
|
|
479
|
+
satisfiesPzi?: boolean;
|
|
480
|
+
/** Output only. Reserved for future use. */
|
|
481
|
+
satisfiesPzs?: boolean;
|
|
482
|
+
/** The schema of the processor version. Describes the output. */
|
|
483
|
+
schema?: GoogleCloudDocumentaiUiv1beta3Schema;
|
|
484
|
+
/** Output only. The state of the processor version. */
|
|
485
|
+
state?: string;
|
|
486
|
+
}
|
|
487
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias {
|
|
488
|
+
/** The alias in the form of `processor_version` resource name. */
|
|
489
|
+
alias?: string;
|
|
490
|
+
/** The resource name of aliased processor version. */
|
|
491
|
+
processorVersion?: string;
|
|
492
|
+
}
|
|
493
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo {
|
|
494
|
+
/** The time at which this processor version will be deprecated. */
|
|
495
|
+
deprecationTime?: string;
|
|
496
|
+
/** If set, the processor version that will be used as a replacement. */
|
|
497
|
+
replacementProcessorVersion?: string;
|
|
498
|
+
}
|
|
499
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo {
|
|
500
|
+
/** Information for a custom Generative AI model created by the user. */
|
|
501
|
+
customGenAiModelInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo;
|
|
502
|
+
/** Information for a pretrained Google-managed foundation model. */
|
|
503
|
+
foundationGenAiModelInfo?: GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo;
|
|
504
|
+
}
|
|
505
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo {
|
|
506
|
+
/** The base processor version ID for the custom model. */
|
|
507
|
+
baseProcessorVersionId?: string;
|
|
508
|
+
/** The type of custom model created by the user. */
|
|
509
|
+
customModelType?: string;
|
|
510
|
+
}
|
|
511
|
+
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
512
|
+
/** Whether finetuning is allowed for this base processor version. */
|
|
513
|
+
finetuningAllowed?: boolean;
|
|
514
|
+
/** The minimum number of labeled documents in the training dataset required for finetuning. */
|
|
515
|
+
minTrainLabeledDocuments?: number;
|
|
516
|
+
}
|
|
517
|
+
interface GoogleCloudDocumentaiUiv1beta3PropertyMetadata {
|
|
518
|
+
/** Field extraction metadata on the property. */
|
|
519
|
+
fieldExtractionMetadata?: GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata;
|
|
520
|
+
/** Field tier metadata on the property */
|
|
521
|
+
fieldTierMetadata?: GoogleCloudDocumentaiUiv1beta3FieldTierMetadata;
|
|
522
|
+
/** Human review labeling config on the property. */
|
|
523
|
+
humanReviewLabelingMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata;
|
|
524
|
+
/** Human review validation config on the property. */
|
|
525
|
+
humanReviewMetadata?: GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata;
|
|
526
|
+
/** Whether the property should be considered as "inactive". */
|
|
527
|
+
inactive?: boolean;
|
|
528
|
+
/** Schema editability metadata on the property. */
|
|
529
|
+
schemaEditabilityMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata;
|
|
530
|
+
/** Schema inference metadata on the property. */
|
|
531
|
+
schemaInferenceMetadata?: GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata;
|
|
532
|
+
}
|
|
297
533
|
interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata {
|
|
298
534
|
/** The basic metadata of the long-running operation. */
|
|
299
535
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
@@ -341,11 +577,54 @@ declare namespace gapi.client {
|
|
|
341
577
|
/** An internal identifier for document. */
|
|
342
578
|
documentId?: string;
|
|
343
579
|
}
|
|
580
|
+
interface GoogleCloudDocumentaiUiv1beta3Schema {
|
|
581
|
+
/** Description of the schema. */
|
|
582
|
+
description?: string;
|
|
583
|
+
/** Display name to show to users. */
|
|
584
|
+
displayName?: string;
|
|
585
|
+
/** Entity types of the schema. */
|
|
586
|
+
entityTypes?: GoogleCloudDocumentaiUiv1beta3SchemaEntityType[];
|
|
587
|
+
}
|
|
588
|
+
interface GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata {
|
|
589
|
+
/** Explicit flag that controls whether the label is editable. */
|
|
590
|
+
editable?: boolean;
|
|
591
|
+
/** Full resource name of processor versions that contain this label. e.g. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` */
|
|
592
|
+
processorVersions?: string[];
|
|
593
|
+
}
|
|
594
|
+
interface GoogleCloudDocumentaiUiv1beta3SchemaEntityType {
|
|
595
|
+
baseType?: string;
|
|
596
|
+
/** Description of the entity type. */
|
|
597
|
+
description?: string;
|
|
598
|
+
/** If specified, lists all the possible values for this entity. */
|
|
599
|
+
enumValues?: string[];
|
|
600
|
+
/** If the entity type is hidden in the schema. This provides the functionality to temporally "disable" an entity without deleting it. */
|
|
601
|
+
hide?: boolean;
|
|
602
|
+
/** Specifies how the entity's value is obtained. */
|
|
603
|
+
method?: string;
|
|
604
|
+
/** Occurrence type limits the number of times an entity type appears in the document. */
|
|
605
|
+
occurrenceType?: string;
|
|
606
|
+
/** 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. */
|
|
607
|
+
properties?: GoogleCloudDocumentaiUiv1beta3SchemaEntityType[];
|
|
608
|
+
/** Source of this entity type. */
|
|
609
|
+
source?: string;
|
|
610
|
+
/** 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. */
|
|
611
|
+
type?: string;
|
|
612
|
+
}
|
|
613
|
+
interface GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata {
|
|
614
|
+
/** True if is inferred by schema inference. */
|
|
615
|
+
inferred?: boolean;
|
|
616
|
+
}
|
|
344
617
|
interface GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata {
|
|
345
618
|
/** The basic metadata of the long-running operation. */
|
|
346
619
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
347
620
|
}
|
|
348
621
|
interface GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse {}
|
|
622
|
+
interface GoogleCloudDocumentaiUiv1beta3SummaryOptions {
|
|
623
|
+
/** The format the summary should be in. */
|
|
624
|
+
format?: string;
|
|
625
|
+
/** How long the summary should be. */
|
|
626
|
+
length?: string;
|
|
627
|
+
}
|
|
349
628
|
interface GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata {
|
|
350
629
|
/** The basic metadata of the long-running operation. */
|
|
351
630
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
@@ -385,6 +664,10 @@ declare namespace gapi.client {
|
|
|
385
664
|
/** The basic metadata of the long-running operation. */
|
|
386
665
|
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
387
666
|
}
|
|
667
|
+
interface GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata {
|
|
668
|
+
/** The basic metadata for the long-running operation. */
|
|
669
|
+
commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
|
|
670
|
+
}
|
|
388
671
|
interface GoogleCloudDocumentaiV1BatchProcessMetadata {
|
|
389
672
|
/** The creation time of the operation. */
|
|
390
673
|
createTime?: string;
|
|
@@ -843,9 +1126,11 @@ declare namespace gapi.client {
|
|
|
843
1126
|
validationResults?: GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult[];
|
|
844
1127
|
}
|
|
845
1128
|
interface GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult {
|
|
1129
|
+
/** Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` */
|
|
1130
|
+
rule?: string;
|
|
846
1131
|
/** The description of the validation rule. */
|
|
847
1132
|
ruleDescription?: string;
|
|
848
|
-
/** The name of the validation rule. */
|
|
1133
|
+
/** The display name of the validation rule. */
|
|
849
1134
|
ruleName?: string;
|
|
850
1135
|
/** The detailed information of the running the validation process using the entity from the document based on the validation rule. */
|
|
851
1136
|
validationDetails?: string;
|
|
@@ -1184,6 +1469,10 @@ declare namespace gapi.client {
|
|
|
1184
1469
|
/** A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. */
|
|
1185
1470
|
stateMessage?: string;
|
|
1186
1471
|
}
|
|
1472
|
+
interface GoogleCloudDocumentaiV1beta3Documents {
|
|
1473
|
+
/** The list of documents. */
|
|
1474
|
+
documents?: GoogleCloudDocumentaiV1beta3Document[];
|
|
1475
|
+
}
|
|
1187
1476
|
interface GoogleCloudDocumentaiV1beta3DocumentSchema {
|
|
1188
1477
|
/** Description of the schema. */
|
|
1189
1478
|
description?: string;
|
|
@@ -1420,6 +1709,30 @@ declare namespace gapi.client {
|
|
|
1420
1709
|
/** The URI prefix. */
|
|
1421
1710
|
gcsUriPrefix?: string;
|
|
1422
1711
|
}
|
|
1712
|
+
interface GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest {
|
|
1713
|
+
/** The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
1714
|
+
baseSchemaVersion?: string;
|
|
1715
|
+
/** The set of documents placed on Cloud Storage. */
|
|
1716
|
+
gcsDocuments?: GoogleCloudDocumentaiV1beta3GcsDocuments;
|
|
1717
|
+
/** The common prefix of documents placed on Cloud Storage. */
|
|
1718
|
+
gcsPrefix?: GoogleCloudDocumentaiV1beta3GcsPrefix;
|
|
1719
|
+
/** Optional. User specified parameters for the schema generation. */
|
|
1720
|
+
generateSchemaVersionParams?: GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams;
|
|
1721
|
+
/** The set of documents specified inline. */
|
|
1722
|
+
inlineDocuments?: GoogleCloudDocumentaiV1beta3Documents;
|
|
1723
|
+
/** The set of raw documents. */
|
|
1724
|
+
rawDocuments?: GoogleCloudDocumentaiV1beta3RawDocuments;
|
|
1725
|
+
}
|
|
1726
|
+
interface GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams {
|
|
1727
|
+
/** Optional. Previous prompt-answers in a chronological order. */
|
|
1728
|
+
history?: GoogleCloudDocumentaiV1beta3SchemaGenerationHistory;
|
|
1729
|
+
/** Optional. The prompt used for the schema generation. */
|
|
1730
|
+
prompt?: string;
|
|
1731
|
+
}
|
|
1732
|
+
interface GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse {
|
|
1733
|
+
/** The schema version generated by the model. */
|
|
1734
|
+
schemaVersion?: GoogleCloudDocumentaiV1beta3SchemaVersion;
|
|
1735
|
+
}
|
|
1423
1736
|
interface GoogleCloudDocumentaiV1beta3GetDocumentResponse {
|
|
1424
1737
|
document?: GoogleCloudDocumentaiV1beta3Document;
|
|
1425
1738
|
}
|
|
@@ -1536,6 +1849,30 @@ declare namespace gapi.client {
|
|
|
1536
1849
|
/** The list of processors. */
|
|
1537
1850
|
processorVersions?: GoogleCloudDocumentaiV1beta3ProcessorVersion[];
|
|
1538
1851
|
}
|
|
1852
|
+
interface GoogleCloudDocumentaiV1beta3ListSchemasResponse {
|
|
1853
|
+
/** Points to the next Schema, otherwise empty. */
|
|
1854
|
+
nextPageToken?: string;
|
|
1855
|
+
/** The list of Schemas. */
|
|
1856
|
+
schemas?: GoogleCloudDocumentaiV1beta3NextSchema[];
|
|
1857
|
+
}
|
|
1858
|
+
interface GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse {
|
|
1859
|
+
/** Points to the next SchemaVersion, otherwise empty. */
|
|
1860
|
+
nextPageToken?: string;
|
|
1861
|
+
/** The list of SchemaVersions. */
|
|
1862
|
+
schemaVersions?: GoogleCloudDocumentaiV1beta3SchemaVersion[];
|
|
1863
|
+
}
|
|
1864
|
+
interface GoogleCloudDocumentaiV1beta3NextSchema {
|
|
1865
|
+
/** Output only. The time when the Schema was created. */
|
|
1866
|
+
createTime?: string;
|
|
1867
|
+
/** Optional. The user-defined name of the Schema. */
|
|
1868
|
+
displayName?: string;
|
|
1869
|
+
/** Optional. The GCP labels for the Schema. */
|
|
1870
|
+
labels?: {[P in string]: string};
|
|
1871
|
+
/** Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
1872
|
+
name?: string;
|
|
1873
|
+
/** Output only. The time when the Schema was last updated. */
|
|
1874
|
+
updateTime?: string;
|
|
1875
|
+
}
|
|
1539
1876
|
interface GoogleCloudDocumentaiV1beta3NormalizedVertex {
|
|
1540
1877
|
/** X coordinate. */
|
|
1541
1878
|
x?: number;
|
|
@@ -1617,6 +1954,8 @@ declare namespace gapi.client {
|
|
|
1617
1954
|
semanticChunkingGroupSize?: boolean;
|
|
1618
1955
|
}
|
|
1619
1956
|
interface GoogleCloudDocumentaiV1beta3Processor {
|
|
1957
|
+
/** 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} */
|
|
1958
|
+
activeSchemaVersion?: string;
|
|
1620
1959
|
/** Output only. The time the processor was created. */
|
|
1621
1960
|
createTime?: string;
|
|
1622
1961
|
/** The default processor version. */
|
|
@@ -1762,6 +2101,10 @@ declare namespace gapi.client {
|
|
|
1762
2101
|
/** An IANA MIME type (RFC6838) indicating the nature and format of the content. */
|
|
1763
2102
|
mimeType?: string;
|
|
1764
2103
|
}
|
|
2104
|
+
interface GoogleCloudDocumentaiV1beta3RawDocuments {
|
|
2105
|
+
/** Specifies raw document content and mime type. */
|
|
2106
|
+
documents?: GoogleCloudDocumentaiV1beta3RawDocument[];
|
|
2107
|
+
}
|
|
1765
2108
|
interface GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata {
|
|
1766
2109
|
/** The basic metadata of the long-running operation. */
|
|
1767
2110
|
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
@@ -1804,6 +2147,30 @@ declare namespace gapi.client {
|
|
|
1804
2147
|
/** Reads the revision given by the id. */
|
|
1805
2148
|
revisionId?: string;
|
|
1806
2149
|
}
|
|
2150
|
+
interface GoogleCloudDocumentaiV1beta3SchemaGenerationHistory {
|
|
2151
|
+
/** Required. Previous prompt-answers in a chronological order. */
|
|
2152
|
+
iterations?: GoogleCloudDocumentaiV1beta3SchemaGenerationIteration[];
|
|
2153
|
+
}
|
|
2154
|
+
interface GoogleCloudDocumentaiV1beta3SchemaGenerationIteration {
|
|
2155
|
+
/** Optional. The previous schema version adjusted by the model. */
|
|
2156
|
+
adjustedSchema?: GoogleCloudDocumentaiV1beta3SchemaVersion;
|
|
2157
|
+
/** Required. The schema version generated by the model. */
|
|
2158
|
+
generatedSchema?: GoogleCloudDocumentaiV1beta3SchemaVersion;
|
|
2159
|
+
/** Optional. The prompt used for the iteration. */
|
|
2160
|
+
prompt?: string;
|
|
2161
|
+
}
|
|
2162
|
+
interface GoogleCloudDocumentaiV1beta3SchemaVersion {
|
|
2163
|
+
/** Output only. The time when the SchemaVersion was created. */
|
|
2164
|
+
createTime?: string;
|
|
2165
|
+
/** Optional. The user-defined name of the SchemaVersion. */
|
|
2166
|
+
displayName?: string;
|
|
2167
|
+
/** Optional. The GCP labels for the SchemaVersion. */
|
|
2168
|
+
labels?: {[P in string]: string};
|
|
2169
|
+
/** Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
2170
|
+
name?: string;
|
|
2171
|
+
/** Required. The schema of the SchemaVersion. */
|
|
2172
|
+
schema?: GoogleCloudDocumentaiV1beta3DocumentSchema;
|
|
2173
|
+
}
|
|
1807
2174
|
interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata {
|
|
1808
2175
|
/** The basic metadata of the long-running operation. */
|
|
1809
2176
|
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
@@ -1881,6 +2248,10 @@ declare namespace gapi.client {
|
|
|
1881
2248
|
/** The basic metadata of the long-running operation. */
|
|
1882
2249
|
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
1883
2250
|
}
|
|
2251
|
+
interface GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata {
|
|
2252
|
+
/** The basic metadata for the long-running operation. */
|
|
2253
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
2254
|
+
}
|
|
1884
2255
|
interface GoogleCloudDocumentaiV1beta3Vertex {
|
|
1885
2256
|
/** X coordinate. */
|
|
1886
2257
|
x?: number;
|
|
@@ -3684,6 +4055,481 @@ declare namespace gapi.client {
|
|
|
3684
4055
|
uploadType?: string;
|
|
3685
4056
|
}): Request<GoogleCloudDocumentaiV1beta3ListProcessorTypesResponse>;
|
|
3686
4057
|
}
|
|
4058
|
+
interface SchemaVersionsResource {
|
|
4059
|
+
/** Creates a schema version. */
|
|
4060
|
+
create(request: {
|
|
4061
|
+
/** V1 error format. */
|
|
4062
|
+
'$.xgafv'?: string;
|
|
4063
|
+
/** OAuth access token. */
|
|
4064
|
+
access_token?: string;
|
|
4065
|
+
/** Data format for response. */
|
|
4066
|
+
alt?: string;
|
|
4067
|
+
/** JSONP */
|
|
4068
|
+
callback?: string;
|
|
4069
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4070
|
+
fields?: string;
|
|
4071
|
+
/** 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. */
|
|
4072
|
+
key?: string;
|
|
4073
|
+
/** OAuth 2.0 token for the current user. */
|
|
4074
|
+
oauth_token?: string;
|
|
4075
|
+
/** Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4076
|
+
parent: string;
|
|
4077
|
+
/** Returns response with indentations and line breaks. */
|
|
4078
|
+
prettyPrint?: boolean;
|
|
4079
|
+
/** 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. */
|
|
4080
|
+
quotaUser?: string;
|
|
4081
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4082
|
+
upload_protocol?: string;
|
|
4083
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4084
|
+
uploadType?: string;
|
|
4085
|
+
/** Request body */
|
|
4086
|
+
resource: GoogleCloudDocumentaiV1beta3SchemaVersion;
|
|
4087
|
+
}): Request<GoogleCloudDocumentaiV1beta3SchemaVersion>;
|
|
4088
|
+
create(
|
|
4089
|
+
request: {
|
|
4090
|
+
/** V1 error format. */
|
|
4091
|
+
'$.xgafv'?: string;
|
|
4092
|
+
/** OAuth access token. */
|
|
4093
|
+
access_token?: string;
|
|
4094
|
+
/** Data format for response. */
|
|
4095
|
+
alt?: string;
|
|
4096
|
+
/** JSONP */
|
|
4097
|
+
callback?: string;
|
|
4098
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4099
|
+
fields?: string;
|
|
4100
|
+
/** 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. */
|
|
4101
|
+
key?: string;
|
|
4102
|
+
/** OAuth 2.0 token for the current user. */
|
|
4103
|
+
oauth_token?: string;
|
|
4104
|
+
/** Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4105
|
+
parent: string;
|
|
4106
|
+
/** Returns response with indentations and line breaks. */
|
|
4107
|
+
prettyPrint?: boolean;
|
|
4108
|
+
/** 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. */
|
|
4109
|
+
quotaUser?: string;
|
|
4110
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4111
|
+
upload_protocol?: string;
|
|
4112
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4113
|
+
uploadType?: string;
|
|
4114
|
+
},
|
|
4115
|
+
body: GoogleCloudDocumentaiV1beta3SchemaVersion,
|
|
4116
|
+
): Request<GoogleCloudDocumentaiV1beta3SchemaVersion>;
|
|
4117
|
+
/** Deletes a schema version. */
|
|
4118
|
+
delete(request?: {
|
|
4119
|
+
/** V1 error format. */
|
|
4120
|
+
'$.xgafv'?: string;
|
|
4121
|
+
/** OAuth access token. */
|
|
4122
|
+
access_token?: string;
|
|
4123
|
+
/** Data format for response. */
|
|
4124
|
+
alt?: string;
|
|
4125
|
+
/** JSONP */
|
|
4126
|
+
callback?: string;
|
|
4127
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4128
|
+
fields?: string;
|
|
4129
|
+
/** 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. */
|
|
4130
|
+
key?: string;
|
|
4131
|
+
/** Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
4132
|
+
name: string;
|
|
4133
|
+
/** OAuth 2.0 token for the current user. */
|
|
4134
|
+
oauth_token?: string;
|
|
4135
|
+
/** Returns response with indentations and line breaks. */
|
|
4136
|
+
prettyPrint?: boolean;
|
|
4137
|
+
/** 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. */
|
|
4138
|
+
quotaUser?: string;
|
|
4139
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4140
|
+
upload_protocol?: string;
|
|
4141
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4142
|
+
uploadType?: string;
|
|
4143
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4144
|
+
/** Generates a schema version. */
|
|
4145
|
+
generate(request: {
|
|
4146
|
+
/** V1 error format. */
|
|
4147
|
+
'$.xgafv'?: string;
|
|
4148
|
+
/** OAuth access token. */
|
|
4149
|
+
access_token?: string;
|
|
4150
|
+
/** Data format for response. */
|
|
4151
|
+
alt?: string;
|
|
4152
|
+
/** JSONP */
|
|
4153
|
+
callback?: string;
|
|
4154
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4155
|
+
fields?: string;
|
|
4156
|
+
/** 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. */
|
|
4157
|
+
key?: string;
|
|
4158
|
+
/** OAuth 2.0 token for the current user. */
|
|
4159
|
+
oauth_token?: string;
|
|
4160
|
+
/** Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4161
|
+
parent: string;
|
|
4162
|
+
/** Returns response with indentations and line breaks. */
|
|
4163
|
+
prettyPrint?: boolean;
|
|
4164
|
+
/** 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. */
|
|
4165
|
+
quotaUser?: string;
|
|
4166
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4167
|
+
upload_protocol?: string;
|
|
4168
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4169
|
+
uploadType?: string;
|
|
4170
|
+
/** Request body */
|
|
4171
|
+
resource: GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest;
|
|
4172
|
+
}): Request<GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse>;
|
|
4173
|
+
generate(
|
|
4174
|
+
request: {
|
|
4175
|
+
/** V1 error format. */
|
|
4176
|
+
'$.xgafv'?: string;
|
|
4177
|
+
/** OAuth access token. */
|
|
4178
|
+
access_token?: string;
|
|
4179
|
+
/** Data format for response. */
|
|
4180
|
+
alt?: string;
|
|
4181
|
+
/** JSONP */
|
|
4182
|
+
callback?: string;
|
|
4183
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4184
|
+
fields?: string;
|
|
4185
|
+
/** 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. */
|
|
4186
|
+
key?: string;
|
|
4187
|
+
/** OAuth 2.0 token for the current user. */
|
|
4188
|
+
oauth_token?: string;
|
|
4189
|
+
/** Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4190
|
+
parent: string;
|
|
4191
|
+
/** Returns response with indentations and line breaks. */
|
|
4192
|
+
prettyPrint?: boolean;
|
|
4193
|
+
/** 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. */
|
|
4194
|
+
quotaUser?: string;
|
|
4195
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4196
|
+
upload_protocol?: string;
|
|
4197
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4198
|
+
uploadType?: string;
|
|
4199
|
+
},
|
|
4200
|
+
body: GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest,
|
|
4201
|
+
): Request<GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse>;
|
|
4202
|
+
/** Gets a schema version. */
|
|
4203
|
+
get(request?: {
|
|
4204
|
+
/** V1 error format. */
|
|
4205
|
+
'$.xgafv'?: string;
|
|
4206
|
+
/** OAuth access token. */
|
|
4207
|
+
access_token?: string;
|
|
4208
|
+
/** Data format for response. */
|
|
4209
|
+
alt?: string;
|
|
4210
|
+
/** JSONP */
|
|
4211
|
+
callback?: string;
|
|
4212
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4213
|
+
fields?: string;
|
|
4214
|
+
/** 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. */
|
|
4215
|
+
key?: string;
|
|
4216
|
+
/** Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
4217
|
+
name: string;
|
|
4218
|
+
/** OAuth 2.0 token for the current user. */
|
|
4219
|
+
oauth_token?: string;
|
|
4220
|
+
/** Returns response with indentations and line breaks. */
|
|
4221
|
+
prettyPrint?: boolean;
|
|
4222
|
+
/** 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. */
|
|
4223
|
+
quotaUser?: string;
|
|
4224
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4225
|
+
upload_protocol?: string;
|
|
4226
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4227
|
+
uploadType?: string;
|
|
4228
|
+
}): Request<GoogleCloudDocumentaiV1beta3SchemaVersion>;
|
|
4229
|
+
/** Lists SchemaVersions. */
|
|
4230
|
+
list(request?: {
|
|
4231
|
+
/** V1 error format. */
|
|
4232
|
+
'$.xgafv'?: string;
|
|
4233
|
+
/** OAuth access token. */
|
|
4234
|
+
access_token?: string;
|
|
4235
|
+
/** Data format for response. */
|
|
4236
|
+
alt?: string;
|
|
4237
|
+
/** JSONP */
|
|
4238
|
+
callback?: string;
|
|
4239
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4240
|
+
fields?: string;
|
|
4241
|
+
/** 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. */
|
|
4242
|
+
key?: string;
|
|
4243
|
+
/** OAuth 2.0 token for the current user. */
|
|
4244
|
+
oauth_token?: string;
|
|
4245
|
+
/** 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`. */
|
|
4246
|
+
pageSize?: number;
|
|
4247
|
+
/** Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion. */
|
|
4248
|
+
pageToken?: string;
|
|
4249
|
+
/** Required. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4250
|
+
parent: string;
|
|
4251
|
+
/** Returns response with indentations and line breaks. */
|
|
4252
|
+
prettyPrint?: boolean;
|
|
4253
|
+
/** 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. */
|
|
4254
|
+
quotaUser?: string;
|
|
4255
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4256
|
+
upload_protocol?: string;
|
|
4257
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4258
|
+
uploadType?: string;
|
|
4259
|
+
}): Request<GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse>;
|
|
4260
|
+
/** Updates a schema version. Editable fields are: - `display_name` - `labels` */
|
|
4261
|
+
patch(request: {
|
|
4262
|
+
/** V1 error format. */
|
|
4263
|
+
'$.xgafv'?: string;
|
|
4264
|
+
/** OAuth access token. */
|
|
4265
|
+
access_token?: string;
|
|
4266
|
+
/** Data format for response. */
|
|
4267
|
+
alt?: string;
|
|
4268
|
+
/** JSONP */
|
|
4269
|
+
callback?: string;
|
|
4270
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4271
|
+
fields?: string;
|
|
4272
|
+
/** 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. */
|
|
4273
|
+
key?: string;
|
|
4274
|
+
/** Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
4275
|
+
name: string;
|
|
4276
|
+
/** OAuth 2.0 token for the current user. */
|
|
4277
|
+
oauth_token?: string;
|
|
4278
|
+
/** Returns response with indentations and line breaks. */
|
|
4279
|
+
prettyPrint?: boolean;
|
|
4280
|
+
/** 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. */
|
|
4281
|
+
quotaUser?: string;
|
|
4282
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
|
|
4283
|
+
updateMask?: string;
|
|
4284
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4285
|
+
upload_protocol?: string;
|
|
4286
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4287
|
+
uploadType?: string;
|
|
4288
|
+
/** Request body */
|
|
4289
|
+
resource: GoogleCloudDocumentaiV1beta3SchemaVersion;
|
|
4290
|
+
}): Request<GoogleCloudDocumentaiV1beta3SchemaVersion>;
|
|
4291
|
+
patch(
|
|
4292
|
+
request: {
|
|
4293
|
+
/** V1 error format. */
|
|
4294
|
+
'$.xgafv'?: string;
|
|
4295
|
+
/** OAuth access token. */
|
|
4296
|
+
access_token?: string;
|
|
4297
|
+
/** Data format for response. */
|
|
4298
|
+
alt?: string;
|
|
4299
|
+
/** JSONP */
|
|
4300
|
+
callback?: string;
|
|
4301
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4302
|
+
fields?: string;
|
|
4303
|
+
/** 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. */
|
|
4304
|
+
key?: string;
|
|
4305
|
+
/** Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` */
|
|
4306
|
+
name: string;
|
|
4307
|
+
/** OAuth 2.0 token for the current user. */
|
|
4308
|
+
oauth_token?: string;
|
|
4309
|
+
/** Returns response with indentations and line breaks. */
|
|
4310
|
+
prettyPrint?: boolean;
|
|
4311
|
+
/** 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. */
|
|
4312
|
+
quotaUser?: string;
|
|
4313
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
|
|
4314
|
+
updateMask?: string;
|
|
4315
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4316
|
+
upload_protocol?: string;
|
|
4317
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4318
|
+
uploadType?: string;
|
|
4319
|
+
},
|
|
4320
|
+
body: GoogleCloudDocumentaiV1beta3SchemaVersion,
|
|
4321
|
+
): Request<GoogleCloudDocumentaiV1beta3SchemaVersion>;
|
|
4322
|
+
}
|
|
4323
|
+
interface SchemasResource {
|
|
4324
|
+
/** Creates a schema. */
|
|
4325
|
+
create(request: {
|
|
4326
|
+
/** V1 error format. */
|
|
4327
|
+
'$.xgafv'?: string;
|
|
4328
|
+
/** OAuth access token. */
|
|
4329
|
+
access_token?: string;
|
|
4330
|
+
/** Data format for response. */
|
|
4331
|
+
alt?: string;
|
|
4332
|
+
/** JSONP */
|
|
4333
|
+
callback?: string;
|
|
4334
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4335
|
+
fields?: string;
|
|
4336
|
+
/** 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. */
|
|
4337
|
+
key?: string;
|
|
4338
|
+
/** OAuth 2.0 token for the current user. */
|
|
4339
|
+
oauth_token?: string;
|
|
4340
|
+
/** Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}` */
|
|
4341
|
+
parent: string;
|
|
4342
|
+
/** Returns response with indentations and line breaks. */
|
|
4343
|
+
prettyPrint?: boolean;
|
|
4344
|
+
/** 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. */
|
|
4345
|
+
quotaUser?: string;
|
|
4346
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4347
|
+
upload_protocol?: string;
|
|
4348
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4349
|
+
uploadType?: string;
|
|
4350
|
+
/** Request body */
|
|
4351
|
+
resource: GoogleCloudDocumentaiV1beta3NextSchema;
|
|
4352
|
+
}): Request<GoogleCloudDocumentaiV1beta3NextSchema>;
|
|
4353
|
+
create(
|
|
4354
|
+
request: {
|
|
4355
|
+
/** V1 error format. */
|
|
4356
|
+
'$.xgafv'?: string;
|
|
4357
|
+
/** OAuth access token. */
|
|
4358
|
+
access_token?: string;
|
|
4359
|
+
/** Data format for response. */
|
|
4360
|
+
alt?: string;
|
|
4361
|
+
/** JSONP */
|
|
4362
|
+
callback?: string;
|
|
4363
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4364
|
+
fields?: string;
|
|
4365
|
+
/** 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. */
|
|
4366
|
+
key?: string;
|
|
4367
|
+
/** OAuth 2.0 token for the current user. */
|
|
4368
|
+
oauth_token?: string;
|
|
4369
|
+
/** Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}` */
|
|
4370
|
+
parent: string;
|
|
4371
|
+
/** Returns response with indentations and line breaks. */
|
|
4372
|
+
prettyPrint?: boolean;
|
|
4373
|
+
/** 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. */
|
|
4374
|
+
quotaUser?: string;
|
|
4375
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4376
|
+
upload_protocol?: string;
|
|
4377
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4378
|
+
uploadType?: string;
|
|
4379
|
+
},
|
|
4380
|
+
body: GoogleCloudDocumentaiV1beta3NextSchema,
|
|
4381
|
+
): Request<GoogleCloudDocumentaiV1beta3NextSchema>;
|
|
4382
|
+
/** Deletes a schema. */
|
|
4383
|
+
delete(request?: {
|
|
4384
|
+
/** V1 error format. */
|
|
4385
|
+
'$.xgafv'?: string;
|
|
4386
|
+
/** OAuth access token. */
|
|
4387
|
+
access_token?: string;
|
|
4388
|
+
/** Data format for response. */
|
|
4389
|
+
alt?: string;
|
|
4390
|
+
/** JSONP */
|
|
4391
|
+
callback?: string;
|
|
4392
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4393
|
+
fields?: string;
|
|
4394
|
+
/** 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.) */
|
|
4395
|
+
force?: boolean;
|
|
4396
|
+
/** 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. */
|
|
4397
|
+
key?: string;
|
|
4398
|
+
/** Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4399
|
+
name: string;
|
|
4400
|
+
/** OAuth 2.0 token for the current user. */
|
|
4401
|
+
oauth_token?: string;
|
|
4402
|
+
/** Returns response with indentations and line breaks. */
|
|
4403
|
+
prettyPrint?: boolean;
|
|
4404
|
+
/** 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. */
|
|
4405
|
+
quotaUser?: string;
|
|
4406
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4407
|
+
upload_protocol?: string;
|
|
4408
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4409
|
+
uploadType?: string;
|
|
4410
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4411
|
+
/** Gets a schema. */
|
|
4412
|
+
get(request?: {
|
|
4413
|
+
/** V1 error format. */
|
|
4414
|
+
'$.xgafv'?: string;
|
|
4415
|
+
/** OAuth access token. */
|
|
4416
|
+
access_token?: string;
|
|
4417
|
+
/** Data format for response. */
|
|
4418
|
+
alt?: string;
|
|
4419
|
+
/** JSONP */
|
|
4420
|
+
callback?: string;
|
|
4421
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4422
|
+
fields?: string;
|
|
4423
|
+
/** 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. */
|
|
4424
|
+
key?: string;
|
|
4425
|
+
/** Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4426
|
+
name: string;
|
|
4427
|
+
/** OAuth 2.0 token for the current user. */
|
|
4428
|
+
oauth_token?: string;
|
|
4429
|
+
/** Returns response with indentations and line breaks. */
|
|
4430
|
+
prettyPrint?: boolean;
|
|
4431
|
+
/** 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. */
|
|
4432
|
+
quotaUser?: string;
|
|
4433
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4434
|
+
upload_protocol?: string;
|
|
4435
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4436
|
+
uploadType?: string;
|
|
4437
|
+
}): Request<GoogleCloudDocumentaiV1beta3NextSchema>;
|
|
4438
|
+
/** Lists Schemas. */
|
|
4439
|
+
list(request?: {
|
|
4440
|
+
/** V1 error format. */
|
|
4441
|
+
'$.xgafv'?: string;
|
|
4442
|
+
/** OAuth access token. */
|
|
4443
|
+
access_token?: string;
|
|
4444
|
+
/** Data format for response. */
|
|
4445
|
+
alt?: string;
|
|
4446
|
+
/** JSONP */
|
|
4447
|
+
callback?: string;
|
|
4448
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4449
|
+
fields?: string;
|
|
4450
|
+
/** 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. */
|
|
4451
|
+
key?: string;
|
|
4452
|
+
/** OAuth 2.0 token for the current user. */
|
|
4453
|
+
oauth_token?: string;
|
|
4454
|
+
/** 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`. */
|
|
4455
|
+
pageSize?: number;
|
|
4456
|
+
/** Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema. */
|
|
4457
|
+
pageToken?: string;
|
|
4458
|
+
/** Required. Format: `projects/{project}/locations/{location}` */
|
|
4459
|
+
parent: string;
|
|
4460
|
+
/** Returns response with indentations and line breaks. */
|
|
4461
|
+
prettyPrint?: boolean;
|
|
4462
|
+
/** 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. */
|
|
4463
|
+
quotaUser?: string;
|
|
4464
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4465
|
+
upload_protocol?: string;
|
|
4466
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4467
|
+
uploadType?: string;
|
|
4468
|
+
}): Request<GoogleCloudDocumentaiV1beta3ListSchemasResponse>;
|
|
4469
|
+
/** Updates a schema. Editable fields are: - `display_name` - `labels` */
|
|
4470
|
+
patch(request: {
|
|
4471
|
+
/** V1 error format. */
|
|
4472
|
+
'$.xgafv'?: string;
|
|
4473
|
+
/** OAuth access token. */
|
|
4474
|
+
access_token?: string;
|
|
4475
|
+
/** Data format for response. */
|
|
4476
|
+
alt?: string;
|
|
4477
|
+
/** JSONP */
|
|
4478
|
+
callback?: string;
|
|
4479
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4480
|
+
fields?: string;
|
|
4481
|
+
/** 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. */
|
|
4482
|
+
key?: string;
|
|
4483
|
+
/** Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4484
|
+
name: string;
|
|
4485
|
+
/** OAuth 2.0 token for the current user. */
|
|
4486
|
+
oauth_token?: string;
|
|
4487
|
+
/** Returns response with indentations and line breaks. */
|
|
4488
|
+
prettyPrint?: boolean;
|
|
4489
|
+
/** 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. */
|
|
4490
|
+
quotaUser?: string;
|
|
4491
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
|
|
4492
|
+
updateMask?: string;
|
|
4493
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4494
|
+
upload_protocol?: string;
|
|
4495
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4496
|
+
uploadType?: string;
|
|
4497
|
+
/** Request body */
|
|
4498
|
+
resource: GoogleCloudDocumentaiV1beta3NextSchema;
|
|
4499
|
+
}): Request<GoogleCloudDocumentaiV1beta3NextSchema>;
|
|
4500
|
+
patch(
|
|
4501
|
+
request: {
|
|
4502
|
+
/** V1 error format. */
|
|
4503
|
+
'$.xgafv'?: string;
|
|
4504
|
+
/** OAuth access token. */
|
|
4505
|
+
access_token?: string;
|
|
4506
|
+
/** Data format for response. */
|
|
4507
|
+
alt?: string;
|
|
4508
|
+
/** JSONP */
|
|
4509
|
+
callback?: string;
|
|
4510
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4511
|
+
fields?: string;
|
|
4512
|
+
/** 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. */
|
|
4513
|
+
key?: string;
|
|
4514
|
+
/** Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` */
|
|
4515
|
+
name: string;
|
|
4516
|
+
/** OAuth 2.0 token for the current user. */
|
|
4517
|
+
oauth_token?: string;
|
|
4518
|
+
/** Returns response with indentations and line breaks. */
|
|
4519
|
+
prettyPrint?: boolean;
|
|
4520
|
+
/** 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. */
|
|
4521
|
+
quotaUser?: string;
|
|
4522
|
+
/** Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. */
|
|
4523
|
+
updateMask?: string;
|
|
4524
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4525
|
+
upload_protocol?: string;
|
|
4526
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4527
|
+
uploadType?: string;
|
|
4528
|
+
},
|
|
4529
|
+
body: GoogleCloudDocumentaiV1beta3NextSchema,
|
|
4530
|
+
): Request<GoogleCloudDocumentaiV1beta3NextSchema>;
|
|
4531
|
+
schemaVersions: SchemaVersionsResource;
|
|
4532
|
+
}
|
|
3687
4533
|
interface LocationsResource {
|
|
3688
4534
|
/** Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated. */
|
|
3689
4535
|
fetchProcessorTypes(request?: {
|
|
@@ -3749,7 +4595,7 @@ declare namespace gapi.client {
|
|
|
3749
4595
|
alt?: string;
|
|
3750
4596
|
/** JSONP */
|
|
3751
4597
|
callback?: string;
|
|
3752
|
-
/** Optional.
|
|
4598
|
+
/** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
|
|
3753
4599
|
extraLocationTypes?: string | string[];
|
|
3754
4600
|
/** Selector specifying which fields to include in a partial response. */
|
|
3755
4601
|
fields?: string;
|
|
@@ -3777,6 +4623,7 @@ declare namespace gapi.client {
|
|
|
3777
4623
|
operations: OperationsResource;
|
|
3778
4624
|
processors: ProcessorsResource;
|
|
3779
4625
|
processorTypes: ProcessorTypesResource;
|
|
4626
|
+
schemas: SchemasResource;
|
|
3780
4627
|
}
|
|
3781
4628
|
interface ProjectsResource {
|
|
3782
4629
|
locations: LocationsResource;
|