@maxim_mazurok/gapi.client.documentai-v1 0.1.20260608 → 0.2.20260706
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 +45 -56
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://documentai.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260706
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -124,7 +124,7 @@ declare namespace gapi.client {
|
|
|
124
124
|
totalDocumentCount?: number;
|
|
125
125
|
}
|
|
126
126
|
interface GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus {
|
|
127
|
-
/** The document
|
|
127
|
+
/** The document ID of the auto-labeled document. This will replace the gcs_uri. */
|
|
128
128
|
documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
129
129
|
/** The status of the document auto-labeling. */
|
|
130
130
|
status?: GoogleRpcStatus;
|
|
@@ -141,7 +141,7 @@ declare namespace gapi.client {
|
|
|
141
141
|
totalDocumentCount?: number;
|
|
142
142
|
}
|
|
143
143
|
interface GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus {
|
|
144
|
-
/** The document
|
|
144
|
+
/** The document ID of the document. */
|
|
145
145
|
documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
146
146
|
/** The status of deleting the document in storage. */
|
|
147
147
|
status?: GoogleRpcStatus;
|
|
@@ -166,7 +166,7 @@ declare namespace gapi.client {
|
|
|
166
166
|
individualBatchMoveStatuses?: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus[];
|
|
167
167
|
}
|
|
168
168
|
interface GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus {
|
|
169
|
-
/** The document
|
|
169
|
+
/** The document ID of the document. */
|
|
170
170
|
documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
171
171
|
/** The status of moving the document. */
|
|
172
172
|
status?: GoogleRpcStatus;
|
|
@@ -179,7 +179,7 @@ declare namespace gapi.client {
|
|
|
179
179
|
individualBatchUpdateStatuses?: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus[];
|
|
180
180
|
}
|
|
181
181
|
interface GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus {
|
|
182
|
-
/** The document
|
|
182
|
+
/** The document ID of the document. */
|
|
183
183
|
documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
184
184
|
/** The status of updating the document in storage. */
|
|
185
185
|
status?: GoogleRpcStatus;
|
|
@@ -230,21 +230,21 @@ declare namespace gapi.client {
|
|
|
230
230
|
}
|
|
231
231
|
interface GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse {}
|
|
232
232
|
interface GoogleCloudDocumentaiUiv1beta3DocumentId {
|
|
233
|
-
/** A document
|
|
233
|
+
/** A document ID within user-managed Cloud Storage. */
|
|
234
234
|
gcsManagedDocId?: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId;
|
|
235
235
|
/** Points to a specific revision of the document if set. */
|
|
236
236
|
revisionRef?: GoogleCloudDocumentaiUiv1beta3RevisionRef;
|
|
237
|
-
/** A document
|
|
237
|
+
/** A document ID within unmanaged dataset. */
|
|
238
238
|
unmanagedDocId?: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId;
|
|
239
239
|
}
|
|
240
240
|
interface GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId {
|
|
241
|
-
/**
|
|
241
|
+
/** ID of the document (indexed) managed by Content Warehouse. */
|
|
242
242
|
cwDocId?: string;
|
|
243
243
|
/** Required. The Cloud Storage URI where the actual document is stored. */
|
|
244
244
|
gcsUri?: string;
|
|
245
245
|
}
|
|
246
246
|
interface GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId {
|
|
247
|
-
/** Required. The
|
|
247
|
+
/** Required. The ID of the document. */
|
|
248
248
|
docId?: string;
|
|
249
249
|
}
|
|
250
250
|
interface GoogleCloudDocumentaiUiv1beta3DocumentSchema {
|
|
@@ -252,7 +252,7 @@ declare namespace gapi.client {
|
|
|
252
252
|
description?: string;
|
|
253
253
|
/** Display name to show users. */
|
|
254
254
|
displayName?: string;
|
|
255
|
-
/** Optional. Document
|
|
255
|
+
/** Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. */
|
|
256
256
|
documentPrompt?: string;
|
|
257
257
|
/** Entity types of the schema. */
|
|
258
258
|
entityTypes?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType[];
|
|
@@ -270,7 +270,7 @@ declare namespace gapi.client {
|
|
|
270
270
|
entityTypeMetadata?: GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata;
|
|
271
271
|
/** 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. */
|
|
272
272
|
enumValues?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues;
|
|
273
|
-
/** 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. */
|
|
273
|
+
/** 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. */
|
|
274
274
|
name?: string;
|
|
275
275
|
/** Description the nested structure, or composition of an entity. */
|
|
276
276
|
properties?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty[];
|
|
@@ -449,7 +449,7 @@ declare namespace gapi.client {
|
|
|
449
449
|
interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus {
|
|
450
450
|
/** The source Cloud Storage URI of the document. */
|
|
451
451
|
inputGcsSource?: string;
|
|
452
|
-
/** The document
|
|
452
|
+
/** The document ID of imported document if it was successful, otherwise empty. */
|
|
453
453
|
outputDocumentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
454
454
|
/** The output_gcs_destination of the processed document if it was successful, otherwise empty. */
|
|
455
455
|
outputGcsDestination?: string;
|
|
@@ -466,7 +466,7 @@ declare namespace gapi.client {
|
|
|
466
466
|
processorVersion?: string;
|
|
467
467
|
}
|
|
468
468
|
interface GoogleCloudDocumentaiUiv1beta3Processor {
|
|
469
|
-
/** 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} */
|
|
469
|
+
/** 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}. */
|
|
470
470
|
activeSchemaVersion?: string;
|
|
471
471
|
/** Output only. The time the processor was created. */
|
|
472
472
|
createTime?: string;
|
|
@@ -568,9 +568,7 @@ declare namespace gapi.client {
|
|
|
568
568
|
baseProcessorVersionId?: string;
|
|
569
569
|
/** The type of custom model created by the user. */
|
|
570
570
|
customModelType?:
|
|
571
|
-
| '
|
|
572
|
-
| 'VERSIONED_FOUNDATION'
|
|
573
|
-
| 'FINE_TUNED';
|
|
571
|
+
'CUSTOM_MODEL_TYPE_UNSPECIFIED' | 'VERSIONED_FOUNDATION' | 'FINE_TUNED';
|
|
574
572
|
}
|
|
575
573
|
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
576
574
|
/** Whether fine tuning is allowed for this base processor version. */
|
|
@@ -814,7 +812,7 @@ declare namespace gapi.client {
|
|
|
814
812
|
totalDocumentCount?: number;
|
|
815
813
|
}
|
|
816
814
|
interface GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus {
|
|
817
|
-
/** The document
|
|
815
|
+
/** The document ID of the document. */
|
|
818
816
|
documentId?: GoogleCloudDocumentaiV1beta3DocumentId;
|
|
819
817
|
/** The status of deleting the document in storage. */
|
|
820
818
|
status?: GoogleRpcStatus;
|
|
@@ -883,10 +881,7 @@ declare namespace gapi.client {
|
|
|
883
881
|
satisfiesPzs?: boolean;
|
|
884
882
|
/** Required. State of the dataset. Ignored when updating dataset. */
|
|
885
883
|
state?:
|
|
886
|
-
| '
|
|
887
|
-
| 'UNINITIALIZED'
|
|
888
|
-
| 'INITIALIZING'
|
|
889
|
-
| 'INITIALIZED';
|
|
884
|
+
'STATE_UNSPECIFIED' | 'UNINITIALIZED' | 'INITIALIZING' | 'INITIALIZED';
|
|
890
885
|
/** Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed). */
|
|
891
886
|
unmanagedDatasetConfig?: any;
|
|
892
887
|
}
|
|
@@ -920,21 +915,21 @@ declare namespace gapi.client {
|
|
|
920
915
|
}
|
|
921
916
|
interface GoogleCloudDocumentaiV1beta3DisableProcessorResponse {}
|
|
922
917
|
interface GoogleCloudDocumentaiV1beta3DocumentId {
|
|
923
|
-
/** A document
|
|
918
|
+
/** A document ID within user-managed Cloud Storage. */
|
|
924
919
|
gcsManagedDocId?: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId;
|
|
925
920
|
/** Points to a specific revision of the document if set. */
|
|
926
921
|
revisionRef?: GoogleCloudDocumentaiV1beta3RevisionRef;
|
|
927
|
-
/** A document
|
|
922
|
+
/** A document ID within unmanaged dataset. */
|
|
928
923
|
unmanagedDocId?: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId;
|
|
929
924
|
}
|
|
930
925
|
interface GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId {
|
|
931
|
-
/**
|
|
926
|
+
/** ID of the document (indexed) managed by Content Warehouse. */
|
|
932
927
|
cwDocId?: string;
|
|
933
928
|
/** Required. The Cloud Storage URI where the actual document is stored. */
|
|
934
929
|
gcsUri?: string;
|
|
935
930
|
}
|
|
936
931
|
interface GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId {
|
|
937
|
-
/** Required. The
|
|
932
|
+
/** Required. The ID of the document. */
|
|
938
933
|
docId?: string;
|
|
939
934
|
}
|
|
940
935
|
interface GoogleCloudDocumentaiV1beta3DocumentSchema {
|
|
@@ -942,7 +937,7 @@ declare namespace gapi.client {
|
|
|
942
937
|
description?: string;
|
|
943
938
|
/** Display name to show users. */
|
|
944
939
|
displayName?: string;
|
|
945
|
-
/** Optional. Document
|
|
940
|
+
/** Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. */
|
|
946
941
|
documentPrompt?: string;
|
|
947
942
|
/** Entity types of the schema. */
|
|
948
943
|
entityTypes?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType[];
|
|
@@ -960,7 +955,7 @@ declare namespace gapi.client {
|
|
|
960
955
|
entityTypeMetadata?: GoogleCloudDocumentaiV1beta3EntityTypeMetadata;
|
|
961
956
|
/** 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. */
|
|
962
957
|
enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
|
|
963
|
-
/** 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. */
|
|
958
|
+
/** 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. */
|
|
964
959
|
name?: string;
|
|
965
960
|
/** Description the nested structure, or composition of an entity. */
|
|
966
961
|
properties?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty[];
|
|
@@ -1091,7 +1086,7 @@ declare namespace gapi.client {
|
|
|
1091
1086
|
interface GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus {
|
|
1092
1087
|
/** The source Cloud Storage URI of the document. */
|
|
1093
1088
|
inputGcsSource?: string;
|
|
1094
|
-
/** The document
|
|
1089
|
+
/** The document ID of imported document if it was successful, otherwise empty. */
|
|
1095
1090
|
outputDocumentId?: GoogleCloudDocumentaiV1beta3DocumentId;
|
|
1096
1091
|
/** The status of the importing of the document. */
|
|
1097
1092
|
status?: GoogleRpcStatus;
|
|
@@ -1106,7 +1101,7 @@ declare namespace gapi.client {
|
|
|
1106
1101
|
processorVersion?: string;
|
|
1107
1102
|
}
|
|
1108
1103
|
interface GoogleCloudDocumentaiV1beta3Processor {
|
|
1109
|
-
/** 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} */
|
|
1104
|
+
/** 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}. */
|
|
1110
1105
|
activeSchemaVersion?: string;
|
|
1111
1106
|
/** Output only. The time the processor was created. */
|
|
1112
1107
|
createTime?: string;
|
|
@@ -1204,9 +1199,7 @@ declare namespace gapi.client {
|
|
|
1204
1199
|
baseProcessorVersionId?: string;
|
|
1205
1200
|
/** The type of custom model created by the user. */
|
|
1206
1201
|
customModelType?:
|
|
1207
|
-
| '
|
|
1208
|
-
| 'VERSIONED_FOUNDATION'
|
|
1209
|
-
| 'FINE_TUNED';
|
|
1202
|
+
'CUSTOM_MODEL_TYPE_UNSPECIFIED' | 'VERSIONED_FOUNDATION' | 'FINE_TUNED';
|
|
1210
1203
|
}
|
|
1211
1204
|
interface GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
1212
1205
|
/** Whether fine tuning is allowed for this base processor version. */
|
|
@@ -1351,7 +1344,7 @@ declare namespace gapi.client {
|
|
|
1351
1344
|
interface GoogleCloudDocumentaiV1DisableProcessorRequest {}
|
|
1352
1345
|
interface GoogleCloudDocumentaiV1DisableProcessorResponse {}
|
|
1353
1346
|
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
|
|
1347
|
+
/** 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
1348
|
blobAssets?: GoogleCloudDocumentaiV1DocumentBlobAsset[];
|
|
1356
1349
|
/** Document chunked based on chunking config. */
|
|
1357
1350
|
chunkedDocument?: GoogleCloudDocumentaiV1DocumentChunkedDocument;
|
|
@@ -1363,7 +1356,7 @@ declare namespace gapi.client {
|
|
|
1363
1356
|
documentLayout?: GoogleCloudDocumentaiV1DocumentDocumentLayout;
|
|
1364
1357
|
/** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
|
|
1365
1358
|
entities?: GoogleCloudDocumentaiV1DocumentEntity[];
|
|
1366
|
-
/** The entity revision ID that `document.entities` field is based on. If this field
|
|
1359
|
+
/** The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. */
|
|
1367
1360
|
entitiesRevisionId?: string;
|
|
1368
1361
|
/** A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. */
|
|
1369
1362
|
entitiesRevisions?: GoogleCloudDocumentaiV1DocumentEntitiesRevision[];
|
|
@@ -1395,7 +1388,7 @@ declare namespace gapi.client {
|
|
|
1395
1388
|
description?: string;
|
|
1396
1389
|
}
|
|
1397
1390
|
interface GoogleCloudDocumentaiV1DocumentBlobAsset {
|
|
1398
|
-
/** Optional. The
|
|
1391
|
+
/** Optional. The ID of the blob asset. */
|
|
1399
1392
|
assetId?: string;
|
|
1400
1393
|
/** Optional. The content of the blob asset, for example, image bytes. */
|
|
1401
1394
|
content?: string;
|
|
@@ -1449,11 +1442,11 @@ declare namespace gapi.client {
|
|
|
1449
1442
|
interface GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkImageChunkField {
|
|
1450
1443
|
/** Annotation of the image chunk field. */
|
|
1451
1444
|
annotations?: GoogleCloudDocumentaiV1DocumentAnnotations;
|
|
1452
|
-
/** Optional. Asset
|
|
1445
|
+
/** Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. */
|
|
1453
1446
|
blobAssetId?: string;
|
|
1454
|
-
/** Optional. Data
|
|
1447
|
+
/** 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
1448
|
dataUri?: string;
|
|
1456
|
-
/** Optional. Google Cloud Storage
|
|
1449
|
+
/** Optional. Google Cloud Storage URI of the image. */
|
|
1457
1450
|
gcsUri?: string;
|
|
1458
1451
|
}
|
|
1459
1452
|
interface GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkTableChunkField {
|
|
@@ -1483,11 +1476,11 @@ declare namespace gapi.client {
|
|
|
1483
1476
|
interface GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock {
|
|
1484
1477
|
/** Annotation of the image block. */
|
|
1485
1478
|
annotations?: GoogleCloudDocumentaiV1DocumentAnnotations;
|
|
1486
|
-
/** Optional. Asset
|
|
1479
|
+
/** Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. */
|
|
1487
1480
|
blobAssetId?: string;
|
|
1488
|
-
/** Optional. Data
|
|
1481
|
+
/** 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
1482
|
dataUri?: string;
|
|
1490
|
-
/** Optional. Google Cloud Storage
|
|
1483
|
+
/** Optional. Google Cloud Storage URI of the image. */
|
|
1491
1484
|
gcsUri?: string;
|
|
1492
1485
|
/** Text extracted from the image using OCR or alt text describing the image. */
|
|
1493
1486
|
imageText?: string;
|
|
@@ -1593,7 +1586,7 @@ declare namespace gapi.client {
|
|
|
1593
1586
|
integerValue?: number;
|
|
1594
1587
|
/** Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */
|
|
1595
1588
|
moneyValue?: GoogleTypeMoney;
|
|
1596
|
-
/** A signature
|
|
1589
|
+
/** A signature, which is a graphical representation of a person's name, often used to sign a document. */
|
|
1597
1590
|
signatureValue?: boolean;
|
|
1598
1591
|
/** Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. */
|
|
1599
1592
|
text?: string;
|
|
@@ -1905,7 +1898,7 @@ declare namespace gapi.client {
|
|
|
1905
1898
|
type?: string;
|
|
1906
1899
|
}
|
|
1907
1900
|
interface GoogleCloudDocumentaiV1DocumentProvenance {
|
|
1908
|
-
/** The
|
|
1901
|
+
/** The ID of this operation. Needs to be unique within the scope of the revision. */
|
|
1909
1902
|
id?: number;
|
|
1910
1903
|
/** References to the original elements that are replaced. */
|
|
1911
1904
|
parents?: GoogleCloudDocumentaiV1DocumentProvenanceParent[];
|
|
@@ -1923,7 +1916,7 @@ declare namespace gapi.client {
|
|
|
1923
1916
|
| 'EVAL_SKIPPED';
|
|
1924
1917
|
}
|
|
1925
1918
|
interface GoogleCloudDocumentaiV1DocumentProvenanceParent {
|
|
1926
|
-
/** The
|
|
1919
|
+
/** The ID of the parent provenance. */
|
|
1927
1920
|
id?: number;
|
|
1928
1921
|
/** The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. */
|
|
1929
1922
|
index?: number;
|
|
@@ -1931,13 +1924,13 @@ declare namespace gapi.client {
|
|
|
1931
1924
|
revision?: number;
|
|
1932
1925
|
}
|
|
1933
1926
|
interface GoogleCloudDocumentaiV1DocumentRevision {
|
|
1934
|
-
/** If the change was made by a person specify the name or
|
|
1927
|
+
/** If the change was made by a person specify the name or ID of that person. */
|
|
1935
1928
|
agent?: string;
|
|
1936
1929
|
/** The time that the revision was created, internally generated by doc proto storage at the time of create. */
|
|
1937
1930
|
createTime?: string;
|
|
1938
1931
|
/** Human Review information of this revision. */
|
|
1939
1932
|
humanReview?: GoogleCloudDocumentaiV1DocumentRevisionHumanReview;
|
|
1940
|
-
/**
|
|
1933
|
+
/** ID of the revision, internally generated by doc proto storage. Unique within the context of the document. */
|
|
1941
1934
|
id?: string;
|
|
1942
1935
|
/** The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. */
|
|
1943
1936
|
parent?: number[];
|
|
@@ -1961,7 +1954,7 @@ declare namespace gapi.client {
|
|
|
1961
1954
|
description?: string;
|
|
1962
1955
|
/** Display name to show users. */
|
|
1963
1956
|
displayName?: string;
|
|
1964
|
-
/** Optional. Document
|
|
1957
|
+
/** Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. */
|
|
1965
1958
|
documentPrompt?: string;
|
|
1966
1959
|
/** Entity types of the schema. */
|
|
1967
1960
|
entityTypes?: GoogleCloudDocumentaiV1DocumentSchemaEntityType[];
|
|
@@ -1975,7 +1968,7 @@ declare namespace gapi.client {
|
|
|
1975
1968
|
displayName?: string;
|
|
1976
1969
|
/** 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. */
|
|
1977
1970
|
enumValues?: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues;
|
|
1978
|
-
/** 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. */
|
|
1971
|
+
/** 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. */
|
|
1979
1972
|
name?: string;
|
|
1980
1973
|
/** Description the nested structure, or composition of an entity. */
|
|
1981
1974
|
properties?: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty[];
|
|
@@ -2357,7 +2350,7 @@ declare namespace gapi.client {
|
|
|
2357
2350
|
includeAncestorHeadings?: boolean;
|
|
2358
2351
|
}
|
|
2359
2352
|
interface GoogleCloudDocumentaiV1Processor {
|
|
2360
|
-
/** 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} */
|
|
2353
|
+
/** 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}. */
|
|
2361
2354
|
activeSchemaVersion?: string;
|
|
2362
2355
|
/** Output only. The time the processor was created. */
|
|
2363
2356
|
createTime?: string;
|
|
@@ -2483,9 +2476,7 @@ declare namespace gapi.client {
|
|
|
2483
2476
|
baseProcessorVersionId?: string;
|
|
2484
2477
|
/** The type of custom model created by the user. */
|
|
2485
2478
|
customModelType?:
|
|
2486
|
-
| '
|
|
2487
|
-
| 'VERSIONED_FOUNDATION'
|
|
2488
|
-
| 'FINE_TUNED';
|
|
2479
|
+
'CUSTOM_MODEL_TYPE_UNSPECIFIED' | 'VERSIONED_FOUNDATION' | 'FINE_TUNED';
|
|
2489
2480
|
}
|
|
2490
2481
|
interface GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
2491
2482
|
/** Whether fine tuning is allowed for this base processor version. */
|
|
@@ -2621,14 +2612,12 @@ declare namespace gapi.client {
|
|
|
2621
2612
|
interface GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions {
|
|
2622
2613
|
/** Optional. Training method to use for CDE training. */
|
|
2623
2614
|
trainingMethod?:
|
|
2624
|
-
| '
|
|
2625
|
-
| 'MODEL_BASED'
|
|
2626
|
-
| 'TEMPLATE_BASED';
|
|
2615
|
+
'TRAINING_METHOD_UNSPECIFIED' | 'MODEL_BASED' | 'TEMPLATE_BASED';
|
|
2627
2616
|
}
|
|
2628
2617
|
interface GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions {
|
|
2629
2618
|
/** 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. */
|
|
2630
2619
|
learningRateMultiplier?: number;
|
|
2631
|
-
/** Optional. Resource name of a previously fine tuned version
|
|
2620
|
+
/** 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
2621
|
previousFineTunedProcessorVersionName?: string;
|
|
2633
2622
|
/** 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. */
|
|
2634
2623
|
trainSteps?: number;
|