@maxim_mazurok/gapi.client.documentai-v1 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=v1
-// 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[];
@@ -466,6 +475,9 @@ declare namespace gapi.client {
             /** The input documents for the BatchProcessDocuments method. */
             inputDocuments?:
                 GoogleCloudDocumentaiV1BatchDocumentsInputConfig;
+            /** Inference-time options for the process API */
+            processOptions?:
+                GoogleCloudDocumentaiV1ProcessOptions;
             /** Whether human review should be skipped for this request. Default to `false`. */
             skipHumanReview?:
                 boolean;
@@ -1935,6 +1947,31 @@ declare namespace gapi.client {
             y?:
                 number;
         }
+        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;
+        }
+        // tslint:disable-next-line:no-empty-interface
+        interface GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse {
+        }
         interface GoogleCloudDocumentaiV1beta3BatchProcessMetadata {
             /** The creation time of the operation. */
             createTime?:
@@ -1992,6 +2029,45 @@ declare namespace gapi.client {
             updateTime?:
                 string;
         }
+        interface GoogleCloudDocumentaiV1beta3Dataset {
+            /** Optional. Document AI Warehouse-based dataset configuration. */
+            documentWarehouseConfig?:
+                GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig;
+            /** Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage 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 reliability, but lacking advanced features like CMEK and content-based search. */
+            spannerIndexingConfig?:
+                any;
+            /** Required. State of the dataset. Ignored when updating dataset. */
+            state?:
+                string;
+            /** Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed). */
+            unmanagedDatasetConfig?:
+                any;
+        }
+        interface GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig {
+            /** Output only. The collection in Document AI Warehouse associated with the dataset. */
+            collection?:
+                string;
+            /** Output only. The schema in Document AI 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;
+        }
+        // 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?:
@@ -2018,6 +2094,30 @@ declare namespace gapi.client {
         // tslint:disable-next-line:no-empty-interface
         interface GoogleCloudDocumentaiV1beta3DisableProcessorResponse {
         }
+        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 GoogleCloudDocumentaiV1beta3EnableProcessorMetadata {
             /** The basic metadata of the long-running operation. */
             commonMetadata?:
@@ -2036,6 +2136,11 @@ declare namespace gapi.client {
             evaluation?:
                 string;
         }
+        interface GoogleCloudDocumentaiV1beta3GcsPrefix {
+            /** The URI prefix. */
+            gcsUriPrefix?:
+                string;
+        }
         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
@@ -2050,6 +2155,42 @@ 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;
+        }
+        // tslint:disable-next-line:no-empty-interface
+        interface GoogleCloudDocumentaiV1beta3ImportDocumentsResponse {
+        }
         interface GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata {
             /** The basic metadata for the long-running operation. */
             commonMetadata?:
@@ -2091,6 +2232,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?:
@@ -2137,6 +2292,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 GoogleCloudDocumentaiV1BoundingPoly {
             /** The bounding polygon normalized vertices. */
             normalizedVertices?:
@@ -3132,6 +3292,46 @@ declare namespace gapi.client {
             y?:
                 number;
         }
+        interface GoogleCloudDocumentaiV1OcrConfig {
+            /**
+             * A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an
+             * alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
+             */
+            advancedOcrOptions?:
+                string[];
+            /** Turn on font id model and returns font style information. */
+            computeStyleInfo?:
+                boolean;
+            /**
+             * Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to
+             * regular OCR to the process call.
+             */
+            enableImageQualityScores?:
+                boolean;
+            /** Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs. */
+            enableNativePdfParsing?:
+                boolean;
+            /** Includes symbol level OCR information if set to true. */
+            enableSymbol?:
+                boolean;
+            /** Hints for the OCR model. */
+            hints?:
+                GoogleCloudDocumentaiV1OcrConfigHints;
+        }
+        interface GoogleCloudDocumentaiV1OcrConfigHints {
+            /**
+             * List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the
+             * Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a
+             * significant hindrance if the hint is wrong).
+             */
+            languageHints?:
+                string[];
+        }
+        interface GoogleCloudDocumentaiV1ProcessOptions {
+            /** Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types. */
+            ocrConfig?:
+                GoogleCloudDocumentaiV1OcrConfig;
+        }
         interface GoogleCloudDocumentaiV1Processor {
             /** The time the processor was created. */
             createTime?:
@@ -3233,9 +3433,15 @@ declare namespace gapi.client {
              */
             fieldMask?:
                 string;
+            /** A raw document on Google Cloud Storage. */
+            gcsDocument?:
+                GoogleCloudDocumentaiV1GcsDocument;
             /** An inline document proto. */
             inlineDocument?:
                 GoogleCloudDocumentaiV1Document;
+            /** Inference-time options for the process API */
+            processOptions?:
+                GoogleCloudDocumentaiV1ProcessOptions;
             /** A raw document content (bytes). */
             rawDocument?:
                 GoogleCloudDocumentaiV1RawDocument;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.documentai-v1",
-  "version": "0.0.20230705",
+  "version": "0.0.20230714",
   "description": "TypeScript typings for Cloud Document AI API v1",
   "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 */
@@ -98,6 +98,22 @@ gapi.load('client', async () => {
                     gcsUriPrefix: "Test string",
                 },
             },
+            processOptions: {
+                ocrConfig: {
+                    advancedOcrOptions: [
+                        "Test string"
+                    ],
+                    computeStyleInfo: true,
+                    enableImageQualityScores: true,
+                    enableNativePdfParsing: true,
+                    enableSymbol: true,
+                    hints: {
+                        languageHints: [
+                            "Test string"
+                        ],
+                    },
+                },
+            },
             skipHumanReview: true,
         });
         /** Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default after its creation. */
@@ -142,6 +158,10 @@ gapi.load('client', async () => {
             name: "Test string",
         }, {
             fieldMask: "Test string",
+            gcsDocument: {
+                gcsUri: "Test string",
+                mimeType: "Test string",
+            },
             inlineDocument: {
                 content: "Test string",
                 entities: [
@@ -986,6 +1006,22 @@ gapi.load('client', async () => {
                 ],
                 uri: "Test string",
             },
+            processOptions: {
+                ocrConfig: {
+                    advancedOcrOptions: [
+                        "Test string"
+                    ],
+                    computeStyleInfo: true,
+                    enableImageQualityScores: true,
+                    enableNativePdfParsing: true,
+                    enableSymbol: true,
+                    hints: {
+                        languageHints: [
+                            "Test string"
+                        ],
+                    },
+                },
+            },
             rawDocument: {
                 content: "Test string",
                 mimeType: "Test string",
@@ -1907,6 +1943,22 @@ gapi.load('client', async () => {
                     gcsUriPrefix: "Test string",
                 },
             },
+            processOptions: {
+                ocrConfig: {
+                    advancedOcrOptions: [
+                        "Test string"
+                    ],
+                    computeStyleInfo: true,
+                    enableImageQualityScores: true,
+                    enableNativePdfParsing: true,
+                    enableSymbol: true,
+                    hints: {
+                        languageHints: [
+                            "Test string"
+                        ],
+                    },
+                },
+            },
             skipHumanReview: true,
         });
         /** Deletes the processor version, all artifacts under the processor version will be deleted. */
@@ -1951,6 +2003,10 @@ gapi.load('client', async () => {
             name: "Test string",
         }, {
             fieldMask: "Test string",
+            gcsDocument: {
+                gcsUri: "Test string",
+                mimeType: "Test string",
+            },
             inlineDocument: {
                 content: "Test string",
                 entities: [
@@ -2795,6 +2851,22 @@ gapi.load('client', async () => {
                 ],
                 uri: "Test string",
             },
+            processOptions: {
+                ocrConfig: {
+                    advancedOcrOptions: [
+                        "Test string"
+                    ],
+                    computeStyleInfo: true,
+                    enableImageQualityScores: true,
+                    enableNativePdfParsing: true,
+                    enableSymbol: true,
+                    hints: {
+                        languageHints: [
+                            "Test string"
+                        ],
+                    },
+                },
+            },
             rawDocument: {
                 content: "Test string",
                 mimeType: "Test string",