@maxim_mazurok/gapi.client.documentai-v1 0.0.20230605 → 0.0.20230619

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +28 -20
  2. package/package.json +1 -1
  3. package/tests.ts +4 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://documentai.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230605
12
+ // Revision: 20230619
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -148,7 +148,7 @@ declare namespace gapi.client {
148
148
  interface GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse {
149
149
  }
150
150
  interface GoogleCloudDocumentaiUiv1beta3DocumentId {
151
- /** A document id within user managed Cloud Storage. */
151
+ /** A document id within user-managed Cloud Storage. */
152
152
  gcsManagedDocId?:
153
153
  GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId;
154
154
  /** Points to a specific revision of the document if set. */
@@ -162,7 +162,7 @@ declare namespace gapi.client {
162
162
  /** Id of the document (indexed) managed by Content Warehouse. */
163
163
  cwDocId?:
164
164
  string;
165
- /** Required. The Cloud Storage uri where the actual document is stored. */
165
+ /** Required. The Cloud Storage URI where the actual document is stored. */
166
166
  gcsUri?:
167
167
  string;
168
168
  }
@@ -466,7 +466,7 @@ declare namespace gapi.client {
466
466
  /** The input documents for the BatchProcessDocuments method. */
467
467
  inputDocuments?:
468
468
  GoogleCloudDocumentaiV1BatchDocumentsInputConfig;
469
- /** Whether Human Review feature should be skipped for this request. Default to `false`. */
469
+ /** Whether human review should be skipped for this request. Default to `false`. */
470
470
  skipHumanReview?:
471
471
  boolean;
472
472
  }
@@ -651,7 +651,7 @@ declare namespace gapi.client {
651
651
  /** 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. */
652
652
  image?:
653
653
  GoogleCloudDocumentaiV1beta1DocumentPageImage;
654
- /** Image Quality Scores. */
654
+ /** Image quality scores. */
655
655
  imageQualityScores?:
656
656
  GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores;
657
657
  /** Layout for the page. */
@@ -800,7 +800,7 @@ declare namespace gapi.client {
800
800
  number;
801
801
  }
802
802
  interface GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect {
803
- /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence of that the defect exists. */
803
+ /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
804
804
  confidence?:
805
805
  number;
806
806
  /**
@@ -1090,7 +1090,7 @@ declare namespace gapi.client {
1090
1090
  /** Font size for the text. */
1091
1091
  size?:
1092
1092
  number;
1093
- /** Unit for the font size. Follows CSS naming (`in`, `px`, `pt`, etc.). */
1093
+ /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
1094
1094
  unit?:
1095
1095
  string;
1096
1096
  }
@@ -1386,7 +1386,7 @@ declare namespace gapi.client {
1386
1386
  /** 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. */
1387
1387
  image?:
1388
1388
  GoogleCloudDocumentaiV1beta2DocumentPageImage;
1389
- /** Image Quality Scores. */
1389
+ /** Image quality scores. */
1390
1390
  imageQualityScores?:
1391
1391
  GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores;
1392
1392
  /** Layout for the page. */
@@ -1535,7 +1535,7 @@ declare namespace gapi.client {
1535
1535
  number;
1536
1536
  }
1537
1537
  interface GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect {
1538
- /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence of that the defect exists. */
1538
+ /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
1539
1539
  confidence?:
1540
1540
  number;
1541
1541
  /**
@@ -1825,7 +1825,7 @@ declare namespace gapi.client {
1825
1825
  /** Font size for the text. */
1826
1826
  size?:
1827
1827
  number;
1828
- /** Unit for the font size. Follows CSS naming (`in`, `px`, `pt`, etc.). */
1828
+ /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
1829
1829
  unit?:
1830
1830
  string;
1831
1831
  }
@@ -2367,7 +2367,7 @@ declare namespace gapi.client {
2367
2367
  /** 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. */
2368
2368
  image?:
2369
2369
  GoogleCloudDocumentaiV1DocumentPageImage;
2370
- /** Image Quality Scores. */
2370
+ /** Image quality scores. */
2371
2371
  imageQualityScores?:
2372
2372
  GoogleCloudDocumentaiV1DocumentPageImageQualityScores;
2373
2373
  /** Layout for the page. */
@@ -2516,7 +2516,7 @@ declare namespace gapi.client {
2516
2516
  number;
2517
2517
  }
2518
2518
  interface GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect {
2519
- /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence of that the defect exists. */
2519
+ /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
2520
2520
  confidence?:
2521
2521
  number;
2522
2522
  /**
@@ -2793,10 +2793,10 @@ declare namespace gapi.client {
2793
2793
  enumValues?:
2794
2794
  GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues;
2795
2795
  /**
2796
- * 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
2797
- * case-sensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling
2798
- * 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
2799
- * for backward compatibility.
2796
+ * 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
2797
+ * case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and
2798
+ * 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
2799
+ * honored for backward compatibility.
2800
2800
  */
2801
2801
  name?:
2802
2802
  string;
@@ -2878,7 +2878,7 @@ declare namespace gapi.client {
2878
2878
  /** Font size for the text. */
2879
2879
  size?:
2880
2880
  number;
2881
- /** Unit for the font size. Follows CSS naming (`in`, `px`, `pt`, etc.). */
2881
+ /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
2882
2882
  unit?:
2883
2883
  string;
2884
2884
  }
@@ -3142,7 +3142,7 @@ declare namespace gapi.client {
3142
3142
  /** The display name of the processor. */
3143
3143
  displayName?:
3144
3144
  string;
3145
- /** The [KMS key](https://cloud.google.com/security-key-management) used for encryption/decryption in CMEK scenarios. */
3145
+ /** The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */
3146
3146
  kmsKeyName?:
3147
3147
  string;
3148
3148
  /** Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` */
@@ -3182,7 +3182,7 @@ declare namespace gapi.client {
3182
3182
  string;
3183
3183
  }
3184
3184
  interface GoogleCloudDocumentaiV1ProcessorTypeLocationInfo {
3185
- /** The location id, refer to [regional and multi-regional support](/document-ai/docs/regions) for supported locations. */
3185
+ /** The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions). */
3186
3186
  locationId?:
3187
3187
  string;
3188
3188
  }
@@ -3239,7 +3239,7 @@ declare namespace gapi.client {
3239
3239
  /** A raw document content (bytes). */
3240
3240
  rawDocument?:
3241
3241
  GoogleCloudDocumentaiV1RawDocument;
3242
- /** Whether Human Review feature should be skipped for this request. Default to false. */
3242
+ /** Whether human review should be skipped for this request. Default to `false`. */
3243
3243
  skipHumanReview?:
3244
3244
  boolean;
3245
3245
  }
@@ -3337,6 +3337,9 @@ declare namespace gapi.client {
3337
3337
  */
3338
3338
  baseProcessorVersion?:
3339
3339
  string;
3340
+ /** Options to control Custom Document Extraction (CDE) Processor. */
3341
+ customDocumentExtractionOptions?:
3342
+ GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions;
3340
3343
  /** Optional. The schema the processor version will be trained with. */
3341
3344
  documentSchema?:
3342
3345
  GoogleCloudDocumentaiV1DocumentSchema;
@@ -3347,6 +3350,11 @@ declare namespace gapi.client {
3347
3350
  processorVersion?:
3348
3351
  GoogleCloudDocumentaiV1ProcessorVersion;
3349
3352
  }
3353
+ interface GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions {
3354
+ /** Training method to use for CDE training. */
3355
+ trainingMethod?:
3356
+ string;
3357
+ }
3350
3358
  interface GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData {
3351
3359
  /** The documents used for testing the trained version. */
3352
3360
  testDocuments?:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.documentai-v1",
3
- "version": "0.0.20230605",
3
+ "version": "0.0.20230619",
4
4
  "description": "TypeScript typings for Cloud Document AI API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230605
6
+ // Revision: 20230619
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -2806,6 +2806,9 @@ gapi.load('client', async () => {
2806
2806
  parent: "Test string",
2807
2807
  }, {
2808
2808
  baseProcessorVersion: "Test string",
2809
+ customDocumentExtractionOptions: {
2810
+ trainingMethod: "Test string",
2811
+ },
2809
2812
  documentSchema: {
2810
2813
  description: "Test string",
2811
2814
  displayName: "Test string",