@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20240523 → 0.0.20240609
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 +214 -2
- package/package.json +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: 20240609
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -358,8 +358,12 @@ declare namespace gapi.client {
|
|
|
358
358
|
vertices?: GoogleCloudDocumentaiV1beta1Vertex[];
|
|
359
359
|
}
|
|
360
360
|
interface GoogleCloudDocumentaiV1beta1Document {
|
|
361
|
+
/** Document chunked based on chunking config. */
|
|
362
|
+
chunkedDocument?: GoogleCloudDocumentaiV1beta1DocumentChunkedDocument;
|
|
361
363
|
/** Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */
|
|
362
364
|
content?: string;
|
|
365
|
+
/** Parsed layout of the document. */
|
|
366
|
+
documentLayout?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayout;
|
|
363
367
|
/** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
|
|
364
368
|
entities?: GoogleCloudDocumentaiV1beta1DocumentEntity[];
|
|
365
369
|
/** Placeholder. Relationship among Document.entities. */
|
|
@@ -383,6 +387,102 @@ declare namespace gapi.client {
|
|
|
383
387
|
/** Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). */
|
|
384
388
|
uri?: string;
|
|
385
389
|
}
|
|
390
|
+
interface GoogleCloudDocumentaiV1beta1DocumentChunkedDocument {
|
|
391
|
+
/** List of chunks. */
|
|
392
|
+
chunks?: GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk[];
|
|
393
|
+
}
|
|
394
|
+
interface GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk {
|
|
395
|
+
/** ID of the chunk. */
|
|
396
|
+
chunkId?: string;
|
|
397
|
+
/** Text content of the chunk. */
|
|
398
|
+
content?: string;
|
|
399
|
+
/** Page footers associated with the chunk. */
|
|
400
|
+
pageFooters?: GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter[];
|
|
401
|
+
/** Page headers associated with the chunk. */
|
|
402
|
+
pageHeaders?: GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader[];
|
|
403
|
+
/** Page span of the chunk. */
|
|
404
|
+
pageSpan?: GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan;
|
|
405
|
+
/** Unused. */
|
|
406
|
+
sourceBlockIds?: string[];
|
|
407
|
+
}
|
|
408
|
+
interface GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter {
|
|
409
|
+
/** Page span of the footer. */
|
|
410
|
+
pageSpan?: GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan;
|
|
411
|
+
/** Footer in text format. */
|
|
412
|
+
text?: string;
|
|
413
|
+
}
|
|
414
|
+
interface GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader {
|
|
415
|
+
/** Page span of the header. */
|
|
416
|
+
pageSpan?: GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan;
|
|
417
|
+
/** Header in text format. */
|
|
418
|
+
text?: string;
|
|
419
|
+
}
|
|
420
|
+
interface GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan {
|
|
421
|
+
/** Page where chunk ends in the document. */
|
|
422
|
+
pageEnd?: number;
|
|
423
|
+
/** Page where chunk starts in the document. */
|
|
424
|
+
pageStart?: number;
|
|
425
|
+
}
|
|
426
|
+
interface GoogleCloudDocumentaiV1beta1DocumentDocumentLayout {
|
|
427
|
+
/** List of blocks in the document. */
|
|
428
|
+
blocks?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
429
|
+
}
|
|
430
|
+
interface GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock {
|
|
431
|
+
/** ID of the block. */
|
|
432
|
+
blockId?: string;
|
|
433
|
+
/** Block consisting of list content/structure. */
|
|
434
|
+
listBlock?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock;
|
|
435
|
+
/** Page span of the block. */
|
|
436
|
+
pageSpan?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan;
|
|
437
|
+
/** Block consisting of table content/structure. */
|
|
438
|
+
tableBlock?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock;
|
|
439
|
+
/** Block consisting of text content. */
|
|
440
|
+
textBlock?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock;
|
|
441
|
+
}
|
|
442
|
+
interface GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock {
|
|
443
|
+
/** List entries that constitute a list block. */
|
|
444
|
+
listEntries?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[];
|
|
445
|
+
/** Type of the list_entries (if exist). Available options are `ordered` and `unordered`. */
|
|
446
|
+
type?: string;
|
|
447
|
+
}
|
|
448
|
+
interface GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry {
|
|
449
|
+
/** A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. */
|
|
450
|
+
blocks?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
451
|
+
}
|
|
452
|
+
interface GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan {
|
|
453
|
+
/** Page where block ends in the document. */
|
|
454
|
+
pageEnd?: number;
|
|
455
|
+
/** Page where block starts in the document. */
|
|
456
|
+
pageStart?: number;
|
|
457
|
+
}
|
|
458
|
+
interface GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock {
|
|
459
|
+
/** Body rows containing main table content. */
|
|
460
|
+
bodyRows?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[];
|
|
461
|
+
/** Table caption/title. */
|
|
462
|
+
caption?: string;
|
|
463
|
+
/** Header rows at the top of the table. */
|
|
464
|
+
headerRows?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[];
|
|
465
|
+
}
|
|
466
|
+
interface GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell {
|
|
467
|
+
/** A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. */
|
|
468
|
+
blocks?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
469
|
+
/** How many columns this cell spans. */
|
|
470
|
+
colSpan?: number;
|
|
471
|
+
/** How many rows this cell spans. */
|
|
472
|
+
rowSpan?: number;
|
|
473
|
+
}
|
|
474
|
+
interface GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow {
|
|
475
|
+
/** A table row is a list of table cells. */
|
|
476
|
+
cells?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[];
|
|
477
|
+
}
|
|
478
|
+
interface GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock {
|
|
479
|
+
/** A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. */
|
|
480
|
+
blocks?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
481
|
+
/** Text content stored in the block. */
|
|
482
|
+
text?: string;
|
|
483
|
+
/** Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. */
|
|
484
|
+
type?: string;
|
|
485
|
+
}
|
|
386
486
|
interface GoogleCloudDocumentaiV1beta1DocumentEntity {
|
|
387
487
|
/** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
|
|
388
488
|
confidence?: number;
|
|
@@ -834,8 +934,12 @@ declare namespace gapi.client {
|
|
|
834
934
|
vertices?: GoogleCloudDocumentaiV1beta2Vertex[];
|
|
835
935
|
}
|
|
836
936
|
interface GoogleCloudDocumentaiV1beta2Document {
|
|
937
|
+
/** Document chunked based on chunking config. */
|
|
938
|
+
chunkedDocument?: GoogleCloudDocumentaiV1beta2DocumentChunkedDocument;
|
|
837
939
|
/** Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */
|
|
838
940
|
content?: string;
|
|
941
|
+
/** Parsed layout of the document. */
|
|
942
|
+
documentLayout?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayout;
|
|
839
943
|
/** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
|
|
840
944
|
entities?: GoogleCloudDocumentaiV1beta2DocumentEntity[];
|
|
841
945
|
/** Placeholder. Relationship among Document.entities. */
|
|
@@ -861,6 +965,102 @@ declare namespace gapi.client {
|
|
|
861
965
|
/** Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). */
|
|
862
966
|
uri?: string;
|
|
863
967
|
}
|
|
968
|
+
interface GoogleCloudDocumentaiV1beta2DocumentChunkedDocument {
|
|
969
|
+
/** List of chunks. */
|
|
970
|
+
chunks?: GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk[];
|
|
971
|
+
}
|
|
972
|
+
interface GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk {
|
|
973
|
+
/** ID of the chunk. */
|
|
974
|
+
chunkId?: string;
|
|
975
|
+
/** Text content of the chunk. */
|
|
976
|
+
content?: string;
|
|
977
|
+
/** Page footers associated with the chunk. */
|
|
978
|
+
pageFooters?: GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter[];
|
|
979
|
+
/** Page headers associated with the chunk. */
|
|
980
|
+
pageHeaders?: GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader[];
|
|
981
|
+
/** Page span of the chunk. */
|
|
982
|
+
pageSpan?: GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan;
|
|
983
|
+
/** Unused. */
|
|
984
|
+
sourceBlockIds?: string[];
|
|
985
|
+
}
|
|
986
|
+
interface GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter {
|
|
987
|
+
/** Page span of the footer. */
|
|
988
|
+
pageSpan?: GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan;
|
|
989
|
+
/** Footer in text format. */
|
|
990
|
+
text?: string;
|
|
991
|
+
}
|
|
992
|
+
interface GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader {
|
|
993
|
+
/** Page span of the header. */
|
|
994
|
+
pageSpan?: GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan;
|
|
995
|
+
/** Header in text format. */
|
|
996
|
+
text?: string;
|
|
997
|
+
}
|
|
998
|
+
interface GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan {
|
|
999
|
+
/** Page where chunk ends in the document. */
|
|
1000
|
+
pageEnd?: number;
|
|
1001
|
+
/** Page where chunk starts in the document. */
|
|
1002
|
+
pageStart?: number;
|
|
1003
|
+
}
|
|
1004
|
+
interface GoogleCloudDocumentaiV1beta2DocumentDocumentLayout {
|
|
1005
|
+
/** List of blocks in the document. */
|
|
1006
|
+
blocks?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
1007
|
+
}
|
|
1008
|
+
interface GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock {
|
|
1009
|
+
/** ID of the block. */
|
|
1010
|
+
blockId?: string;
|
|
1011
|
+
/** Block consisting of list content/structure. */
|
|
1012
|
+
listBlock?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock;
|
|
1013
|
+
/** Page span of the block. */
|
|
1014
|
+
pageSpan?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan;
|
|
1015
|
+
/** Block consisting of table content/structure. */
|
|
1016
|
+
tableBlock?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock;
|
|
1017
|
+
/** Block consisting of text content. */
|
|
1018
|
+
textBlock?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock;
|
|
1019
|
+
}
|
|
1020
|
+
interface GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock {
|
|
1021
|
+
/** List entries that constitute a list block. */
|
|
1022
|
+
listEntries?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[];
|
|
1023
|
+
/** Type of the list_entries (if exist). Available options are `ordered` and `unordered`. */
|
|
1024
|
+
type?: string;
|
|
1025
|
+
}
|
|
1026
|
+
interface GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry {
|
|
1027
|
+
/** A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. */
|
|
1028
|
+
blocks?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
1029
|
+
}
|
|
1030
|
+
interface GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan {
|
|
1031
|
+
/** Page where block ends in the document. */
|
|
1032
|
+
pageEnd?: number;
|
|
1033
|
+
/** Page where block starts in the document. */
|
|
1034
|
+
pageStart?: number;
|
|
1035
|
+
}
|
|
1036
|
+
interface GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock {
|
|
1037
|
+
/** Body rows containing main table content. */
|
|
1038
|
+
bodyRows?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[];
|
|
1039
|
+
/** Table caption/title. */
|
|
1040
|
+
caption?: string;
|
|
1041
|
+
/** Header rows at the top of the table. */
|
|
1042
|
+
headerRows?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[];
|
|
1043
|
+
}
|
|
1044
|
+
interface GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell {
|
|
1045
|
+
/** A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. */
|
|
1046
|
+
blocks?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
1047
|
+
/** How many columns this cell spans. */
|
|
1048
|
+
colSpan?: number;
|
|
1049
|
+
/** How many rows this cell spans. */
|
|
1050
|
+
rowSpan?: number;
|
|
1051
|
+
}
|
|
1052
|
+
interface GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow {
|
|
1053
|
+
/** A table row is a list of table cells. */
|
|
1054
|
+
cells?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[];
|
|
1055
|
+
}
|
|
1056
|
+
interface GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock {
|
|
1057
|
+
/** A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. */
|
|
1058
|
+
blocks?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
1059
|
+
/** Text content stored in the block. */
|
|
1060
|
+
text?: string;
|
|
1061
|
+
/** Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. */
|
|
1062
|
+
type?: string;
|
|
1063
|
+
}
|
|
864
1064
|
interface GoogleCloudDocumentaiV1beta2DocumentEntity {
|
|
865
1065
|
/** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
|
|
866
1066
|
confidence?: number;
|
|
@@ -1424,6 +1624,10 @@ declare namespace gapi.client {
|
|
|
1424
1624
|
gcsManagedConfig?: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig;
|
|
1425
1625
|
/** Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset` */
|
|
1426
1626
|
name?: string;
|
|
1627
|
+
/** Output only. Reserved for future use. */
|
|
1628
|
+
satisfiesPzi?: boolean;
|
|
1629
|
+
/** Output only. Reserved for future use. */
|
|
1630
|
+
satisfiesPzs?: boolean;
|
|
1427
1631
|
/** Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search. */
|
|
1428
1632
|
spannerIndexingConfig?: any;
|
|
1429
1633
|
/** Required. State of the dataset. Ignored when updating dataset. */
|
|
@@ -1514,7 +1718,7 @@ declare namespace gapi.client {
|
|
|
1514
1718
|
pageHeaders?: GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageHeader[];
|
|
1515
1719
|
/** Page span of the chunk. */
|
|
1516
1720
|
pageSpan?: GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan;
|
|
1517
|
-
/**
|
|
1721
|
+
/** Unused. */
|
|
1518
1722
|
sourceBlockIds?: string[];
|
|
1519
1723
|
}
|
|
1520
1724
|
interface GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageFooter {
|
|
@@ -2406,6 +2610,10 @@ declare namespace gapi.client {
|
|
|
2406
2610
|
processEndpoint?: string;
|
|
2407
2611
|
/** Output only. The processor version aliases. */
|
|
2408
2612
|
processorVersionAliases?: GoogleCloudDocumentaiV1beta3ProcessorVersionAlias[];
|
|
2613
|
+
/** Output only. Reserved for future use. */
|
|
2614
|
+
satisfiesPzi?: boolean;
|
|
2615
|
+
/** Output only. Reserved for future use. */
|
|
2616
|
+
satisfiesPzs?: boolean;
|
|
2409
2617
|
/** Output only. The state of the processor. */
|
|
2410
2618
|
state?: string;
|
|
2411
2619
|
/** The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */
|
|
@@ -2452,6 +2660,10 @@ declare namespace gapi.client {
|
|
|
2452
2660
|
modelType?: string;
|
|
2453
2661
|
/** Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` */
|
|
2454
2662
|
name?: string;
|
|
2663
|
+
/** Output only. Reserved for future use. */
|
|
2664
|
+
satisfiesPzi?: boolean;
|
|
2665
|
+
/** Output only. Reserved for future use. */
|
|
2666
|
+
satisfiesPzs?: boolean;
|
|
2455
2667
|
/** Output only. The state of the processor version. */
|
|
2456
2668
|
state?: string;
|
|
2457
2669
|
}
|