@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20220808 → 0.0.20220824

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +89 -27
  2. package/package.json +1 -1
  3. package/tests.ts +22 -7
package/index.d.ts CHANGED
@@ -10,7 +10,7 @@
10
10
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
11
11
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
12
12
  // Generated from: https://documentai.googleapis.com/$discovery/rest?version=v1beta3
13
- // Revision: 20220808
13
+ // Revision: 20220824
14
14
 
15
15
  /// <reference types="gapi.client" />
16
16
 
@@ -26,13 +26,17 @@ declare namespace gapi.client {
26
26
  interface GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata {
27
27
  /** The basic metadata of the long running operation. */
28
28
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
29
+ /** Total number of documents that failed to be deleted in storage. */
30
+ errorDocumentCount?: number;
29
31
  /** The list of response details of each document. */
30
32
  individualBatchDeleteStatuses?: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus[];
33
+ /** Total number of documents deleting from dataset. */
34
+ totalDocumentCount?: number;
31
35
  }
32
36
  interface GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus {
33
37
  /** The document id of the document. */
34
38
  documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
35
- /** The status of deleting the document. */
39
+ /** The status of deleting the document in storage. */
36
40
  status?: GoogleRpcStatus;
37
41
  }
38
42
  // tslint:disable-next-line:no-empty-interface
@@ -129,6 +133,31 @@ declare namespace gapi.client {
129
133
  /** The resource name of the created evaluation. */
130
134
  evaluation?: string;
131
135
  }
136
+ interface GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata {
137
+ /** The basic metadata of the long running operation. */
138
+ commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
139
+ /** The list of response details of each document. */
140
+ individualExportStatuses?: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus[];
141
+ /** The list of statistics for each dataset split type. */
142
+ splitExportStats?: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat[];
143
+ }
144
+ interface GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus {
145
+ /** The path to source docproto of the document. */
146
+ documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
147
+ /** The output_gcs_destination of the exported document if it was successful, otherwise empty. */
148
+ outputGcsDestination?: string;
149
+ /** The status of the exporting of the document. */
150
+ status?: GoogleRpcStatus;
151
+ }
152
+ interface GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat {
153
+ /** The dataset split type. */
154
+ splitType?: string;
155
+ /** Total number of documents with the given dataset split type to be exported. */
156
+ totalDocumentCount?: number;
157
+ }
158
+ // tslint:disable-next-line:no-empty-interface
159
+ interface GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse {
160
+ }
132
161
  interface GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata {
133
162
  /** The common metadata about the operation. */
134
163
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
@@ -140,11 +169,19 @@ declare namespace gapi.client {
140
169
  interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata {
141
170
  /** The basic metadata of the long running operation. */
142
171
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
172
+ /** Validation statuses of the batch documents import config. */
173
+ importConfigValidationResults?: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult[];
143
174
  /** The list of response details of each document. */
144
175
  individualImportStatuses?: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus[];
145
176
  /** Total number of the documents that are qualified for importing. */
146
177
  totalDocumentCount?: number;
147
178
  }
179
+ interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult {
180
+ /** The source Cloud Storage URI specified in the import config. */
181
+ inputGcsSource?: string;
182
+ /** The validation status of import config. */
183
+ status?: GoogleRpcStatus;
184
+ }
148
185
  interface GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus {
149
186
  /** The source Cloud Storage URI of the document. */
150
187
  inputGcsSource?: string;
@@ -159,15 +196,23 @@ declare namespace gapi.client {
159
196
  interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata {
160
197
  /** The basic metadata of the long running operation. */
161
198
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
162
- /** Returns the newly added document Cloud Storage prefix if the documents are founded in Cloud Storage while not in Document Service storage. */
163
- newlyAddedDocuments?: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument[];
164
- }
165
- interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument {
166
- /** The prefix of cloud storage, identifies the destination document which should be updated by resync pipeline. */
167
- destinationPrefix?: string;
168
- /** The prefix of cloud storage, identifies the original document which should be updated by resync pipeline. */
169
- sourcePrefix?: string;
170
- /** The final status of the documents which should be updated by resync pipeline. */
199
+ /** The list of dataset resync statuses. Not checked when `dataset_documents` is specified in ResyncRequest. */
200
+ datasetResyncStatuses?: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus[];
201
+ /** The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies. */
202
+ individualDocumentResyncStatuses?: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus[];
203
+ }
204
+ interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus {
205
+ /** The type of the inconsistency of the dataset. */
206
+ datasetInconsistencyType?: string;
207
+ /** The status of resyncing the dataset with regards to the detected inconsistency. Empty if `validate_only` is true in the request. */
208
+ status?: GoogleRpcStatus;
209
+ }
210
+ interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus {
211
+ /** The document identifier. */
212
+ documentId?: GoogleCloudDocumentaiUiv1beta3DocumentId;
213
+ /** The type of document inconsistency. */
214
+ documentInconsistencyType?: string;
215
+ /** The status of resyncing the document with regards to the detected inconsistency. Empty if `validate_only` is true in the request. */
171
216
  status?: GoogleRpcStatus;
172
217
  }
173
218
  // tslint:disable-next-line:no-empty-interface
@@ -343,11 +388,6 @@ declare namespace gapi.client {
343
388
  mentionId?: string;
344
389
  /** Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. */
345
390
  mentionText?: string;
346
- /**
347
- * Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a
348
- * false negative. A non-present entity should have an empty mention_text and text_anchor.
349
- */
350
- nonPresent?: boolean;
351
391
  /**
352
392
  * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only
353
393
  * populated for certain supported document types.
@@ -825,11 +865,6 @@ declare namespace gapi.client {
825
865
  mentionId?: string;
826
866
  /** Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. */
827
867
  mentionText?: string;
828
- /**
829
- * Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a
830
- * false negative. A non-present entity should have an empty mention_text and text_anchor.
831
- */
832
- nonPresent?: boolean;
833
868
  /**
834
869
  * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only
835
870
  * populated for certain supported document types.
@@ -1418,11 +1453,6 @@ declare namespace gapi.client {
1418
1453
  mentionId?: string;
1419
1454
  /** Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. */
1420
1455
  mentionText?: string;
1421
- /**
1422
- * Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a
1423
- * false negative. A non-present entity should have an empty mention_text and text_anchor.
1424
- */
1425
- nonPresent?: boolean;
1426
1456
  /**
1427
1457
  * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only
1428
1458
  * populated for certain supported document types.
@@ -1744,6 +1774,8 @@ declare namespace gapi.client {
1744
1774
  baseTypes?: string[];
1745
1775
  /** User defined name for the type. */
1746
1776
  displayName?: string;
1777
+ /** Metadata for the entity type. */
1778
+ entityTypeMetadata?: GoogleCloudDocumentaiV1beta3EntityTypeMetadata;
1747
1779
  /**
1748
1780
  * 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
1749
1781
  * `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
@@ -1751,7 +1783,7 @@ declare namespace gapi.client {
1751
1783
  enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
1752
1784
  /**
1753
1785
  * Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use snake_casing* - name matching
1754
- * is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and
1786
+ * is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and
1755
1787
  * 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
1756
1788
  * honored for backward compatibility.
1757
1789
  */
@@ -1768,6 +1800,8 @@ declare namespace gapi.client {
1768
1800
  name?: string;
1769
1801
  /** Occurrence type limits the number of instances an entity type appears in the document. */
1770
1802
  occurrenceType?: string;
1803
+ /** Any additional metadata about the property can be added here. */
1804
+ propertyMetadata?: GoogleCloudDocumentaiV1beta3PropertyMetadata;
1771
1805
  /** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
1772
1806
  valueType?: string;
1773
1807
  }
@@ -1847,6 +1881,16 @@ declare namespace gapi.client {
1847
1881
  // tslint:disable-next-line:no-empty-interface
1848
1882
  interface GoogleCloudDocumentaiV1beta3EnableProcessorResponse {
1849
1883
  }
1884
+ interface GoogleCloudDocumentaiV1beta3EntityTypeMetadata {
1885
+ /** Human review labeling config on the property. */
1886
+ humanReviewLabelingMetadata?: GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata;
1887
+ /** Human review config on the entity type. */
1888
+ humanReviewMetadata?: GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata;
1889
+ /** Whether the entity type should be considered as "inactive". */
1890
+ inactive?: boolean;
1891
+ /** If set, the properties of this entity type must be prefixed with the parents. */
1892
+ prefixedNamingOnProperties?: boolean;
1893
+ }
1850
1894
  interface GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse {
1851
1895
  /** The list of processor types. */
1852
1896
  processorTypes?: GoogleCloudDocumentaiV1beta3ProcessorType[];
@@ -1865,6 +1909,10 @@ declare namespace gapi.client {
1865
1909
  /** The URI prefix. */
1866
1910
  gcsUriPrefix?: string;
1867
1911
  }
1912
+ interface GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata {
1913
+ /** Whether to enable normalization editing. */
1914
+ enableNormalizationEditing?: boolean;
1915
+ }
1868
1916
  interface GoogleCloudDocumentaiV1beta3HumanReviewStatus {
1869
1917
  /**
1870
1918
  * The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and
@@ -1876,6 +1924,12 @@ declare namespace gapi.client {
1876
1924
  /** A message providing more details about the human review state. */
1877
1925
  stateMessage?: string;
1878
1926
  }
1927
+ interface GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata {
1928
+ /** The confidence threshold if human review validation is enabled. */
1929
+ confidenceThreshold?: number;
1930
+ /** Whether to enable human review validation. */
1931
+ enableValidation?: boolean;
1932
+ }
1879
1933
  interface GoogleCloudDocumentaiV1beta3ListProcessorsResponse {
1880
1934
  /** Points to the next processor, otherwise empty. */
1881
1935
  nextPageToken?: string;
@@ -1983,6 +2037,14 @@ declare namespace gapi.client {
1983
2037
  /** The status of human review on the processed document. */
1984
2038
  humanReviewStatus?: GoogleCloudDocumentaiV1beta3HumanReviewStatus;
1985
2039
  }
2040
+ interface GoogleCloudDocumentaiV1beta3PropertyMetadata {
2041
+ /** Human review labeling config on the property. */
2042
+ humanReviewLabelingMetadata?: GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata;
2043
+ /** Human review validation config on the property. */
2044
+ humanReviewMetadata?: GoogleCloudDocumentaiV1beta3HumanReviewValidationMetadata;
2045
+ /** Whether the property should be considered as "inactive". */
2046
+ inactive?: boolean;
2047
+ }
1986
2048
  interface GoogleCloudDocumentaiV1beta3RawDocument {
1987
2049
  /** Inline document content. */
1988
2050
  content?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.documentai-v1beta3",
3
- "version": "0.0.20220808",
3
+ "version": "0.0.20220824",
4
4
  "description": "TypeScript typings for Cloud Document AI API v1beta3",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20220808
6
+ // Revision: 20220824
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -151,7 +151,6 @@ gapi.load('client', async () => {
151
151
  id: "Test string",
152
152
  mentionId: "Test string",
153
153
  mentionText: "Test string",
154
- nonPresent: true,
155
154
  normalizedValue: {
156
155
  addressValue: {
157
156
  addressLines: [
@@ -948,7 +947,6 @@ gapi.load('client', async () => {
948
947
  id: "Test string",
949
948
  mentionId: "Test string",
950
949
  mentionText: "Test string",
951
- nonPresent: true,
952
950
  normalizedValue: {
953
951
  addressValue: {
954
952
  addressLines: [
@@ -1760,7 +1758,6 @@ gapi.load('client', async () => {
1760
1758
  id: "Test string",
1761
1759
  mentionId: "Test string",
1762
1760
  mentionText: "Test string",
1763
- nonPresent: true,
1764
1761
  normalizedValue: {
1765
1762
  addressValue: {
1766
1763
  addressLines: [
@@ -2557,6 +2554,17 @@ gapi.load('client', async () => {
2557
2554
  "Test string"
2558
2555
  ],
2559
2556
  displayName: "Test string",
2557
+ entityTypeMetadata: {
2558
+ humanReviewLabelingMetadata: {
2559
+ enableNormalizationEditing: true,
2560
+ },
2561
+ humanReviewMetadata: {
2562
+ confidenceThreshold: 42,
2563
+ enableValidation: true,
2564
+ },
2565
+ inactive: true,
2566
+ prefixedNamingOnProperties: true,
2567
+ },
2560
2568
  enumValues: {
2561
2569
  values: [
2562
2570
  "Test string"
@@ -2567,6 +2575,16 @@ gapi.load('client', async () => {
2567
2575
  {
2568
2576
  name: "Test string",
2569
2577
  occurrenceType: "Test string",
2578
+ propertyMetadata: {
2579
+ humanReviewLabelingMetadata: {
2580
+ enableNormalizationEditing: true,
2581
+ },
2582
+ humanReviewMetadata: {
2583
+ confidenceThreshold: 42,
2584
+ enableValidation: true,
2585
+ },
2586
+ inactive: true,
2587
+ },
2570
2588
  valueType: "Test string",
2571
2589
  }
2572
2590
  ],
@@ -2588,7 +2606,6 @@ gapi.load('client', async () => {
2588
2606
  id: "Test string",
2589
2607
  mentionId: "Test string",
2590
2608
  mentionText: "Test string",
2591
- nonPresent: true,
2592
2609
  normalizedValue: {
2593
2610
  addressValue: {
2594
2611
  addressLines: [
@@ -3442,7 +3459,6 @@ gapi.load('client', async () => {
3442
3459
  id: "Test string",
3443
3460
  mentionId: "Test string",
3444
3461
  mentionText: "Test string",
3445
- nonPresent: true,
3446
3462
  normalizedValue: {
3447
3463
  addressValue: {
3448
3464
  addressLines: [
@@ -4239,7 +4255,6 @@ gapi.load('client', async () => {
4239
4255
  id: "Test string",
4240
4256
  mentionId: "Test string",
4241
4257
  mentionText: "Test string",
4242
- nonPresent: true,
4243
4258
  normalizedValue: {
4244
4259
  addressValue: {
4245
4260
  addressLines: [