@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20230705 → 0.0.20230714

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: 20230705
+// Revision: 20230714
 
 /// <reference types="gapi.client" />
 
@@ -258,6 +258,9 @@ declare namespace gapi.client {
             /** The source Cloud Storage URI of the document. */
             inputGcsSource?:
                 string;
+            /** The document id of imported document if it was successful, otherwise empty. */
+            outputDocumentId?:
+                GoogleCloudDocumentaiUiv1beta3DocumentId;
             /** The output_gcs_destination of the processed document if it was successful, otherwise empty. */
             outputGcsDestination?:
                 string;
@@ -331,6 +334,12 @@ declare namespace gapi.client {
                 GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata;
         }
         interface GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse {
+            /** The status of sampling documents in test split. */
+            sampleTestStatus?:
+                GoogleRpcStatus;
+            /** The status of sampling documents in training split. */
+            sampleTrainingStatus?:
+                GoogleRpcStatus;
             /** The result of the sampling process. */
             selectedDocuments?:
                 GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument[];
@@ -1916,6 +1925,52 @@ declare namespace gapi.client {
             valueFormat?:
                 string;
         }
+        interface GoogleCloudDocumentaiV1beta3BatchDatasetDocuments {
+            /** A filter matching the documents. Follows the same format and restriction as [google.cloud.documentai.master.ListDocumentsRequest.filter]. */
+            filter?:
+                string;
+            /** Document identifiers. */
+            individualDocumentIds?:
+                GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds;
+        }
+        interface GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds {
+            /** Required. List of Document IDs indicating where the actual documents are stored. */
+            documentIds?:
+                GoogleCloudDocumentaiV1beta3DocumentId[];
+        }
+        interface GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata {
+            /** The basic metadata of the long running operation. */
+            commonMetadata?:
+                GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
+            /** Total number of documents that failed to be deleted in storage. */
+            errorDocumentCount?:
+                number;
+            /** The list of response details of each document. */
+            individualBatchDeleteStatuses?:
+                GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus[];
+            /** Total number of documents deleting from dataset. */
+            totalDocumentCount?:
+                number;
+        }
+        interface GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus {
+            /** The document id of the document. */
+            documentId?:
+                GoogleCloudDocumentaiV1beta3DocumentId;
+            /** The status of deleting the document in storage. */
+            status?:
+                GoogleRpcStatus;
+        }
+        interface GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest {
+            /**
+             * Required. Dataset documents input. If given `filter`, all documents satisfying the filter will be deleted. If given documentIds, a maximum of 50 documents can be deleted in a batch.
+             * The request will be rejected if more than 50 document_ids are provided.
+             */
+            datasetDocuments?:
+                GoogleCloudDocumentaiV1beta3BatchDatasetDocuments;
+        }
+        // tslint:disable-next-line:no-empty-interface
+        interface GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse {
+        }
         interface GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig {
             /** The set of documents individually specified on Cloud Storage. */
             gcsDocuments?:
@@ -2231,6 +2286,30 @@ declare namespace gapi.client {
             subjectId?:
                 string;
         }
+        interface GoogleCloudDocumentaiV1beta3DocumentId {
+            /** A document id within user-managed Cloud Storage. */
+            gcsManagedDocId?:
+                GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId;
+            /** Points to a specific revision of the document if set. */
+            revisionRef?:
+                GoogleCloudDocumentaiV1beta3RevisionRef;
+            /** A document id within unmanaged dataset. */
+            unmanagedDocId?:
+                GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId;
+        }
+        interface GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId {
+            /** Id of the document (indexed) managed by Content Warehouse. */
+            cwDocId?:
+                string;
+            /** Required. The Cloud Storage URI where the actual document is stored. */
+            gcsUri?:
+                string;
+        }
+        interface GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId {
+            /** Required. The id of the document. */
+            docId?:
+                string;
+        }
         interface GoogleCloudDocumentaiV1beta3DocumentOutputConfig {
             /** Output config to write the results to Cloud Storage. */
             gcsOutputConfig?:
@@ -2999,6 +3078,10 @@ declare namespace gapi.client {
             gcsUriPrefix?:
                 string;
         }
+        interface GoogleCloudDocumentaiV1beta3GetDocumentResponse {
+            document?:
+                GoogleCloudDocumentaiV1beta3Document;
+        }
         interface GoogleCloudDocumentaiV1beta3HumanReviewStatus {
             /**
              * 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 metadata
@@ -3013,6 +3096,63 @@ declare namespace gapi.client {
             stateMessage?:
                 string;
         }
+        interface GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata {
+            /** The basic metadata of the long running operation. */
+            commonMetadata?:
+                GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
+            /** Validation statuses of the batch documents import config. */
+            importConfigValidationResults?:
+                GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult[];
+            /** The list of response details of each document. */
+            individualImportStatuses?:
+                GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus[];
+            /** Total number of the documents that are qualified for importing. */
+            totalDocumentCount?:
+                number;
+        }
+        interface GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult {
+            /** The source Cloud Storage URI specified in the import config. */
+            inputGcsSource?:
+                string;
+            /** The validation status of import config. */
+            status?:
+                GoogleRpcStatus;
+        }
+        interface GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus {
+            /** The source Cloud Storage URI of the document. */
+            inputGcsSource?:
+                string;
+            /** The document id of imported document if it was successful, otherwise empty. */
+            outputDocumentId?:
+                GoogleCloudDocumentaiV1beta3DocumentId;
+            /** The status of the importing of the document. */
+            status?:
+                GoogleRpcStatus;
+        }
+        interface GoogleCloudDocumentaiV1beta3ImportDocumentsRequest {
+            /** Required. The Cloud Storage uri containing raw documents that must be imported. */
+            batchDocumentsImportConfigs?:
+                GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig[];
+        }
+        interface GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig {
+            /** If set, documents will be automatically split into training and test split category with the specified ratio. */
+            autoSplitConfig?:
+                GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig;
+            /** The common config to specify a set of documents used as input. */
+            batchInputConfig?:
+                GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
+            /** Target dataset split where the documents must be stored. */
+            datasetSplit?:
+                string;
+        }
+        interface GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig {
+            /** Ratio of training dataset split. */
+            trainingSplitRatio?:
+                number;
+        }
+        // tslint:disable-next-line:no-empty-interface
+        interface GoogleCloudDocumentaiV1beta3ImportDocumentsResponse {
+        }
         interface GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata {
             /** The basic metadata for the long-running operation. */
             commonMetadata?:
@@ -3212,6 +3352,9 @@ declare namespace gapi.client {
              */
             fieldMask?:
                 string;
+            /** A raw document on Google Cloud Storage. */
+            gcsDocument?:
+                GoogleCloudDocumentaiV1beta3GcsDocument;
             /** An inline document proto. */
             inlineDocument?:
                 GoogleCloudDocumentaiV1beta3Document;
@@ -3300,6 +3443,20 @@ declare namespace gapi.client {
             state?:
                 string;
         }
+        interface GoogleCloudDocumentaiV1beta3RevisionRef {
+            /**
+             * Reads the revision generated by the processor version. The format takes the full resource name of processor version.
+             * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
+             */
+            latestProcessorVersion?:
+                string;
+            /** Reads the revision by the predefined case. */
+            revisionCase?:
+                string;
+            /** Reads the revision given by the id. */
+            revisionId?:
+                string;
+        }
         interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata {
             /** The basic metadata of the long-running operation. */
             commonMetadata?:
@@ -3387,6 +3544,11 @@ declare namespace gapi.client {
         // tslint:disable-next-line:no-empty-interface
         interface GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse {
         }
+        interface GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata {
+            /** The basic metadata of the long running operation. */
+            commonMetadata?:
+                GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
+        }
         interface GoogleCloudDocumentaiV1beta3Vertex {
             /** X coordinate. */
             x?:
@@ -3892,6 +4054,87 @@ declare namespace gapi.client {
             }): Request<GoogleLongrunningListOperationsResponse>;
         }
         interface DatasetResource {
+            /** Deletes a set of documents. */
+            batchDeleteDocuments(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset */
+                dataset:
+                    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;
+                /** 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;
+                /** Request body */
+                resource:
+                    GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest;
+            }): Request<GoogleLongrunningOperation>;
+            batchDeleteDocuments(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset */
+                dataset:
+                    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;
+                /** 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;
+            },
+            body: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest): Request<GoogleLongrunningOperation>;
             /** Gets the `DatasetSchema` of a `Dataset`. */
             getDatasetSchema(request?: {
                 /** V1 error format. */
@@ -3934,6 +4177,156 @@ declare namespace gapi.client {
                 visibleFieldsOnly?:
                     boolean;
             }): Request<GoogleCloudDocumentaiV1beta3DatasetSchema>;
+            /** Returns relevant fields present in the requested document. */
+            getDocument(request?: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset */
+                dataset:
+                    string;
+                /** Id of the document (indexed) managed by Content Warehouse. */
+                "documentId.gcsManagedDocId.cwDocId"?:
+                    string;
+                /** Required. The Cloud Storage URI where the actual document is stored. */
+                "documentId.gcsManagedDocId.gcsUri"?:
+                    string;
+                /**
+                 * Reads the revision generated by the processor version. The format takes the full resource name of processor version.
+                 * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
+                 */
+                "documentId.revisionRef.latestProcessorVersion"?:
+                    string;
+                /** Reads the revision by the predefined case. */
+                "documentId.revisionRef.revisionCase"?:
+                    string;
+                /** Reads the revision given by the id. */
+                "documentId.revisionRef.revisionId"?:
+                    string;
+                /** Required. The id of the document. */
+                "documentId.unmanagedDocId.docId"?:
+                    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;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Last page number (one-based index) to be returned. */
+                "pageRange.end"?:
+                    number;
+                /** First page number (one-based index) to be returned. */
+                "pageRange.start"?:
+                    number;
+                /** 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;
+                /** If set, only fields listed here will be returned. Otherwise, all fields will be returned by default. */
+                readMask?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            }): Request<GoogleCloudDocumentaiV1beta3GetDocumentResponse>;
+            /** Import documents into a dataset. */
+            importDocuments(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset */
+                dataset:
+                    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;
+                /** 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;
+                /** Request body */
+                resource:
+                    GoogleCloudDocumentaiV1beta3ImportDocumentsRequest;
+            }): Request<GoogleLongrunningOperation>;
+            importDocuments(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset */
+                dataset:
+                    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;
+                /** 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;
+            },
+            body: GoogleCloudDocumentaiV1beta3ImportDocumentsRequest): Request<GoogleLongrunningOperation>;
             /** Updates a `DatasetSchema`. */
             updateDatasetSchema(request: {
                 /** V1 error format. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.documentai-v1beta3",
-  "version": "0.0.20230705",
+  "version": "0.0.20230714",
   "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: 20230705
+// Revision: 20230714
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -1004,6 +1004,10 @@ gapi.load('client', async () => {
                 uri: "Test string",
             },
             fieldMask: "Test string",
+            gcsDocument: {
+                gcsUri: "Test string",
+                mimeType: "Test string",
+            },
             inlineDocument: {
                 content: "Test string",
                 entities: [
@@ -1897,11 +1901,76 @@ gapi.load('client', async () => {
             unmanagedDatasetConfig: {
             },
         });
+        /** Deletes a set of documents. */
+        await gapi.client.documentai.projects.locations.processors.dataset.batchDeleteDocuments({
+            dataset: "Test string",
+        }, {
+            datasetDocuments: {
+                filter: "Test string",
+                individualDocumentIds: {
+                    documentIds: [
+                        {
+                            gcsManagedDocId: {
+                                cwDocId: "Test string",
+                                gcsUri: "Test string",
+                            },
+                            revisionRef: {
+                                latestProcessorVersion: "Test string",
+                                revisionCase: "Test string",
+                                revisionId: "Test string",
+                            },
+                            unmanagedDocId: {
+                                docId: "Test string",
+                            },
+                        }
+                    ],
+                },
+            },
+        });
         /** Gets the `DatasetSchema` of a `Dataset`. */
         await gapi.client.documentai.projects.locations.processors.dataset.getDatasetSchema({
             name: "Test string",
             visibleFieldsOnly: true,
         });
+        /** Returns relevant fields present in the requested document. */
+        await gapi.client.documentai.projects.locations.processors.dataset.getDocument({
+            dataset: "Test string",
+            "documentId.gcsManagedDocId.cwDocId": "Test string",
+            "documentId.gcsManagedDocId.gcsUri": "Test string",
+            "documentId.revisionRef.latestProcessorVersion": "Test string",
+            "documentId.revisionRef.revisionCase": "Test string",
+            "documentId.revisionRef.revisionId": "Test string",
+            "documentId.unmanagedDocId.docId": "Test string",
+            "pageRange.end": 42,
+            "pageRange.start": 42,
+            readMask: "Test string",
+        });
+        /** Import documents into a dataset. */
+        await gapi.client.documentai.projects.locations.processors.dataset.importDocuments({
+            dataset: "Test string",
+        }, {
+            batchDocumentsImportConfigs: [
+                {
+                    autoSplitConfig: {
+                        trainingSplitRatio: 42,
+                    },
+                    batchInputConfig: {
+                        gcsDocuments: {
+                            documents: [
+                                {
+                                    gcsUri: "Test string",
+                                    mimeType: "Test string",
+                                }
+                            ],
+                        },
+                        gcsPrefix: {
+                            gcsUriPrefix: "Test string",
+                        },
+                    },
+                    datasetSplit: "Test string",
+                }
+            ],
+        });
         /** Updates a `DatasetSchema`. */
         await gapi.client.documentai.projects.locations.processors.dataset.updateDatasetSchema({
             name: "Test string",
@@ -4624,6 +4693,10 @@ gapi.load('client', async () => {
                 uri: "Test string",
             },
             fieldMask: "Test string",
+            gcsDocument: {
+                gcsUri: "Test string",
+                mimeType: "Test string",
+            },
             inlineDocument: {
                 content: "Test string",
                 entities: [