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

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 +137 -85
  2. package/package.json +1 -1
  3. package/tests.ts +29 -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=v1beta3
12
- // Revision: 20221108
12
+ // Revision: 20221201
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -319,17 +319,17 @@ declare namespace gapi.client {
319
319
  }
320
320
  interface GoogleCloudDocumentaiV1beta1Barcode {
321
321
  /**
322
- * Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF:
323
- * ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1
324
- * DataBar code type.
322
+ * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D
323
+ * Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417
324
+ * type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.
325
325
  */
326
326
  format?: string;
327
- /** Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. */
327
+ /** Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. */
328
328
  rawValue?: string;
329
329
  /**
330
- * Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier.
331
- * PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event.
332
- * DRIVER_LICENSE: Driver's license.
330
+ * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN
331
+ * identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization.
332
+ * - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.
333
333
  */
334
334
  valueFormat?: string;
335
335
  }
@@ -366,11 +366,11 @@ declare namespace gapi.client {
366
366
  /** Optional. UTF-8 encoded text in reading order from the document. */
367
367
  text?: string;
368
368
  /**
369
- * Placeholder. A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap
369
+ * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap
370
370
  * with each other.
371
371
  */
372
372
  textChanges?: GoogleCloudDocumentaiV1beta1DocumentTextChange[];
373
- /** Placeholder. Styles for the Document.text. */
373
+ /** Styles for the Document.text. */
374
374
  textStyles?: GoogleCloudDocumentaiV1beta1DocumentStyle[];
375
375
  /**
376
376
  * 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
@@ -379,7 +379,7 @@ declare namespace gapi.client {
379
379
  uri?: string;
380
380
  }
381
381
  interface GoogleCloudDocumentaiV1beta1DocumentEntity {
382
- /** Optional. Confidence of detected Schema entity. Range [0, 1]. */
382
+ /** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
383
383
  confidence?: number;
384
384
  /** Optional. Canonical id. This will be a unique value in the entity list for this document. */
385
385
  id?: string;
@@ -422,9 +422,9 @@ declare namespace gapi.client {
422
422
  moneyValue?: GoogleTypeMoney;
423
423
  /**
424
424
  * 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
425
- * `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. -
426
- * 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
427
- * text format.
425
+ * `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
426
+ * 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
427
+ * ISO 8601 text format.
428
428
  */
429
429
  text?: string;
430
430
  }
@@ -479,14 +479,14 @@ declare namespace gapi.client {
479
479
  interface GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef {
480
480
  /** Optional. Identifies the bounding polygon of a layout element on the page. */
481
481
  boundingPoly?: GoogleCloudDocumentaiV1beta1BoundingPoly;
482
- /** Optional. Confidence of detected page element, if applicable. Range [0, 1]. */
482
+ /** Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. */
483
483
  confidence?: number;
484
484
  /** Optional. Deprecated. Use PageRef.bounding_poly instead. */
485
485
  layoutId?: string;
486
486
  /** Optional. The type of the layout element that is being referenced if any. */
487
487
  layoutType?: string;
488
488
  /**
489
- * 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
489
+ * 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
490
490
  * https://developers.google.com/protocol-buffers/docs/proto3#json.
491
491
  */
492
492
  page?: string;
@@ -506,9 +506,9 @@ declare namespace gapi.client {
506
506
  layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
507
507
  }
508
508
  interface GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage {
509
- /** Confidence of detected language. Range [0, 1]. */
509
+ /** Confidence of detected language. Range `[0, 1]`. */
510
510
  confidence?: number;
511
- /** 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. */
511
+ /** 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. */
512
512
  languageCode?: string;
513
513
  }
514
514
  interface GoogleCloudDocumentaiV1beta1DocumentPageDimension {
@@ -535,8 +535,8 @@ declare namespace gapi.client {
535
535
  /** A list of detected languages for value together with confidence. */
536
536
  valueDetectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
537
537
  /**
538
- * 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" -
539
- * "filled_checkbox"
538
+ * 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` -
539
+ * `filled_checkbox`
540
540
  */
541
541
  valueType?: string;
542
542
  }
@@ -553,15 +553,15 @@ declare namespace gapi.client {
553
553
  interface GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores {
554
554
  /** A list of detected defects. */
555
555
  detectedDefects?: GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect[];
556
- /** The overall quality score. Range [0, 1] where 1 is perfect quality. */
556
+ /** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
557
557
  qualityScore?: number;
558
558
  }
559
559
  interface GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect {
560
- /** Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists. */
560
+ /** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
561
561
  confidence?: number;
562
562
  /**
563
- * Name of the defect type. Supported values are "quality/defect_blurry", "quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/defect_text_too_small",
564
- * "quality/defect_document_cutoff", "quality/defect_text_cutoff", "quality/defect_glare"
563
+ * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small`
564
+ * - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
565
565
  */
566
566
  type?: string;
567
567
  }
@@ -570,7 +570,7 @@ declare namespace gapi.client {
570
570
  boundingPoly?: GoogleCloudDocumentaiV1beta1BoundingPoly;
571
571
  /**
572
572
  * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context.
573
- * Range [0, 1].
573
+ * Range `[0, 1]`.
574
574
  */
575
575
  confidence?: number;
576
576
  /** Detected orientation for the Layout. */
@@ -717,7 +717,7 @@ declare namespace gapi.client {
717
717
  backgroundColor?: GoogleTypeColor;
718
718
  /** Text color. */
719
719
  color?: GoogleTypeColor;
720
- /** Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp */
720
+ /** Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp */
721
721
  fontFamily?: string;
722
722
  /** Font size. */
723
723
  fontSize?: GoogleCloudDocumentaiV1beta1DocumentStyleFontSize;
@@ -815,17 +815,17 @@ declare namespace gapi.client {
815
815
  }
816
816
  interface GoogleCloudDocumentaiV1beta2Barcode {
817
817
  /**
818
- * Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF:
819
- * ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1
820
- * DataBar code type.
818
+ * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D
819
+ * Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417
820
+ * type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.
821
821
  */
822
822
  format?: string;
823
- /** Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. */
823
+ /** Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. */
824
824
  rawValue?: string;
825
825
  /**
826
- * Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier.
827
- * PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event.
828
- * DRIVER_LICENSE: Driver's license.
826
+ * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN
827
+ * identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization.
828
+ * - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.
829
829
  */
830
830
  valueFormat?: string;
831
831
  }
@@ -864,11 +864,11 @@ declare namespace gapi.client {
864
864
  /** Optional. UTF-8 encoded text in reading order from the document. */
865
865
  text?: string;
866
866
  /**
867
- * Placeholder. A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap
867
+ * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap
868
868
  * with each other.
869
869
  */
870
870
  textChanges?: GoogleCloudDocumentaiV1beta2DocumentTextChange[];
871
- /** Placeholder. Styles for the Document.text. */
871
+ /** Styles for the Document.text. */
872
872
  textStyles?: GoogleCloudDocumentaiV1beta2DocumentStyle[];
873
873
  /**
874
874
  * 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
@@ -877,7 +877,7 @@ declare namespace gapi.client {
877
877
  uri?: string;
878
878
  }
879
879
  interface GoogleCloudDocumentaiV1beta2DocumentEntity {
880
- /** Optional. Confidence of detected Schema entity. Range [0, 1]. */
880
+ /** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
881
881
  confidence?: number;
882
882
  /** Optional. Canonical id. This will be a unique value in the entity list for this document. */
883
883
  id?: string;
@@ -920,9 +920,9 @@ declare namespace gapi.client {
920
920
  moneyValue?: GoogleTypeMoney;
921
921
  /**
922
922
  * 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
923
- * `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. -
924
- * 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
925
- * text format.
923
+ * `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
924
+ * 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
925
+ * ISO 8601 text format.
926
926
  */
927
927
  text?: string;
928
928
  }
@@ -985,14 +985,14 @@ declare namespace gapi.client {
985
985
  interface GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef {
986
986
  /** Optional. Identifies the bounding polygon of a layout element on the page. */
987
987
  boundingPoly?: GoogleCloudDocumentaiV1beta2BoundingPoly;
988
- /** Optional. Confidence of detected page element, if applicable. Range [0, 1]. */
988
+ /** Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. */
989
989
  confidence?: number;
990
990
  /** Optional. Deprecated. Use PageRef.bounding_poly instead. */
991
991
  layoutId?: string;
992
992
  /** Optional. The type of the layout element that is being referenced if any. */
993
993
  layoutType?: string;
994
994
  /**
995
- * 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
995
+ * 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
996
996
  * https://developers.google.com/protocol-buffers/docs/proto3#json.
997
997
  */
998
998
  page?: string;
@@ -1012,9 +1012,9 @@ declare namespace gapi.client {
1012
1012
  layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1013
1013
  }
1014
1014
  interface GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage {
1015
- /** Confidence of detected language. Range [0, 1]. */
1015
+ /** Confidence of detected language. Range `[0, 1]`. */
1016
1016
  confidence?: number;
1017
- /** 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. */
1017
+ /** 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. */
1018
1018
  languageCode?: string;
1019
1019
  }
1020
1020
  interface GoogleCloudDocumentaiV1beta2DocumentPageDimension {
@@ -1041,8 +1041,8 @@ declare namespace gapi.client {
1041
1041
  /** A list of detected languages for value together with confidence. */
1042
1042
  valueDetectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1043
1043
  /**
1044
- * 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" -
1045
- * "filled_checkbox"
1044
+ * 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` -
1045
+ * `filled_checkbox`
1046
1046
  */
1047
1047
  valueType?: string;
1048
1048
  }
@@ -1059,15 +1059,15 @@ declare namespace gapi.client {
1059
1059
  interface GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores {
1060
1060
  /** A list of detected defects. */
1061
1061
  detectedDefects?: GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect[];
1062
- /** The overall quality score. Range [0, 1] where 1 is perfect quality. */
1062
+ /** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
1063
1063
  qualityScore?: number;
1064
1064
  }
1065
1065
  interface GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect {
1066
- /** Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists. */
1066
+ /** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
1067
1067
  confidence?: number;
1068
1068
  /**
1069
- * Name of the defect type. Supported values are "quality/defect_blurry", "quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/defect_text_too_small",
1070
- * "quality/defect_document_cutoff", "quality/defect_text_cutoff", "quality/defect_glare"
1069
+ * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small`
1070
+ * - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
1071
1071
  */
1072
1072
  type?: string;
1073
1073
  }
@@ -1076,7 +1076,7 @@ declare namespace gapi.client {
1076
1076
  boundingPoly?: GoogleCloudDocumentaiV1beta2BoundingPoly;
1077
1077
  /**
1078
1078
  * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context.
1079
- * Range [0, 1].
1079
+ * Range `[0, 1]`.
1080
1080
  */
1081
1081
  confidence?: number;
1082
1082
  /** Detected orientation for the Layout. */
@@ -1223,7 +1223,7 @@ declare namespace gapi.client {
1223
1223
  backgroundColor?: GoogleTypeColor;
1224
1224
  /** Text color. */
1225
1225
  color?: GoogleTypeColor;
1226
- /** Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp */
1226
+ /** Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp */
1227
1227
  fontFamily?: string;
1228
1228
  /** Font size. */
1229
1229
  fontSize?: GoogleCloudDocumentaiV1beta2DocumentStyleFontSize;
@@ -1326,24 +1326,24 @@ declare namespace gapi.client {
1326
1326
  }
1327
1327
  interface GoogleCloudDocumentaiV1beta3Barcode {
1328
1328
  /**
1329
- * Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF:
1330
- * ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1
1331
- * DataBar code type.
1329
+ * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D
1330
+ * Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417
1331
+ * type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.
1332
1332
  */
1333
1333
  format?: string;
1334
- /** Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. */
1334
+ /** Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. */
1335
1335
  rawValue?: string;
1336
1336
  /**
1337
- * Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier.
1338
- * PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event.
1339
- * DRIVER_LICENSE: Driver's license.
1337
+ * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN
1338
+ * identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization.
1339
+ * - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.
1340
1340
  */
1341
1341
  valueFormat?: string;
1342
1342
  }
1343
1343
  interface GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig {
1344
1344
  /** The set of documents individually specified on Cloud Storage. */
1345
1345
  gcsDocuments?: GoogleCloudDocumentaiV1beta3GcsDocuments;
1346
- /** The set of documents that match the specified Cloud Storage [gcs_prefix]. */
1346
+ /** The set of documents that match the specified Cloud Storage `gcs_prefix`. */
1347
1347
  gcsPrefix?: GoogleCloudDocumentaiV1beta3GcsPrefix;
1348
1348
  }
1349
1349
  interface GoogleCloudDocumentaiV1beta3BatchProcessMetadata {
@@ -1385,6 +1385,8 @@ declare namespace gapi.client {
1385
1385
  inputDocuments?: GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
1386
1386
  /** The overall output config for batch process. */
1387
1387
  outputConfig?: GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig;
1388
+ /** Inference-time options for the process API */
1389
+ processOptions?: GoogleCloudDocumentaiV1beta3ProcessOptions;
1388
1390
  /** Whether Human Review feature should be skipped for this request. Default to false. */
1389
1391
  skipHumanReview?: boolean;
1390
1392
  }
@@ -1473,11 +1475,11 @@ declare namespace gapi.client {
1473
1475
  /** Optional. UTF-8 encoded text in reading order from the document. */
1474
1476
  text?: string;
1475
1477
  /**
1476
- * Placeholder. A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap
1478
+ * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap
1477
1479
  * with each other.
1478
1480
  */
1479
1481
  textChanges?: GoogleCloudDocumentaiV1beta3DocumentTextChange[];
1480
- /** Placeholder. Styles for the Document.text. */
1482
+ /** Styles for the Document.text. */
1481
1483
  textStyles?: GoogleCloudDocumentaiV1beta3DocumentStyle[];
1482
1484
  /**
1483
1485
  * 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
@@ -1486,7 +1488,7 @@ declare namespace gapi.client {
1486
1488
  uri?: string;
1487
1489
  }
1488
1490
  interface GoogleCloudDocumentaiV1beta3DocumentEntity {
1489
- /** Optional. Confidence of detected Schema entity. Range [0, 1]. */
1491
+ /** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
1490
1492
  confidence?: number;
1491
1493
  /** Optional. Canonical id. This will be a unique value in the entity list for this document. */
1492
1494
  id?: string;
@@ -1529,9 +1531,9 @@ declare namespace gapi.client {
1529
1531
  moneyValue?: GoogleTypeMoney;
1530
1532
  /**
1531
1533
  * 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
1532
- * `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. -
1533
- * 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
1534
- * text format.
1534
+ * `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
1535
+ * 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
1536
+ * ISO 8601 text format.
1535
1537
  */
1536
1538
  text?: string;
1537
1539
  }
@@ -1555,6 +1557,14 @@ declare namespace gapi.client {
1555
1557
  fieldMask?: string;
1556
1558
  /** The Cloud Storage uri (a directory) of the output. */
1557
1559
  gcsUri?: string;
1560
+ /** Specifies the sharding config for the output document. */
1561
+ shardingConfig?: GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig;
1562
+ }
1563
+ interface GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig {
1564
+ /** The number of overlapping pages between consecutive shards. */
1565
+ pagesOverlap?: number;
1566
+ /** The number of pages per shard. */
1567
+ pagesPerShard?: number;
1558
1568
  }
1559
1569
  interface GoogleCloudDocumentaiV1beta3DocumentPage {
1560
1570
  /** 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. */
@@ -1599,14 +1609,14 @@ declare namespace gapi.client {
1599
1609
  interface GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef {
1600
1610
  /** Optional. Identifies the bounding polygon of a layout element on the page. */
1601
1611
  boundingPoly?: GoogleCloudDocumentaiV1beta3BoundingPoly;
1602
- /** Optional. Confidence of detected page element, if applicable. Range [0, 1]. */
1612
+ /** Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. */
1603
1613
  confidence?: number;
1604
1614
  /** Optional. Deprecated. Use PageRef.bounding_poly instead. */
1605
1615
  layoutId?: string;
1606
1616
  /** Optional. The type of the layout element that is being referenced if any. */
1607
1617
  layoutType?: string;
1608
1618
  /**
1609
- * 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
1619
+ * 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
1610
1620
  * https://developers.google.com/protocol-buffers/docs/proto3#json.
1611
1621
  */
1612
1622
  page?: string;
@@ -1626,9 +1636,9 @@ declare namespace gapi.client {
1626
1636
  layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
1627
1637
  }
1628
1638
  interface GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage {
1629
- /** Confidence of detected language. Range [0, 1]. */
1639
+ /** Confidence of detected language. Range `[0, 1]`. */
1630
1640
  confidence?: number;
1631
- /** 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. */
1641
+ /** 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. */
1632
1642
  languageCode?: string;
1633
1643
  }
1634
1644
  interface GoogleCloudDocumentaiV1beta3DocumentPageDimension {
@@ -1655,8 +1665,8 @@ declare namespace gapi.client {
1655
1665
  /** A list of detected languages for value together with confidence. */
1656
1666
  valueDetectedLanguages?: GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[];
1657
1667
  /**
1658
- * 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" -
1659
- * "filled_checkbox"
1668
+ * 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` -
1669
+ * `filled_checkbox`
1660
1670
  */
1661
1671
  valueType?: string;
1662
1672
  }
@@ -1673,15 +1683,15 @@ declare namespace gapi.client {
1673
1683
  interface GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores {
1674
1684
  /** A list of detected defects. */
1675
1685
  detectedDefects?: GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect[];
1676
- /** The overall quality score. Range [0, 1] where 1 is perfect quality. */
1686
+ /** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
1677
1687
  qualityScore?: number;
1678
1688
  }
1679
1689
  interface GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect {
1680
- /** Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists. */
1690
+ /** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
1681
1691
  confidence?: number;
1682
1692
  /**
1683
- * Name of the defect type. Supported values are "quality/defect_blurry", "quality/defect_noisy", "quality/defect_dark", "quality/defect_faint", "quality/defect_text_too_small",
1684
- * "quality/defect_document_cutoff", "quality/defect_text_cutoff", "quality/defect_glare"
1693
+ * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small`
1694
+ * - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
1685
1695
  */
1686
1696
  type?: string;
1687
1697
  }
@@ -1690,7 +1700,7 @@ declare namespace gapi.client {
1690
1700
  boundingPoly?: GoogleCloudDocumentaiV1beta3BoundingPoly;
1691
1701
  /**
1692
1702
  * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context.
1693
- * Range [0, 1].
1703
+ * Range `[0, 1]`.
1694
1704
  */
1695
1705
  confidence?: number;
1696
1706
  /** Detected orientation for the Layout. */
@@ -1845,10 +1855,10 @@ declare namespace gapi.client {
1845
1855
  */
1846
1856
  enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
1847
1857
  /**
1848
- * 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
1849
- * is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and
1850
- * 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
1851
- * honored for backward compatibility.
1858
+ * 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
1859
+ * matching is case-sensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure
1860
+ * 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
1861
+ * be honored for backward compatibility.
1852
1862
  */
1853
1863
  name?: string;
1854
1864
  /** Describing the nested structure, or composition of an entity. */
@@ -1892,7 +1902,7 @@ declare namespace gapi.client {
1892
1902
  backgroundColor?: GoogleTypeColor;
1893
1903
  /** Text color. */
1894
1904
  color?: GoogleTypeColor;
1895
- /** Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp */
1905
+ /** Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp */
1896
1906
  fontFamily?: string;
1897
1907
  /** Font size. */
1898
1908
  fontSize?: GoogleCloudDocumentaiV1beta3DocumentStyleFontSize;
@@ -1944,10 +1954,18 @@ declare namespace gapi.client {
1944
1954
  // tslint:disable-next-line:no-empty-interface
1945
1955
  interface GoogleCloudDocumentaiV1beta3EnableProcessorResponse {
1946
1956
  }
1957
+ interface GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata {
1958
+ /** The basic metadata of the long running operation. */
1959
+ commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
1960
+ }
1947
1961
  interface GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest {
1948
1962
  /** Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input. */
1949
1963
  evaluationDocuments?: GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
1950
1964
  }
1965
+ interface GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse {
1966
+ /** The resource name of the created evaluation. */
1967
+ evaluation?: string;
1968
+ }
1951
1969
  interface GoogleCloudDocumentaiV1beta3Evaluation {
1952
1970
  /** Metrics for all the entities in aggregate. */
1953
1971
  allEntitiesMetrics?: GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics;
@@ -2079,6 +2097,14 @@ declare namespace gapi.client {
2079
2097
  /** Y coordinate (starts from the top of the image). */
2080
2098
  y?: number;
2081
2099
  }
2100
+ interface GoogleCloudDocumentaiV1beta3OcrConfig {
2101
+ /** Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs. */
2102
+ enableNativePdfParsing?: boolean;
2103
+ }
2104
+ interface GoogleCloudDocumentaiV1beta3ProcessOptions {
2105
+ /** Only applicable to "Document OCR Processor". Returns error if set on other processor types. */
2106
+ ocrConfig?: GoogleCloudDocumentaiV1beta3OcrConfig;
2107
+ }
2082
2108
  interface GoogleCloudDocumentaiV1beta3Processor {
2083
2109
  /** The time the processor was created. */
2084
2110
  createTime?: string;
@@ -2094,7 +2120,7 @@ declare namespace gapi.client {
2094
2120
  processEndpoint?: string;
2095
2121
  /** Output only. The state of the processor. */
2096
2122
  state?: string;
2097
- /** The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc. To get a list of processors types, see FetchProcessorTypes. */
2123
+ /** The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. To get a list of processors types, see FetchProcessorTypes. */
2098
2124
  type?: string;
2099
2125
  }
2100
2126
  interface GoogleCloudDocumentaiV1beta3ProcessorType {
@@ -2106,9 +2132,11 @@ declare namespace gapi.client {
2106
2132
  category?: string;
2107
2133
  /** Launch stage of the processor type */
2108
2134
  launchStage?: string;
2109
- /** The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type} */
2135
+ /** The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}` */
2110
2136
  name?: string;
2111
- /** The type of the processor, e.g., "invoice_parsing". */
2137
+ /** A set of Cloud Storage URIs of sample documents for this processor. */
2138
+ sampleDocumentUris?: string[];
2139
+ /** The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. */
2112
2140
  type?: string;
2113
2141
  }
2114
2142
  interface GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo {
@@ -2151,6 +2179,8 @@ declare namespace gapi.client {
2151
2179
  fieldMask?: string;
2152
2180
  /** An inline document proto. */
2153
2181
  inlineDocument?: GoogleCloudDocumentaiV1beta3Document;
2182
+ /** Inference-time options for the process API */
2183
+ processOptions?: GoogleCloudDocumentaiV1beta3ProcessOptions;
2154
2184
  /** A raw document content (bytes). */
2155
2185
  rawDocument?: GoogleCloudDocumentaiV1beta3RawDocument;
2156
2186
  /** Whether Human Review feature should be skipped for this request. Default to false. */
@@ -2170,7 +2200,7 @@ declare namespace gapi.client {
2170
2200
  interface GoogleCloudDocumentaiV1beta3RawDocument {
2171
2201
  /** Inline document content. */
2172
2202
  content?: string;
2173
- /** An IANA MIME type (RFC6838) indicating the nature and format of the [content]. */
2203
+ /** An IANA MIME type (RFC6838) indicating the nature and format of the content. */
2174
2204
  mimeType?: string;
2175
2205
  }
2176
2206
  interface GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata {
@@ -2218,6 +2248,24 @@ declare namespace gapi.client {
2218
2248
  // tslint:disable-next-line:no-empty-interface
2219
2249
  interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {
2220
2250
  }
2251
+ interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata {
2252
+ /** The basic metadata of the long running operation. */
2253
+ commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
2254
+ /** The test dataset validation information. */
2255
+ testDatasetValidation?: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation;
2256
+ /** The training dataset validation information. */
2257
+ trainingDatasetValidation?: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation;
2258
+ }
2259
+ interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation {
2260
+ /** The total number of dataset errors. */
2261
+ datasetErrorCount?: number;
2262
+ /** Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. */
2263
+ datasetErrors?: GoogleRpcStatus[];
2264
+ /** The total number of document errors. */
2265
+ documentErrorCount?: number;
2266
+ /** Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. */
2267
+ documentErrors?: GoogleRpcStatus[];
2268
+ }
2221
2269
  interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest {
2222
2270
  /**
2223
2271
  * Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format:
@@ -2237,6 +2285,10 @@ declare namespace gapi.client {
2237
2285
  /** The documents used for training the new version. */
2238
2286
  trainingDocuments?: GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
2239
2287
  }
2288
+ interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse {
2289
+ /** The resource name of the processor version produced by training. */
2290
+ processorVersion?: string;
2291
+ }
2240
2292
  interface GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata {
2241
2293
  /** The basic metadata of the long running operation. */
2242
2294
  commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.documentai-v1beta3",
3
- "version": "0.0.20221108",
3
+ "version": "0.0.20221201",
4
4
  "description": "TypeScript typings for Cloud Document AI API v1beta3",
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: 20221108
6
+ // Revision: 20221201
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -77,6 +77,10 @@ gapi.load('client', async () => {
77
77
  gcsOutputConfig: {
78
78
  fieldMask: "Test string",
79
79
  gcsUri: "Test string",
80
+ shardingConfig: {
81
+ pagesOverlap: 42,
82
+ pagesPerShard: 42,
83
+ },
80
84
  },
81
85
  },
82
86
  inputConfigs: [
@@ -101,6 +105,11 @@ gapi.load('client', async () => {
101
105
  outputConfig: {
102
106
  gcsDestination: "Test string",
103
107
  },
108
+ processOptions: {
109
+ ocrConfig: {
110
+ enableNativePdfParsing: true,
111
+ },
112
+ },
104
113
  skipHumanReview: true,
105
114
  });
106
115
  /** 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 () => {
1779
1788
  ],
1780
1789
  uri: "Test string",
1781
1790
  },
1791
+ processOptions: {
1792
+ ocrConfig: {
1793
+ enableNativePdfParsing: true,
1794
+ },
1795
+ },
1782
1796
  rawDocument: {
1783
1797
  content: "Test string",
1784
1798
  mimeType: "Test string",
@@ -3471,6 +3485,10 @@ gapi.load('client', async () => {
3471
3485
  gcsOutputConfig: {
3472
3486
  fieldMask: "Test string",
3473
3487
  gcsUri: "Test string",
3488
+ shardingConfig: {
3489
+ pagesOverlap: 42,
3490
+ pagesPerShard: 42,
3491
+ },
3474
3492
  },
3475
3493
  },
3476
3494
  inputConfigs: [
@@ -3495,6 +3513,11 @@ gapi.load('client', async () => {
3495
3513
  outputConfig: {
3496
3514
  gcsDestination: "Test string",
3497
3515
  },
3516
+ processOptions: {
3517
+ ocrConfig: {
3518
+ enableNativePdfParsing: true,
3519
+ },
3520
+ },
3498
3521
  skipHumanReview: true,
3499
3522
  });
3500
3523
  /** Deletes the processor version, all artifacts under the processor version will be deleted. */
@@ -5173,6 +5196,11 @@ gapi.load('client', async () => {
5173
5196
  ],
5174
5197
  uri: "Test string",
5175
5198
  },
5199
+ processOptions: {
5200
+ ocrConfig: {
5201
+ enableNativePdfParsing: true,
5202
+ },
5203
+ },
5176
5204
  rawDocument: {
5177
5205
  content: "Test string",
5178
5206
  mimeType: "Test string",