@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20220815 → 0.0.20220901

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 +60 -11
  2. package/package.json +1 -1
  3. package/tests.ts +22 -1
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: 20220815
13
+ // Revision: 20220901
14
14
 
15
15
  /// <reference types="gapi.client" />
16
16
 
@@ -26,6 +26,8 @@ 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[];
31
33
  /** Total number of documents deleting from dataset. */
@@ -131,6 +133,31 @@ declare namespace gapi.client {
131
133
  /** The resource name of the created evaluation. */
132
134
  evaluation?: string;
133
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
+ }
134
161
  interface GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata {
135
162
  /** The common metadata about the operation. */
136
163
  commonMetadata?: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
@@ -173,8 +200,6 @@ declare namespace gapi.client {
173
200
  datasetResyncStatuses?: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus[];
174
201
  /** The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies. */
175
202
  individualDocumentResyncStatuses?: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus[];
176
- /** Returns the newly added document Cloud Storage prefix if the documents are founded in Cloud Storage while not in Document Service storage. */
177
- newlyAddedDocuments?: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument[];
178
203
  }
179
204
  interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus {
180
205
  /** The type of the inconsistency of the dataset. */
@@ -190,14 +215,6 @@ declare namespace gapi.client {
190
215
  /** The status of resyncing the document with regards to the detected inconsistency. Empty if `validate_only` is true in the request. */
191
216
  status?: GoogleRpcStatus;
192
217
  }
193
- interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument {
194
- /** The prefix of cloud storage, identifies the destination document which should be updated by resync pipeline. */
195
- destinationPrefix?: string;
196
- /** The prefix of cloud storage, identifies the original document which should be updated by resync pipeline. */
197
- sourcePrefix?: string;
198
- /** The final status of the documents which should be updated by resync pipeline. */
199
- status?: GoogleRpcStatus;
200
- }
201
218
  // tslint:disable-next-line:no-empty-interface
202
219
  interface GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse {
203
220
  }
@@ -1757,6 +1774,8 @@ declare namespace gapi.client {
1757
1774
  baseTypes?: string[];
1758
1775
  /** User defined name for the type. */
1759
1776
  displayName?: string;
1777
+ /** Metadata for the entity type. */
1778
+ entityTypeMetadata?: GoogleCloudDocumentaiV1beta3EntityTypeMetadata;
1760
1779
  /**
1761
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
1762
1781
  * `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
@@ -1781,6 +1800,8 @@ declare namespace gapi.client {
1781
1800
  name?: string;
1782
1801
  /** Occurrence type limits the number of instances an entity type appears in the document. */
1783
1802
  occurrenceType?: string;
1803
+ /** Any additional metadata about the property can be added here. */
1804
+ propertyMetadata?: GoogleCloudDocumentaiV1beta3PropertyMetadata;
1784
1805
  /** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
1785
1806
  valueType?: string;
1786
1807
  }
@@ -1860,6 +1881,16 @@ declare namespace gapi.client {
1860
1881
  // tslint:disable-next-line:no-empty-interface
1861
1882
  interface GoogleCloudDocumentaiV1beta3EnableProcessorResponse {
1862
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
+ }
1863
1894
  interface GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse {
1864
1895
  /** The list of processor types. */
1865
1896
  processorTypes?: GoogleCloudDocumentaiV1beta3ProcessorType[];
@@ -1878,6 +1909,10 @@ declare namespace gapi.client {
1878
1909
  /** The URI prefix. */
1879
1910
  gcsUriPrefix?: string;
1880
1911
  }
1912
+ interface GoogleCloudDocumentaiV1beta3HumanReviewLabelingMetadata {
1913
+ /** Whether to enable normalization editing. */
1914
+ enableNormalizationEditing?: boolean;
1915
+ }
1881
1916
  interface GoogleCloudDocumentaiV1beta3HumanReviewStatus {
1882
1917
  /**
1883
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
@@ -1889,6 +1924,12 @@ declare namespace gapi.client {
1889
1924
  /** A message providing more details about the human review state. */
1890
1925
  stateMessage?: string;
1891
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
+ }
1892
1933
  interface GoogleCloudDocumentaiV1beta3ListProcessorsResponse {
1893
1934
  /** Points to the next processor, otherwise empty. */
1894
1935
  nextPageToken?: string;
@@ -1996,6 +2037,14 @@ declare namespace gapi.client {
1996
2037
  /** The status of human review on the processed document. */
1997
2038
  humanReviewStatus?: GoogleCloudDocumentaiV1beta3HumanReviewStatus;
1998
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
+ }
1999
2048
  interface GoogleCloudDocumentaiV1beta3RawDocument {
2000
2049
  /** Inline document content. */
2001
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.20220815",
3
+ "version": "0.0.20220901",
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: 20220815
6
+ // Revision: 20220901
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -2554,6 +2554,17 @@ gapi.load('client', async () => {
2554
2554
  "Test string"
2555
2555
  ],
2556
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
+ },
2557
2568
  enumValues: {
2558
2569
  values: [
2559
2570
  "Test string"
@@ -2564,6 +2575,16 @@ gapi.load('client', async () => {
2564
2575
  {
2565
2576
  name: "Test string",
2566
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
+ },
2567
2588
  valueType: "Test string",
2568
2589
  }
2569
2590
  ],