@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20240328 → 0.0.20240415
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 +115 -1
- 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: 20240415
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1470,8 +1470,12 @@ declare namespace gapi.client {
|
|
|
1470
1470
|
interface GoogleCloudDocumentaiV1beta3DisableProcessorRequest {}
|
|
1471
1471
|
interface GoogleCloudDocumentaiV1beta3DisableProcessorResponse {}
|
|
1472
1472
|
interface GoogleCloudDocumentaiV1beta3Document {
|
|
1473
|
+
/** Document chunked based on chunking config. */
|
|
1474
|
+
chunkedDocument?: GoogleCloudDocumentaiV1beta3DocumentChunkedDocument;
|
|
1473
1475
|
/** 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. */
|
|
1474
1476
|
content?: string;
|
|
1477
|
+
/** Parsed layout of the document. */
|
|
1478
|
+
documentLayout?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayout;
|
|
1475
1479
|
/** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
|
|
1476
1480
|
entities?: GoogleCloudDocumentaiV1beta3DocumentEntity[];
|
|
1477
1481
|
/** Placeholder. Relationship among Document.entities. */
|
|
@@ -1495,6 +1499,100 @@ declare namespace gapi.client {
|
|
|
1495
1499
|
/** 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). */
|
|
1496
1500
|
uri?: string;
|
|
1497
1501
|
}
|
|
1502
|
+
interface GoogleCloudDocumentaiV1beta3DocumentChunkedDocument {
|
|
1503
|
+
/** List of chunks. */
|
|
1504
|
+
chunks?: GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunk[];
|
|
1505
|
+
}
|
|
1506
|
+
interface GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunk {
|
|
1507
|
+
/** ID of the chunk. */
|
|
1508
|
+
chunkId?: string;
|
|
1509
|
+
/** Text content of the chunk. */
|
|
1510
|
+
content?: string;
|
|
1511
|
+
/** Page footers associated with the chunk. */
|
|
1512
|
+
pageFooters?: GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageFooter[];
|
|
1513
|
+
/** Page headers associated with the chunk. */
|
|
1514
|
+
pageHeaders?: GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageHeader[];
|
|
1515
|
+
/** Page span of the chunk. */
|
|
1516
|
+
pageSpan?: GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan;
|
|
1517
|
+
}
|
|
1518
|
+
interface GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageFooter {
|
|
1519
|
+
/** Page span of the footer. */
|
|
1520
|
+
pageSpan?: GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan;
|
|
1521
|
+
/** Footer in text format. */
|
|
1522
|
+
text?: string;
|
|
1523
|
+
}
|
|
1524
|
+
interface GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageHeader {
|
|
1525
|
+
/** Page span of the header. */
|
|
1526
|
+
pageSpan?: GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan;
|
|
1527
|
+
/** Header in text format. */
|
|
1528
|
+
text?: string;
|
|
1529
|
+
}
|
|
1530
|
+
interface GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan {
|
|
1531
|
+
/** Page where chunk ends in the document. */
|
|
1532
|
+
pageEnd?: number;
|
|
1533
|
+
/** Page where chunk starts in the document. */
|
|
1534
|
+
pageStart?: number;
|
|
1535
|
+
}
|
|
1536
|
+
interface GoogleCloudDocumentaiV1beta3DocumentDocumentLayout {
|
|
1537
|
+
/** List of blocks in the document. */
|
|
1538
|
+
blocks?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
1539
|
+
}
|
|
1540
|
+
interface GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock {
|
|
1541
|
+
/** ID of the block. */
|
|
1542
|
+
blockId?: string;
|
|
1543
|
+
/** Block consisting of list content/structure. */
|
|
1544
|
+
listBlock?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock;
|
|
1545
|
+
/** Page span of the block. */
|
|
1546
|
+
pageSpan?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan;
|
|
1547
|
+
/** Block consisting of table content/structure. */
|
|
1548
|
+
tableBlock?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock;
|
|
1549
|
+
/** Block consisting of text content. */
|
|
1550
|
+
textBlock?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock;
|
|
1551
|
+
}
|
|
1552
|
+
interface GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock {
|
|
1553
|
+
/** List entries that constitute a list block. */
|
|
1554
|
+
listEntries?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[];
|
|
1555
|
+
/** Type of the list_entries (if exist). Available options are `ordered` and `unordered`. */
|
|
1556
|
+
type?: string;
|
|
1557
|
+
}
|
|
1558
|
+
interface GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry {
|
|
1559
|
+
/** A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. */
|
|
1560
|
+
blocks?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
1561
|
+
}
|
|
1562
|
+
interface GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan {
|
|
1563
|
+
/** Page where block ends in the document. */
|
|
1564
|
+
pageEnd?: number;
|
|
1565
|
+
/** Page where block starts in the document. */
|
|
1566
|
+
pageStart?: number;
|
|
1567
|
+
}
|
|
1568
|
+
interface GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock {
|
|
1569
|
+
/** Body rows containing main table content. */
|
|
1570
|
+
bodyRows?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[];
|
|
1571
|
+
/** Table caption/title. */
|
|
1572
|
+
caption?: string;
|
|
1573
|
+
/** Header rows at the top of the table. */
|
|
1574
|
+
headerRows?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[];
|
|
1575
|
+
}
|
|
1576
|
+
interface GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell {
|
|
1577
|
+
/** A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. */
|
|
1578
|
+
blocks?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
1579
|
+
/** How many columns this cell spans. */
|
|
1580
|
+
colSpan?: number;
|
|
1581
|
+
/** How many rows this cell spans. */
|
|
1582
|
+
rowSpan?: number;
|
|
1583
|
+
}
|
|
1584
|
+
interface GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow {
|
|
1585
|
+
/** A table row is a list of table cells. */
|
|
1586
|
+
cells?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[];
|
|
1587
|
+
}
|
|
1588
|
+
interface GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock {
|
|
1589
|
+
/** A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. */
|
|
1590
|
+
blocks?: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[];
|
|
1591
|
+
/** Text content stored in the block. */
|
|
1592
|
+
text?: string;
|
|
1593
|
+
/** Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. */
|
|
1594
|
+
type?: string;
|
|
1595
|
+
}
|
|
1498
1596
|
interface GoogleCloudDocumentaiV1beta3DocumentEntity {
|
|
1499
1597
|
/** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
|
|
1500
1598
|
confidence?: number;
|
|
@@ -2266,6 +2364,8 @@ declare namespace gapi.client {
|
|
|
2266
2364
|
fromStart?: number;
|
|
2267
2365
|
/** Which pages to process (1-indexed). */
|
|
2268
2366
|
individualPageSelector?: GoogleCloudDocumentaiV1beta3ProcessOptionsIndividualPageSelector;
|
|
2367
|
+
/** Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns error if set on other processor types. */
|
|
2368
|
+
layoutConfig?: GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig;
|
|
2269
2369
|
/** Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types. */
|
|
2270
2370
|
ocrConfig?: GoogleCloudDocumentaiV1beta3OcrConfig;
|
|
2271
2371
|
/** Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. */
|
|
@@ -2275,6 +2375,20 @@ declare namespace gapi.client {
|
|
|
2275
2375
|
/** Optional. Indices of the pages (starting from 1). */
|
|
2276
2376
|
pages?: number[];
|
|
2277
2377
|
}
|
|
2378
|
+
interface GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig {
|
|
2379
|
+
/** Optional. Config for chunking in layout parser processor. */
|
|
2380
|
+
chunkingConfig?: GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig;
|
|
2381
|
+
}
|
|
2382
|
+
interface GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig {
|
|
2383
|
+
/** Optional. The percentile of cosine dissimilarity that must be exceeded between a group of tokens and the next. The smaller this number is, the more chunks will be generated. */
|
|
2384
|
+
breakpointPercentileThreshold?: number;
|
|
2385
|
+
/** Optional. The chunk sizes to use when splitting documents, in order of level. */
|
|
2386
|
+
chunkSize?: number;
|
|
2387
|
+
/** Optional. Whether or not to include ancestor headings when splitting. */
|
|
2388
|
+
includeAncestorHeadings?: boolean;
|
|
2389
|
+
/** Optional. The number of tokens to group together when evaluating semantic similarity. */
|
|
2390
|
+
semanticChunkingGroupSize?: boolean;
|
|
2391
|
+
}
|
|
2278
2392
|
interface GoogleCloudDocumentaiV1beta3Processor {
|
|
2279
2393
|
/** The time the processor was created. */
|
|
2280
2394
|
createTime?: string;
|