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

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: 20230526
+// Revision: 20230609
 
 /// <reference types="gapi.client" />
 
@@ -148,7 +148,7 @@ declare namespace gapi.client {
         interface GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse {
         }
         interface GoogleCloudDocumentaiUiv1beta3DocumentId {
-            /** A document id within user managed Cloud Storage. */
+            /** A document id within user-managed Cloud Storage. */
             gcsManagedDocId?:
                 GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId;
             /** Points to a specific revision of the document if set. */
@@ -162,7 +162,7 @@ declare namespace gapi.client {
             /** Id of the document (indexed) managed by Content Warehouse. */
             cwDocId?:
                 string;
-            /** Required. The Cloud Storage uri where the actual document is stored. */
+            /** Required. The Cloud Storage URI where the actual document is stored. */
             gcsUri?:
                 string;
         }
@@ -483,7 +483,7 @@ declare namespace gapi.client {
             /** Any error that occurred while processing this document. */
             error?:
                 GoogleRpcStatus;
-            /** An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml. */
+            /** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
             mimeType?:
                 string;
             /** Visual page layout for the Document. */
@@ -613,7 +613,7 @@ declare namespace gapi.client {
             /** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
             image?:
                 GoogleCloudDocumentaiV1beta1DocumentPageImage;
-            /** Image Quality Scores. */
+            /** Image quality scores. */
             imageQualityScores?:
                 GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores;
             /** Layout for the page. */
@@ -695,7 +695,7 @@ declare namespace gapi.client {
             /** Confidence of detected language. Range `[0, 1]`. */
             confidence?:
                 number;
-            /** The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
+            /** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
             languageCode?:
                 string;
         }
@@ -746,7 +746,7 @@ declare namespace gapi.client {
             /** Height of the image in pixels. */
             height?:
                 number;
-            /** Encoding mime type for the image. */
+            /** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
             mimeType?:
                 string;
             /** Width of the image in pixels. */
@@ -757,12 +757,12 @@ declare namespace gapi.client {
             /** A list of detected defects. */
             detectedDefects?:
                 GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect[];
-            /** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
+            /** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
             qualityScore?:
                 number;
         }
         interface GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect {
-            /** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
+            /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
             confidence?:
                 number;
             /**
@@ -1035,16 +1035,16 @@ declare namespace gapi.client {
             /** Font size. */
             fontSize?:
                 GoogleCloudDocumentaiV1beta1DocumentStyleFontSize;
-            /** Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp */
+            /** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
             fontWeight?:
                 string;
             /** Text anchor indexing into the Document.text. */
             textAnchor?:
                 GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
-            /** Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp */
+            /** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
             textDecoration?:
                 string;
-            /** Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp */
+            /** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
             textStyle?:
                 string;
         }
@@ -1052,7 +1052,7 @@ declare namespace gapi.client {
             /** Font size for the text. */
             size?:
                 number;
-            /** Unit for the font size. Follows CSS naming (in, px, pt, etc.). */
+            /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
             unit?:
                 string;
         }
@@ -1207,7 +1207,7 @@ declare namespace gapi.client {
             /** Labels for this document. */
             labels?:
                 GoogleCloudDocumentaiV1beta2DocumentLabel[];
-            /** An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml. */
+            /** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
             mimeType?:
                 string;
             /** Visual page layout for the Document. */
@@ -1348,7 +1348,7 @@ declare namespace gapi.client {
             /** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
             image?:
                 GoogleCloudDocumentaiV1beta2DocumentPageImage;
-            /** Image Quality Scores. */
+            /** Image quality scores. */
             imageQualityScores?:
                 GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores;
             /** Layout for the page. */
@@ -1430,7 +1430,7 @@ declare namespace gapi.client {
             /** Confidence of detected language. Range `[0, 1]`. */
             confidence?:
                 number;
-            /** The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
+            /** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
             languageCode?:
                 string;
         }
@@ -1481,7 +1481,7 @@ declare namespace gapi.client {
             /** Height of the image in pixels. */
             height?:
                 number;
-            /** Encoding mime type for the image. */
+            /** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
             mimeType?:
                 string;
             /** Width of the image in pixels. */
@@ -1492,12 +1492,12 @@ declare namespace gapi.client {
             /** A list of detected defects. */
             detectedDefects?:
                 GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect[];
-            /** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
+            /** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
             qualityScore?:
                 number;
         }
         interface GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect {
-            /** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
+            /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
             confidence?:
                 number;
             /**
@@ -1770,16 +1770,16 @@ declare namespace gapi.client {
             /** Font size. */
             fontSize?:
                 GoogleCloudDocumentaiV1beta2DocumentStyleFontSize;
-            /** Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp */
+            /** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
             fontWeight?:
                 string;
             /** Text anchor indexing into the Document.text. */
             textAnchor?:
                 GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
-            /** Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp */
+            /** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
             textDecoration?:
                 string;
-            /** Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp */
+            /** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
             textStyle?:
                 string;
         }
@@ -1787,7 +1787,7 @@ declare namespace gapi.client {
             /** Font size for the text. */
             size?:
                 number;
-            /** Unit for the font size. Follows CSS naming (in, px, pt, etc.). */
+            /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
             unit?:
                 string;
         }
@@ -1977,7 +1977,7 @@ declare namespace gapi.client {
             /** Inference-time options for the process API */
             processOptions?:
                 GoogleCloudDocumentaiV1beta3ProcessOptions;
-            /** Whether Human Review feature should be skipped for this request. Default to false. */
+            /** Whether human review should be skipped for this request. Default to `false`. */
             skipHumanReview?:
                 boolean;
         }
@@ -1986,8 +1986,8 @@ declare namespace gapi.client {
             gcsSource?:
                 string;
             /**
-             * Media type (MIME type) of the input. If the input is a raw document, refer to [supported file types](https://cloud.google.com/document-ai/docs/file-types) for the list of media
-             * types. If the input is a Document, the type should be `application/json`.
+             * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of the input. If the input is a raw document, refer to [supported file
+             * types](https://cloud.google.com/document-ai/docs/file-types) for the list of media types. If the input is a Document, the type should be `application/json`.
              */
             mimeType?:
                 string;
@@ -2026,35 +2026,35 @@ declare namespace gapi.client {
                 string;
         }
         interface GoogleCloudDocumentaiV1beta3Dataset {
-            /** Optional. Document Warehouse-based dataset config. */
+            /** Optional. Document AI Warehouse-based dataset configuration. */
             documentWarehouseConfig?:
                 GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig;
-            /** Optional. User managed GCS dataset config. Use this config if the dataset documents are stored under a user managed GCS location. */
+            /** 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 reliablity, but lack advanced features like CMEK and content based search. */
+            /** 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. Will be ignored when updating dataset. */
+            /** Required. State of the dataset. 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). */
+            /** 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 Warehouse associated with the dataset. */
+            /** Output only. The collection in Document AI Warehouse associated with the dataset. */
             collection?:
                 string;
-            /** Output only. The schema in Document Warehouse associated with the dataset. */
+            /** 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. */
+            /** Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored. */
             gcsPrefix?:
                 GoogleCloudDocumentaiV1beta3GcsPrefix;
         }
@@ -2120,7 +2120,7 @@ declare namespace gapi.client {
             /** Any error that occurred while processing this document. */
             error?:
                 GoogleRpcStatus;
-            /** An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml. */
+            /** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
             mimeType?:
                 string;
             /** Visual page layout for the Document. */
@@ -2277,7 +2277,7 @@ declare namespace gapi.client {
             /** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
             image?:
                 GoogleCloudDocumentaiV1beta3DocumentPageImage;
-            /** Image Quality Scores. */
+            /** Image quality scores. */
             imageQualityScores?:
                 GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores;
             /** Layout for the page. */
@@ -2359,7 +2359,7 @@ declare namespace gapi.client {
             /** Confidence of detected language. Range `[0, 1]`. */
             confidence?:
                 number;
-            /** The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
+            /** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
             languageCode?:
                 string;
         }
@@ -2410,7 +2410,7 @@ declare namespace gapi.client {
             /** Height of the image in pixels. */
             height?:
                 number;
-            /** Encoding mime type for the image. */
+            /** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
             mimeType?:
                 string;
             /** Width of the image in pixels. */
@@ -2421,12 +2421,12 @@ declare namespace gapi.client {
             /** A list of detected defects. */
             detectedDefects?:
                 GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect[];
-            /** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
+            /** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
             qualityScore?:
                 number;
         }
         interface GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect {
-            /** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
+            /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
             confidence?:
                 number;
             /**
@@ -2706,10 +2706,10 @@ 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-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 of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name 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;
@@ -2740,7 +2740,7 @@ declare namespace gapi.client {
             /** If true, on a given page, there can be multiple `document` annotations covering it. */
             documentAllowMultipleLabels?:
                 boolean;
-            /** If true, a `document` entity type can be applied to subdocument ( splitting). Otherwise, it can only be applied to the entire document (classification). */
+            /** If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */
             documentSplitter?:
                 boolean;
             /** If set, all the nested entities must be prefixed with the parents. */
@@ -2777,16 +2777,16 @@ declare namespace gapi.client {
             /** Font size. */
             fontSize?:
                 GoogleCloudDocumentaiV1beta3DocumentStyleFontSize;
-            /** Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp */
+            /** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
             fontWeight?:
                 string;
             /** Text anchor indexing into the Document.text. */
             textAnchor?:
                 GoogleCloudDocumentaiV1beta3DocumentTextAnchor;
-            /** Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp */
+            /** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
             textDecoration?:
                 string;
-            /** Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp */
+            /** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
             textStyle?:
                 string;
         }
@@ -2794,7 +2794,7 @@ declare namespace gapi.client {
             /** Font size for the text. */
             size?:
                 number;
-            /** Unit for the font size. Follows CSS naming (in, px, pt, etc.). */
+            /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
             unit?:
                 string;
         }
@@ -2840,7 +2840,7 @@ declare namespace gapi.client {
         interface GoogleCloudDocumentaiV1beta3EnableProcessorResponse {
         }
         interface GoogleCloudDocumentaiV1beta3EntityTypeMetadata {
-            /** Whether the entity type should be considered as "inactive". */
+            /** Whether the entity type should be considered inactive. */
             inactive?:
                 boolean;
         }
@@ -3104,7 +3104,7 @@ declare namespace gapi.client {
                 string[];
         }
         interface GoogleCloudDocumentaiV1beta3ProcessOptions {
-            /** Only applicable to "Document OCR Processor". Returns error if set on other processor types. */
+            /** Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types. */
             ocrConfig?:
                 GoogleCloudDocumentaiV1beta3OcrConfig;
         }
@@ -3118,7 +3118,7 @@ declare namespace gapi.client {
             /** The display name of the processor. */
             displayName?:
                 string;
-            /** The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management. */
+            /** The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */
             kmsKeyName?:
                 string;
             /** Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` */
@@ -3158,7 +3158,7 @@ declare namespace gapi.client {
                 string;
         }
         interface GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo {
-            /** The location id, currently must be one of [us, eu]. */
+            /** The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions). */
             locationId?:
                 string;
         }
@@ -3175,7 +3175,7 @@ declare namespace gapi.client {
             /** The schema of the processor version. Describes the output. */
             documentSchema?:
                 GoogleCloudDocumentaiV1beta3DocumentSchema;
-            /** Denotes that this ProcessorVersion is managed by google. */
+            /** Denotes that this `ProcessorVersion` is managed by Google. */
             googleManaged?:
                 boolean;
             /** The KMS key name used for encryption. */
@@ -3221,7 +3221,7 @@ declare namespace gapi.client {
             /** A raw document content (bytes). */
             rawDocument?:
                 GoogleCloudDocumentaiV1beta3RawDocument;
-            /** Whether Human Review feature should be skipped for this request. Default to false. */
+            /** Whether human review should be skipped for this request. Default to `false`. */
             skipHumanReview?:
                 boolean;
         }
@@ -3884,7 +3884,7 @@ declare namespace gapi.client {
             }): Request<GoogleLongrunningListOperationsResponse>;
         }
         interface DatasetResource {
-            /** Gets the DatasetSchema of a Dataset. */
+            /** Gets the `DatasetSchema` of a `Dataset`. */
             getDatasetSchema(request?: {
                 /** V1 error format. */
                 "$.xgafv"?:
@@ -3926,7 +3926,7 @@ declare namespace gapi.client {
                 visibleFieldsOnly?:
                     boolean;
             }): Request<GoogleCloudDocumentaiV1beta3DatasetSchema>;
-            /** Updates a DatasetSchema. */
+            /** Updates a `DatasetSchema`. */
             updateDatasetSchema(request: {
                 /** V1 error format. */
                 "$.xgafv"?:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.documentai-v1beta3",
-  "version": "0.0.20230526",
+  "version": "0.0.20230609",
   "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: 20230526
+// Revision: 20230609
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -1897,12 +1897,12 @@ gapi.load('client', async () => {
             unmanagedDatasetConfig: {
             },
         });
-        /** Gets the DatasetSchema of a Dataset. */
+        /** Gets the `DatasetSchema` of a `Dataset`. */
         await gapi.client.documentai.projects.locations.processors.dataset.getDatasetSchema({
             name: "Test string",
             visibleFieldsOnly: true,
         });
-        /** Updates a DatasetSchema. */
+        /** Updates a `DatasetSchema`. */
         await gapi.client.documentai.projects.locations.processors.dataset.updateDatasetSchema({
             name: "Test string",
             updateMask: "Test string",