@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20230526 → 0.0.20230605
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 +41 -41
- 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: 20230605
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -483,7 +483,7 @@ declare namespace gapi.client {
|
|
|
483
483
|
/** Any error that occurred while processing this document. */
|
|
484
484
|
error?:
|
|
485
485
|
GoogleRpcStatus;
|
|
486
|
-
/** An IANA published
|
|
486
|
+
/** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
|
|
487
487
|
mimeType?:
|
|
488
488
|
string;
|
|
489
489
|
/** Visual page layout for the Document. */
|
|
@@ -695,7 +695,7 @@ declare namespace gapi.client {
|
|
|
695
695
|
/** Confidence of detected language. Range `[0, 1]`. */
|
|
696
696
|
confidence?:
|
|
697
697
|
number;
|
|
698
|
-
/** The BCP-47 language code, such as `en-US` or `sr-Latn`.
|
|
698
|
+
/** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
|
|
699
699
|
languageCode?:
|
|
700
700
|
string;
|
|
701
701
|
}
|
|
@@ -746,7 +746,7 @@ declare namespace gapi.client {
|
|
|
746
746
|
/** Height of the image in pixels. */
|
|
747
747
|
height?:
|
|
748
748
|
number;
|
|
749
|
-
/** Encoding
|
|
749
|
+
/** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
|
|
750
750
|
mimeType?:
|
|
751
751
|
string;
|
|
752
752
|
/** Width of the image in pixels. */
|
|
@@ -757,12 +757,12 @@ declare namespace gapi.client {
|
|
|
757
757
|
/** A list of detected defects. */
|
|
758
758
|
detectedDefects?:
|
|
759
759
|
GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect[];
|
|
760
|
-
/** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
|
|
760
|
+
/** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
|
|
761
761
|
qualityScore?:
|
|
762
762
|
number;
|
|
763
763
|
}
|
|
764
764
|
interface GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect {
|
|
765
|
-
/** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
|
|
765
|
+
/** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence of that the defect exists. */
|
|
766
766
|
confidence?:
|
|
767
767
|
number;
|
|
768
768
|
/**
|
|
@@ -1035,16 +1035,16 @@ declare namespace gapi.client {
|
|
|
1035
1035
|
/** Font size. */
|
|
1036
1036
|
fontSize?:
|
|
1037
1037
|
GoogleCloudDocumentaiV1beta1DocumentStyleFontSize;
|
|
1038
|
-
/** Font weight. Possible values are normal
|
|
1038
|
+
/** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
|
|
1039
1039
|
fontWeight?:
|
|
1040
1040
|
string;
|
|
1041
1041
|
/** Text anchor indexing into the Document.text. */
|
|
1042
1042
|
textAnchor?:
|
|
1043
1043
|
GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
|
|
1044
|
-
/** Text decoration
|
|
1044
|
+
/** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
|
|
1045
1045
|
textDecoration?:
|
|
1046
1046
|
string;
|
|
1047
|
-
/** Text style. Possible values are normal
|
|
1047
|
+
/** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
|
|
1048
1048
|
textStyle?:
|
|
1049
1049
|
string;
|
|
1050
1050
|
}
|
|
@@ -1052,7 +1052,7 @@ declare namespace gapi.client {
|
|
|
1052
1052
|
/** Font size for the text. */
|
|
1053
1053
|
size?:
|
|
1054
1054
|
number;
|
|
1055
|
-
/** Unit for the font size. Follows CSS naming (in
|
|
1055
|
+
/** Unit for the font size. Follows CSS naming (`in`, `px`, `pt`, etc.). */
|
|
1056
1056
|
unit?:
|
|
1057
1057
|
string;
|
|
1058
1058
|
}
|
|
@@ -1207,7 +1207,7 @@ declare namespace gapi.client {
|
|
|
1207
1207
|
/** Labels for this document. */
|
|
1208
1208
|
labels?:
|
|
1209
1209
|
GoogleCloudDocumentaiV1beta2DocumentLabel[];
|
|
1210
|
-
/** An IANA published
|
|
1210
|
+
/** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
|
|
1211
1211
|
mimeType?:
|
|
1212
1212
|
string;
|
|
1213
1213
|
/** Visual page layout for the Document. */
|
|
@@ -1430,7 +1430,7 @@ declare namespace gapi.client {
|
|
|
1430
1430
|
/** Confidence of detected language. Range `[0, 1]`. */
|
|
1431
1431
|
confidence?:
|
|
1432
1432
|
number;
|
|
1433
|
-
/** The BCP-47 language code, such as `en-US` or `sr-Latn`.
|
|
1433
|
+
/** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
|
|
1434
1434
|
languageCode?:
|
|
1435
1435
|
string;
|
|
1436
1436
|
}
|
|
@@ -1481,7 +1481,7 @@ declare namespace gapi.client {
|
|
|
1481
1481
|
/** Height of the image in pixels. */
|
|
1482
1482
|
height?:
|
|
1483
1483
|
number;
|
|
1484
|
-
/** Encoding
|
|
1484
|
+
/** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
|
|
1485
1485
|
mimeType?:
|
|
1486
1486
|
string;
|
|
1487
1487
|
/** Width of the image in pixels. */
|
|
@@ -1492,12 +1492,12 @@ declare namespace gapi.client {
|
|
|
1492
1492
|
/** A list of detected defects. */
|
|
1493
1493
|
detectedDefects?:
|
|
1494
1494
|
GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect[];
|
|
1495
|
-
/** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
|
|
1495
|
+
/** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
|
|
1496
1496
|
qualityScore?:
|
|
1497
1497
|
number;
|
|
1498
1498
|
}
|
|
1499
1499
|
interface GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect {
|
|
1500
|
-
/** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
|
|
1500
|
+
/** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence of that the defect exists. */
|
|
1501
1501
|
confidence?:
|
|
1502
1502
|
number;
|
|
1503
1503
|
/**
|
|
@@ -1770,16 +1770,16 @@ declare namespace gapi.client {
|
|
|
1770
1770
|
/** Font size. */
|
|
1771
1771
|
fontSize?:
|
|
1772
1772
|
GoogleCloudDocumentaiV1beta2DocumentStyleFontSize;
|
|
1773
|
-
/** Font weight. Possible values are normal
|
|
1773
|
+
/** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
|
|
1774
1774
|
fontWeight?:
|
|
1775
1775
|
string;
|
|
1776
1776
|
/** Text anchor indexing into the Document.text. */
|
|
1777
1777
|
textAnchor?:
|
|
1778
1778
|
GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
|
|
1779
|
-
/** Text decoration
|
|
1779
|
+
/** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
|
|
1780
1780
|
textDecoration?:
|
|
1781
1781
|
string;
|
|
1782
|
-
/** Text style. Possible values are normal
|
|
1782
|
+
/** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
|
|
1783
1783
|
textStyle?:
|
|
1784
1784
|
string;
|
|
1785
1785
|
}
|
|
@@ -1787,7 +1787,7 @@ declare namespace gapi.client {
|
|
|
1787
1787
|
/** Font size for the text. */
|
|
1788
1788
|
size?:
|
|
1789
1789
|
number;
|
|
1790
|
-
/** Unit for the font size. Follows CSS naming (in
|
|
1790
|
+
/** Unit for the font size. Follows CSS naming (`in`, `px`, `pt`, etc.). */
|
|
1791
1791
|
unit?:
|
|
1792
1792
|
string;
|
|
1793
1793
|
}
|
|
@@ -1977,7 +1977,7 @@ declare namespace gapi.client {
|
|
|
1977
1977
|
/** Inference-time options for the process API */
|
|
1978
1978
|
processOptions?:
|
|
1979
1979
|
GoogleCloudDocumentaiV1beta3ProcessOptions;
|
|
1980
|
-
/** Whether Human Review feature should be skipped for this request. Default to false
|
|
1980
|
+
/** Whether Human Review feature should be skipped for this request. Default to `false`. */
|
|
1981
1981
|
skipHumanReview?:
|
|
1982
1982
|
boolean;
|
|
1983
1983
|
}
|
|
@@ -1986,8 +1986,8 @@ declare namespace gapi.client {
|
|
|
1986
1986
|
gcsSource?:
|
|
1987
1987
|
string;
|
|
1988
1988
|
/**
|
|
1989
|
-
*
|
|
1990
|
-
* types. If the input is a Document, the type should be `application/json`.
|
|
1989
|
+
* 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
|
|
1990
|
+
* 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`.
|
|
1991
1991
|
*/
|
|
1992
1992
|
mimeType?:
|
|
1993
1993
|
string;
|
|
@@ -2035,7 +2035,7 @@ declare namespace gapi.client {
|
|
|
2035
2035
|
/** Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset` */
|
|
2036
2036
|
name?:
|
|
2037
2037
|
string;
|
|
2038
|
-
/** Optional. A lightweight indexing source with low latency and high
|
|
2038
|
+
/** Optional. A lightweight indexing source with low latency and high reliability, but lack advanced features like CMEK and content based search. */
|
|
2039
2039
|
spannerIndexingConfig?:
|
|
2040
2040
|
any;
|
|
2041
2041
|
/** Required. State of the dataset. Will be ignored when updating dataset. */
|
|
@@ -2120,7 +2120,7 @@ declare namespace gapi.client {
|
|
|
2120
2120
|
/** Any error that occurred while processing this document. */
|
|
2121
2121
|
error?:
|
|
2122
2122
|
GoogleRpcStatus;
|
|
2123
|
-
/** An IANA published
|
|
2123
|
+
/** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
|
|
2124
2124
|
mimeType?:
|
|
2125
2125
|
string;
|
|
2126
2126
|
/** Visual page layout for the Document. */
|
|
@@ -2359,7 +2359,7 @@ declare namespace gapi.client {
|
|
|
2359
2359
|
/** Confidence of detected language. Range `[0, 1]`. */
|
|
2360
2360
|
confidence?:
|
|
2361
2361
|
number;
|
|
2362
|
-
/** The BCP-47 language code, such as `en-US` or `sr-Latn`.
|
|
2362
|
+
/** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
|
|
2363
2363
|
languageCode?:
|
|
2364
2364
|
string;
|
|
2365
2365
|
}
|
|
@@ -2410,7 +2410,7 @@ declare namespace gapi.client {
|
|
|
2410
2410
|
/** Height of the image in pixels. */
|
|
2411
2411
|
height?:
|
|
2412
2412
|
number;
|
|
2413
|
-
/** Encoding
|
|
2413
|
+
/** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
|
|
2414
2414
|
mimeType?:
|
|
2415
2415
|
string;
|
|
2416
2416
|
/** Width of the image in pixels. */
|
|
@@ -2421,12 +2421,12 @@ declare namespace gapi.client {
|
|
|
2421
2421
|
/** A list of detected defects. */
|
|
2422
2422
|
detectedDefects?:
|
|
2423
2423
|
GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect[];
|
|
2424
|
-
/** The overall quality score. Range `[0, 1]` where 1 is perfect quality. */
|
|
2424
|
+
/** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
|
|
2425
2425
|
qualityScore?:
|
|
2426
2426
|
number;
|
|
2427
2427
|
}
|
|
2428
2428
|
interface GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect {
|
|
2429
|
-
/** Confidence of detected defect. Range `[0, 1]` where 1 indicates strong confidence of that the defect exists. */
|
|
2429
|
+
/** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence of that the defect exists. */
|
|
2430
2430
|
confidence?:
|
|
2431
2431
|
number;
|
|
2432
2432
|
/**
|
|
@@ -2706,10 +2706,10 @@ declare namespace gapi.client {
|
|
|
2706
2706
|
enumValues?:
|
|
2707
2707
|
GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues;
|
|
2708
2708
|
/**
|
|
2709
|
-
* Name of the type. It must be unique within the schema file and cannot be a
|
|
2710
|
-
*
|
|
2711
|
-
*
|
|
2712
|
-
*
|
|
2709
|
+
* 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
|
|
2710
|
+
* case-sensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling
|
|
2711
|
+
* 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
|
|
2712
|
+
* for backward compatibility.
|
|
2713
2713
|
*/
|
|
2714
2714
|
name?:
|
|
2715
2715
|
string;
|
|
@@ -2740,7 +2740,7 @@ declare namespace gapi.client {
|
|
|
2740
2740
|
/** If true, on a given page, there can be multiple `document` annotations covering it. */
|
|
2741
2741
|
documentAllowMultipleLabels?:
|
|
2742
2742
|
boolean;
|
|
2743
|
-
/** If true, a `document` entity type can be applied to subdocument (
|
|
2743
|
+
/** If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */
|
|
2744
2744
|
documentSplitter?:
|
|
2745
2745
|
boolean;
|
|
2746
2746
|
/** If set, all the nested entities must be prefixed with the parents. */
|
|
@@ -2777,16 +2777,16 @@ declare namespace gapi.client {
|
|
|
2777
2777
|
/** Font size. */
|
|
2778
2778
|
fontSize?:
|
|
2779
2779
|
GoogleCloudDocumentaiV1beta3DocumentStyleFontSize;
|
|
2780
|
-
/** Font weight. Possible values are normal
|
|
2780
|
+
/** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
|
|
2781
2781
|
fontWeight?:
|
|
2782
2782
|
string;
|
|
2783
2783
|
/** Text anchor indexing into the Document.text. */
|
|
2784
2784
|
textAnchor?:
|
|
2785
2785
|
GoogleCloudDocumentaiV1beta3DocumentTextAnchor;
|
|
2786
|
-
/** Text decoration
|
|
2786
|
+
/** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
|
|
2787
2787
|
textDecoration?:
|
|
2788
2788
|
string;
|
|
2789
|
-
/** Text style. Possible values are normal
|
|
2789
|
+
/** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
|
|
2790
2790
|
textStyle?:
|
|
2791
2791
|
string;
|
|
2792
2792
|
}
|
|
@@ -2794,7 +2794,7 @@ declare namespace gapi.client {
|
|
|
2794
2794
|
/** Font size for the text. */
|
|
2795
2795
|
size?:
|
|
2796
2796
|
number;
|
|
2797
|
-
/** Unit for the font size. Follows CSS naming (in
|
|
2797
|
+
/** Unit for the font size. Follows CSS naming (`in`, `px`, `pt`, etc.). */
|
|
2798
2798
|
unit?:
|
|
2799
2799
|
string;
|
|
2800
2800
|
}
|
|
@@ -3104,7 +3104,7 @@ declare namespace gapi.client {
|
|
|
3104
3104
|
string[];
|
|
3105
3105
|
}
|
|
3106
3106
|
interface GoogleCloudDocumentaiV1beta3ProcessOptions {
|
|
3107
|
-
/** Only applicable to
|
|
3107
|
+
/** Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types. */
|
|
3108
3108
|
ocrConfig?:
|
|
3109
3109
|
GoogleCloudDocumentaiV1beta3OcrConfig;
|
|
3110
3110
|
}
|
|
@@ -3118,7 +3118,7 @@ declare namespace gapi.client {
|
|
|
3118
3118
|
/** The display name of the processor. */
|
|
3119
3119
|
displayName?:
|
|
3120
3120
|
string;
|
|
3121
|
-
/** The KMS key used for encryption/decryption in CMEK scenarios.
|
|
3121
|
+
/** The [KMS key](https://cloud.google.com/security-key-management) used for encryption/decryption in CMEK scenarios. */
|
|
3122
3122
|
kmsKeyName?:
|
|
3123
3123
|
string;
|
|
3124
3124
|
/** Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` */
|
|
@@ -3158,7 +3158,7 @@ declare namespace gapi.client {
|
|
|
3158
3158
|
string;
|
|
3159
3159
|
}
|
|
3160
3160
|
interface GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo {
|
|
3161
|
-
/** The location id,
|
|
3161
|
+
/** The location id, refer to [regional and multi-regional support](/document-ai/docs/regions) for supported locations. */
|
|
3162
3162
|
locationId?:
|
|
3163
3163
|
string;
|
|
3164
3164
|
}
|
|
@@ -3175,7 +3175,7 @@ declare namespace gapi.client {
|
|
|
3175
3175
|
/** The schema of the processor version. Describes the output. */
|
|
3176
3176
|
documentSchema?:
|
|
3177
3177
|
GoogleCloudDocumentaiV1beta3DocumentSchema;
|
|
3178
|
-
/** Denotes that this ProcessorVersion is managed by
|
|
3178
|
+
/** Denotes that this `ProcessorVersion` is managed by Google. */
|
|
3179
3179
|
googleManaged?:
|
|
3180
3180
|
boolean;
|
|
3181
3181
|
/** The KMS key name used for encryption. */
|
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: 20230605
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|