@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20221108 → 0.0.20221114
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.
- package/index.d.ts +94 -64
- package/package.json +1 -1
- package/tests.ts +1 -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:
|
|
12
|
+
// Revision: 20221114
|
|
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
|
|
323
|
-
* ITF type. EAN_13
|
|
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
|
|
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
|
|
331
|
-
* PHONE
|
|
332
|
-
* DRIVER_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,7 +366,7 @@ 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
|
|
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[];
|
|
@@ -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;
|
|
@@ -479,7 +479,7 @@ 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;
|
|
@@ -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
|
|
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 {
|
|
@@ -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
|
|
564
|
-
*
|
|
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
|
|
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
|
|
819
|
-
* ITF type. EAN_13
|
|
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
|
|
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
|
|
827
|
-
* PHONE
|
|
828
|
-
* DRIVER_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,7 +864,7 @@ 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
|
|
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[];
|
|
@@ -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;
|
|
@@ -985,7 +985,7 @@ 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;
|
|
@@ -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
|
|
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 {
|
|
@@ -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
|
|
1070
|
-
*
|
|
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
|
|
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
|
|
1330
|
-
* ITF type. EAN_13
|
|
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
|
|
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
|
|
1338
|
-
* PHONE
|
|
1339
|
-
* DRIVER_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
|
|
1346
|
+
/** The set of documents that match the specified Cloud Storage `gcs_prefix`. */
|
|
1347
1347
|
gcsPrefix?: GoogleCloudDocumentaiV1beta3GcsPrefix;
|
|
1348
1348
|
}
|
|
1349
1349
|
interface GoogleCloudDocumentaiV1beta3BatchProcessMetadata {
|
|
@@ -1473,7 +1473,7 @@ declare namespace gapi.client {
|
|
|
1473
1473
|
/** Optional. UTF-8 encoded text in reading order from the document. */
|
|
1474
1474
|
text?: string;
|
|
1475
1475
|
/**
|
|
1476
|
-
* Placeholder. A list of text corrections made to
|
|
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
|
|
1477
1477
|
* with each other.
|
|
1478
1478
|
*/
|
|
1479
1479
|
textChanges?: GoogleCloudDocumentaiV1beta3DocumentTextChange[];
|
|
@@ -1486,7 +1486,7 @@ declare namespace gapi.client {
|
|
|
1486
1486
|
uri?: string;
|
|
1487
1487
|
}
|
|
1488
1488
|
interface GoogleCloudDocumentaiV1beta3DocumentEntity {
|
|
1489
|
-
/** Optional. Confidence of detected Schema entity. Range [0, 1]
|
|
1489
|
+
/** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
|
|
1490
1490
|
confidence?: number;
|
|
1491
1491
|
/** Optional. Canonical id. This will be a unique value in the entity list for this document. */
|
|
1492
1492
|
id?: string;
|
|
@@ -1599,7 +1599,7 @@ declare namespace gapi.client {
|
|
|
1599
1599
|
interface GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef {
|
|
1600
1600
|
/** Optional. Identifies the bounding polygon of a layout element on the page. */
|
|
1601
1601
|
boundingPoly?: GoogleCloudDocumentaiV1beta3BoundingPoly;
|
|
1602
|
-
/** Optional. Confidence of detected page element, if applicable. Range [0, 1]
|
|
1602
|
+
/** Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. */
|
|
1603
1603
|
confidence?: number;
|
|
1604
1604
|
/** Optional. Deprecated. Use PageRef.bounding_poly instead. */
|
|
1605
1605
|
layoutId?: string;
|
|
@@ -1626,9 +1626,9 @@ declare namespace gapi.client {
|
|
|
1626
1626
|
layout?: GoogleCloudDocumentaiV1beta3DocumentPageLayout;
|
|
1627
1627
|
}
|
|
1628
1628
|
interface GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage {
|
|
1629
|
-
/** Confidence of detected language. Range [0, 1]
|
|
1629
|
+
/** Confidence of detected language. Range `[0, 1]`. */
|
|
1630
1630
|
confidence?: number;
|
|
1631
|
-
/** The BCP-47 language code, such as
|
|
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. */
|
|
1632
1632
|
languageCode?: string;
|
|
1633
1633
|
}
|
|
1634
1634
|
interface GoogleCloudDocumentaiV1beta3DocumentPageDimension {
|
|
@@ -1673,15 +1673,15 @@ declare namespace gapi.client {
|
|
|
1673
1673
|
interface GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores {
|
|
1674
1674
|
/** A list of detected defects. */
|
|
1675
1675
|
detectedDefects?: GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect[];
|
|
1676
|
-
/** The overall quality score. Range [0, 1] where 1 is perfect quality. */
|
|
1676
|
+
/** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
|
|
1677
1677
|
qualityScore?: number;
|
|
1678
1678
|
}
|
|
1679
1679
|
interface GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect {
|
|
1680
|
-
/** Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists. */
|
|
1680
|
+
/** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
|
|
1681
1681
|
confidence?: number;
|
|
1682
1682
|
/**
|
|
1683
|
-
* Name of the defect type. Supported values are
|
|
1684
|
-
*
|
|
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`
|
|
1685
1685
|
*/
|
|
1686
1686
|
type?: string;
|
|
1687
1687
|
}
|
|
@@ -1690,7 +1690,7 @@ declare namespace gapi.client {
|
|
|
1690
1690
|
boundingPoly?: GoogleCloudDocumentaiV1beta3BoundingPoly;
|
|
1691
1691
|
/**
|
|
1692
1692
|
* 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]
|
|
1693
|
+
* Range `[0, 1]`.
|
|
1694
1694
|
*/
|
|
1695
1695
|
confidence?: number;
|
|
1696
1696
|
/** Detected orientation for the Layout. */
|
|
@@ -1845,10 +1845,10 @@ declare namespace gapi.client {
|
|
|
1845
1845
|
*/
|
|
1846
1846
|
enumValues?: GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
|
|
1847
1847
|
/**
|
|
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
|
|
1849
|
-
* is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal
|
|
1850
|
-
* tooling can handle any ascii character) - The
|
|
1851
|
-
* honored for backward compatibility.
|
|
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
|
|
1849
|
+
* matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal
|
|
1850
|
+
* 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,
|
|
1851
|
+
* but will still be honored for backward compatibility.
|
|
1852
1852
|
*/
|
|
1853
1853
|
name?: string;
|
|
1854
1854
|
/** Describing the nested structure, or composition of an entity. */
|
|
@@ -1892,7 +1892,7 @@ declare namespace gapi.client {
|
|
|
1892
1892
|
backgroundColor?: GoogleTypeColor;
|
|
1893
1893
|
/** Text color. */
|
|
1894
1894
|
color?: GoogleTypeColor;
|
|
1895
|
-
/** Font family such as
|
|
1895
|
+
/** Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp */
|
|
1896
1896
|
fontFamily?: string;
|
|
1897
1897
|
/** Font size. */
|
|
1898
1898
|
fontSize?: GoogleCloudDocumentaiV1beta3DocumentStyleFontSize;
|
|
@@ -1944,10 +1944,18 @@ declare namespace gapi.client {
|
|
|
1944
1944
|
// tslint:disable-next-line:no-empty-interface
|
|
1945
1945
|
interface GoogleCloudDocumentaiV1beta3EnableProcessorResponse {
|
|
1946
1946
|
}
|
|
1947
|
+
interface GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata {
|
|
1948
|
+
/** The basic metadata of the long running operation. */
|
|
1949
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
1950
|
+
}
|
|
1947
1951
|
interface GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest {
|
|
1948
1952
|
/** Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input. */
|
|
1949
1953
|
evaluationDocuments?: GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
|
|
1950
1954
|
}
|
|
1955
|
+
interface GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse {
|
|
1956
|
+
/** The resource name of the created evaluation. */
|
|
1957
|
+
evaluation?: string;
|
|
1958
|
+
}
|
|
1951
1959
|
interface GoogleCloudDocumentaiV1beta3Evaluation {
|
|
1952
1960
|
/** Metrics for all the entities in aggregate. */
|
|
1953
1961
|
allEntitiesMetrics?: GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics;
|
|
@@ -2094,7 +2102,7 @@ declare namespace gapi.client {
|
|
|
2094
2102
|
processEndpoint?: string;
|
|
2095
2103
|
/** Output only. The state of the processor. */
|
|
2096
2104
|
state?: string;
|
|
2097
|
-
/** The processor type, e.g., OCR_PROCESSOR
|
|
2105
|
+
/** The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. To get a list of processors types, see FetchProcessorTypes. */
|
|
2098
2106
|
type?: string;
|
|
2099
2107
|
}
|
|
2100
2108
|
interface GoogleCloudDocumentaiV1beta3ProcessorType {
|
|
@@ -2106,9 +2114,9 @@ declare namespace gapi.client {
|
|
|
2106
2114
|
category?: string;
|
|
2107
2115
|
/** Launch stage of the processor type */
|
|
2108
2116
|
launchStage?: string;
|
|
2109
|
-
/** The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type} */
|
|
2117
|
+
/** The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}` */
|
|
2110
2118
|
name?: string;
|
|
2111
|
-
/** The type
|
|
2119
|
+
/** The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. */
|
|
2112
2120
|
type?: string;
|
|
2113
2121
|
}
|
|
2114
2122
|
interface GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo {
|
|
@@ -2170,7 +2178,7 @@ declare namespace gapi.client {
|
|
|
2170
2178
|
interface GoogleCloudDocumentaiV1beta3RawDocument {
|
|
2171
2179
|
/** Inline document content. */
|
|
2172
2180
|
content?: string;
|
|
2173
|
-
/** An IANA MIME type (RFC6838) indicating the nature and format of the
|
|
2181
|
+
/** An IANA MIME type (RFC6838) indicating the nature and format of the content. */
|
|
2174
2182
|
mimeType?: string;
|
|
2175
2183
|
}
|
|
2176
2184
|
interface GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata {
|
|
@@ -2218,6 +2226,24 @@ declare namespace gapi.client {
|
|
|
2218
2226
|
// tslint:disable-next-line:no-empty-interface
|
|
2219
2227
|
interface GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {
|
|
2220
2228
|
}
|
|
2229
|
+
interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata {
|
|
2230
|
+
/** The basic metadata of the long running operation. */
|
|
2231
|
+
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
|
2232
|
+
/** The test dataset validation information. */
|
|
2233
|
+
testDatasetValidation?: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation;
|
|
2234
|
+
/** The training dataset validation information. */
|
|
2235
|
+
trainingDatasetValidation?: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation;
|
|
2236
|
+
}
|
|
2237
|
+
interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation {
|
|
2238
|
+
/** The total number of dataset errors. */
|
|
2239
|
+
datasetErrorCount?: number;
|
|
2240
|
+
/** 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. */
|
|
2241
|
+
datasetErrors?: GoogleRpcStatus[];
|
|
2242
|
+
/** The total number of document errors. */
|
|
2243
|
+
documentErrorCount?: number;
|
|
2244
|
+
/** 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. */
|
|
2245
|
+
documentErrors?: GoogleRpcStatus[];
|
|
2246
|
+
}
|
|
2221
2247
|
interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest {
|
|
2222
2248
|
/**
|
|
2223
2249
|
* Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format:
|
|
@@ -2237,6 +2263,10 @@ declare namespace gapi.client {
|
|
|
2237
2263
|
/** The documents used for training the new version. */
|
|
2238
2264
|
trainingDocuments?: GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig;
|
|
2239
2265
|
}
|
|
2266
|
+
interface GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse {
|
|
2267
|
+
/** The resource name of the processor version produced by training. */
|
|
2268
|
+
processorVersion?: string;
|
|
2269
|
+
}
|
|
2240
2270
|
interface GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata {
|
|
2241
2271
|
/** The basic metadata of the long running operation. */
|
|
2242
2272
|
commonMetadata?: GoogleCloudDocumentaiV1beta3CommonOperationMetadata;
|
package/package.json
CHANGED
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:
|
|
6
|
+
// Revision: 20221114
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|