@maxim_mazurok/gapi.client.documentai-v1 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=v1
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
  }
@@ -1828,6 +1845,8 @@ declare namespace gapi.client {
1828
1845
  baseTypes?: string[];
1829
1846
  /** User defined name for the type. */
1830
1847
  displayName?: string;
1848
+ /** Metadata for the entity type. */
1849
+ entityTypeMetadata?: GoogleCloudDocumentaiV1EntityTypeMetadata;
1831
1850
  /**
1832
1851
  * 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
1833
1852
  * `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
@@ -1852,6 +1871,8 @@ declare namespace gapi.client {
1852
1871
  name?: string;
1853
1872
  /** Occurrence type limits the number of instances an entity type appears in the document. */
1854
1873
  occurrenceType?: string;
1874
+ /** Any additional metadata about the property can be added here. */
1875
+ propertyMetadata?: GoogleCloudDocumentaiV1PropertyMetadata;
1855
1876
  /** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
1856
1877
  valueType?: string;
1857
1878
  }
@@ -1931,6 +1952,16 @@ declare namespace gapi.client {
1931
1952
  // tslint:disable-next-line:no-empty-interface
1932
1953
  interface GoogleCloudDocumentaiV1EnableProcessorResponse {
1933
1954
  }
1955
+ interface GoogleCloudDocumentaiV1EntityTypeMetadata {
1956
+ /** Human review labeling config on the property. */
1957
+ humanReviewLabelingMetadata?: GoogleCloudDocumentaiV1HumanReviewLabelingMetadata;
1958
+ /** Human review config on the entity type. */
1959
+ humanReviewMetadata?: GoogleCloudDocumentaiV1HumanReviewValidationMetadata;
1960
+ /** Whether the entity type should be considered as "inactive". */
1961
+ inactive?: boolean;
1962
+ /** If set, the properties of this entity type must be prefixed with the parents. */
1963
+ prefixedNamingOnProperties?: boolean;
1964
+ }
1934
1965
  interface GoogleCloudDocumentaiV1FetchProcessorTypesResponse {
1935
1966
  /** The list of processor types. */
1936
1967
  processorTypes?: GoogleCloudDocumentaiV1ProcessorType[];
@@ -1949,6 +1980,10 @@ declare namespace gapi.client {
1949
1980
  /** The URI prefix. */
1950
1981
  gcsUriPrefix?: string;
1951
1982
  }
1983
+ interface GoogleCloudDocumentaiV1HumanReviewLabelingMetadata {
1984
+ /** Whether to enable normalization editing. */
1985
+ enableNormalizationEditing?: boolean;
1986
+ }
1952
1987
  interface GoogleCloudDocumentaiV1HumanReviewStatus {
1953
1988
  /**
1954
1989
  * 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
@@ -1960,6 +1995,12 @@ declare namespace gapi.client {
1960
1995
  /** A message providing more details about the human review state. */
1961
1996
  stateMessage?: string;
1962
1997
  }
1998
+ interface GoogleCloudDocumentaiV1HumanReviewValidationMetadata {
1999
+ /** The confidence threshold if human review validation is enabled. */
2000
+ confidenceThreshold?: number;
2001
+ /** Whether to enable human review validation. */
2002
+ enableValidation?: boolean;
2003
+ }
1963
2004
  interface GoogleCloudDocumentaiV1ListProcessorsResponse {
1964
2005
  /** Points to the next processor, otherwise empty. */
1965
2006
  nextPageToken?: string;
@@ -2060,6 +2101,14 @@ declare namespace gapi.client {
2060
2101
  /** The status of human review on the processed document. */
2061
2102
  humanReviewStatus?: GoogleCloudDocumentaiV1HumanReviewStatus;
2062
2103
  }
2104
+ interface GoogleCloudDocumentaiV1PropertyMetadata {
2105
+ /** Human review labeling config on the property. */
2106
+ humanReviewLabelingMetadata?: GoogleCloudDocumentaiV1HumanReviewLabelingMetadata;
2107
+ /** Human review validation config on the property. */
2108
+ humanReviewMetadata?: GoogleCloudDocumentaiV1HumanReviewValidationMetadata;
2109
+ /** Whether the property should be considered as "inactive". */
2110
+ inactive?: boolean;
2111
+ }
2063
2112
  interface GoogleCloudDocumentaiV1RawDocument {
2064
2113
  /** Inline document content. */
2065
2114
  content?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.documentai-v1",
3
- "version": "0.0.20220815",
3
+ "version": "0.0.20220901",
4
4
  "description": "TypeScript typings for Cloud Document AI API v1",
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 */
@@ -962,6 +962,17 @@ gapi.load('client', async () => {
962
962
  "Test string"
963
963
  ],
964
964
  displayName: "Test string",
965
+ entityTypeMetadata: {
966
+ humanReviewLabelingMetadata: {
967
+ enableNormalizationEditing: true,
968
+ },
969
+ humanReviewMetadata: {
970
+ confidenceThreshold: 42,
971
+ enableValidation: true,
972
+ },
973
+ inactive: true,
974
+ prefixedNamingOnProperties: true,
975
+ },
965
976
  enumValues: {
966
977
  values: [
967
978
  "Test string"
@@ -972,6 +983,16 @@ gapi.load('client', async () => {
972
983
  {
973
984
  name: "Test string",
974
985
  occurrenceType: "Test string",
986
+ propertyMetadata: {
987
+ humanReviewLabelingMetadata: {
988
+ enableNormalizationEditing: true,
989
+ },
990
+ humanReviewMetadata: {
991
+ confidenceThreshold: 42,
992
+ enableValidation: true,
993
+ },
994
+ inactive: true,
995
+ },
975
996
  valueType: "Test string",
976
997
  }
977
998
  ],