@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20230504 → 0.0.20230526

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://documentai.googleapis.com/$discovery/rest?version=v1beta3
-// Revision: 20230504
+// Revision: 20230526
 
 /// <reference types="gapi.client" />
 
@@ -148,11 +148,15 @@ declare namespace gapi.client {
         interface GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse {
         }
         interface GoogleCloudDocumentaiUiv1beta3DocumentId {
+            /** A document id within user managed Cloud Storage. */
             gcsManagedDocId?:
                 GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId;
             /** Points to a specific revision of the document if set. */
             revisionRef?:
                 GoogleCloudDocumentaiUiv1beta3RevisionRef;
+            /** A document id within unmanaged dataset. */
+            unmanagedDocId?:
+                GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId;
         }
         interface GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId {
             /** Id of the document (indexed) managed by Content Warehouse. */
@@ -162,6 +166,11 @@ declare namespace gapi.client {
             gcsUri?:
                 string;
         }
+        interface GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId {
+            /** Required. The id of the document. */
+            docId?:
+                string;
+        }
         interface GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata {
             /** The basic metadata of the long-running operation. */
             commonMetadata?:
@@ -2016,6 +2025,53 @@ declare namespace gapi.client {
             updateTime?:
                 string;
         }
+        interface GoogleCloudDocumentaiV1beta3Dataset {
+            /** Optional. Document Warehouse-based dataset config. */
+            documentWarehouseConfig?:
+                GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig;
+            /** Optional. User managed GCS dataset config. Use this config if the dataset documents are stored under a user managed GCS location. */
+            gcsManagedConfig?:
+                GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig;
+            /** Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset` */
+            name?:
+                string;
+            /** Optional. A lightweight indexing source with low latency and high reliablity, but lack advanced features like CMEK and content based search. */
+            spannerIndexingConfig?:
+                any;
+            /** Required. State of the dataset. Will be ignored when updating dataset. */
+            state?:
+                string;
+            /** Optional. Unmanaged dataset config. Use this config if the dataset documents are managed by the document service internally (not user managed). */
+            unmanagedDatasetConfig?:
+                any;
+        }
+        interface GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig {
+            /** Output only. The collection in Document Warehouse associated with the dataset. */
+            collection?:
+                string;
+            /** Output only. The schema in Document Warehouse associated with the dataset. */
+            schema?:
+                string;
+        }
+        interface GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig {
+            /** Required. The Cloud Storage uri (a directory) where the documents belonging to the dataset must be stored. */
+            gcsPrefix?:
+                GoogleCloudDocumentaiV1beta3GcsPrefix;
+        }
+        interface GoogleCloudDocumentaiV1beta3DatasetSchema {
+            /** Optional. Schema of the dataset. */
+            documentSchema?:
+                GoogleCloudDocumentaiV1beta3DocumentSchema;
+            /** Dataset schema resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema` */
+            name?:
+                string;
+        }
+        // tslint:disable-next-line:no-empty-interface
+        interface GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig {
+        }
+        // tslint:disable-next-line:no-empty-interface
+        interface GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig {
+        }
         interface GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata {
             /** The basic metadata of the long-running operation. */
             commonMetadata?:
@@ -2640,6 +2696,9 @@ declare namespace gapi.client {
             /** User defined name for the type. */
             displayName?:
                 string;
+            /** Metadata for the entity type. */
+            entityTypeMetadata?:
+                GoogleCloudDocumentaiV1beta3EntityTypeMetadata;
             /**
              * 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.
@@ -2670,6 +2729,9 @@ declare namespace gapi.client {
             /** Occurrence type limits the number of instances an entity type appears in the document. */
             occurrenceType?:
                 string;
+            /** Any additional metadata about the property can be added here. */
+            propertyMetadata?:
+                GoogleCloudDocumentaiV1beta3PropertyMetadata;
             /** A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */
             valueType?:
                 string;
@@ -2777,6 +2839,11 @@ declare namespace gapi.client {
         // tslint:disable-next-line:no-empty-interface
         interface GoogleCloudDocumentaiV1beta3EnableProcessorResponse {
         }
+        interface GoogleCloudDocumentaiV1beta3EntityTypeMetadata {
+            /** Whether the entity type should be considered as "inactive". */
+            inactive?:
+                boolean;
+        }
         interface GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata {
             /** The basic metadata of the long-running operation. */
             commonMetadata?:
@@ -3172,6 +3239,11 @@ declare namespace gapi.client {
             humanReviewStatus?:
                 GoogleCloudDocumentaiV1beta3HumanReviewStatus;
         }
+        interface GoogleCloudDocumentaiV1beta3PropertyMetadata {
+            /** Whether the property should be considered as "inactive". */
+            inactive?:
+                boolean;
+        }
         interface GoogleCloudDocumentaiV1beta3RawDocument {
             /** Inline document content. */
             content?:
@@ -3811,6 +3883,137 @@ declare namespace gapi.client {
                     string;
             }): Request<GoogleLongrunningListOperationsResponse>;
         }
+        interface DatasetResource {
+            /** Gets the DatasetSchema of a Dataset. */
+            getDatasetSchema(request?: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** Required. The dataset schema resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** If set, only returns the visible fields of the schema. */
+                visibleFieldsOnly?:
+                    boolean;
+            }): Request<GoogleCloudDocumentaiV1beta3DatasetSchema>;
+            /** Updates a DatasetSchema. */
+            updateDatasetSchema(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** Dataset schema resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema` */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** The update mask applies to the resource. */
+                updateMask?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    GoogleCloudDocumentaiV1beta3DatasetSchema;
+            }): Request<GoogleCloudDocumentaiV1beta3DatasetSchema>;
+            updateDatasetSchema(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** Dataset schema resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema` */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** The update mask applies to the resource. */
+                updateMask?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: GoogleCloudDocumentaiV1beta3DatasetSchema): Request<GoogleCloudDocumentaiV1beta3DatasetSchema>;
+        }
         interface HumanReviewConfigResource {
             /** Send a document for Human Review. The input document should be processed by the specified processor. */
             reviewDocument(request: {
@@ -5317,6 +5520,95 @@ declare namespace gapi.client {
                     string;
             },
             body: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest): Request<GoogleLongrunningOperation>;
+            /** Updates metadata associated with a dataset. */
+            updateDataset(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset` */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** The update mask applies to the resource. */
+                updateMask?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    GoogleCloudDocumentaiV1beta3Dataset;
+            }): Request<GoogleLongrunningOperation>;
+            updateDataset(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset` */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** The update mask applies to the resource. */
+                updateMask?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: GoogleCloudDocumentaiV1beta3Dataset): Request<GoogleLongrunningOperation>;
+            dataset:
+                DatasetResource;
             humanReviewConfig:
                 HumanReviewConfigResource;
             processorVersions:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.documentai-v1beta3",
-  "version": "0.0.20230504",
+  "version": "0.0.20230526",
   "description": "TypeScript typings for Cloud Document AI API v1beta3",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230504
+// Revision: 20230526
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -1876,6 +1876,76 @@ gapi.load('client', async () => {
         }, {
             defaultProcessorVersion: "Test string",
         });
+        /** Updates metadata associated with a dataset. */
+        await gapi.client.documentai.projects.locations.processors.updateDataset({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            documentWarehouseConfig: {
+                collection: "Test string",
+                schema: "Test string",
+            },
+            gcsManagedConfig: {
+                gcsPrefix: {
+                    gcsUriPrefix: "Test string",
+                },
+            },
+            name: "Test string",
+            spannerIndexingConfig: {
+            },
+            state: "Test string",
+            unmanagedDatasetConfig: {
+            },
+        });
+        /** Gets the DatasetSchema of a Dataset. */
+        await gapi.client.documentai.projects.locations.processors.dataset.getDatasetSchema({
+            name: "Test string",
+            visibleFieldsOnly: true,
+        });
+        /** Updates a DatasetSchema. */
+        await gapi.client.documentai.projects.locations.processors.dataset.updateDatasetSchema({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            documentSchema: {
+                description: "Test string",
+                displayName: "Test string",
+                entityTypes: [
+                    {
+                        baseTypes: [
+                            "Test string"
+                        ],
+                        displayName: "Test string",
+                        entityTypeMetadata: {
+                            inactive: true,
+                        },
+                        enumValues: {
+                            values: [
+                                "Test string"
+                            ],
+                        },
+                        name: "Test string",
+                        properties: [
+                            {
+                                name: "Test string",
+                                occurrenceType: "Test string",
+                                propertyMetadata: {
+                                    inactive: true,
+                                },
+                                valueType: "Test string",
+                            }
+                        ],
+                    }
+                ],
+                metadata: {
+                    documentAllowMultipleLabels: true,
+                    documentSplitter: true,
+                    prefixedNamingOnProperties: true,
+                    skipNamingValidation: true,
+                },
+            },
+            name: "Test string",
+        });
         /** Send a document for Human Review. The input document should be processed by the specified processor. */
         await gapi.client.documentai.projects.locations.processors.humanReviewConfig.reviewDocument({
             humanReviewConfig: "Test string",
@@ -2733,6 +2803,9 @@ gapi.load('client', async () => {
                             "Test string"
                         ],
                         displayName: "Test string",
+                        entityTypeMetadata: {
+                            inactive: true,
+                        },
                         enumValues: {
                             values: [
                                 "Test string"
@@ -2743,6 +2816,9 @@ gapi.load('client', async () => {
                             {
                                 name: "Test string",
                                 occurrenceType: "Test string",
+                                propertyMetadata: {
+                                    inactive: true,
+                                },
                                 valueType: "Test string",
                             }
                         ],
@@ -5428,6 +5504,9 @@ gapi.load('client', async () => {
                             "Test string"
                         ],
                         displayName: "Test string",
+                        entityTypeMetadata: {
+                            inactive: true,
+                        },
                         enumValues: {
                             values: [
                                 "Test string"
@@ -5438,6 +5517,9 @@ gapi.load('client', async () => {
                             {
                                 name: "Test string",
                                 occurrenceType: "Test string",
+                                propertyMetadata: {
+                                    inactive: true,
+                                },
                                 valueType: "Test string",
                             }
                         ],
@@ -5494,6 +5576,9 @@ gapi.load('client', async () => {
                                 "Test string"
                             ],
                             displayName: "Test string",
+                            entityTypeMetadata: {
+                                inactive: true,
+                            },
                             enumValues: {
                                 values: [
                                     "Test string"
@@ -5504,6 +5589,9 @@ gapi.load('client', async () => {
                                 {
                                     name: "Test string",
                                     occurrenceType: "Test string",
+                                    propertyMetadata: {
+                                        inactive: true,
+                                    },
                                     valueType: "Test string",
                                 }
                             ],