@maxim_mazurok/gapi.client.documentai-v1beta3 0.0.20240911 → 0.0.20240925

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.
Files changed (2) hide show
  1. package/index.d.ts +1 -1165
  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: 20240911
12
+ // Revision: 20240925
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -339,1170 +339,6 @@ declare namespace gapi.client {
339
339
  status?: GoogleRpcStatus;
340
340
  }
341
341
  interface GoogleCloudDocumentaiV1BatchProcessResponse {}
342
- interface GoogleCloudDocumentaiV1beta1Barcode {
343
- /** 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 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 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. */
344
- format?: string;
345
- /** Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. */
346
- rawValue?: string;
347
- /** 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 identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. */
348
- valueFormat?: string;
349
- }
350
- interface GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse {
351
- /** Responses for each individual document. */
352
- responses?: GoogleCloudDocumentaiV1beta1ProcessDocumentResponse[];
353
- }
354
- interface GoogleCloudDocumentaiV1beta1BoundingPoly {
355
- /** The bounding polygon normalized vertices. */
356
- normalizedVertices?: GoogleCloudDocumentaiV1beta1NormalizedVertex[];
357
- /** The bounding polygon vertices. */
358
- vertices?: GoogleCloudDocumentaiV1beta1Vertex[];
359
- }
360
- interface GoogleCloudDocumentaiV1beta1Document {
361
- /** Document chunked based on chunking config. */
362
- chunkedDocument?: GoogleCloudDocumentaiV1beta1DocumentChunkedDocument;
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. */
364
- content?: string;
365
- /** Parsed layout of the document. */
366
- documentLayout?: GoogleCloudDocumentaiV1beta1DocumentDocumentLayout;
367
- /** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
368
- entities?: GoogleCloudDocumentaiV1beta1DocumentEntity[];
369
- /** Placeholder. Relationship among Document.entities. */
370
- entityRelations?: GoogleCloudDocumentaiV1beta1DocumentEntityRelation[];
371
- /** Any error that occurred while processing this document. */
372
- error?: GoogleRpcStatus;
373
- /** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
374
- mimeType?: string;
375
- /** Visual page layout for the Document. */
376
- pages?: GoogleCloudDocumentaiV1beta1DocumentPage[];
377
- /** Placeholder. Revision history of this document. */
378
- revisions?: GoogleCloudDocumentaiV1beta1DocumentRevision[];
379
- /** Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. */
380
- shardInfo?: GoogleCloudDocumentaiV1beta1DocumentShardInfo;
381
- /** Optional. UTF-8 encoded text in reading order from the document. */
382
- text?: string;
383
- /** 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 with each other. */
384
- textChanges?: GoogleCloudDocumentaiV1beta1DocumentTextChange[];
385
- /** Styles for the Document.text. */
386
- textStyles?: GoogleCloudDocumentaiV1beta1DocumentStyle[];
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). */
388
- uri?: string;
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
- }
486
- interface GoogleCloudDocumentaiV1beta1DocumentEntity {
487
- /** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
488
- confidence?: number;
489
- /** Optional. Canonical id. This will be a unique value in the entity list for this document. */
490
- id?: string;
491
- /** Optional. Deprecated. Use `id` field instead. */
492
- mentionId?: string;
493
- /** Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. */
494
- mentionText?: string;
495
- /** Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. */
496
- normalizedValue?: GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue;
497
- /** Optional. Represents the provenance of this entity wrt. the location on the page where it was found. */
498
- pageAnchor?: GoogleCloudDocumentaiV1beta1DocumentPageAnchor;
499
- /** Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. */
500
- properties?: GoogleCloudDocumentaiV1beta1DocumentEntity[];
501
- /** Optional. The history of this annotation. */
502
- provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
503
- /** Optional. Whether the entity will be redacted for de-identification purposes. */
504
- redacted?: boolean;
505
- /** Optional. Provenance of the entity. Text anchor indexing into the Document.text. */
506
- textAnchor?: GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
507
- /** Required. Entity type from a schema e.g. `Address`. */
508
- type?: string;
509
- }
510
- interface GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue {
511
- /** Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto */
512
- addressValue?: GoogleTypePostalAddress;
513
- /** Boolean value. Can be used for entities with binary values, or for checkboxes. */
514
- booleanValue?: boolean;
515
- /** DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto */
516
- datetimeValue?: GoogleTypeDateTime;
517
- /** Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto */
518
- dateValue?: GoogleTypeDate;
519
- /** Float value. */
520
- floatValue?: number;
521
- /** Integer value. */
522
- integerValue?: number;
523
- /** Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */
524
- moneyValue?: GoogleTypeMoney;
525
- /** 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 `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 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 ISO 8601 text format. */
526
- text?: string;
527
- }
528
- interface GoogleCloudDocumentaiV1beta1DocumentEntityRelation {
529
- /** Object entity id. */
530
- objectId?: string;
531
- /** Relationship description. */
532
- relation?: string;
533
- /** Subject entity id. */
534
- subjectId?: string;
535
- }
536
- interface GoogleCloudDocumentaiV1beta1DocumentPage {
537
- /** 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. */
538
- blocks?: GoogleCloudDocumentaiV1beta1DocumentPageBlock[];
539
- /** A list of detected barcodes. */
540
- detectedBarcodes?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode[];
541
- /** A list of detected languages together with confidence. */
542
- detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
543
- /** Physical dimension of the page. */
544
- dimension?: GoogleCloudDocumentaiV1beta1DocumentPageDimension;
545
- /** A list of visually detected form fields on the page. */
546
- formFields?: GoogleCloudDocumentaiV1beta1DocumentPageFormField[];
547
- /** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
548
- image?: GoogleCloudDocumentaiV1beta1DocumentPageImage;
549
- /** Image quality scores. */
550
- imageQualityScores?: GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores;
551
- /** Layout for the page. */
552
- layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
553
- /** A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. */
554
- lines?: GoogleCloudDocumentaiV1beta1DocumentPageLine[];
555
- /** 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. */
556
- pageNumber?: number;
557
- /** A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. */
558
- paragraphs?: GoogleCloudDocumentaiV1beta1DocumentPageParagraph[];
559
- /** The history of this page. */
560
- provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
561
- /** A list of visually detected symbols on the page. */
562
- symbols?: GoogleCloudDocumentaiV1beta1DocumentPageSymbol[];
563
- /** A list of visually detected tables on the page. */
564
- tables?: GoogleCloudDocumentaiV1beta1DocumentPageTable[];
565
- /** A list of visually detected tokens on the page. */
566
- tokens?: GoogleCloudDocumentaiV1beta1DocumentPageToken[];
567
- /** Transformation matrices that were applied to the original document image to produce Page.image. */
568
- transforms?: GoogleCloudDocumentaiV1beta1DocumentPageMatrix[];
569
- /** A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. */
570
- visualElements?: GoogleCloudDocumentaiV1beta1DocumentPageVisualElement[];
571
- }
572
- interface GoogleCloudDocumentaiV1beta1DocumentPageAnchor {
573
- /** One or more references to visual page elements */
574
- pageRefs?: GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef[];
575
- }
576
- interface GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef {
577
- /** Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to. */
578
- boundingPoly?: GoogleCloudDocumentaiV1beta1BoundingPoly;
579
- /** Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. */
580
- confidence?: number;
581
- /** Optional. Deprecated. Use PageRef.bounding_poly instead. */
582
- layoutId?: string;
583
- /** Optional. The type of the layout element that is being referenced if any. */
584
- layoutType?: string;
585
- /** 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 https://developers.google.com/protocol-buffers/docs/proto3#json. */
586
- page?: string;
587
- }
588
- interface GoogleCloudDocumentaiV1beta1DocumentPageBlock {
589
- /** A list of detected languages together with confidence. */
590
- detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
591
- /** Layout for Block. */
592
- layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
593
- /** The history of this annotation. */
594
- provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
595
- }
596
- interface GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode {
597
- /** Detailed barcode information of the DetectedBarcode. */
598
- barcode?: GoogleCloudDocumentaiV1beta1Barcode;
599
- /** Layout for DetectedBarcode. */
600
- layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
601
- }
602
- interface GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage {
603
- /** Confidence of detected language. Range `[0, 1]`. */
604
- confidence?: number;
605
- /** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
606
- languageCode?: string;
607
- }
608
- interface GoogleCloudDocumentaiV1beta1DocumentPageDimension {
609
- /** Page height. */
610
- height?: number;
611
- /** Dimension unit. */
612
- unit?: string;
613
- /** Page width. */
614
- width?: number;
615
- }
616
- interface GoogleCloudDocumentaiV1beta1DocumentPageFormField {
617
- /** Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. */
618
- correctedKeyText?: string;
619
- /** Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. */
620
- correctedValueText?: string;
621
- /** Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. */
622
- fieldName?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
623
- /** Layout for the FormField value. */
624
- fieldValue?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
625
- /** A list of detected languages for name together with confidence. */
626
- nameDetectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
627
- /** The history of this annotation. */
628
- provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
629
- /** A list of detected languages for value together with confidence. */
630
- valueDetectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
631
- /** 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` - `filled_checkbox` */
632
- valueType?: string;
633
- }
634
- interface GoogleCloudDocumentaiV1beta1DocumentPageImage {
635
- /** Raw byte content of the image. */
636
- content?: string;
637
- /** Height of the image in pixels. */
638
- height?: number;
639
- /** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
640
- mimeType?: string;
641
- /** Width of the image in pixels. */
642
- width?: number;
643
- }
644
- interface GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores {
645
- /** A list of detected defects. */
646
- detectedDefects?: GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect[];
647
- /** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
648
- qualityScore?: number;
649
- }
650
- interface GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect {
651
- /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
652
- confidence?: number;
653
- /** 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` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` */
654
- type?: string;
655
- }
656
- interface GoogleCloudDocumentaiV1beta1DocumentPageLayout {
657
- /** The bounding polygon for the Layout. */
658
- boundingPoly?: GoogleCloudDocumentaiV1beta1BoundingPoly;
659
- /** 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. Range `[0, 1]`. */
660
- confidence?: number;
661
- /** Detected orientation for the Layout. */
662
- orientation?: string;
663
- /** Text anchor indexing into the Document.text. */
664
- textAnchor?: GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
665
- }
666
- interface GoogleCloudDocumentaiV1beta1DocumentPageLine {
667
- /** A list of detected languages together with confidence. */
668
- detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
669
- /** Layout for Line. */
670
- layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
671
- /** The history of this annotation. */
672
- provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
673
- }
674
- interface GoogleCloudDocumentaiV1beta1DocumentPageMatrix {
675
- /** Number of columns in the matrix. */
676
- cols?: number;
677
- /** The matrix data. */
678
- data?: string;
679
- /** Number of rows in the matrix. */
680
- rows?: number;
681
- /** This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html */
682
- type?: number;
683
- }
684
- interface GoogleCloudDocumentaiV1beta1DocumentPageParagraph {
685
- /** A list of detected languages together with confidence. */
686
- detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
687
- /** Layout for Paragraph. */
688
- layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
689
- /** The history of this annotation. */
690
- provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
691
- }
692
- interface GoogleCloudDocumentaiV1beta1DocumentPageSymbol {
693
- /** A list of detected languages together with confidence. */
694
- detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
695
- /** Layout for Symbol. */
696
- layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
697
- }
698
- interface GoogleCloudDocumentaiV1beta1DocumentPageTable {
699
- /** Body rows of the table. */
700
- bodyRows?: GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow[];
701
- /** A list of detected languages together with confidence. */
702
- detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
703
- /** Header rows of the table. */
704
- headerRows?: GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow[];
705
- /** Layout for Table. */
706
- layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
707
- /** The history of this table. */
708
- provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
709
- }
710
- interface GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell {
711
- /** How many columns this cell spans. */
712
- colSpan?: number;
713
- /** A list of detected languages together with confidence. */
714
- detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
715
- /** Layout for TableCell. */
716
- layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
717
- /** How many rows this cell spans. */
718
- rowSpan?: number;
719
- }
720
- interface GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow {
721
- /** Cells that make up this row. */
722
- cells?: GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell[];
723
- }
724
- interface GoogleCloudDocumentaiV1beta1DocumentPageToken {
725
- /** Detected break at the end of a Token. */
726
- detectedBreak?: GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak;
727
- /** A list of detected languages together with confidence. */
728
- detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
729
- /** Layout for Token. */
730
- layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
731
- /** The history of this annotation. */
732
- provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance;
733
- /** Text style attributes. */
734
- styleInfo?: GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo;
735
- }
736
- interface GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak {
737
- /** Detected break type. */
738
- type?: string;
739
- }
740
- interface GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo {
741
- /** Color of the background. */
742
- backgroundColor?: GoogleTypeColor;
743
- /** Whether the text is bold (equivalent to font_weight is at least `700`). */
744
- bold?: boolean;
745
- /** Font size in points (`1` point is `¹⁄₇₂` inches). */
746
- fontSize?: number;
747
- /** Name or style of the font. */
748
- fontType?: string;
749
- /** TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. */
750
- fontWeight?: number;
751
- /** Whether the text is handwritten. */
752
- handwritten?: boolean;
753
- /** Whether the text is italic. */
754
- italic?: boolean;
755
- /** Letter spacing in points. */
756
- letterSpacing?: number;
757
- /** Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. */
758
- pixelFontSize?: number;
759
- /** Whether the text is in small caps. This feature is not supported yet. */
760
- smallcaps?: boolean;
761
- /** Whether the text is strikethrough. This feature is not supported yet. */
762
- strikeout?: boolean;
763
- /** Whether the text is a subscript. This feature is not supported yet. */
764
- subscript?: boolean;
765
- /** Whether the text is a superscript. This feature is not supported yet. */
766
- superscript?: boolean;
767
- /** Color of the text. */
768
- textColor?: GoogleTypeColor;
769
- /** Whether the text is underlined. */
770
- underlined?: boolean;
771
- }
772
- interface GoogleCloudDocumentaiV1beta1DocumentPageVisualElement {
773
- /** A list of detected languages together with confidence. */
774
- detectedLanguages?: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[];
775
- /** Layout for VisualElement. */
776
- layout?: GoogleCloudDocumentaiV1beta1DocumentPageLayout;
777
- /** Type of the VisualElement. */
778
- type?: string;
779
- }
780
- interface GoogleCloudDocumentaiV1beta1DocumentProvenance {
781
- /** The Id of this operation. Needs to be unique within the scope of the revision. */
782
- id?: number;
783
- /** References to the original elements that are replaced. */
784
- parents?: GoogleCloudDocumentaiV1beta1DocumentProvenanceParent[];
785
- /** The index of the revision that produced this element. */
786
- revision?: number;
787
- /** The type of provenance operation. */
788
- type?: string;
789
- }
790
- interface GoogleCloudDocumentaiV1beta1DocumentProvenanceParent {
791
- /** The id of the parent provenance. */
792
- id?: number;
793
- /** The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. */
794
- index?: number;
795
- /** The index of the index into current revision's parent_ids list. */
796
- revision?: number;
797
- }
798
- interface GoogleCloudDocumentaiV1beta1DocumentRevision {
799
- /** If the change was made by a person specify the name or id of that person. */
800
- agent?: string;
801
- /** The time that the revision was created, internally generated by doc proto storage at the time of create. */
802
- createTime?: string;
803
- /** Human Review information of this revision. */
804
- humanReview?: GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview;
805
- /** Id of the revision, internally generated by doc proto storage. Unique within the context of the document. */
806
- id?: string;
807
- /** The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. */
808
- parent?: number[];
809
- /** The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. */
810
- parentIds?: string[];
811
- /** If the annotation was made by processor identify the processor by its resource name. */
812
- processor?: string;
813
- }
814
- interface GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview {
815
- /** Human review state. e.g. `requested`, `succeeded`, `rejected`. */
816
- state?: string;
817
- /** A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. */
818
- stateMessage?: string;
819
- }
820
- interface GoogleCloudDocumentaiV1beta1DocumentShardInfo {
821
- /** Total number of shards. */
822
- shardCount?: string;
823
- /** The 0-based index of this shard. */
824
- shardIndex?: string;
825
- /** The index of the first character in Document.text in the overall document global text. */
826
- textOffset?: string;
827
- }
828
- interface GoogleCloudDocumentaiV1beta1DocumentStyle {
829
- /** Text background color. */
830
- backgroundColor?: GoogleTypeColor;
831
- /** Text color. */
832
- color?: GoogleTypeColor;
833
- /** Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp */
834
- fontFamily?: string;
835
- /** Font size. */
836
- fontSize?: GoogleCloudDocumentaiV1beta1DocumentStyleFontSize;
837
- /** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
838
- fontWeight?: string;
839
- /** Text anchor indexing into the Document.text. */
840
- textAnchor?: GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
841
- /** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
842
- textDecoration?: string;
843
- /** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
844
- textStyle?: string;
845
- }
846
- interface GoogleCloudDocumentaiV1beta1DocumentStyleFontSize {
847
- /** Font size for the text. */
848
- size?: number;
849
- /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
850
- unit?: string;
851
- }
852
- interface GoogleCloudDocumentaiV1beta1DocumentTextAnchor {
853
- /** Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. */
854
- content?: string;
855
- /** The text segments from the Document.text. */
856
- textSegments?: GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment[];
857
- }
858
- interface GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment {
859
- /** TextSegment half open end UTF-8 char index in the Document.text. */
860
- endIndex?: string;
861
- /** TextSegment start UTF-8 char index in the Document.text. */
862
- startIndex?: string;
863
- }
864
- interface GoogleCloudDocumentaiV1beta1DocumentTextChange {
865
- /** The text that replaces the text identified in the `text_anchor`. */
866
- changedText?: string;
867
- /** The history of this annotation. */
868
- provenance?: GoogleCloudDocumentaiV1beta1DocumentProvenance[];
869
- /** Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. */
870
- textAnchor?: GoogleCloudDocumentaiV1beta1DocumentTextAnchor;
871
- }
872
- interface GoogleCloudDocumentaiV1beta1GcsDestination {
873
- uri?: string;
874
- }
875
- interface GoogleCloudDocumentaiV1beta1GcsSource {
876
- uri?: string;
877
- }
878
- interface GoogleCloudDocumentaiV1beta1InputConfig {
879
- /** The Google Cloud Storage location to read the input from. This must be a single file. */
880
- gcsSource?: GoogleCloudDocumentaiV1beta1GcsSource;
881
- /** Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format. */
882
- mimeType?: string;
883
- }
884
- interface GoogleCloudDocumentaiV1beta1NormalizedVertex {
885
- /** X coordinate. */
886
- x?: number;
887
- /** Y coordinate (starts from the top of the image). */
888
- y?: number;
889
- }
890
- interface GoogleCloudDocumentaiV1beta1OperationMetadata {
891
- /** The creation time of the operation. */
892
- createTime?: string;
893
- /** The state of the current batch processing. */
894
- state?: string;
895
- /** A message providing more details about the current state of processing. */
896
- stateMessage?: string;
897
- /** The last update time of the operation. */
898
- updateTime?: string;
899
- }
900
- interface GoogleCloudDocumentaiV1beta1OutputConfig {
901
- /** The Google Cloud Storage location to write the output to. */
902
- gcsDestination?: GoogleCloudDocumentaiV1beta1GcsDestination;
903
- /** The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json */
904
- pagesPerShard?: number;
905
- }
906
- interface GoogleCloudDocumentaiV1beta1ProcessDocumentResponse {
907
- /** Information about the input file. This is the same as the corresponding input config in the request. */
908
- inputConfig?: GoogleCloudDocumentaiV1beta1InputConfig;
909
- /** The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects. */
910
- outputConfig?: GoogleCloudDocumentaiV1beta1OutputConfig;
911
- }
912
- interface GoogleCloudDocumentaiV1beta1Vertex {
913
- /** X coordinate. */
914
- x?: number;
915
- /** Y coordinate (starts from the top of the image). */
916
- y?: number;
917
- }
918
- interface GoogleCloudDocumentaiV1beta2Barcode {
919
- /** 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 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 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. */
920
- format?: string;
921
- /** Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. */
922
- rawValue?: string;
923
- /** 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 identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. */
924
- valueFormat?: string;
925
- }
926
- interface GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse {
927
- /** Responses for each individual document. */
928
- responses?: GoogleCloudDocumentaiV1beta2ProcessDocumentResponse[];
929
- }
930
- interface GoogleCloudDocumentaiV1beta2BoundingPoly {
931
- /** The bounding polygon normalized vertices. */
932
- normalizedVertices?: GoogleCloudDocumentaiV1beta2NormalizedVertex[];
933
- /** The bounding polygon vertices. */
934
- vertices?: GoogleCloudDocumentaiV1beta2Vertex[];
935
- }
936
- interface GoogleCloudDocumentaiV1beta2Document {
937
- /** Document chunked based on chunking config. */
938
- chunkedDocument?: GoogleCloudDocumentaiV1beta2DocumentChunkedDocument;
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. */
940
- content?: string;
941
- /** Parsed layout of the document. */
942
- documentLayout?: GoogleCloudDocumentaiV1beta2DocumentDocumentLayout;
943
- /** A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */
944
- entities?: GoogleCloudDocumentaiV1beta2DocumentEntity[];
945
- /** Placeholder. Relationship among Document.entities. */
946
- entityRelations?: GoogleCloudDocumentaiV1beta2DocumentEntityRelation[];
947
- /** Any error that occurred while processing this document. */
948
- error?: GoogleRpcStatus;
949
- /** Labels for this document. */
950
- labels?: GoogleCloudDocumentaiV1beta2DocumentLabel[];
951
- /** An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */
952
- mimeType?: string;
953
- /** Visual page layout for the Document. */
954
- pages?: GoogleCloudDocumentaiV1beta2DocumentPage[];
955
- /** Placeholder. Revision history of this document. */
956
- revisions?: GoogleCloudDocumentaiV1beta2DocumentRevision[];
957
- /** Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. */
958
- shardInfo?: GoogleCloudDocumentaiV1beta2DocumentShardInfo;
959
- /** Optional. UTF-8 encoded text in reading order from the document. */
960
- text?: string;
961
- /** 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 with each other. */
962
- textChanges?: GoogleCloudDocumentaiV1beta2DocumentTextChange[];
963
- /** Styles for the Document.text. */
964
- textStyles?: GoogleCloudDocumentaiV1beta2DocumentStyle[];
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). */
966
- uri?: string;
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
- }
1064
- interface GoogleCloudDocumentaiV1beta2DocumentEntity {
1065
- /** Optional. Confidence of detected Schema entity. Range `[0, 1]`. */
1066
- confidence?: number;
1067
- /** Optional. Canonical id. This will be a unique value in the entity list for this document. */
1068
- id?: string;
1069
- /** Optional. Deprecated. Use `id` field instead. */
1070
- mentionId?: string;
1071
- /** Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. */
1072
- mentionText?: string;
1073
- /** Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. */
1074
- normalizedValue?: GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue;
1075
- /** Optional. Represents the provenance of this entity wrt. the location on the page where it was found. */
1076
- pageAnchor?: GoogleCloudDocumentaiV1beta2DocumentPageAnchor;
1077
- /** Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. */
1078
- properties?: GoogleCloudDocumentaiV1beta2DocumentEntity[];
1079
- /** Optional. The history of this annotation. */
1080
- provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
1081
- /** Optional. Whether the entity will be redacted for de-identification purposes. */
1082
- redacted?: boolean;
1083
- /** Optional. Provenance of the entity. Text anchor indexing into the Document.text. */
1084
- textAnchor?: GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
1085
- /** Required. Entity type from a schema e.g. `Address`. */
1086
- type?: string;
1087
- }
1088
- interface GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue {
1089
- /** Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto */
1090
- addressValue?: GoogleTypePostalAddress;
1091
- /** Boolean value. Can be used for entities with binary values, or for checkboxes. */
1092
- booleanValue?: boolean;
1093
- /** DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto */
1094
- datetimeValue?: GoogleTypeDateTime;
1095
- /** Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto */
1096
- dateValue?: GoogleTypeDate;
1097
- /** Float value. */
1098
- floatValue?: number;
1099
- /** Integer value. */
1100
- integerValue?: number;
1101
- /** Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */
1102
- moneyValue?: GoogleTypeMoney;
1103
- /** 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 `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 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 ISO 8601 text format. */
1104
- text?: string;
1105
- }
1106
- interface GoogleCloudDocumentaiV1beta2DocumentEntityRelation {
1107
- /** Object entity id. */
1108
- objectId?: string;
1109
- /** Relationship description. */
1110
- relation?: string;
1111
- /** Subject entity id. */
1112
- subjectId?: string;
1113
- }
1114
- interface GoogleCloudDocumentaiV1beta2DocumentLabel {
1115
- /** Label is generated AutoML model. This field stores the full resource name of the AutoML model. Format: `projects/{project-id}/locations/{location-id}/models/{model-id}` */
1116
- automlModel?: string;
1117
- /** Confidence score between 0 and 1 for label assignment. */
1118
- confidence?: number;
1119
- /** Name of the label. When the label is generated from AutoML Text Classification model, this field represents the name of the category. */
1120
- name?: string;
1121
- }
1122
- interface GoogleCloudDocumentaiV1beta2DocumentPage {
1123
- /** 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. */
1124
- blocks?: GoogleCloudDocumentaiV1beta2DocumentPageBlock[];
1125
- /** A list of detected barcodes. */
1126
- detectedBarcodes?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode[];
1127
- /** A list of detected languages together with confidence. */
1128
- detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1129
- /** Physical dimension of the page. */
1130
- dimension?: GoogleCloudDocumentaiV1beta2DocumentPageDimension;
1131
- /** A list of visually detected form fields on the page. */
1132
- formFields?: GoogleCloudDocumentaiV1beta2DocumentPageFormField[];
1133
- /** Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */
1134
- image?: GoogleCloudDocumentaiV1beta2DocumentPageImage;
1135
- /** Image quality scores. */
1136
- imageQualityScores?: GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores;
1137
- /** Layout for the page. */
1138
- layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1139
- /** A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. */
1140
- lines?: GoogleCloudDocumentaiV1beta2DocumentPageLine[];
1141
- /** 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. */
1142
- pageNumber?: number;
1143
- /** A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. */
1144
- paragraphs?: GoogleCloudDocumentaiV1beta2DocumentPageParagraph[];
1145
- /** The history of this page. */
1146
- provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
1147
- /** A list of visually detected symbols on the page. */
1148
- symbols?: GoogleCloudDocumentaiV1beta2DocumentPageSymbol[];
1149
- /** A list of visually detected tables on the page. */
1150
- tables?: GoogleCloudDocumentaiV1beta2DocumentPageTable[];
1151
- /** A list of visually detected tokens on the page. */
1152
- tokens?: GoogleCloudDocumentaiV1beta2DocumentPageToken[];
1153
- /** Transformation matrices that were applied to the original document image to produce Page.image. */
1154
- transforms?: GoogleCloudDocumentaiV1beta2DocumentPageMatrix[];
1155
- /** A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. */
1156
- visualElements?: GoogleCloudDocumentaiV1beta2DocumentPageVisualElement[];
1157
- }
1158
- interface GoogleCloudDocumentaiV1beta2DocumentPageAnchor {
1159
- /** One or more references to visual page elements */
1160
- pageRefs?: GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef[];
1161
- }
1162
- interface GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef {
1163
- /** Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to. */
1164
- boundingPoly?: GoogleCloudDocumentaiV1beta2BoundingPoly;
1165
- /** Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. */
1166
- confidence?: number;
1167
- /** Optional. Deprecated. Use PageRef.bounding_poly instead. */
1168
- layoutId?: string;
1169
- /** Optional. The type of the layout element that is being referenced if any. */
1170
- layoutType?: string;
1171
- /** 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 https://developers.google.com/protocol-buffers/docs/proto3#json. */
1172
- page?: string;
1173
- }
1174
- interface GoogleCloudDocumentaiV1beta2DocumentPageBlock {
1175
- /** A list of detected languages together with confidence. */
1176
- detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1177
- /** Layout for Block. */
1178
- layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1179
- /** The history of this annotation. */
1180
- provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
1181
- }
1182
- interface GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode {
1183
- /** Detailed barcode information of the DetectedBarcode. */
1184
- barcode?: GoogleCloudDocumentaiV1beta2Barcode;
1185
- /** Layout for DetectedBarcode. */
1186
- layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1187
- }
1188
- interface GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage {
1189
- /** Confidence of detected language. Range `[0, 1]`. */
1190
- confidence?: number;
1191
- /** The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */
1192
- languageCode?: string;
1193
- }
1194
- interface GoogleCloudDocumentaiV1beta2DocumentPageDimension {
1195
- /** Page height. */
1196
- height?: number;
1197
- /** Dimension unit. */
1198
- unit?: string;
1199
- /** Page width. */
1200
- width?: number;
1201
- }
1202
- interface GoogleCloudDocumentaiV1beta2DocumentPageFormField {
1203
- /** Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. */
1204
- correctedKeyText?: string;
1205
- /** Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. */
1206
- correctedValueText?: string;
1207
- /** Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. */
1208
- fieldName?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1209
- /** Layout for the FormField value. */
1210
- fieldValue?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1211
- /** A list of detected languages for name together with confidence. */
1212
- nameDetectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1213
- /** The history of this annotation. */
1214
- provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
1215
- /** A list of detected languages for value together with confidence. */
1216
- valueDetectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1217
- /** 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` - `filled_checkbox` */
1218
- valueType?: string;
1219
- }
1220
- interface GoogleCloudDocumentaiV1beta2DocumentPageImage {
1221
- /** Raw byte content of the image. */
1222
- content?: string;
1223
- /** Height of the image in pixels. */
1224
- height?: number;
1225
- /** Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */
1226
- mimeType?: string;
1227
- /** Width of the image in pixels. */
1228
- width?: number;
1229
- }
1230
- interface GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores {
1231
- /** A list of detected defects. */
1232
- detectedDefects?: GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect[];
1233
- /** The overall quality score. Range `[0, 1]` where `1` is perfect quality. */
1234
- qualityScore?: number;
1235
- }
1236
- interface GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect {
1237
- /** Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */
1238
- confidence?: number;
1239
- /** 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` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` */
1240
- type?: string;
1241
- }
1242
- interface GoogleCloudDocumentaiV1beta2DocumentPageLayout {
1243
- /** The bounding polygon for the Layout. */
1244
- boundingPoly?: GoogleCloudDocumentaiV1beta2BoundingPoly;
1245
- /** 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. Range `[0, 1]`. */
1246
- confidence?: number;
1247
- /** Detected orientation for the Layout. */
1248
- orientation?: string;
1249
- /** Text anchor indexing into the Document.text. */
1250
- textAnchor?: GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
1251
- }
1252
- interface GoogleCloudDocumentaiV1beta2DocumentPageLine {
1253
- /** A list of detected languages together with confidence. */
1254
- detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1255
- /** Layout for Line. */
1256
- layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1257
- /** The history of this annotation. */
1258
- provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
1259
- }
1260
- interface GoogleCloudDocumentaiV1beta2DocumentPageMatrix {
1261
- /** Number of columns in the matrix. */
1262
- cols?: number;
1263
- /** The matrix data. */
1264
- data?: string;
1265
- /** Number of rows in the matrix. */
1266
- rows?: number;
1267
- /** This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html */
1268
- type?: number;
1269
- }
1270
- interface GoogleCloudDocumentaiV1beta2DocumentPageParagraph {
1271
- /** A list of detected languages together with confidence. */
1272
- detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1273
- /** Layout for Paragraph. */
1274
- layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1275
- /** The history of this annotation. */
1276
- provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
1277
- }
1278
- interface GoogleCloudDocumentaiV1beta2DocumentPageSymbol {
1279
- /** A list of detected languages together with confidence. */
1280
- detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1281
- /** Layout for Symbol. */
1282
- layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1283
- }
1284
- interface GoogleCloudDocumentaiV1beta2DocumentPageTable {
1285
- /** Body rows of the table. */
1286
- bodyRows?: GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow[];
1287
- /** A list of detected languages together with confidence. */
1288
- detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1289
- /** Header rows of the table. */
1290
- headerRows?: GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow[];
1291
- /** Layout for Table. */
1292
- layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1293
- /** The history of this table. */
1294
- provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
1295
- }
1296
- interface GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell {
1297
- /** How many columns this cell spans. */
1298
- colSpan?: number;
1299
- /** A list of detected languages together with confidence. */
1300
- detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1301
- /** Layout for TableCell. */
1302
- layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1303
- /** How many rows this cell spans. */
1304
- rowSpan?: number;
1305
- }
1306
- interface GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow {
1307
- /** Cells that make up this row. */
1308
- cells?: GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell[];
1309
- }
1310
- interface GoogleCloudDocumentaiV1beta2DocumentPageToken {
1311
- /** Detected break at the end of a Token. */
1312
- detectedBreak?: GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak;
1313
- /** A list of detected languages together with confidence. */
1314
- detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1315
- /** Layout for Token. */
1316
- layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1317
- /** The history of this annotation. */
1318
- provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance;
1319
- /** Text style attributes. */
1320
- styleInfo?: GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo;
1321
- }
1322
- interface GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak {
1323
- /** Detected break type. */
1324
- type?: string;
1325
- }
1326
- interface GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo {
1327
- /** Color of the background. */
1328
- backgroundColor?: GoogleTypeColor;
1329
- /** Whether the text is bold (equivalent to font_weight is at least `700`). */
1330
- bold?: boolean;
1331
- /** Font size in points (`1` point is `¹⁄₇₂` inches). */
1332
- fontSize?: number;
1333
- /** Name or style of the font. */
1334
- fontType?: string;
1335
- /** TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. */
1336
- fontWeight?: number;
1337
- /** Whether the text is handwritten. */
1338
- handwritten?: boolean;
1339
- /** Whether the text is italic. */
1340
- italic?: boolean;
1341
- /** Letter spacing in points. */
1342
- letterSpacing?: number;
1343
- /** Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. */
1344
- pixelFontSize?: number;
1345
- /** Whether the text is in small caps. This feature is not supported yet. */
1346
- smallcaps?: boolean;
1347
- /** Whether the text is strikethrough. This feature is not supported yet. */
1348
- strikeout?: boolean;
1349
- /** Whether the text is a subscript. This feature is not supported yet. */
1350
- subscript?: boolean;
1351
- /** Whether the text is a superscript. This feature is not supported yet. */
1352
- superscript?: boolean;
1353
- /** Color of the text. */
1354
- textColor?: GoogleTypeColor;
1355
- /** Whether the text is underlined. */
1356
- underlined?: boolean;
1357
- }
1358
- interface GoogleCloudDocumentaiV1beta2DocumentPageVisualElement {
1359
- /** A list of detected languages together with confidence. */
1360
- detectedLanguages?: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[];
1361
- /** Layout for VisualElement. */
1362
- layout?: GoogleCloudDocumentaiV1beta2DocumentPageLayout;
1363
- /** Type of the VisualElement. */
1364
- type?: string;
1365
- }
1366
- interface GoogleCloudDocumentaiV1beta2DocumentProvenance {
1367
- /** The Id of this operation. Needs to be unique within the scope of the revision. */
1368
- id?: number;
1369
- /** References to the original elements that are replaced. */
1370
- parents?: GoogleCloudDocumentaiV1beta2DocumentProvenanceParent[];
1371
- /** The index of the revision that produced this element. */
1372
- revision?: number;
1373
- /** The type of provenance operation. */
1374
- type?: string;
1375
- }
1376
- interface GoogleCloudDocumentaiV1beta2DocumentProvenanceParent {
1377
- /** The id of the parent provenance. */
1378
- id?: number;
1379
- /** The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. */
1380
- index?: number;
1381
- /** The index of the index into current revision's parent_ids list. */
1382
- revision?: number;
1383
- }
1384
- interface GoogleCloudDocumentaiV1beta2DocumentRevision {
1385
- /** If the change was made by a person specify the name or id of that person. */
1386
- agent?: string;
1387
- /** The time that the revision was created, internally generated by doc proto storage at the time of create. */
1388
- createTime?: string;
1389
- /** Human Review information of this revision. */
1390
- humanReview?: GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview;
1391
- /** Id of the revision, internally generated by doc proto storage. Unique within the context of the document. */
1392
- id?: string;
1393
- /** The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. */
1394
- parent?: number[];
1395
- /** The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. */
1396
- parentIds?: string[];
1397
- /** If the annotation was made by processor identify the processor by its resource name. */
1398
- processor?: string;
1399
- }
1400
- interface GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview {
1401
- /** Human review state. e.g. `requested`, `succeeded`, `rejected`. */
1402
- state?: string;
1403
- /** A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. */
1404
- stateMessage?: string;
1405
- }
1406
- interface GoogleCloudDocumentaiV1beta2DocumentShardInfo {
1407
- /** Total number of shards. */
1408
- shardCount?: string;
1409
- /** The 0-based index of this shard. */
1410
- shardIndex?: string;
1411
- /** The index of the first character in Document.text in the overall document global text. */
1412
- textOffset?: string;
1413
- }
1414
- interface GoogleCloudDocumentaiV1beta2DocumentStyle {
1415
- /** Text background color. */
1416
- backgroundColor?: GoogleTypeColor;
1417
- /** Text color. */
1418
- color?: GoogleTypeColor;
1419
- /** Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp */
1420
- fontFamily?: string;
1421
- /** Font size. */
1422
- fontSize?: GoogleCloudDocumentaiV1beta2DocumentStyleFontSize;
1423
- /** [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */
1424
- fontWeight?: string;
1425
- /** Text anchor indexing into the Document.text. */
1426
- textAnchor?: GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
1427
- /** [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */
1428
- textDecoration?: string;
1429
- /** [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */
1430
- textStyle?: string;
1431
- }
1432
- interface GoogleCloudDocumentaiV1beta2DocumentStyleFontSize {
1433
- /** Font size for the text. */
1434
- size?: number;
1435
- /** Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */
1436
- unit?: string;
1437
- }
1438
- interface GoogleCloudDocumentaiV1beta2DocumentTextAnchor {
1439
- /** Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. */
1440
- content?: string;
1441
- /** The text segments from the Document.text. */
1442
- textSegments?: GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment[];
1443
- }
1444
- interface GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment {
1445
- /** TextSegment half open end UTF-8 char index in the Document.text. */
1446
- endIndex?: string;
1447
- /** TextSegment start UTF-8 char index in the Document.text. */
1448
- startIndex?: string;
1449
- }
1450
- interface GoogleCloudDocumentaiV1beta2DocumentTextChange {
1451
- /** The text that replaces the text identified in the `text_anchor`. */
1452
- changedText?: string;
1453
- /** The history of this annotation. */
1454
- provenance?: GoogleCloudDocumentaiV1beta2DocumentProvenance[];
1455
- /** Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. */
1456
- textAnchor?: GoogleCloudDocumentaiV1beta2DocumentTextAnchor;
1457
- }
1458
- interface GoogleCloudDocumentaiV1beta2GcsDestination {
1459
- uri?: string;
1460
- }
1461
- interface GoogleCloudDocumentaiV1beta2GcsSource {
1462
- uri?: string;
1463
- }
1464
- interface GoogleCloudDocumentaiV1beta2InputConfig {
1465
- /** Content in bytes, represented as a stream of bytes. Note: As with all `bytes` fields, proto buffer messages use a pure binary representation, whereas JSON representations use base64. This field only works for synchronous ProcessDocument method. */
1466
- contents?: string;
1467
- /** The Google Cloud Storage location to read the input from. This must be a single file. */
1468
- gcsSource?: GoogleCloudDocumentaiV1beta2GcsSource;
1469
- /** Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format. */
1470
- mimeType?: string;
1471
- }
1472
- interface GoogleCloudDocumentaiV1beta2NormalizedVertex {
1473
- /** X coordinate. */
1474
- x?: number;
1475
- /** Y coordinate (starts from the top of the image). */
1476
- y?: number;
1477
- }
1478
- interface GoogleCloudDocumentaiV1beta2OperationMetadata {
1479
- /** The creation time of the operation. */
1480
- createTime?: string;
1481
- /** The state of the current batch processing. */
1482
- state?: string;
1483
- /** A message providing more details about the current state of processing. */
1484
- stateMessage?: string;
1485
- /** The last update time of the operation. */
1486
- updateTime?: string;
1487
- }
1488
- interface GoogleCloudDocumentaiV1beta2OutputConfig {
1489
- /** The Google Cloud Storage location to write the output to. */
1490
- gcsDestination?: GoogleCloudDocumentaiV1beta2GcsDestination;
1491
- /** The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json */
1492
- pagesPerShard?: number;
1493
- }
1494
- interface GoogleCloudDocumentaiV1beta2ProcessDocumentResponse {
1495
- /** Information about the input file. This is the same as the corresponding input config in the request. */
1496
- inputConfig?: GoogleCloudDocumentaiV1beta2InputConfig;
1497
- /** The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects. */
1498
- outputConfig?: GoogleCloudDocumentaiV1beta2OutputConfig;
1499
- }
1500
- interface GoogleCloudDocumentaiV1beta2Vertex {
1501
- /** X coordinate. */
1502
- x?: number;
1503
- /** Y coordinate (starts from the top of the image). */
1504
- y?: number;
1505
- }
1506
342
  interface GoogleCloudDocumentaiV1beta3Barcode {
1507
343
  /** 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 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 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. */
1508
344
  format?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.documentai-v1beta3",
3
- "version": "0.0.20240911",
3
+ "version": "0.0.20240925",
4
4
  "description": "TypeScript typings for Cloud Document AI API v1beta3",
5
5
  "repository": {
6
6
  "type": "git",