@maxim_mazurok/gapi.client.documentai-v1 0.0.20221114 → 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.
- package/index.d.ts +35 -25
- package/package.json +1 -1
- package/tests.ts +9 -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:
|
|
12
|
+
// Revision: 20221201
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -400,7 +400,7 @@ declare namespace gapi.client {
|
|
|
400
400
|
* with each other.
|
|
401
401
|
*/
|
|
402
402
|
textChanges?: GoogleCloudDocumentaiV1beta1DocumentTextChange[];
|
|
403
|
-
/**
|
|
403
|
+
/** Styles for the Document.text. */
|
|
404
404
|
textStyles?: GoogleCloudDocumentaiV1beta1DocumentStyle[];
|
|
405
405
|
/**
|
|
406
406
|
* 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
|
|
@@ -452,9 +452,9 @@ declare namespace gapi.client {
|
|
|
452
452
|
moneyValue?: GoogleTypeMoney;
|
|
453
453
|
/**
|
|
454
454
|
* 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
|
|
455
|
-
* `structured_value` will be normalized. For example, some processors may not generate float or
|
|
456
|
-
* 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
|
|
457
|
-
* text format.
|
|
455
|
+
* `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
|
|
456
|
+
* 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
|
|
457
|
+
* ISO 8601 text format.
|
|
458
458
|
*/
|
|
459
459
|
text?: string;
|
|
460
460
|
}
|
|
@@ -516,7 +516,7 @@ declare namespace gapi.client {
|
|
|
516
516
|
/** Optional. The type of the layout element that is being referenced if any. */
|
|
517
517
|
layoutType?: string;
|
|
518
518
|
/**
|
|
519
|
-
* 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
|
|
519
|
+
* 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
|
|
520
520
|
* https://developers.google.com/protocol-buffers/docs/proto3#json.
|
|
521
521
|
*/
|
|
522
522
|
page?: string;
|
|
@@ -565,8 +565,8 @@ declare namespace gapi.client {
|
|
|
565
565
|
/** A list of detected languages for value together with confidence. */
|
|
566
566
|
valueDetectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
|
|
567
567
|
/**
|
|
568
|
-
* If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) -
|
|
569
|
-
*
|
|
568
|
+
* 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` -
|
|
569
|
+
* `filled_checkbox`
|
|
570
570
|
*/
|
|
571
571
|
valueType?: string;
|
|
572
572
|
}
|
|
@@ -898,7 +898,7 @@ declare namespace gapi.client {
|
|
|
898
898
|
* with each other.
|
|
899
899
|
*/
|
|
900
900
|
textChanges?: GoogleCloudDocumentaiV1beta2DocumentTextChange[];
|
|
901
|
-
/**
|
|
901
|
+
/** Styles for the Document.text. */
|
|
902
902
|
textStyles?: GoogleCloudDocumentaiV1beta2DocumentStyle[];
|
|
903
903
|
/**
|
|
904
904
|
* 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
|
|
@@ -950,9 +950,9 @@ declare namespace gapi.client {
|
|
|
950
950
|
moneyValue?: GoogleTypeMoney;
|
|
951
951
|
/**
|
|
952
952
|
* 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
|
|
953
|
-
* `structured_value` will be normalized. For example, some processors may not generate float or
|
|
954
|
-
* 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
|
|
955
|
-
* text format.
|
|
953
|
+
* `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
|
|
954
|
+
* 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
|
|
955
|
+
* ISO 8601 text format.
|
|
956
956
|
*/
|
|
957
957
|
text?: string;
|
|
958
958
|
}
|
|
@@ -1022,7 +1022,7 @@ declare namespace gapi.client {
|
|
|
1022
1022
|
/** Optional. The type of the layout element that is being referenced if any. */
|
|
1023
1023
|
layoutType?: string;
|
|
1024
1024
|
/**
|
|
1025
|
-
* 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
|
|
1025
|
+
* 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
|
|
1026
1026
|
* https://developers.google.com/protocol-buffers/docs/proto3#json.
|
|
1027
1027
|
*/
|
|
1028
1028
|
page?: string;
|
|
@@ -1071,8 +1071,8 @@ declare namespace gapi.client {
|
|
|
1071
1071
|
/** A list of detected languages for value together with confidence. */
|
|
1072
1072
|
valueDetectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
|
|
1073
1073
|
/**
|
|
1074
|
-
* If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) -
|
|
1075
|
-
*
|
|
1074
|
+
* 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` -
|
|
1075
|
+
* `filled_checkbox`
|
|
1076
1076
|
*/
|
|
1077
1077
|
valueType?: string;
|
|
1078
1078
|
}
|
|
@@ -1578,7 +1578,7 @@ declare namespace gapi.client {
|
|
|
1578
1578
|
* with each other.
|
|
1579
1579
|
*/
|
|
1580
1580
|
textChanges?: GoogleCloudDocumentaiV1DocumentTextChange[];
|
|
1581
|
-
/**
|
|
1581
|
+
/** Styles for the Document.text. */
|
|
1582
1582
|
textStyles?: GoogleCloudDocumentaiV1DocumentStyle[];
|
|
1583
1583
|
/**
|
|
1584
1584
|
* 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
|
|
@@ -1630,9 +1630,9 @@ declare namespace gapi.client {
|
|
|
1630
1630
|
moneyValue?: GoogleTypeMoney;
|
|
1631
1631
|
/**
|
|
1632
1632
|
* 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
|
|
1633
|
-
* `structured_value` will be normalized. For example, some processors may not generate float or
|
|
1634
|
-
* 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
|
|
1635
|
-
* text format.
|
|
1633
|
+
* `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
|
|
1634
|
+
* 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
|
|
1635
|
+
* ISO 8601 text format.
|
|
1636
1636
|
*/
|
|
1637
1637
|
text?: string;
|
|
1638
1638
|
}
|
|
@@ -1656,6 +1656,14 @@ declare namespace gapi.client {
|
|
|
1656
1656
|
fieldMask?: string;
|
|
1657
1657
|
/** The Cloud Storage uri (a directory) of the output. */
|
|
1658
1658
|
gcsUri?: string;
|
|
1659
|
+
/** Specifies the sharding config for the output document. */
|
|
1660
|
+
shardingConfig?: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig;
|
|
1661
|
+
}
|
|
1662
|
+
interface GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig {
|
|
1663
|
+
/** The number of overlapping pages between consecutive shards. */
|
|
1664
|
+
pagesOverlap?: number;
|
|
1665
|
+
/** The number of pages per shard. */
|
|
1666
|
+
pagesPerShard?: number;
|
|
1659
1667
|
}
|
|
1660
1668
|
interface GoogleCloudDocumentaiV1DocumentPage {
|
|
1661
1669
|
/** 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. */
|
|
@@ -1707,7 +1715,7 @@ declare namespace gapi.client {
|
|
|
1707
1715
|
/** Optional. The type of the layout element that is being referenced if any. */
|
|
1708
1716
|
layoutType?: string;
|
|
1709
1717
|
/**
|
|
1710
|
-
* 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
|
|
1718
|
+
* 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
|
|
1711
1719
|
* https://developers.google.com/protocol-buffers/docs/proto3#json.
|
|
1712
1720
|
*/
|
|
1713
1721
|
page?: string;
|
|
@@ -1756,8 +1764,8 @@ declare namespace gapi.client {
|
|
|
1756
1764
|
/** A list of detected languages for value together with confidence. */
|
|
1757
1765
|
valueDetectedLanguages?: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[];
|
|
1758
1766
|
/**
|
|
1759
|
-
* If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) -
|
|
1760
|
-
*
|
|
1767
|
+
* 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` -
|
|
1768
|
+
* `filled_checkbox`
|
|
1761
1769
|
*/
|
|
1762
1770
|
valueType?: string;
|
|
1763
1771
|
}
|
|
@@ -1947,9 +1955,9 @@ declare namespace gapi.client {
|
|
|
1947
1955
|
enumValues?: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues;
|
|
1948
1956
|
/**
|
|
1949
1957
|
* 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
|
|
1950
|
-
* matching is case-
|
|
1951
|
-
*
|
|
1952
|
-
*
|
|
1958
|
+
* matching is case-sensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure
|
|
1959
|
+
* 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
|
|
1960
|
+
* be honored for backward compatibility.
|
|
1953
1961
|
*/
|
|
1954
1962
|
name?: string;
|
|
1955
1963
|
/** Describing the nested structure, or composition of an entity. */
|
|
@@ -2127,6 +2135,8 @@ declare namespace gapi.client {
|
|
|
2127
2135
|
launchStage?: string;
|
|
2128
2136
|
/** The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}` */
|
|
2129
2137
|
name?: string;
|
|
2138
|
+
/** A set of Cloud Storage URIs of sample documents for this processor. */
|
|
2139
|
+
sampleDocumentUris?: string[];
|
|
2130
2140
|
/** The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. */
|
|
2131
2141
|
type?: string;
|
|
2132
2142
|
}
|
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: 20221201
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -84,6 +84,10 @@ gapi.load('client', async () => {
|
|
|
84
84
|
gcsOutputConfig: {
|
|
85
85
|
fieldMask: "Test string",
|
|
86
86
|
gcsUri: "Test string",
|
|
87
|
+
shardingConfig: {
|
|
88
|
+
pagesOverlap: 42,
|
|
89
|
+
pagesPerShard: 42,
|
|
90
|
+
},
|
|
87
91
|
},
|
|
88
92
|
},
|
|
89
93
|
inputDocuments: {
|
|
@@ -1835,6 +1839,10 @@ gapi.load('client', async () => {
|
|
|
1835
1839
|
gcsOutputConfig: {
|
|
1836
1840
|
fieldMask: "Test string",
|
|
1837
1841
|
gcsUri: "Test string",
|
|
1842
|
+
shardingConfig: {
|
|
1843
|
+
pagesOverlap: 42,
|
|
1844
|
+
pagesPerShard: 42,
|
|
1845
|
+
},
|
|
1838
1846
|
},
|
|
1839
1847
|
},
|
|
1840
1848
|
inputDocuments: {
|