@maxim_mazurok/gapi.client.documentai-v1beta3 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 +49 -54
- 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: 20260706
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -128,7 +128,7 @@ declare namespace gapi.client {
|
|
|
128
128
|
totalDocumentCount?: number;
|
|
129
129
|
}
|
|
130
130
|
interface GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus {
|
|
131
|
-
/** The document
|
|
131
|
+
/** The document ID of the auto-labeled document. This will replace the gcs_uri. */
|
|
132
132
|
documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
133
133
|
/** The status of the document auto-labeling. */
|
|
134
134
|
status?: GoogleRpcStatus;
|
|
@@ -145,7 +145,7 @@ declare namespace gapi.client {
|
|
|
145
145
|
totalDocumentCount?: number;
|
|
146
146
|
}
|
|
147
147
|
interface GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus {
|
|
148
|
-
/** The document
|
|
148
|
+
/** The document ID of the document. */
|
|
149
149
|
documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
150
150
|
/** The status of deleting the document in storage. */
|
|
151
151
|
status?: GoogleRpcStatus;
|
|
@@ -170,7 +170,7 @@ declare namespace gapi.client {
|
|
|
170
170
|
individualBatchMoveStatuses?: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus[];
|
|
171
171
|
}
|
|
172
172
|
interface GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus {
|
|
173
|
-
/** The document
|
|
173
|
+
/** The document ID of the document. */
|
|
174
174
|
documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
175
175
|
/** The status of moving the document. */
|
|
176
176
|
status?: GoogleRpcStatus;
|
|
@@ -183,7 +183,7 @@ declare namespace gapi.client {
|
|
|
183
183
|
individualBatchUpdateStatuses?: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus[];
|
|
184
184
|
}
|
|
185
185
|
interface GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus {
|
|
186
|
-
/** The document
|
|
186
|
+
/** The document ID of the document. */
|
|
187
187
|
documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
188
188
|
/** The status of updating the document in storage. */
|
|
189
189
|
status?: GoogleRpcStatus;
|
|
@@ -234,21 +234,21 @@ declare namespace gapi.client {
|
|
|
234
234
|
}
|
|
235
235
|
interface GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse {}
|
|
236
236
|
interface GoogleCloudDocumentaiUiv1beta3DocumentId {
|
|
237
|
-
/** A document
|
|
237
|
+
/** A document ID within user-managed Cloud Storage. */
|
|
238
238
|
gcsManagedDocId?: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId;
|
|
239
239
|
/** Points to a specific revision of the document if set. */
|
|
240
240
|
revisionRef?: GoogleCloudDocumentaiUiv1beta3RevisionRef;
|
|
241
|
-
/** A document
|
|
241
|
+
/** A document ID within unmanaged dataset. */
|
|
242
242
|
unmanagedDocId?: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId;
|
|
243
243
|
}
|
|
244
244
|
interface GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId {
|
|
245
|
-
/**
|
|
245
|
+
/** ID of the document (indexed) managed by Content Warehouse. */
|
|
246
246
|
cwDocId?: string;
|
|
247
247
|
/** Required. The Cloud Storage URI where the actual document is stored. */
|
|
248
248
|
gcsUri?: string;
|
|
249
249
|
}
|
|
250
250
|
interface GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId {
|
|
251
|
-
/** Required. The
|
|
251
|
+
/** Required. The ID of the document. */
|
|
252
252
|
docId?: string;
|
|
253
253
|
}
|
|
254
254
|
interface GoogleCloudDocumentaiUiv1beta3DocumentSchema {
|
|
@@ -256,7 +256,7 @@ declare namespace gapi.client {
|
|
|
256
256
|
description?: string;
|
|
257
257
|
/** Display name to show users. */
|
|
258
258
|
displayName?: string;
|
|
259
|
-
/** Optional. Document
|
|
259
|
+
/** 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. */
|
|
260
260
|
documentPrompt?: string;
|
|
261
261
|
/** Entity types of the schema. */
|
|
262
262
|
entityTypes?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType[];
|
|
@@ -274,7 +274,7 @@ declare namespace gapi.client {
|
|
|
274
274
|
entityTypeMetadata?: GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata;
|
|
275
275
|
/** 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. */
|
|
276
276
|
enumValues?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues;
|
|
277
|
-
/** 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. */
|
|
277
|
+
/** 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. */
|
|
278
278
|
name?: string;
|
|
279
279
|
/** Description the nested structure, or composition of an entity. */
|
|
280
280
|
properties?: GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty[];
|
|
@@ -453,7 +453,7 @@ declare namespace gapi.client {
|
|
|
453
453
|
interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus {
|
|
454
454
|
/** The source Cloud Storage URI of the document. */
|
|
455
455
|
inputGcsSource?: string;
|
|
456
|
-
/** The document
|
|
456
|
+
/** The document ID of imported document if it was successful, otherwise empty. */
|
|
457
457
|
outputDocumentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
|
|
458
458
|
/** The output_gcs_destination of the processed document if it was successful, otherwise empty. */
|
|
459
459
|
outputGcsDestination?: string;
|
|
@@ -470,7 +470,7 @@ declare namespace gapi.client {
|
|
|
470
470
|
processorVersion?: string;
|
|
471
471
|
}
|
|
472
472
|
interface GoogleCloudDocumentaiUiv1beta3Processor {
|
|
473
|
-
/** 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} */
|
|
473
|
+
/** 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}. */
|
|
474
474
|
activeSchemaVersion?: string;
|
|
475
475
|
/** Output only. The time the processor was created. */
|
|
476
476
|
createTime?: string;
|
|
@@ -572,9 +572,7 @@ declare namespace gapi.client {
|
|
|
572
572
|
baseProcessorVersionId?: string;
|
|
573
573
|
/** The type of custom model created by the user. */
|
|
574
574
|
customModelType?:
|
|
575
|
-
| '
|
|
576
|
-
| 'VERSIONED_FOUNDATION'
|
|
577
|
-
| 'FINE_TUNED';
|
|
575
|
+
'CUSTOM_MODEL_TYPE_UNSPECIFIED' | 'VERSIONED_FOUNDATION' | 'FINE_TUNED';
|
|
578
576
|
}
|
|
579
577
|
interface GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
580
578
|
/** Whether fine tuning is allowed for this base processor version. */
|
|
@@ -810,7 +808,7 @@ declare namespace gapi.client {
|
|
|
810
808
|
totalDocumentCount?: number;
|
|
811
809
|
}
|
|
812
810
|
interface GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus {
|
|
813
|
-
/** The document
|
|
811
|
+
/** The document ID of the document. */
|
|
814
812
|
documentId?: GoogleCloudDocumentaiV1beta3DocumentId;
|
|
815
813
|
/** The status of deleting the document in storage. */
|
|
816
814
|
status?: GoogleRpcStatus;
|
|
@@ -921,10 +919,7 @@ declare namespace gapi.client {
|
|
|
921
919
|
satisfiesPzs?: boolean;
|
|
922
920
|
/** Required. State of the dataset. Ignored when updating dataset. */
|
|
923
921
|
state?:
|
|
924
|
-
| '
|
|
925
|
-
| 'UNINITIALIZED'
|
|
926
|
-
| 'INITIALIZING'
|
|
927
|
-
| 'INITIALIZED';
|
|
922
|
+
'STATE_UNSPECIFIED' | 'UNINITIALIZED' | 'INITIALIZING' | 'INITIALIZED';
|
|
928
923
|
/** Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed). */
|
|
929
924
|
unmanagedDatasetConfig?: any;
|
|
930
925
|
}
|
|
@@ -970,7 +965,7 @@ declare namespace gapi.client {
|
|
|
970
965
|
interface GoogleCloudDocumentaiV1beta3DisableProcessorRequest {}
|
|
971
966
|
interface GoogleCloudDocumentaiV1beta3DisableProcessorResponse {}
|
|
972
967
|
interface GoogleCloudDocumentaiV1beta3Document {
|
|
973
|
-
/** 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
|
|
968
|
+
/** 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. */
|
|
974
969
|
blobAssets?: GoogleCloudDocumentaiV1beta3DocumentBlobAsset[];
|
|
975
970
|
/** Document chunked based on chunking config. */
|
|
976
971
|
chunkedDocument?: GoogleCloudDocumentaiV1beta3DocumentChunkedDocument;
|
|
@@ -982,7 +977,7 @@ declare namespace gapi.client {
|
|
|
982
977
|
documentLayout?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayout;
|
|
983
978
|
/** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
|
|
984
979
|
entities?: GoogleCloudDocumentaiV1beta3DocumentEntity[];
|
|
985
|
-
/** The entity revision ID that `document.entities` field is based on. If this field
|
|
980
|
+
/** 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. */
|
|
986
981
|
entitiesRevisionId?: string;
|
|
987
982
|
/** 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. */
|
|
988
983
|
entitiesRevisions?: GoogleCloudDocumentaiV1beta3DocumentEntitiesRevision[];
|
|
@@ -1014,7 +1009,7 @@ declare namespace gapi.client {
|
|
|
1014
1009
|
description?: string;
|
|
1015
1010
|
}
|
|
1016
1011
|
interface GoogleCloudDocumentaiV1beta3DocumentBlobAsset {
|
|
1017
|
-
/** Optional. The
|
|
1012
|
+
/** Optional. The ID of the blob asset. */
|
|
1018
1013
|
assetId?: string;
|
|
1019
1014
|
/** Optional. The content of the blob asset, for example, image bytes. */
|
|
1020
1015
|
content?: string;
|
|
@@ -1068,11 +1063,11 @@ declare namespace gapi.client {
|
|
|
1068
1063
|
interface GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField {
|
|
1069
1064
|
/** Annotation of the image chunk field. */
|
|
1070
1065
|
annotations?: GoogleCloudDocumentaiV1beta3DocumentAnnotations;
|
|
1071
|
-
/** Optional. Asset
|
|
1066
|
+
/** Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. */
|
|
1072
1067
|
blobAssetId?: string;
|
|
1073
|
-
/** Optional. Data
|
|
1068
|
+
/** 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:, */
|
|
1074
1069
|
dataUri?: string;
|
|
1075
|
-
/** Optional. Google Cloud Storage
|
|
1070
|
+
/** Optional. Google Cloud Storage URI of the image. */
|
|
1076
1071
|
gcsUri?: string;
|
|
1077
1072
|
}
|
|
1078
1073
|
interface GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField {
|
|
@@ -1102,11 +1097,11 @@ declare namespace gapi.client {
|
|
|
1102
1097
|
interface GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock {
|
|
1103
1098
|
/** Annotation of the image block. */
|
|
1104
1099
|
annotations?: GoogleCloudDocumentaiV1beta3DocumentAnnotations;
|
|
1105
|
-
/** Optional. Asset
|
|
1100
|
+
/** Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. */
|
|
1106
1101
|
blobAssetId?: string;
|
|
1107
|
-
/** Optional. Data
|
|
1102
|
+
/** 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:, */
|
|
1108
1103
|
dataUri?: string;
|
|
1109
|
-
/** Optional. Google Cloud Storage
|
|
1104
|
+
/** Optional. Google Cloud Storage URI of the image. */
|
|
1110
1105
|
gcsUri?: string;
|
|
1111
1106
|
/** Text extracted from the image using OCR or alt text describing the image. */
|
|
1112
1107
|
imageText?: string;
|
|
@@ -1212,7 +1207,7 @@ declare namespace gapi.client {
|
|
|
1212
1207
|
integerValue?: number;
|
|
1213
1208
|
/** Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */
|
|
1214
1209
|
moneyValue?: GoogleTypeMoney;
|
|
1215
|
-
/** A signature
|
|
1210
|
+
/** A signature, which is a graphical representation of a person's name, often used to sign a document. */
|
|
1216
1211
|
signatureValue?: boolean;
|
|
1217
1212
|
/** 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. */
|
|
1218
1213
|
text?: string;
|
|
@@ -1249,21 +1244,21 @@ declare namespace gapi.client {
|
|
|
1249
1244
|
| 'VALIDATION_RESULT_TYPE_NOT_APPLICABLE';
|
|
1250
1245
|
}
|
|
1251
1246
|
interface GoogleCloudDocumentaiV1beta3DocumentId {
|
|
1252
|
-
/** A document
|
|
1247
|
+
/** A document ID within user-managed Cloud Storage. */
|
|
1253
1248
|
gcsManagedDocId?: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId;
|
|
1254
1249
|
/** Points to a specific revision of the document if set. */
|
|
1255
1250
|
revisionRef?: GoogleCloudDocumentaiV1beta3RevisionRef;
|
|
1256
|
-
/** A document
|
|
1251
|
+
/** A document ID within unmanaged dataset. */
|
|
1257
1252
|
unmanagedDocId?: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId;
|
|
1258
1253
|
}
|
|
1259
1254
|
interface GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId {
|
|
1260
|
-
/**
|
|
1255
|
+
/** ID of the document (indexed) managed by Content Warehouse. */
|
|
1261
1256
|
cwDocId?: string;
|
|
1262
1257
|
/** Required. The Cloud Storage URI where the actual document is stored. */
|
|
1263
1258
|
gcsUri?: string;
|
|
1264
1259
|
}
|
|
1265
1260
|
interface GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId {
|
|
1266
|
-
/** Required. The
|
|
1261
|
+
/** Required. The ID of the document. */
|
|
1267
1262
|
docId?: string;
|
|
1268
1263
|
}
|
|
1269
1264
|
interface GoogleCloudDocumentaiV1beta3DocumentMetadata {
|
|
@@ -1562,7 +1557,7 @@ declare namespace gapi.client {
|
|
|
1562
1557
|
type?: string;
|
|
1563
1558
|
}
|
|
1564
1559
|
interface GoogleCloudDocumentaiV1beta3DocumentProvenance {
|
|
1565
|
-
/** The
|
|
1560
|
+
/** The ID of this operation. Needs to be unique within the scope of the revision. */
|
|
1566
1561
|
id?: number;
|
|
1567
1562
|
/** References to the original elements that are replaced. */
|
|
1568
1563
|
parents?: GoogleCloudDocumentaiV1beta3DocumentProvenanceParent[];
|
|
@@ -1580,7 +1575,7 @@ declare namespace gapi.client {
|
|
|
1580
1575
|
| 'EVAL_SKIPPED';
|
|
1581
1576
|
}
|
|
1582
1577
|
interface GoogleCloudDocumentaiV1beta3DocumentProvenanceParent {
|
|
1583
|
-
/** The
|
|
1578
|
+
/** The ID of the parent provenance. */
|
|
1584
1579
|
id?: number;
|
|
1585
1580
|
/** The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. */
|
|
1586
1581
|
index?: number;
|
|
@@ -1588,13 +1583,13 @@ declare namespace gapi.client {
|
|
|
1588
1583
|
revision?: number;
|
|
1589
1584
|
}
|
|
1590
1585
|
interface GoogleCloudDocumentaiV1beta3DocumentRevision {
|
|
1591
|
-
/** If the change was made by a person specify the name or
|
|
1586
|
+
/** If the change was made by a person specify the name or ID of that person. */
|
|
1592
1587
|
agent?: string;
|
|
1593
1588
|
/** The time that the revision was created, internally generated by doc proto storage at the time of create. */
|
|
1594
1589
|
createTime?: string;
|
|
1595
1590
|
/** Human Review information of this revision. */
|
|
1596
1591
|
humanReview?: GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview;
|
|
1597
|
-
/**
|
|
1592
|
+
/** ID of the revision, internally generated by doc proto storage. Unique within the context of the document. */
|
|
1598
1593
|
id?: string;
|
|
1599
1594
|
/** 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. */
|
|
1600
1595
|
parent?: number[];
|
|
@@ -1618,7 +1613,7 @@ declare namespace gapi.client {
|
|
|
1618
1613
|
description?: string;
|
|
1619
1614
|
/** Display name to show users. */
|
|
1620
1615
|
displayName?: string;
|
|
1621
|
-
/** Optional. Document
|
|
1616
|
+
/** 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. */
|
|
1622
1617
|
documentPrompt?: string;
|
|
1623
1618
|
/** Entity types of the schema. */
|
|
1624
1619
|
entityTypes?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType[];
|
|
@@ -1636,7 +1631,7 @@ declare namespace gapi.client {
|
|
|
1636
1631
|
entityTypeMetadata?: GoogleCloudDocumentaiV1beta3EntityTypeMetadata;
|
|
1637
1632
|
/** 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. */
|
|
1638
1633
|
enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
|
|
1639
|
-
/** 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. */
|
|
1634
|
+
/** 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. */
|
|
1640
1635
|
name?: string;
|
|
1641
1636
|
/** Description the nested structure, or composition of an entity. */
|
|
1642
1637
|
properties?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty[];
|
|
@@ -1761,7 +1756,9 @@ declare namespace gapi.client {
|
|
|
1761
1756
|
documentCounters?: GoogleCloudDocumentaiV1beta3EvaluationCounters;
|
|
1762
1757
|
/** Metrics across confidence levels, for different entities. */
|
|
1763
1758
|
entityMetrics?: {
|
|
1764
|
-
[
|
|
1759
|
+
[
|
|
1760
|
+
P in string
|
|
1761
|
+
]: GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics;
|
|
1765
1762
|
};
|
|
1766
1763
|
/** The KMS key name used for encryption. */
|
|
1767
1764
|
kmsKeyName?: string;
|
|
@@ -1795,7 +1792,9 @@ declare namespace gapi.client {
|
|
|
1795
1792
|
documentCounters?: GoogleCloudDocumentaiV1beta3EvaluationCounters;
|
|
1796
1793
|
/** Output only. Metrics across confidence levels, for different entities. */
|
|
1797
1794
|
entityMetrics?: {
|
|
1798
|
-
[
|
|
1795
|
+
[
|
|
1796
|
+
P in string
|
|
1797
|
+
]: GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics;
|
|
1799
1798
|
};
|
|
1800
1799
|
/** Output only. The revision ID of the evaluation. */
|
|
1801
1800
|
revisionId?: string;
|
|
@@ -1931,7 +1930,7 @@ declare namespace gapi.client {
|
|
|
1931
1930
|
interface GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus {
|
|
1932
1931
|
/** The source Cloud Storage URI of the document. */
|
|
1933
1932
|
inputGcsSource?: string;
|
|
1934
|
-
/** The document
|
|
1933
|
+
/** The document ID of imported document if it was successful, otherwise empty. */
|
|
1935
1934
|
outputDocumentId?: GoogleCloudDocumentaiV1beta3DocumentId;
|
|
1936
1935
|
/** The status of the importing of the document. */
|
|
1937
1936
|
status?: GoogleRpcStatus;
|
|
@@ -2130,7 +2129,7 @@ declare namespace gapi.client {
|
|
|
2130
2129
|
semanticChunkingGroupSize?: boolean;
|
|
2131
2130
|
}
|
|
2132
2131
|
interface GoogleCloudDocumentaiV1beta3Processor {
|
|
2133
|
-
/** 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} */
|
|
2132
|
+
/** 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}. */
|
|
2134
2133
|
activeSchemaVersion?: string;
|
|
2135
2134
|
/** Output only. The time the processor was created. */
|
|
2136
2135
|
createTime?: string;
|
|
@@ -2256,9 +2255,7 @@ declare namespace gapi.client {
|
|
|
2256
2255
|
baseProcessorVersionId?: string;
|
|
2257
2256
|
/** The type of custom model created by the user. */
|
|
2258
2257
|
customModelType?:
|
|
2259
|
-
| '
|
|
2260
|
-
| 'VERSIONED_FOUNDATION'
|
|
2261
|
-
| 'FINE_TUNED';
|
|
2258
|
+
'CUSTOM_MODEL_TYPE_UNSPECIFIED' | 'VERSIONED_FOUNDATION' | 'FINE_TUNED';
|
|
2262
2259
|
}
|
|
2263
2260
|
interface GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo {
|
|
2264
2261
|
/** Whether fine tuning is allowed for this base processor version. */
|
|
@@ -2438,14 +2435,12 @@ declare namespace gapi.client {
|
|
|
2438
2435
|
interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions {
|
|
2439
2436
|
/** Optional. Training method to use for CDE training. */
|
|
2440
2437
|
trainingMethod?:
|
|
2441
|
-
| '
|
|
2442
|
-
| 'MODEL_BASED'
|
|
2443
|
-
| 'TEMPLATE_BASED';
|
|
2438
|
+
'TRAINING_METHOD_UNSPECIFIED' | 'MODEL_BASED' | 'TEMPLATE_BASED';
|
|
2444
2439
|
}
|
|
2445
2440
|
interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestFoundationModelTuningOptions {
|
|
2446
2441
|
/** 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. */
|
|
2447
2442
|
learningRateMultiplier?: number;
|
|
2448
|
-
/** Optional. Resource name of a previously fine tuned version
|
|
2443
|
+
/** 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}`. */
|
|
2449
2444
|
previousFineTunedProcessorVersionName?: string;
|
|
2450
2445
|
/** 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. */
|
|
2451
2446
|
trainSteps?: number;
|
|
@@ -2902,7 +2897,7 @@ declare namespace gapi.client {
|
|
|
2902
2897
|
callback?: string;
|
|
2903
2898
|
/** Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset */
|
|
2904
2899
|
dataset: string;
|
|
2905
|
-
/**
|
|
2900
|
+
/** ID of the document (indexed) managed by Content Warehouse. */
|
|
2906
2901
|
'documentId.gcsManagedDocId.cwDocId'?: string;
|
|
2907
2902
|
/** Required. The Cloud Storage URI where the actual document is stored. */
|
|
2908
2903
|
'documentId.gcsManagedDocId.gcsUri'?: string;
|
|
@@ -2916,7 +2911,7 @@ declare namespace gapi.client {
|
|
|
2916
2911
|
| 'BASE_OCR_REVISION';
|
|
2917
2912
|
/** Reads the revision given by the id. */
|
|
2918
2913
|
'documentId.revisionRef.revisionId'?: string;
|
|
2919
|
-
/** Required. The
|
|
2914
|
+
/** Required. The ID of the document. */
|
|
2920
2915
|
'documentId.unmanagedDocId.docId'?: string;
|
|
2921
2916
|
/** Selector specifying which fields to include in a partial response. */
|
|
2922
2917
|
fields?: string;
|