@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20221114 → 0.0.20221201

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: 20221114
+// Revision: 20221201
 
 /// <reference types="gapi.client" />
 
@@ -370,7 +370,7 @@ declare namespace gapi.client {
              * with each other.
              */
             textChanges?: GoogleCloudDocumentaiV1beta1DocumentTextChange[];
-            /** Placeholder. Styles for the Document.text. */
+            /** Styles for the Document.text. */
             textStyles?: GoogleCloudDocumentaiV1beta1DocumentStyle[];
             /**
              * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request
@@ -422,9 +422,9 @@ declare namespace gapi.client {
             moneyValue?: GoogleTypeMoney;
             /**
              * Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of
-             * `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. -
-             * Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601
-             * text format.
+             * `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured
+             * values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the
+             * ISO 8601 text format.
              */
             text?: string;
         }
@@ -486,7 +486,7 @@ declare namespace gapi.client {
             /** Optional. The type of the layout element that is being referenced if any. */
             layoutType?: string;
             /**
-             * Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See
+             * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See
              * https://developers.google.com/protocol-buffers/docs/proto3#json.
              */
             page?: string;
@@ -535,8 +535,8 @@ declare namespace gapi.client {
             /** A list of detected languages for value together with confidence. */
             valueDetectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
             /**
-             * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - "unfilled_checkbox" -
-             * "filled_checkbox"
+             * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` -
+             * `filled_checkbox`
              */
             valueType?: string;
         }
@@ -868,7 +868,7 @@ declare namespace gapi.client {
              * with each other.
              */
             textChanges?: GoogleCloudDocumentaiV1beta2DocumentTextChange[];
-            /** Placeholder. Styles for the Document.text. */
+            /** Styles for the Document.text. */
             textStyles?: GoogleCloudDocumentaiV1beta2DocumentStyle[];
             /**
              * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request
@@ -920,9 +920,9 @@ declare namespace gapi.client {
             moneyValue?: GoogleTypeMoney;
             /**
              * Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of
-             * `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. -
-             * Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601
-             * text format.
+             * `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured
+             * values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the
+             * ISO 8601 text format.
              */
             text?: string;
         }
@@ -992,7 +992,7 @@ declare namespace gapi.client {
             /** Optional. The type of the layout element that is being referenced if any. */
             layoutType?: string;
             /**
-             * Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See
+             * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See
              * https://developers.google.com/protocol-buffers/docs/proto3#json.
              */
             page?: string;
@@ -1041,8 +1041,8 @@ declare namespace gapi.client {
             /** A list of detected languages for value together with confidence. */
             valueDetectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
             /**
-             * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - "unfilled_checkbox" -
-             * "filled_checkbox"
+             * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` -
+             * `filled_checkbox`
              */
             valueType?: string;
         }
@@ -1385,6 +1385,8 @@ declare namespace gapi.client {
             inputDocuments?: GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
             /** The overall output config for batch process. */
             outputConfig?: GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig;
+            /** Inference-time options for the process API */
+            processOptions?: GoogleCloudDocumentaiV1beta3ProcessOptions;
             /** Whether Human Review feature should be skipped for this request. Default to false. */
             skipHumanReview?: boolean;
         }
@@ -1477,7 +1479,7 @@ declare namespace gapi.client {
              * with each other.
              */
             textChanges?: GoogleCloudDocumentaiV1beta3DocumentTextChange[];
-            /** Placeholder. Styles for the Document.text. */
+            /** Styles for the Document.text. */
             textStyles?: GoogleCloudDocumentaiV1beta3DocumentStyle[];
             /**
              * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request
@@ -1529,9 +1531,9 @@ declare namespace gapi.client {
             moneyValue?: GoogleTypeMoney;
             /**
              * Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of
-             * `structured_value` will be normalized. For example, some processors may not generate float or int normalized text by default. Below are sample formats mapped to structured values. -
-             * Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601
-             * text format.
+             * `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured
+             * values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the
+             * ISO 8601 text format.
              */
             text?: string;
         }
@@ -1555,6 +1557,14 @@ declare namespace gapi.client {
             fieldMask?: string;
             /** The Cloud Storage uri (a directory) of the output. */
             gcsUri?: string;
+            /** Specifies the sharding config for the output document. */
+            shardingConfig?: GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig;
+        }
+        interface GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig {
+            /** The number of overlapping pages between consecutive shards. */
+            pagesOverlap?: number;
+            /** The number of pages per shard. */
+            pagesPerShard?: number;
         }
         interface GoogleCloudDocumentaiV1beta3DocumentPage {
             /** A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. */
@@ -1606,7 +1616,7 @@ declare namespace gapi.client {
             /** Optional. The type of the layout element that is being referenced if any. */
             layoutType?: string;
             /**
-             * Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See
+             * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See
              * https://developers.google.com/protocol-buffers/docs/proto3#json.
              */
             page?: string;
@@ -1655,8 +1665,8 @@ declare namespace gapi.client {
             /** A list of detected languages for value together with confidence. */
             valueDetectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
             /**
-             * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - "unfilled_checkbox" -
-             * "filled_checkbox"
+             * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` -
+             * `filled_checkbox`
              */
             valueType?: string;
         }
@@ -1846,9 +1856,9 @@ declare namespace gapi.client {
             enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
             /**
              * Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use `snake_casing`* - name
-             * matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal
-             * infrastructure and tooling can handle any ascii character) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated,
-             * but will still be honored for backward compatibility.
+             * matching is case-sensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure
+             * and tooling can handle any ascii character) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still
+             * be honored for backward compatibility.
              */
             name?: string;
             /** Describing the nested structure, or composition of an entity. */
@@ -2087,6 +2097,14 @@ declare namespace gapi.client {
             /** Y coordinate (starts from the top of the image). */
             y?: number;
         }
+        interface GoogleCloudDocumentaiV1beta3OcrConfig {
+            /** Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs. */
+            enableNativePdfParsing?: boolean;
+        }
+        interface GoogleCloudDocumentaiV1beta3ProcessOptions {
+            /** Only applicable to "Document OCR Processor". Returns error if set on other processor types. */
+            ocrConfig?: GoogleCloudDocumentaiV1beta3OcrConfig;
+        }
         interface GoogleCloudDocumentaiV1beta3Processor {
             /** The time the processor was created. */
             createTime?: string;
@@ -2116,6 +2134,8 @@ declare namespace gapi.client {
             launchStage?: string;
             /** The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}` */
             name?: string;
+            /** A set of Cloud Storage URIs of sample documents for this processor. */
+            sampleDocumentUris?: string[];
             /** The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. */
             type?: string;
         }
@@ -2159,6 +2179,8 @@ declare namespace gapi.client {
             fieldMask?: string;
             /** An inline document proto. */
             inlineDocument?: GoogleCloudDocumentaiV1beta3Document;
+            /** Inference-time options for the process API */
+            processOptions?: GoogleCloudDocumentaiV1beta3ProcessOptions;
             /** A raw document content (bytes). */
             rawDocument?: GoogleCloudDocumentaiV1beta3RawDocument;
             /** Whether Human Review feature should be skipped for this request. Default to false. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.documentai-v1beta3",
-  "version": "0.0.20221114",
+  "version": "0.0.20221201",
   "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: 20221114
+// Revision: 20221201
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -77,6 +77,10 @@ gapi.load('client', async () => {
                 gcsOutputConfig: {
                     fieldMask: "Test string",
                     gcsUri: "Test string",
+                    shardingConfig: {
+                        pagesOverlap: 42,
+                        pagesPerShard: 42,
+                    },
                 },
             },
             inputConfigs: [
@@ -101,6 +105,11 @@ gapi.load('client', async () => {
             outputConfig: {
                 gcsDestination: "Test string",
             },
+            processOptions: {
+                ocrConfig: {
+                    enableNativePdfParsing: true,
+                },
+            },
             skipHumanReview: true,
         });
         /** Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation. */
@@ -1779,6 +1788,11 @@ gapi.load('client', async () => {
                 ],
                 uri: "Test string",
             },
+            processOptions: {
+                ocrConfig: {
+                    enableNativePdfParsing: true,
+                },
+            },
             rawDocument: {
                 content: "Test string",
                 mimeType: "Test string",
@@ -3471,6 +3485,10 @@ gapi.load('client', async () => {
                 gcsOutputConfig: {
                     fieldMask: "Test string",
                     gcsUri: "Test string",
+                    shardingConfig: {
+                        pagesOverlap: 42,
+                        pagesPerShard: 42,
+                    },
                 },
             },
             inputConfigs: [
@@ -3495,6 +3513,11 @@ gapi.load('client', async () => {
             outputConfig: {
                 gcsDestination: "Test string",
             },
+            processOptions: {
+                ocrConfig: {
+                    enableNativePdfParsing: true,
+                },
+            },
             skipHumanReview: true,
         });
         /** Deletes the processor version, all artifacts under the processor version will be deleted. */
@@ -5173,6 +5196,11 @@ gapi.load('client', async () => {
                 ],
                 uri: "Test string",
             },
+            processOptions: {
+                ocrConfig: {
+                    enableNativePdfParsing: true,
+                },
+            },
             rawDocument: {
                 content: "Test string",
                 mimeType: "Test string",