@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20230911 → 0.0.20230923

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: 20230911
+// Revision: 20230923
 
 /// <reference types="gapi.client" />
 
@@ -34,6 +34,9 @@ declare namespace gapi.client {
                 number;
         }
         interface GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus {
+            /** The document id of the auto-labeled document. This will replace the gcs_uri. */
+            documentId?:
+                GoogleCloudDocumentaiUiv1beta3DocumentId;
             /** The gcs_uri of the auto-labeling document, which uniquely identifies a dataset document. */
             gcsUri?:
                 string;
@@ -2329,6 +2332,23 @@ declare namespace gapi.client {
             docId?:
                 string;
         }
+        interface GoogleCloudDocumentaiV1beta3DocumentMetadata {
+            /** Type of the dataset split to which the document belongs. */
+            datasetType?:
+                string;
+            /** The display name of the document. */
+            displayName?:
+                string;
+            /** Document identifier. */
+            documentId?:
+                GoogleCloudDocumentaiV1beta3DocumentId;
+            /** Labelling state of the document. */
+            labelingState?:
+                string;
+            /** Number of pages in the document. */
+            pageCount?:
+                number;
+        }
         interface GoogleCloudDocumentaiV1beta3DocumentOutputConfig {
             /** Output config to write the results to Cloud Storage. */
             gcsOutputConfig?:
@@ -3203,6 +3223,53 @@ declare namespace gapi.client {
             processorVersion?:
                 string;
         }
+        interface GoogleCloudDocumentaiV1beta3ListDocumentsRequest {
+            /**
+             * Optional. Query to filter the documents based on https://google.aip.dev/160. ## Currently support query strings are:
+             * `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED` - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED` -
+             * `DisplayName=\"file_name.pdf\"` - `EntityType=abc/def` - `TagName=\"auto-labeling-running\"|\"sampled\"` Note: - Only `AND`, `=` and `!=` are supported. e.g. `DisplayName=file_name
+             * AND EntityType!=abc` IS supported. - Wildcard `*` is supported only in `DisplayName` filter - No duplicate filter keys are allowed, e.g. `EntityType=a AND EntityType=b` is NOT
+             * supported. - String match is case sensitive (for filter `DisplayName` & `EntityType`).
+             */
+            filter?:
+                string;
+            /**
+             * The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values
+             * above 100 will be coerced to 100.
+             */
+            pageSize?:
+                number;
+            /**
+             * A page token, received from a previous `ListDocuments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDocuments` must
+             * match the call that provided the page token.
+             */
+            pageToken?:
+                string;
+            /**
+             * Optional. Controls if the ListDocuments request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact
+             * performance. Defaults to false.
+             */
+            returnTotalSize?:
+                boolean;
+            /**
+             * Optional. Number of results to skip beginning from the `page_token` if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values wil
+             * be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, `ListDocumentsResponse.document_metadata` and
+             * `ListDocumentsResponse.next_page_token` will be empty.
+             */
+            skip?:
+                number;
+        }
+        interface GoogleCloudDocumentaiV1beta3ListDocumentsResponse {
+            /** Document metadata corresponding to the listed documents. */
+            documentMetadata?:
+                GoogleCloudDocumentaiV1beta3DocumentMetadata[];
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?:
+                string;
+            /** Total count of documents queried. */
+            totalSize?:
+                number;
+        }
         interface GoogleCloudDocumentaiV1beta3ListEvaluationsResponse {
             /** The evaluations requested. */
             evaluations?:
@@ -3250,9 +3317,12 @@ declare namespace gapi.client {
              */
             advancedOcrOptions?:
                 string[];
-            /** Turn on font identification model and return font style information. */
+            /** Turn on font identification model and return font style information. Deprecated, use PremiumFeatures.compute_style_info instead. */
             computeStyleInfo?:
                 boolean;
+            /** Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors. */
+            disableCharacterBoxesDetection?:
+                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.
@@ -3268,6 +3338,9 @@ declare namespace gapi.client {
             /** Hints for the OCR model. */
             hints?:
                 GoogleCloudDocumentaiV1beta3OcrConfigHints;
+            /** Configurations for premium OCR features. */
+            premiumFeatures?:
+                GoogleCloudDocumentaiV1beta3OcrConfigPremiumFeatures;
         }
         interface GoogleCloudDocumentaiV1beta3OcrConfigHints {
             /**
@@ -3278,7 +3351,27 @@ declare namespace gapi.client {
             languageHints?:
                 string[];
         }
+        interface GoogleCloudDocumentaiV1beta3OcrConfigPremiumFeatures {
+            /** Turn on font identification model and return font style information. */
+            computeStyleInfo?:
+                boolean;
+            /** Turn on the model that can extract LaTeX math formulas. */
+            enableMathOcr?:
+                boolean;
+            /** Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors. */
+            enableSelectionMarkDetection?:
+                boolean;
+        }
         interface GoogleCloudDocumentaiV1beta3ProcessOptions {
+            /** Only process certain pages from the end, same as above. */
+            fromEnd?:
+                number;
+            /** Only process certain pages from the start. Process all if the document has fewer pages. */
+            fromStart?:
+                number;
+            /** Which pages to process (1-indexed). */
+            individualPageSelector?:
+                GoogleCloudDocumentaiV1beta3ProcessOptionsIndividualPageSelector;
             /** Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types. */
             ocrConfig?:
                 GoogleCloudDocumentaiV1beta3OcrConfig;
@@ -3289,6 +3382,11 @@ declare namespace gapi.client {
             schemaOverride?:
                 GoogleCloudDocumentaiV1beta3DocumentSchema;
         }
+        interface GoogleCloudDocumentaiV1beta3ProcessOptionsIndividualPageSelector {
+            /** Optional. Indices of the pages (starting from 1). */
+            pages?:
+                number[];
+        }
         interface GoogleCloudDocumentaiV1beta3Processor {
             /** The time the processor was created. */
             createTime?:
@@ -4396,6 +4494,87 @@ declare namespace gapi.client {
                     string;
             },
             body: GoogleCloudDocumentaiV1beta3ImportDocumentsRequest): Request<GoogleLongrunningOperation>;
+            /** Returns a list of documents present in the dataset. */
+            listDocuments(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 to be listed. 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:
+                    GoogleCloudDocumentaiV1beta3ListDocumentsRequest;
+            }): Request<GoogleCloudDocumentaiV1beta3ListDocumentsResponse>;
+            listDocuments(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 to be listed. 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: GoogleCloudDocumentaiV1beta3ListDocumentsRequest): Request<GoogleCloudDocumentaiV1beta3ListDocumentsResponse>;
             /** 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.20230911",
+  "version": "0.0.20230923",
   "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: 20230911
+// Revision: 20230923
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -101,11 +101,19 @@ gapi.load('client', async () => {
                 gcsDestination: "Test string",
             },
             processOptions: {
+                fromEnd: 42,
+                fromStart: 42,
+                individualPageSelector: {
+                    pages: [
+                        42
+                    ],
+                },
                 ocrConfig: {
                     advancedOcrOptions: [
                         "Test string"
                     ],
                     computeStyleInfo: true,
+                    disableCharacterBoxesDetection: true,
                     enableImageQualityScores: true,
                     enableNativePdfParsing: true,
                     enableSymbol: true,
@@ -114,6 +122,11 @@ gapi.load('client', async () => {
                             "Test string"
                         ],
                     },
+                    premiumFeatures: {
+                        computeStyleInfo: true,
+                        enableMathOcr: true,
+                        enableSelectionMarkDetection: true,
+                    },
                 },
                 schemaOverride: {
                     description: "Test string",
@@ -1902,11 +1915,19 @@ gapi.load('client', async () => {
                 uri: "Test string",
             },
             processOptions: {
+                fromEnd: 42,
+                fromStart: 42,
+                individualPageSelector: {
+                    pages: [
+                        42
+                    ],
+                },
                 ocrConfig: {
                     advancedOcrOptions: [
                         "Test string"
                     ],
                     computeStyleInfo: true,
+                    disableCharacterBoxesDetection: true,
                     enableImageQualityScores: true,
                     enableNativePdfParsing: true,
                     enableSymbol: true,
@@ -1915,6 +1936,11 @@ gapi.load('client', async () => {
                             "Test string"
                         ],
                     },
+                    premiumFeatures: {
+                        computeStyleInfo: true,
+                        enableMathOcr: true,
+                        enableSelectionMarkDetection: true,
+                    },
                 },
                 schemaOverride: {
                     description: "Test string",
@@ -2064,6 +2090,16 @@ gapi.load('client', async () => {
                 }
             ],
         });
+        /** Returns a list of documents present in the dataset. */
+        await gapi.client.documentai.projects.locations.processors.dataset.listDocuments({
+            dataset: "Test string",
+        }, {
+            filter: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            returnTotalSize: true,
+            skip: 42,
+        });
         /** Updates a `DatasetSchema`. */
         await gapi.client.documentai.projects.locations.processors.dataset.updateDatasetSchema({
             name: "Test string",
@@ -3889,11 +3925,19 @@ gapi.load('client', async () => {
                 gcsDestination: "Test string",
             },
             processOptions: {
+                fromEnd: 42,
+                fromStart: 42,
+                individualPageSelector: {
+                    pages: [
+                        42
+                    ],
+                },
                 ocrConfig: {
                     advancedOcrOptions: [
                         "Test string"
                     ],
                     computeStyleInfo: true,
+                    disableCharacterBoxesDetection: true,
                     enableImageQualityScores: true,
                     enableNativePdfParsing: true,
                     enableSymbol: true,
@@ -3902,6 +3946,11 @@ gapi.load('client', async () => {
                             "Test string"
                         ],
                     },
+                    premiumFeatures: {
+                        computeStyleInfo: true,
+                        enableMathOcr: true,
+                        enableSelectionMarkDetection: true,
+                    },
                 },
                 schemaOverride: {
                     description: "Test string",
@@ -5694,11 +5743,19 @@ gapi.load('client', async () => {
                 uri: "Test string",
             },
             processOptions: {
+                fromEnd: 42,
+                fromStart: 42,
+                individualPageSelector: {
+                    pages: [
+                        42
+                    ],
+                },
                 ocrConfig: {
                     advancedOcrOptions: [
                         "Test string"
                     ],
                     computeStyleInfo: true,
+                    disableCharacterBoxesDetection: true,
                     enableImageQualityScores: true,
                     enableNativePdfParsing: true,
                     enableSymbol: true,
@@ -5707,6 +5764,11 @@ gapi.load('client', async () => {
                             "Test string"
                         ],
                     },
+                    premiumFeatures: {
+                        computeStyleInfo: true,
+                        enableMathOcr: true,
+                        enableSelectionMarkDetection: true,
+                    },
                 },
                 schemaOverride: {
                     description: "Test string",