google-api-python-client 2.145.0__py2.py3-none-any.whl → 2.146.0__py2.py3-none-any.whl

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 (67) hide show
  1. {google_api_python_client-2.145.0.dist-info → google_api_python_client-2.146.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.145.0.dist-info → google_api_python_client-2.146.0.dist-info}/RECORD +67 -67
  3. googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +112 -1
  4. googleapiclient/discovery_cache/documents/aiplatform.v1.json +24 -1
  5. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +226 -1
  6. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +6 -6
  7. googleapiclient/discovery_cache/documents/apigee.v1.json +113 -1
  8. googleapiclient/discovery_cache/documents/backupdr.v1.json +2 -2
  9. googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +157 -347
  10. googleapiclient/discovery_cache/documents/bigquery.v2.json +29 -22
  11. googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +30 -1
  12. googleapiclient/discovery_cache/documents/calendar.v3.json +7 -3
  13. googleapiclient/discovery_cache/documents/chat.v1.json +25 -5
  14. googleapiclient/discovery_cache/documents/civicinfo.v2.json +34 -1
  15. googleapiclient/discovery_cache/documents/classroom.v1.json +58 -58
  16. googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +2 -2
  17. googleapiclient/discovery_cache/documents/cloudchannel.v1.json +4 -132
  18. googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json +2 -2
  19. googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json +2 -2
  20. googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +1 -616
  21. googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +1 -411
  22. googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +1 -411
  23. googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +1 -411
  24. googleapiclient/discovery_cache/documents/compute.alpha.json +334 -4
  25. googleapiclient/discovery_cache/documents/compute.beta.json +30 -4
  26. googleapiclient/discovery_cache/documents/compute.v1.json +26 -4
  27. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +9 -1
  28. googleapiclient/discovery_cache/documents/container.v1.json +49 -2
  29. googleapiclient/discovery_cache/documents/css.v1.json +59 -1
  30. googleapiclient/discovery_cache/documents/datastream.v1.json +5 -1
  31. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +272 -73
  32. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +213 -82
  33. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +212 -81
  34. googleapiclient/discovery_cache/documents/displayvideo.v2.json +7 -7
  35. googleapiclient/discovery_cache/documents/displayvideo.v3.json +8 -8
  36. googleapiclient/discovery_cache/documents/documentai.v1.json +1 -3349
  37. googleapiclient/discovery_cache/documents/documentai.v1beta3.json +9 -3349
  38. googleapiclient/discovery_cache/documents/firebase.v1beta1.json +14 -1
  39. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +5 -3
  40. googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +103 -6
  41. googleapiclient/discovery_cache/documents/firestore.v1.json +37 -1
  42. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +97 -1
  43. googleapiclient/discovery_cache/documents/iap.v1.json +3 -3
  44. googleapiclient/discovery_cache/documents/logging.v2.json +552 -1
  45. googleapiclient/discovery_cache/documents/looker.v1.json +9 -1
  46. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +87 -4
  47. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +191 -1
  48. googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +65 -13
  49. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +71 -5
  50. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +71 -5
  51. googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +30 -28
  52. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +35 -1
  53. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +35 -1
  54. googleapiclient/discovery_cache/documents/serviceusage.v1.json +35 -1
  55. googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +35 -1
  56. googleapiclient/discovery_cache/documents/sts.v1.json +3 -3
  57. googleapiclient/discovery_cache/documents/translate.v3.json +3 -2
  58. googleapiclient/discovery_cache/documents/vpcaccess.v1.json +8 -6
  59. googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json +8 -6
  60. googleapiclient/discovery_cache/documents/walletobjects.v1.json +6 -1
  61. googleapiclient/discovery_cache/documents/workstations.v1.json +3 -3
  62. googleapiclient/discovery_cache/documents/workstations.v1beta.json +7 -7
  63. googleapiclient/discovery_cache/documents/youtube.v3.json +2 -2
  64. googleapiclient/version.py +1 -1
  65. {google_api_python_client-2.145.0.dist-info → google_api_python_client-2.146.0.dist-info}/LICENSE +0 -0
  66. {google_api_python_client-2.145.0.dist-info → google_api_python_client-2.146.0.dist-info}/WHEEL +0 -0
  67. {google_api_python_client-2.145.0.dist-info → google_api_python_client-2.146.0.dist-info}/top_level.txt +0 -0
@@ -1284,7 +1284,7 @@
1284
1284
  }
1285
1285
  }
1286
1286
  },
1287
- "revision": "20240813",
1287
+ "revision": "20240911",
1288
1288
  "rootUrl": "https://documentai.googleapis.com/",
1289
1289
  "schemas": {
1290
1290
  "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {
@@ -2569,3354 +2569,6 @@
2569
2569
  "properties": {},
2570
2570
  "type": "object"
2571
2571
  },
2572
- "GoogleCloudDocumentaiV1beta1Barcode": {
2573
- "description": "Encodes the detailed information of a barcode.",
2574
- "id": "GoogleCloudDocumentaiV1beta1Barcode",
2575
- "properties": {
2576
- "format": {
2577
- "description": "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.",
2578
- "type": "string"
2579
- },
2580
- "rawValue": {
2581
- "description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.",
2582
- "type": "string"
2583
- },
2584
- "valueFormat": {
2585
- "description": "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.",
2586
- "type": "string"
2587
- }
2588
- },
2589
- "type": "object"
2590
- },
2591
- "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse": {
2592
- "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.",
2593
- "id": "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse",
2594
- "properties": {
2595
- "responses": {
2596
- "description": "Responses for each individual document.",
2597
- "items": {
2598
- "$ref": "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse"
2599
- },
2600
- "type": "array"
2601
- }
2602
- },
2603
- "type": "object"
2604
- },
2605
- "GoogleCloudDocumentaiV1beta1BoundingPoly": {
2606
- "description": "A bounding polygon for the detected image annotation.",
2607
- "id": "GoogleCloudDocumentaiV1beta1BoundingPoly",
2608
- "properties": {
2609
- "normalizedVertices": {
2610
- "description": "The bounding polygon normalized vertices.",
2611
- "items": {
2612
- "$ref": "GoogleCloudDocumentaiV1beta1NormalizedVertex"
2613
- },
2614
- "type": "array"
2615
- },
2616
- "vertices": {
2617
- "description": "The bounding polygon vertices.",
2618
- "items": {
2619
- "$ref": "GoogleCloudDocumentaiV1beta1Vertex"
2620
- },
2621
- "type": "array"
2622
- }
2623
- },
2624
- "type": "object"
2625
- },
2626
- "GoogleCloudDocumentaiV1beta1Document": {
2627
- "description": "Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.",
2628
- "id": "GoogleCloudDocumentaiV1beta1Document",
2629
- "properties": {
2630
- "chunkedDocument": {
2631
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument",
2632
- "description": "Document chunked based on chunking config."
2633
- },
2634
- "content": {
2635
- "description": "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.",
2636
- "format": "byte",
2637
- "type": "string"
2638
- },
2639
- "documentLayout": {
2640
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout",
2641
- "description": "Parsed layout of the document."
2642
- },
2643
- "entities": {
2644
- "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.",
2645
- "items": {
2646
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntity"
2647
- },
2648
- "type": "array"
2649
- },
2650
- "entityRelations": {
2651
- "description": "Placeholder. Relationship among Document.entities.",
2652
- "items": {
2653
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityRelation"
2654
- },
2655
- "type": "array"
2656
- },
2657
- "error": {
2658
- "$ref": "GoogleRpcStatus",
2659
- "description": "Any error that occurred while processing this document."
2660
- },
2661
- "mimeType": {
2662
- "description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).",
2663
- "type": "string"
2664
- },
2665
- "pages": {
2666
- "description": "Visual page layout for the Document.",
2667
- "items": {
2668
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPage"
2669
- },
2670
- "type": "array"
2671
- },
2672
- "revisions": {
2673
- "description": "Placeholder. Revision history of this document.",
2674
- "items": {
2675
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentRevision"
2676
- },
2677
- "type": "array"
2678
- },
2679
- "shardInfo": {
2680
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentShardInfo",
2681
- "description": "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."
2682
- },
2683
- "text": {
2684
- "description": "Optional. UTF-8 encoded text in reading order from the document.",
2685
- "type": "string"
2686
- },
2687
- "textChanges": {
2688
- "description": "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.",
2689
- "items": {
2690
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextChange"
2691
- },
2692
- "type": "array"
2693
- },
2694
- "textStyles": {
2695
- "deprecated": true,
2696
- "description": "Styles for the Document.text.",
2697
- "items": {
2698
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle"
2699
- },
2700
- "type": "array"
2701
- },
2702
- "uri": {
2703
- "description": "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).",
2704
- "type": "string"
2705
- }
2706
- },
2707
- "type": "object"
2708
- },
2709
- "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument": {
2710
- "description": "Represents the chunks that the document is divided into.",
2711
- "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument",
2712
- "properties": {
2713
- "chunks": {
2714
- "description": "List of chunks.",
2715
- "items": {
2716
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk"
2717
- },
2718
- "type": "array"
2719
- }
2720
- },
2721
- "type": "object"
2722
- },
2723
- "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk": {
2724
- "description": "Represents a chunk.",
2725
- "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk",
2726
- "properties": {
2727
- "chunkId": {
2728
- "description": "ID of the chunk.",
2729
- "type": "string"
2730
- },
2731
- "content": {
2732
- "description": "Text content of the chunk.",
2733
- "type": "string"
2734
- },
2735
- "pageFooters": {
2736
- "description": "Page footers associated with the chunk.",
2737
- "items": {
2738
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter"
2739
- },
2740
- "type": "array"
2741
- },
2742
- "pageHeaders": {
2743
- "description": "Page headers associated with the chunk.",
2744
- "items": {
2745
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader"
2746
- },
2747
- "type": "array"
2748
- },
2749
- "pageSpan": {
2750
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan",
2751
- "description": "Page span of the chunk."
2752
- },
2753
- "sourceBlockIds": {
2754
- "description": "Unused.",
2755
- "items": {
2756
- "type": "string"
2757
- },
2758
- "type": "array"
2759
- }
2760
- },
2761
- "type": "object"
2762
- },
2763
- "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter": {
2764
- "description": "Represents the page footer associated with the chunk.",
2765
- "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter",
2766
- "properties": {
2767
- "pageSpan": {
2768
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan",
2769
- "description": "Page span of the footer."
2770
- },
2771
- "text": {
2772
- "description": "Footer in text format.",
2773
- "type": "string"
2774
- }
2775
- },
2776
- "type": "object"
2777
- },
2778
- "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader": {
2779
- "description": "Represents the page header associated with the chunk.",
2780
- "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader",
2781
- "properties": {
2782
- "pageSpan": {
2783
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan",
2784
- "description": "Page span of the header."
2785
- },
2786
- "text": {
2787
- "description": "Header in text format.",
2788
- "type": "string"
2789
- }
2790
- },
2791
- "type": "object"
2792
- },
2793
- "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan": {
2794
- "description": "Represents where the chunk starts and ends in the document.",
2795
- "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan",
2796
- "properties": {
2797
- "pageEnd": {
2798
- "description": "Page where chunk ends in the document.",
2799
- "format": "int32",
2800
- "type": "integer"
2801
- },
2802
- "pageStart": {
2803
- "description": "Page where chunk starts in the document.",
2804
- "format": "int32",
2805
- "type": "integer"
2806
- }
2807
- },
2808
- "type": "object"
2809
- },
2810
- "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout": {
2811
- "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.",
2812
- "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout",
2813
- "properties": {
2814
- "blocks": {
2815
- "description": "List of blocks in the document.",
2816
- "items": {
2817
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock"
2818
- },
2819
- "type": "array"
2820
- }
2821
- },
2822
- "type": "object"
2823
- },
2824
- "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock": {
2825
- "description": "Represents a block. A block could be one of the various types (text, table, list) supported.",
2826
- "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock",
2827
- "properties": {
2828
- "blockId": {
2829
- "description": "ID of the block.",
2830
- "type": "string"
2831
- },
2832
- "listBlock": {
2833
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock",
2834
- "description": "Block consisting of list content/structure."
2835
- },
2836
- "pageSpan": {
2837
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan",
2838
- "description": "Page span of the block."
2839
- },
2840
- "tableBlock": {
2841
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock",
2842
- "description": "Block consisting of table content/structure."
2843
- },
2844
- "textBlock": {
2845
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
2846
- "description": "Block consisting of text content."
2847
- }
2848
- },
2849
- "type": "object"
2850
- },
2851
- "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": {
2852
- "description": "Represents a list type block.",
2853
- "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock",
2854
- "properties": {
2855
- "listEntries": {
2856
- "description": "List entries that constitute a list block.",
2857
- "items": {
2858
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry"
2859
- },
2860
- "type": "array"
2861
- },
2862
- "type": {
2863
- "description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.",
2864
- "type": "string"
2865
- }
2866
- },
2867
- "type": "object"
2868
- },
2869
- "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": {
2870
- "description": "Represents an entry in the list.",
2871
- "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry",
2872
- "properties": {
2873
- "blocks": {
2874
- "description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.",
2875
- "items": {
2876
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock"
2877
- },
2878
- "type": "array"
2879
- }
2880
- },
2881
- "type": "object"
2882
- },
2883
- "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": {
2884
- "description": "Represents where the block starts and ends in the document.",
2885
- "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan",
2886
- "properties": {
2887
- "pageEnd": {
2888
- "description": "Page where block ends in the document.",
2889
- "format": "int32",
2890
- "type": "integer"
2891
- },
2892
- "pageStart": {
2893
- "description": "Page where block starts in the document.",
2894
- "format": "int32",
2895
- "type": "integer"
2896
- }
2897
- },
2898
- "type": "object"
2899
- },
2900
- "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": {
2901
- "description": "Represents a table type block.",
2902
- "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock",
2903
- "properties": {
2904
- "bodyRows": {
2905
- "description": "Body rows containing main table content.",
2906
- "items": {
2907
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow"
2908
- },
2909
- "type": "array"
2910
- },
2911
- "caption": {
2912
- "description": "Table caption/title.",
2913
- "type": "string"
2914
- },
2915
- "headerRows": {
2916
- "description": "Header rows at the top of the table.",
2917
- "items": {
2918
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow"
2919
- },
2920
- "type": "array"
2921
- }
2922
- },
2923
- "type": "object"
2924
- },
2925
- "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": {
2926
- "description": "Represents a cell in a table row.",
2927
- "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell",
2928
- "properties": {
2929
- "blocks": {
2930
- "description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.",
2931
- "items": {
2932
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock"
2933
- },
2934
- "type": "array"
2935
- },
2936
- "colSpan": {
2937
- "description": "How many columns this cell spans.",
2938
- "format": "int32",
2939
- "type": "integer"
2940
- },
2941
- "rowSpan": {
2942
- "description": "How many rows this cell spans.",
2943
- "format": "int32",
2944
- "type": "integer"
2945
- }
2946
- },
2947
- "type": "object"
2948
- },
2949
- "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": {
2950
- "description": "Represents a row in a table.",
2951
- "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow",
2952
- "properties": {
2953
- "cells": {
2954
- "description": "A table row is a list of table cells.",
2955
- "items": {
2956
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell"
2957
- },
2958
- "type": "array"
2959
- }
2960
- },
2961
- "type": "object"
2962
- },
2963
- "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": {
2964
- "description": "Represents a text type block.",
2965
- "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
2966
- "properties": {
2967
- "blocks": {
2968
- "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.",
2969
- "items": {
2970
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock"
2971
- },
2972
- "type": "array"
2973
- },
2974
- "text": {
2975
- "description": "Text content stored in the block.",
2976
- "type": "string"
2977
- },
2978
- "type": {
2979
- "description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.",
2980
- "type": "string"
2981
- }
2982
- },
2983
- "type": "object"
2984
- },
2985
- "GoogleCloudDocumentaiV1beta1DocumentEntity": {
2986
- "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.",
2987
- "id": "GoogleCloudDocumentaiV1beta1DocumentEntity",
2988
- "properties": {
2989
- "confidence": {
2990
- "description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.",
2991
- "format": "float",
2992
- "type": "number"
2993
- },
2994
- "id": {
2995
- "description": "Optional. Canonical id. This will be a unique value in the entity list for this document.",
2996
- "type": "string"
2997
- },
2998
- "mentionId": {
2999
- "description": "Optional. Deprecated. Use `id` field instead.",
3000
- "type": "string"
3001
- },
3002
- "mentionText": {
3003
- "description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.",
3004
- "type": "string"
3005
- },
3006
- "normalizedValue": {
3007
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue",
3008
- "description": "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."
3009
- },
3010
- "pageAnchor": {
3011
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageAnchor",
3012
- "description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found."
3013
- },
3014
- "properties": {
3015
- "description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.",
3016
- "items": {
3017
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntity"
3018
- },
3019
- "type": "array"
3020
- },
3021
- "provenance": {
3022
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
3023
- "description": "Optional. The history of this annotation."
3024
- },
3025
- "redacted": {
3026
- "description": "Optional. Whether the entity will be redacted for de-identification purposes.",
3027
- "type": "boolean"
3028
- },
3029
- "textAnchor": {
3030
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
3031
- "description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text."
3032
- },
3033
- "type": {
3034
- "description": "Required. Entity type from a schema e.g. `Address`.",
3035
- "type": "string"
3036
- }
3037
- },
3038
- "type": "object"
3039
- },
3040
- "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue": {
3041
- "description": "Parsed and normalized entity value.",
3042
- "id": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue",
3043
- "properties": {
3044
- "addressValue": {
3045
- "$ref": "GoogleTypePostalAddress",
3046
- "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto"
3047
- },
3048
- "booleanValue": {
3049
- "description": "Boolean value. Can be used for entities with binary values, or for checkboxes.",
3050
- "type": "boolean"
3051
- },
3052
- "dateValue": {
3053
- "$ref": "GoogleTypeDate",
3054
- "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto"
3055
- },
3056
- "datetimeValue": {
3057
- "$ref": "GoogleTypeDateTime",
3058
- "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto"
3059
- },
3060
- "floatValue": {
3061
- "description": "Float value.",
3062
- "format": "float",
3063
- "type": "number"
3064
- },
3065
- "integerValue": {
3066
- "description": "Integer value.",
3067
- "format": "int32",
3068
- "type": "integer"
3069
- },
3070
- "moneyValue": {
3071
- "$ref": "GoogleTypeMoney",
3072
- "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto"
3073
- },
3074
- "text": {
3075
- "description": "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.",
3076
- "type": "string"
3077
- }
3078
- },
3079
- "type": "object"
3080
- },
3081
- "GoogleCloudDocumentaiV1beta1DocumentEntityRelation": {
3082
- "description": "Relationship between Entities.",
3083
- "id": "GoogleCloudDocumentaiV1beta1DocumentEntityRelation",
3084
- "properties": {
3085
- "objectId": {
3086
- "description": "Object entity id.",
3087
- "type": "string"
3088
- },
3089
- "relation": {
3090
- "description": "Relationship description.",
3091
- "type": "string"
3092
- },
3093
- "subjectId": {
3094
- "description": "Subject entity id.",
3095
- "type": "string"
3096
- }
3097
- },
3098
- "type": "object"
3099
- },
3100
- "GoogleCloudDocumentaiV1beta1DocumentPage": {
3101
- "description": "A page in a Document.",
3102
- "id": "GoogleCloudDocumentaiV1beta1DocumentPage",
3103
- "properties": {
3104
- "blocks": {
3105
- "description": "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.",
3106
- "items": {
3107
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageBlock"
3108
- },
3109
- "type": "array"
3110
- },
3111
- "detectedBarcodes": {
3112
- "description": "A list of detected barcodes.",
3113
- "items": {
3114
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode"
3115
- },
3116
- "type": "array"
3117
- },
3118
- "detectedLanguages": {
3119
- "description": "A list of detected languages together with confidence.",
3120
- "items": {
3121
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3122
- },
3123
- "type": "array"
3124
- },
3125
- "dimension": {
3126
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDimension",
3127
- "description": "Physical dimension of the page."
3128
- },
3129
- "formFields": {
3130
- "description": "A list of visually detected form fields on the page.",
3131
- "items": {
3132
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageFormField"
3133
- },
3134
- "type": "array"
3135
- },
3136
- "image": {
3137
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImage",
3138
- "description": "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."
3139
- },
3140
- "imageQualityScores": {
3141
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores",
3142
- "description": "Image quality scores."
3143
- },
3144
- "layout": {
3145
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3146
- "description": "Layout for the page."
3147
- },
3148
- "lines": {
3149
- "description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.",
3150
- "items": {
3151
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLine"
3152
- },
3153
- "type": "array"
3154
- },
3155
- "pageNumber": {
3156
- "description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.",
3157
- "format": "int32",
3158
- "type": "integer"
3159
- },
3160
- "paragraphs": {
3161
- "description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.",
3162
- "items": {
3163
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageParagraph"
3164
- },
3165
- "type": "array"
3166
- },
3167
- "provenance": {
3168
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
3169
- "deprecated": true,
3170
- "description": "The history of this page."
3171
- },
3172
- "symbols": {
3173
- "description": "A list of visually detected symbols on the page.",
3174
- "items": {
3175
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageSymbol"
3176
- },
3177
- "type": "array"
3178
- },
3179
- "tables": {
3180
- "description": "A list of visually detected tables on the page.",
3181
- "items": {
3182
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTable"
3183
- },
3184
- "type": "array"
3185
- },
3186
- "tokens": {
3187
- "description": "A list of visually detected tokens on the page.",
3188
- "items": {
3189
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageToken"
3190
- },
3191
- "type": "array"
3192
- },
3193
- "transforms": {
3194
- "description": "Transformation matrices that were applied to the original document image to produce Page.image.",
3195
- "items": {
3196
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageMatrix"
3197
- },
3198
- "type": "array"
3199
- },
3200
- "visualElements": {
3201
- "description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.",
3202
- "items": {
3203
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement"
3204
- },
3205
- "type": "array"
3206
- }
3207
- },
3208
- "type": "object"
3209
- },
3210
- "GoogleCloudDocumentaiV1beta1DocumentPageAnchor": {
3211
- "description": "Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.",
3212
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageAnchor",
3213
- "properties": {
3214
- "pageRefs": {
3215
- "description": "One or more references to visual page elements",
3216
- "items": {
3217
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef"
3218
- },
3219
- "type": "array"
3220
- }
3221
- },
3222
- "type": "object"
3223
- },
3224
- "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef": {
3225
- "description": "Represents a weak reference to a page element within a document.",
3226
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef",
3227
- "properties": {
3228
- "boundingPoly": {
3229
- "$ref": "GoogleCloudDocumentaiV1beta1BoundingPoly",
3230
- "description": "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."
3231
- },
3232
- "confidence": {
3233
- "description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.",
3234
- "format": "float",
3235
- "type": "number"
3236
- },
3237
- "layoutId": {
3238
- "deprecated": true,
3239
- "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.",
3240
- "type": "string"
3241
- },
3242
- "layoutType": {
3243
- "description": "Optional. The type of the layout element that is being referenced if any.",
3244
- "enum": [
3245
- "LAYOUT_TYPE_UNSPECIFIED",
3246
- "BLOCK",
3247
- "PARAGRAPH",
3248
- "LINE",
3249
- "TOKEN",
3250
- "VISUAL_ELEMENT",
3251
- "TABLE",
3252
- "FORM_FIELD"
3253
- ],
3254
- "enumDescriptions": [
3255
- "Layout Unspecified.",
3256
- "References a Page.blocks element.",
3257
- "References a Page.paragraphs element.",
3258
- "References a Page.lines element.",
3259
- "References a Page.tokens element.",
3260
- "References a Page.visual_elements element.",
3261
- "Refrrences a Page.tables element.",
3262
- "References a Page.form_fields element."
3263
- ],
3264
- "type": "string"
3265
- },
3266
- "page": {
3267
- "description": "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.",
3268
- "format": "int64",
3269
- "type": "string"
3270
- }
3271
- },
3272
- "type": "object"
3273
- },
3274
- "GoogleCloudDocumentaiV1beta1DocumentPageBlock": {
3275
- "description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.",
3276
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageBlock",
3277
- "properties": {
3278
- "detectedLanguages": {
3279
- "description": "A list of detected languages together with confidence.",
3280
- "items": {
3281
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3282
- },
3283
- "type": "array"
3284
- },
3285
- "layout": {
3286
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3287
- "description": "Layout for Block."
3288
- },
3289
- "provenance": {
3290
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
3291
- "deprecated": true,
3292
- "description": "The history of this annotation."
3293
- }
3294
- },
3295
- "type": "object"
3296
- },
3297
- "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode": {
3298
- "description": "A detected barcode.",
3299
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode",
3300
- "properties": {
3301
- "barcode": {
3302
- "$ref": "GoogleCloudDocumentaiV1beta1Barcode",
3303
- "description": "Detailed barcode information of the DetectedBarcode."
3304
- },
3305
- "layout": {
3306
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3307
- "description": "Layout for DetectedBarcode."
3308
- }
3309
- },
3310
- "type": "object"
3311
- },
3312
- "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage": {
3313
- "description": "Detected language for a structural component.",
3314
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage",
3315
- "properties": {
3316
- "confidence": {
3317
- "description": "Confidence of detected language. Range `[0, 1]`.",
3318
- "format": "float",
3319
- "type": "number"
3320
- },
3321
- "languageCode": {
3322
- "description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.",
3323
- "type": "string"
3324
- }
3325
- },
3326
- "type": "object"
3327
- },
3328
- "GoogleCloudDocumentaiV1beta1DocumentPageDimension": {
3329
- "description": "Dimension for the page.",
3330
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageDimension",
3331
- "properties": {
3332
- "height": {
3333
- "description": "Page height.",
3334
- "format": "float",
3335
- "type": "number"
3336
- },
3337
- "unit": {
3338
- "description": "Dimension unit.",
3339
- "type": "string"
3340
- },
3341
- "width": {
3342
- "description": "Page width.",
3343
- "format": "float",
3344
- "type": "number"
3345
- }
3346
- },
3347
- "type": "object"
3348
- },
3349
- "GoogleCloudDocumentaiV1beta1DocumentPageFormField": {
3350
- "description": "A form field detected on the page.",
3351
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageFormField",
3352
- "properties": {
3353
- "correctedKeyText": {
3354
- "description": "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.",
3355
- "type": "string"
3356
- },
3357
- "correctedValueText": {
3358
- "description": "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.",
3359
- "type": "string"
3360
- },
3361
- "fieldName": {
3362
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3363
- "description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc."
3364
- },
3365
- "fieldValue": {
3366
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3367
- "description": "Layout for the FormField value."
3368
- },
3369
- "nameDetectedLanguages": {
3370
- "description": "A list of detected languages for name together with confidence.",
3371
- "items": {
3372
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3373
- },
3374
- "type": "array"
3375
- },
3376
- "provenance": {
3377
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
3378
- "description": "The history of this annotation."
3379
- },
3380
- "valueDetectedLanguages": {
3381
- "description": "A list of detected languages for value together with confidence.",
3382
- "items": {
3383
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3384
- },
3385
- "type": "array"
3386
- },
3387
- "valueType": {
3388
- "description": "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`",
3389
- "type": "string"
3390
- }
3391
- },
3392
- "type": "object"
3393
- },
3394
- "GoogleCloudDocumentaiV1beta1DocumentPageImage": {
3395
- "description": "Rendered image contents for this page.",
3396
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageImage",
3397
- "properties": {
3398
- "content": {
3399
- "description": "Raw byte content of the image.",
3400
- "format": "byte",
3401
- "type": "string"
3402
- },
3403
- "height": {
3404
- "description": "Height of the image in pixels.",
3405
- "format": "int32",
3406
- "type": "integer"
3407
- },
3408
- "mimeType": {
3409
- "description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.",
3410
- "type": "string"
3411
- },
3412
- "width": {
3413
- "description": "Width of the image in pixels.",
3414
- "format": "int32",
3415
- "type": "integer"
3416
- }
3417
- },
3418
- "type": "object"
3419
- },
3420
- "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores": {
3421
- "description": "Image quality scores for the page image.",
3422
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores",
3423
- "properties": {
3424
- "detectedDefects": {
3425
- "description": "A list of detected defects.",
3426
- "items": {
3427
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect"
3428
- },
3429
- "type": "array"
3430
- },
3431
- "qualityScore": {
3432
- "description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.",
3433
- "format": "float",
3434
- "type": "number"
3435
- }
3436
- },
3437
- "type": "object"
3438
- },
3439
- "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect": {
3440
- "description": "Image Quality Defects",
3441
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect",
3442
- "properties": {
3443
- "confidence": {
3444
- "description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.",
3445
- "format": "float",
3446
- "type": "number"
3447
- },
3448
- "type": {
3449
- "description": "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`",
3450
- "type": "string"
3451
- }
3452
- },
3453
- "type": "object"
3454
- },
3455
- "GoogleCloudDocumentaiV1beta1DocumentPageLayout": {
3456
- "description": "Visual element describing a layout unit on a page.",
3457
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3458
- "properties": {
3459
- "boundingPoly": {
3460
- "$ref": "GoogleCloudDocumentaiV1beta1BoundingPoly",
3461
- "description": "The bounding polygon for the Layout."
3462
- },
3463
- "confidence": {
3464
- "description": "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]`.",
3465
- "format": "float",
3466
- "type": "number"
3467
- },
3468
- "orientation": {
3469
- "description": "Detected orientation for the Layout.",
3470
- "enum": [
3471
- "ORIENTATION_UNSPECIFIED",
3472
- "PAGE_UP",
3473
- "PAGE_RIGHT",
3474
- "PAGE_DOWN",
3475
- "PAGE_LEFT"
3476
- ],
3477
- "enumDescriptions": [
3478
- "Unspecified orientation.",
3479
- "Orientation is aligned with page up.",
3480
- "Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.",
3481
- "Orientation is aligned with page down. Turn the head 180 degrees from upright to read.",
3482
- "Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read."
3483
- ],
3484
- "type": "string"
3485
- },
3486
- "textAnchor": {
3487
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
3488
- "description": "Text anchor indexing into the Document.text."
3489
- }
3490
- },
3491
- "type": "object"
3492
- },
3493
- "GoogleCloudDocumentaiV1beta1DocumentPageLine": {
3494
- "description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.",
3495
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageLine",
3496
- "properties": {
3497
- "detectedLanguages": {
3498
- "description": "A list of detected languages together with confidence.",
3499
- "items": {
3500
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3501
- },
3502
- "type": "array"
3503
- },
3504
- "layout": {
3505
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3506
- "description": "Layout for Line."
3507
- },
3508
- "provenance": {
3509
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
3510
- "deprecated": true,
3511
- "description": "The history of this annotation."
3512
- }
3513
- },
3514
- "type": "object"
3515
- },
3516
- "GoogleCloudDocumentaiV1beta1DocumentPageMatrix": {
3517
- "description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.",
3518
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageMatrix",
3519
- "properties": {
3520
- "cols": {
3521
- "description": "Number of columns in the matrix.",
3522
- "format": "int32",
3523
- "type": "integer"
3524
- },
3525
- "data": {
3526
- "description": "The matrix data.",
3527
- "format": "byte",
3528
- "type": "string"
3529
- },
3530
- "rows": {
3531
- "description": "Number of rows in the matrix.",
3532
- "format": "int32",
3533
- "type": "integer"
3534
- },
3535
- "type": {
3536
- "description": "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",
3537
- "format": "int32",
3538
- "type": "integer"
3539
- }
3540
- },
3541
- "type": "object"
3542
- },
3543
- "GoogleCloudDocumentaiV1beta1DocumentPageParagraph": {
3544
- "description": "A collection of lines that a human would perceive as a paragraph.",
3545
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageParagraph",
3546
- "properties": {
3547
- "detectedLanguages": {
3548
- "description": "A list of detected languages together with confidence.",
3549
- "items": {
3550
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3551
- },
3552
- "type": "array"
3553
- },
3554
- "layout": {
3555
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3556
- "description": "Layout for Paragraph."
3557
- },
3558
- "provenance": {
3559
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
3560
- "deprecated": true,
3561
- "description": "The history of this annotation."
3562
- }
3563
- },
3564
- "type": "object"
3565
- },
3566
- "GoogleCloudDocumentaiV1beta1DocumentPageSymbol": {
3567
- "description": "A detected symbol.",
3568
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageSymbol",
3569
- "properties": {
3570
- "detectedLanguages": {
3571
- "description": "A list of detected languages together with confidence.",
3572
- "items": {
3573
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3574
- },
3575
- "type": "array"
3576
- },
3577
- "layout": {
3578
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3579
- "description": "Layout for Symbol."
3580
- }
3581
- },
3582
- "type": "object"
3583
- },
3584
- "GoogleCloudDocumentaiV1beta1DocumentPageTable": {
3585
- "description": "A table representation similar to HTML table structure.",
3586
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageTable",
3587
- "properties": {
3588
- "bodyRows": {
3589
- "description": "Body rows of the table.",
3590
- "items": {
3591
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow"
3592
- },
3593
- "type": "array"
3594
- },
3595
- "detectedLanguages": {
3596
- "description": "A list of detected languages together with confidence.",
3597
- "items": {
3598
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3599
- },
3600
- "type": "array"
3601
- },
3602
- "headerRows": {
3603
- "description": "Header rows of the table.",
3604
- "items": {
3605
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow"
3606
- },
3607
- "type": "array"
3608
- },
3609
- "layout": {
3610
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3611
- "description": "Layout for Table."
3612
- },
3613
- "provenance": {
3614
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
3615
- "deprecated": true,
3616
- "description": "The history of this table."
3617
- }
3618
- },
3619
- "type": "object"
3620
- },
3621
- "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell": {
3622
- "description": "A cell representation inside the table.",
3623
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell",
3624
- "properties": {
3625
- "colSpan": {
3626
- "description": "How many columns this cell spans.",
3627
- "format": "int32",
3628
- "type": "integer"
3629
- },
3630
- "detectedLanguages": {
3631
- "description": "A list of detected languages together with confidence.",
3632
- "items": {
3633
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3634
- },
3635
- "type": "array"
3636
- },
3637
- "layout": {
3638
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3639
- "description": "Layout for TableCell."
3640
- },
3641
- "rowSpan": {
3642
- "description": "How many rows this cell spans.",
3643
- "format": "int32",
3644
- "type": "integer"
3645
- }
3646
- },
3647
- "type": "object"
3648
- },
3649
- "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow": {
3650
- "description": "A row of table cells.",
3651
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow",
3652
- "properties": {
3653
- "cells": {
3654
- "description": "Cells that make up this row.",
3655
- "items": {
3656
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell"
3657
- },
3658
- "type": "array"
3659
- }
3660
- },
3661
- "type": "object"
3662
- },
3663
- "GoogleCloudDocumentaiV1beta1DocumentPageToken": {
3664
- "description": "A detected token.",
3665
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageToken",
3666
- "properties": {
3667
- "detectedBreak": {
3668
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak",
3669
- "description": "Detected break at the end of a Token."
3670
- },
3671
- "detectedLanguages": {
3672
- "description": "A list of detected languages together with confidence.",
3673
- "items": {
3674
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3675
- },
3676
- "type": "array"
3677
- },
3678
- "layout": {
3679
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3680
- "description": "Layout for Token."
3681
- },
3682
- "provenance": {
3683
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
3684
- "deprecated": true,
3685
- "description": "The history of this annotation."
3686
- },
3687
- "styleInfo": {
3688
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo",
3689
- "description": "Text style attributes."
3690
- }
3691
- },
3692
- "type": "object"
3693
- },
3694
- "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak": {
3695
- "description": "Detected break at the end of a Token.",
3696
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak",
3697
- "properties": {
3698
- "type": {
3699
- "description": "Detected break type.",
3700
- "enum": [
3701
- "TYPE_UNSPECIFIED",
3702
- "SPACE",
3703
- "WIDE_SPACE",
3704
- "HYPHEN"
3705
- ],
3706
- "enumDescriptions": [
3707
- "Unspecified break type.",
3708
- "A single whitespace.",
3709
- "A wider whitespace.",
3710
- "A hyphen that indicates that a token has been split across lines."
3711
- ],
3712
- "type": "string"
3713
- }
3714
- },
3715
- "type": "object"
3716
- },
3717
- "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo": {
3718
- "description": "Font and other text style attributes.",
3719
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo",
3720
- "properties": {
3721
- "backgroundColor": {
3722
- "$ref": "GoogleTypeColor",
3723
- "description": "Color of the background."
3724
- },
3725
- "bold": {
3726
- "description": "Whether the text is bold (equivalent to font_weight is at least `700`).",
3727
- "type": "boolean"
3728
- },
3729
- "fontSize": {
3730
- "description": "Font size in points (`1` point is `\u00b9\u2044\u2087\u2082` inches).",
3731
- "format": "int32",
3732
- "type": "integer"
3733
- },
3734
- "fontType": {
3735
- "description": "Name or style of the font.",
3736
- "type": "string"
3737
- },
3738
- "fontWeight": {
3739
- "description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.",
3740
- "format": "int32",
3741
- "type": "integer"
3742
- },
3743
- "handwritten": {
3744
- "description": "Whether the text is handwritten.",
3745
- "type": "boolean"
3746
- },
3747
- "italic": {
3748
- "description": "Whether the text is italic.",
3749
- "type": "boolean"
3750
- },
3751
- "letterSpacing": {
3752
- "description": "Letter spacing in points.",
3753
- "format": "double",
3754
- "type": "number"
3755
- },
3756
- "pixelFontSize": {
3757
- "description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ \u00f7 `72.0`.",
3758
- "format": "double",
3759
- "type": "number"
3760
- },
3761
- "smallcaps": {
3762
- "description": "Whether the text is in small caps. This feature is not supported yet.",
3763
- "type": "boolean"
3764
- },
3765
- "strikeout": {
3766
- "description": "Whether the text is strikethrough. This feature is not supported yet.",
3767
- "type": "boolean"
3768
- },
3769
- "subscript": {
3770
- "description": "Whether the text is a subscript. This feature is not supported yet.",
3771
- "type": "boolean"
3772
- },
3773
- "superscript": {
3774
- "description": "Whether the text is a superscript. This feature is not supported yet.",
3775
- "type": "boolean"
3776
- },
3777
- "textColor": {
3778
- "$ref": "GoogleTypeColor",
3779
- "description": "Color of the text."
3780
- },
3781
- "underlined": {
3782
- "description": "Whether the text is underlined.",
3783
- "type": "boolean"
3784
- }
3785
- },
3786
- "type": "object"
3787
- },
3788
- "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement": {
3789
- "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.",
3790
- "id": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement",
3791
- "properties": {
3792
- "detectedLanguages": {
3793
- "description": "A list of detected languages together with confidence.",
3794
- "items": {
3795
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
3796
- },
3797
- "type": "array"
3798
- },
3799
- "layout": {
3800
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
3801
- "description": "Layout for VisualElement."
3802
- },
3803
- "type": {
3804
- "description": "Type of the VisualElement.",
3805
- "type": "string"
3806
- }
3807
- },
3808
- "type": "object"
3809
- },
3810
- "GoogleCloudDocumentaiV1beta1DocumentProvenance": {
3811
- "description": "Structure to identify provenance relationships between annotations in different revisions.",
3812
- "id": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
3813
- "properties": {
3814
- "id": {
3815
- "deprecated": true,
3816
- "description": "The Id of this operation. Needs to be unique within the scope of the revision.",
3817
- "format": "int32",
3818
- "type": "integer"
3819
- },
3820
- "parents": {
3821
- "description": "References to the original elements that are replaced.",
3822
- "items": {
3823
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent"
3824
- },
3825
- "type": "array"
3826
- },
3827
- "revision": {
3828
- "deprecated": true,
3829
- "description": "The index of the revision that produced this element.",
3830
- "format": "int32",
3831
- "type": "integer"
3832
- },
3833
- "type": {
3834
- "description": "The type of provenance operation.",
3835
- "enum": [
3836
- "OPERATION_TYPE_UNSPECIFIED",
3837
- "ADD",
3838
- "REMOVE",
3839
- "UPDATE",
3840
- "REPLACE",
3841
- "EVAL_REQUESTED",
3842
- "EVAL_APPROVED",
3843
- "EVAL_SKIPPED"
3844
- ],
3845
- "enumDeprecated": [
3846
- false,
3847
- false,
3848
- false,
3849
- false,
3850
- false,
3851
- true,
3852
- true,
3853
- true
3854
- ],
3855
- "enumDescriptions": [
3856
- "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.",
3857
- "Add an element.",
3858
- "Remove an element identified by `parent`.",
3859
- "Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.",
3860
- "Currently unused. Replace an element identified by `parent`.",
3861
- "Deprecated. Request human review for the element identified by `parent`.",
3862
- "Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.",
3863
- "Deprecated. Element is skipped in the validation process."
3864
- ],
3865
- "type": "string"
3866
- }
3867
- },
3868
- "type": "object"
3869
- },
3870
- "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent": {
3871
- "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.",
3872
- "id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent",
3873
- "properties": {
3874
- "id": {
3875
- "deprecated": true,
3876
- "description": "The id of the parent provenance.",
3877
- "format": "int32",
3878
- "type": "integer"
3879
- },
3880
- "index": {
3881
- "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.",
3882
- "format": "int32",
3883
- "type": "integer"
3884
- },
3885
- "revision": {
3886
- "description": "The index of the index into current revision's parent_ids list.",
3887
- "format": "int32",
3888
- "type": "integer"
3889
- }
3890
- },
3891
- "type": "object"
3892
- },
3893
- "GoogleCloudDocumentaiV1beta1DocumentRevision": {
3894
- "description": "Contains past or forward revisions of this document.",
3895
- "id": "GoogleCloudDocumentaiV1beta1DocumentRevision",
3896
- "properties": {
3897
- "agent": {
3898
- "description": "If the change was made by a person specify the name or id of that person.",
3899
- "type": "string"
3900
- },
3901
- "createTime": {
3902
- "description": "The time that the revision was created, internally generated by doc proto storage at the time of create.",
3903
- "format": "google-datetime",
3904
- "type": "string"
3905
- },
3906
- "humanReview": {
3907
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview",
3908
- "description": "Human Review information of this revision."
3909
- },
3910
- "id": {
3911
- "description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.",
3912
- "type": "string"
3913
- },
3914
- "parent": {
3915
- "deprecated": true,
3916
- "description": "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.",
3917
- "items": {
3918
- "format": "int32",
3919
- "type": "integer"
3920
- },
3921
- "type": "array"
3922
- },
3923
- "parentIds": {
3924
- "description": "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.",
3925
- "items": {
3926
- "type": "string"
3927
- },
3928
- "type": "array"
3929
- },
3930
- "processor": {
3931
- "description": "If the annotation was made by processor identify the processor by its resource name.",
3932
- "type": "string"
3933
- }
3934
- },
3935
- "type": "object"
3936
- },
3937
- "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview": {
3938
- "description": "Human Review information of the document.",
3939
- "id": "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview",
3940
- "properties": {
3941
- "state": {
3942
- "description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.",
3943
- "type": "string"
3944
- },
3945
- "stateMessage": {
3946
- "description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.",
3947
- "type": "string"
3948
- }
3949
- },
3950
- "type": "object"
3951
- },
3952
- "GoogleCloudDocumentaiV1beta1DocumentShardInfo": {
3953
- "description": "For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.",
3954
- "id": "GoogleCloudDocumentaiV1beta1DocumentShardInfo",
3955
- "properties": {
3956
- "shardCount": {
3957
- "description": "Total number of shards.",
3958
- "format": "int64",
3959
- "type": "string"
3960
- },
3961
- "shardIndex": {
3962
- "description": "The 0-based index of this shard.",
3963
- "format": "int64",
3964
- "type": "string"
3965
- },
3966
- "textOffset": {
3967
- "description": "The index of the first character in Document.text in the overall document global text.",
3968
- "format": "int64",
3969
- "type": "string"
3970
- }
3971
- },
3972
- "type": "object"
3973
- },
3974
- "GoogleCloudDocumentaiV1beta1DocumentStyle": {
3975
- "description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.",
3976
- "id": "GoogleCloudDocumentaiV1beta1DocumentStyle",
3977
- "properties": {
3978
- "backgroundColor": {
3979
- "$ref": "GoogleTypeColor",
3980
- "description": "Text background color."
3981
- },
3982
- "color": {
3983
- "$ref": "GoogleTypeColor",
3984
- "description": "Text color."
3985
- },
3986
- "fontFamily": {
3987
- "description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp",
3988
- "type": "string"
3989
- },
3990
- "fontSize": {
3991
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize",
3992
- "description": "Font size."
3993
- },
3994
- "fontWeight": {
3995
- "description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.",
3996
- "type": "string"
3997
- },
3998
- "textAnchor": {
3999
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
4000
- "description": "Text anchor indexing into the Document.text."
4001
- },
4002
- "textDecoration": {
4003
- "description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ",
4004
- "type": "string"
4005
- },
4006
- "textStyle": {
4007
- "description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.",
4008
- "type": "string"
4009
- }
4010
- },
4011
- "type": "object"
4012
- },
4013
- "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize": {
4014
- "description": "Font size with unit.",
4015
- "id": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize",
4016
- "properties": {
4017
- "size": {
4018
- "description": "Font size for the text.",
4019
- "format": "float",
4020
- "type": "number"
4021
- },
4022
- "unit": {
4023
- "description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).",
4024
- "type": "string"
4025
- }
4026
- },
4027
- "type": "object"
4028
- },
4029
- "GoogleCloudDocumentaiV1beta1DocumentTextAnchor": {
4030
- "description": "Text reference indexing into the Document.text.",
4031
- "id": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
4032
- "properties": {
4033
- "content": {
4034
- "description": "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.",
4035
- "type": "string"
4036
- },
4037
- "textSegments": {
4038
- "description": "The text segments from the Document.text.",
4039
- "items": {
4040
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment"
4041
- },
4042
- "type": "array"
4043
- }
4044
- },
4045
- "type": "object"
4046
- },
4047
- "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment": {
4048
- "description": "A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset",
4049
- "id": "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment",
4050
- "properties": {
4051
- "endIndex": {
4052
- "description": "TextSegment half open end UTF-8 char index in the Document.text.",
4053
- "format": "int64",
4054
- "type": "string"
4055
- },
4056
- "startIndex": {
4057
- "description": "TextSegment start UTF-8 char index in the Document.text.",
4058
- "format": "int64",
4059
- "type": "string"
4060
- }
4061
- },
4062
- "type": "object"
4063
- },
4064
- "GoogleCloudDocumentaiV1beta1DocumentTextChange": {
4065
- "description": "This message is used for text changes aka. OCR corrections.",
4066
- "id": "GoogleCloudDocumentaiV1beta1DocumentTextChange",
4067
- "properties": {
4068
- "changedText": {
4069
- "description": "The text that replaces the text identified in the `text_anchor`.",
4070
- "type": "string"
4071
- },
4072
- "provenance": {
4073
- "deprecated": true,
4074
- "description": "The history of this annotation.",
4075
- "items": {
4076
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance"
4077
- },
4078
- "type": "array"
4079
- },
4080
- "textAnchor": {
4081
- "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
4082
- "description": "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."
4083
- }
4084
- },
4085
- "type": "object"
4086
- },
4087
- "GoogleCloudDocumentaiV1beta1GcsDestination": {
4088
- "description": "The Google Cloud Storage location where the output file will be written to.",
4089
- "id": "GoogleCloudDocumentaiV1beta1GcsDestination",
4090
- "properties": {
4091
- "uri": {
4092
- "type": "string"
4093
- }
4094
- },
4095
- "type": "object"
4096
- },
4097
- "GoogleCloudDocumentaiV1beta1GcsSource": {
4098
- "description": "The Google Cloud Storage location where the input file will be read from.",
4099
- "id": "GoogleCloudDocumentaiV1beta1GcsSource",
4100
- "properties": {
4101
- "uri": {
4102
- "type": "string"
4103
- }
4104
- },
4105
- "type": "object"
4106
- },
4107
- "GoogleCloudDocumentaiV1beta1InputConfig": {
4108
- "description": "The desired input location and metadata.",
4109
- "id": "GoogleCloudDocumentaiV1beta1InputConfig",
4110
- "properties": {
4111
- "gcsSource": {
4112
- "$ref": "GoogleCloudDocumentaiV1beta1GcsSource",
4113
- "description": "The Google Cloud Storage location to read the input from. This must be a single file."
4114
- },
4115
- "mimeType": {
4116
- "description": "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.",
4117
- "type": "string"
4118
- }
4119
- },
4120
- "type": "object"
4121
- },
4122
- "GoogleCloudDocumentaiV1beta1NormalizedVertex": {
4123
- "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.",
4124
- "id": "GoogleCloudDocumentaiV1beta1NormalizedVertex",
4125
- "properties": {
4126
- "x": {
4127
- "description": "X coordinate.",
4128
- "format": "float",
4129
- "type": "number"
4130
- },
4131
- "y": {
4132
- "description": "Y coordinate (starts from the top of the image).",
4133
- "format": "float",
4134
- "type": "number"
4135
- }
4136
- },
4137
- "type": "object"
4138
- },
4139
- "GoogleCloudDocumentaiV1beta1OperationMetadata": {
4140
- "description": "Contains metadata for the BatchProcessDocuments operation.",
4141
- "id": "GoogleCloudDocumentaiV1beta1OperationMetadata",
4142
- "properties": {
4143
- "createTime": {
4144
- "description": "The creation time of the operation.",
4145
- "format": "google-datetime",
4146
- "type": "string"
4147
- },
4148
- "state": {
4149
- "description": "The state of the current batch processing.",
4150
- "enum": [
4151
- "STATE_UNSPECIFIED",
4152
- "ACCEPTED",
4153
- "WAITING",
4154
- "RUNNING",
4155
- "SUCCEEDED",
4156
- "CANCELLED",
4157
- "FAILED"
4158
- ],
4159
- "enumDescriptions": [
4160
- "The default value. This value is used if the state is omitted.",
4161
- "Request is received.",
4162
- "Request operation is waiting for scheduling.",
4163
- "Request is being processed.",
4164
- "The batch processing completed successfully.",
4165
- "The batch processing was cancelled.",
4166
- "The batch processing has failed."
4167
- ],
4168
- "type": "string"
4169
- },
4170
- "stateMessage": {
4171
- "description": "A message providing more details about the current state of processing.",
4172
- "type": "string"
4173
- },
4174
- "updateTime": {
4175
- "description": "The last update time of the operation.",
4176
- "format": "google-datetime",
4177
- "type": "string"
4178
- }
4179
- },
4180
- "type": "object"
4181
- },
4182
- "GoogleCloudDocumentaiV1beta1OutputConfig": {
4183
- "description": "The desired output location and metadata.",
4184
- "id": "GoogleCloudDocumentaiV1beta1OutputConfig",
4185
- "properties": {
4186
- "gcsDestination": {
4187
- "$ref": "GoogleCloudDocumentaiV1beta1GcsDestination",
4188
- "description": "The Google Cloud Storage location to write the output to."
4189
- },
4190
- "pagesPerShard": {
4191
- "description": "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",
4192
- "format": "int32",
4193
- "type": "integer"
4194
- }
4195
- },
4196
- "type": "object"
4197
- },
4198
- "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse": {
4199
- "description": "Response to a single document processing request.",
4200
- "id": "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse",
4201
- "properties": {
4202
- "inputConfig": {
4203
- "$ref": "GoogleCloudDocumentaiV1beta1InputConfig",
4204
- "description": "Information about the input file. This is the same as the corresponding input config in the request."
4205
- },
4206
- "outputConfig": {
4207
- "$ref": "GoogleCloudDocumentaiV1beta1OutputConfig",
4208
- "description": "The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects."
4209
- }
4210
- },
4211
- "type": "object"
4212
- },
4213
- "GoogleCloudDocumentaiV1beta1Vertex": {
4214
- "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.",
4215
- "id": "GoogleCloudDocumentaiV1beta1Vertex",
4216
- "properties": {
4217
- "x": {
4218
- "description": "X coordinate.",
4219
- "format": "int32",
4220
- "type": "integer"
4221
- },
4222
- "y": {
4223
- "description": "Y coordinate (starts from the top of the image).",
4224
- "format": "int32",
4225
- "type": "integer"
4226
- }
4227
- },
4228
- "type": "object"
4229
- },
4230
- "GoogleCloudDocumentaiV1beta2Barcode": {
4231
- "description": "Encodes the detailed information of a barcode.",
4232
- "id": "GoogleCloudDocumentaiV1beta2Barcode",
4233
- "properties": {
4234
- "format": {
4235
- "description": "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.",
4236
- "type": "string"
4237
- },
4238
- "rawValue": {
4239
- "description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.",
4240
- "type": "string"
4241
- },
4242
- "valueFormat": {
4243
- "description": "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.",
4244
- "type": "string"
4245
- }
4246
- },
4247
- "type": "object"
4248
- },
4249
- "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse": {
4250
- "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.",
4251
- "id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse",
4252
- "properties": {
4253
- "responses": {
4254
- "description": "Responses for each individual document.",
4255
- "items": {
4256
- "$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse"
4257
- },
4258
- "type": "array"
4259
- }
4260
- },
4261
- "type": "object"
4262
- },
4263
- "GoogleCloudDocumentaiV1beta2BoundingPoly": {
4264
- "description": "A bounding polygon for the detected image annotation.",
4265
- "id": "GoogleCloudDocumentaiV1beta2BoundingPoly",
4266
- "properties": {
4267
- "normalizedVertices": {
4268
- "description": "The bounding polygon normalized vertices.",
4269
- "items": {
4270
- "$ref": "GoogleCloudDocumentaiV1beta2NormalizedVertex"
4271
- },
4272
- "type": "array"
4273
- },
4274
- "vertices": {
4275
- "description": "The bounding polygon vertices.",
4276
- "items": {
4277
- "$ref": "GoogleCloudDocumentaiV1beta2Vertex"
4278
- },
4279
- "type": "array"
4280
- }
4281
- },
4282
- "type": "object"
4283
- },
4284
- "GoogleCloudDocumentaiV1beta2Document": {
4285
- "description": "Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.",
4286
- "id": "GoogleCloudDocumentaiV1beta2Document",
4287
- "properties": {
4288
- "chunkedDocument": {
4289
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument",
4290
- "description": "Document chunked based on chunking config."
4291
- },
4292
- "content": {
4293
- "description": "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.",
4294
- "format": "byte",
4295
- "type": "string"
4296
- },
4297
- "documentLayout": {
4298
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout",
4299
- "description": "Parsed layout of the document."
4300
- },
4301
- "entities": {
4302
- "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.",
4303
- "items": {
4304
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntity"
4305
- },
4306
- "type": "array"
4307
- },
4308
- "entityRelations": {
4309
- "description": "Placeholder. Relationship among Document.entities.",
4310
- "items": {
4311
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityRelation"
4312
- },
4313
- "type": "array"
4314
- },
4315
- "error": {
4316
- "$ref": "GoogleRpcStatus",
4317
- "description": "Any error that occurred while processing this document."
4318
- },
4319
- "labels": {
4320
- "description": "Labels for this document.",
4321
- "items": {
4322
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentLabel"
4323
- },
4324
- "type": "array"
4325
- },
4326
- "mimeType": {
4327
- "description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).",
4328
- "type": "string"
4329
- },
4330
- "pages": {
4331
- "description": "Visual page layout for the Document.",
4332
- "items": {
4333
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPage"
4334
- },
4335
- "type": "array"
4336
- },
4337
- "revisions": {
4338
- "description": "Placeholder. Revision history of this document.",
4339
- "items": {
4340
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentRevision"
4341
- },
4342
- "type": "array"
4343
- },
4344
- "shardInfo": {
4345
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentShardInfo",
4346
- "description": "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."
4347
- },
4348
- "text": {
4349
- "description": "Optional. UTF-8 encoded text in reading order from the document.",
4350
- "type": "string"
4351
- },
4352
- "textChanges": {
4353
- "description": "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.",
4354
- "items": {
4355
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextChange"
4356
- },
4357
- "type": "array"
4358
- },
4359
- "textStyles": {
4360
- "deprecated": true,
4361
- "description": "Styles for the Document.text.",
4362
- "items": {
4363
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle"
4364
- },
4365
- "type": "array"
4366
- },
4367
- "uri": {
4368
- "description": "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).",
4369
- "type": "string"
4370
- }
4371
- },
4372
- "type": "object"
4373
- },
4374
- "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument": {
4375
- "description": "Represents the chunks that the document is divided into.",
4376
- "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument",
4377
- "properties": {
4378
- "chunks": {
4379
- "description": "List of chunks.",
4380
- "items": {
4381
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk"
4382
- },
4383
- "type": "array"
4384
- }
4385
- },
4386
- "type": "object"
4387
- },
4388
- "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk": {
4389
- "description": "Represents a chunk.",
4390
- "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk",
4391
- "properties": {
4392
- "chunkId": {
4393
- "description": "ID of the chunk.",
4394
- "type": "string"
4395
- },
4396
- "content": {
4397
- "description": "Text content of the chunk.",
4398
- "type": "string"
4399
- },
4400
- "pageFooters": {
4401
- "description": "Page footers associated with the chunk.",
4402
- "items": {
4403
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter"
4404
- },
4405
- "type": "array"
4406
- },
4407
- "pageHeaders": {
4408
- "description": "Page headers associated with the chunk.",
4409
- "items": {
4410
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader"
4411
- },
4412
- "type": "array"
4413
- },
4414
- "pageSpan": {
4415
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan",
4416
- "description": "Page span of the chunk."
4417
- },
4418
- "sourceBlockIds": {
4419
- "description": "Unused.",
4420
- "items": {
4421
- "type": "string"
4422
- },
4423
- "type": "array"
4424
- }
4425
- },
4426
- "type": "object"
4427
- },
4428
- "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter": {
4429
- "description": "Represents the page footer associated with the chunk.",
4430
- "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter",
4431
- "properties": {
4432
- "pageSpan": {
4433
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan",
4434
- "description": "Page span of the footer."
4435
- },
4436
- "text": {
4437
- "description": "Footer in text format.",
4438
- "type": "string"
4439
- }
4440
- },
4441
- "type": "object"
4442
- },
4443
- "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader": {
4444
- "description": "Represents the page header associated with the chunk.",
4445
- "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader",
4446
- "properties": {
4447
- "pageSpan": {
4448
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan",
4449
- "description": "Page span of the header."
4450
- },
4451
- "text": {
4452
- "description": "Header in text format.",
4453
- "type": "string"
4454
- }
4455
- },
4456
- "type": "object"
4457
- },
4458
- "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan": {
4459
- "description": "Represents where the chunk starts and ends in the document.",
4460
- "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan",
4461
- "properties": {
4462
- "pageEnd": {
4463
- "description": "Page where chunk ends in the document.",
4464
- "format": "int32",
4465
- "type": "integer"
4466
- },
4467
- "pageStart": {
4468
- "description": "Page where chunk starts in the document.",
4469
- "format": "int32",
4470
- "type": "integer"
4471
- }
4472
- },
4473
- "type": "object"
4474
- },
4475
- "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout": {
4476
- "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.",
4477
- "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout",
4478
- "properties": {
4479
- "blocks": {
4480
- "description": "List of blocks in the document.",
4481
- "items": {
4482
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock"
4483
- },
4484
- "type": "array"
4485
- }
4486
- },
4487
- "type": "object"
4488
- },
4489
- "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock": {
4490
- "description": "Represents a block. A block could be one of the various types (text, table, list) supported.",
4491
- "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock",
4492
- "properties": {
4493
- "blockId": {
4494
- "description": "ID of the block.",
4495
- "type": "string"
4496
- },
4497
- "listBlock": {
4498
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock",
4499
- "description": "Block consisting of list content/structure."
4500
- },
4501
- "pageSpan": {
4502
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan",
4503
- "description": "Page span of the block."
4504
- },
4505
- "tableBlock": {
4506
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock",
4507
- "description": "Block consisting of table content/structure."
4508
- },
4509
- "textBlock": {
4510
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
4511
- "description": "Block consisting of text content."
4512
- }
4513
- },
4514
- "type": "object"
4515
- },
4516
- "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": {
4517
- "description": "Represents a list type block.",
4518
- "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock",
4519
- "properties": {
4520
- "listEntries": {
4521
- "description": "List entries that constitute a list block.",
4522
- "items": {
4523
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry"
4524
- },
4525
- "type": "array"
4526
- },
4527
- "type": {
4528
- "description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.",
4529
- "type": "string"
4530
- }
4531
- },
4532
- "type": "object"
4533
- },
4534
- "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": {
4535
- "description": "Represents an entry in the list.",
4536
- "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry",
4537
- "properties": {
4538
- "blocks": {
4539
- "description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.",
4540
- "items": {
4541
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock"
4542
- },
4543
- "type": "array"
4544
- }
4545
- },
4546
- "type": "object"
4547
- },
4548
- "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": {
4549
- "description": "Represents where the block starts and ends in the document.",
4550
- "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan",
4551
- "properties": {
4552
- "pageEnd": {
4553
- "description": "Page where block ends in the document.",
4554
- "format": "int32",
4555
- "type": "integer"
4556
- },
4557
- "pageStart": {
4558
- "description": "Page where block starts in the document.",
4559
- "format": "int32",
4560
- "type": "integer"
4561
- }
4562
- },
4563
- "type": "object"
4564
- },
4565
- "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": {
4566
- "description": "Represents a table type block.",
4567
- "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock",
4568
- "properties": {
4569
- "bodyRows": {
4570
- "description": "Body rows containing main table content.",
4571
- "items": {
4572
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow"
4573
- },
4574
- "type": "array"
4575
- },
4576
- "caption": {
4577
- "description": "Table caption/title.",
4578
- "type": "string"
4579
- },
4580
- "headerRows": {
4581
- "description": "Header rows at the top of the table.",
4582
- "items": {
4583
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow"
4584
- },
4585
- "type": "array"
4586
- }
4587
- },
4588
- "type": "object"
4589
- },
4590
- "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": {
4591
- "description": "Represents a cell in a table row.",
4592
- "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell",
4593
- "properties": {
4594
- "blocks": {
4595
- "description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.",
4596
- "items": {
4597
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock"
4598
- },
4599
- "type": "array"
4600
- },
4601
- "colSpan": {
4602
- "description": "How many columns this cell spans.",
4603
- "format": "int32",
4604
- "type": "integer"
4605
- },
4606
- "rowSpan": {
4607
- "description": "How many rows this cell spans.",
4608
- "format": "int32",
4609
- "type": "integer"
4610
- }
4611
- },
4612
- "type": "object"
4613
- },
4614
- "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": {
4615
- "description": "Represents a row in a table.",
4616
- "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow",
4617
- "properties": {
4618
- "cells": {
4619
- "description": "A table row is a list of table cells.",
4620
- "items": {
4621
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell"
4622
- },
4623
- "type": "array"
4624
- }
4625
- },
4626
- "type": "object"
4627
- },
4628
- "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": {
4629
- "description": "Represents a text type block.",
4630
- "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
4631
- "properties": {
4632
- "blocks": {
4633
- "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.",
4634
- "items": {
4635
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock"
4636
- },
4637
- "type": "array"
4638
- },
4639
- "text": {
4640
- "description": "Text content stored in the block.",
4641
- "type": "string"
4642
- },
4643
- "type": {
4644
- "description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.",
4645
- "type": "string"
4646
- }
4647
- },
4648
- "type": "object"
4649
- },
4650
- "GoogleCloudDocumentaiV1beta2DocumentEntity": {
4651
- "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.",
4652
- "id": "GoogleCloudDocumentaiV1beta2DocumentEntity",
4653
- "properties": {
4654
- "confidence": {
4655
- "description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.",
4656
- "format": "float",
4657
- "type": "number"
4658
- },
4659
- "id": {
4660
- "description": "Optional. Canonical id. This will be a unique value in the entity list for this document.",
4661
- "type": "string"
4662
- },
4663
- "mentionId": {
4664
- "description": "Optional. Deprecated. Use `id` field instead.",
4665
- "type": "string"
4666
- },
4667
- "mentionText": {
4668
- "description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.",
4669
- "type": "string"
4670
- },
4671
- "normalizedValue": {
4672
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue",
4673
- "description": "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."
4674
- },
4675
- "pageAnchor": {
4676
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageAnchor",
4677
- "description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found."
4678
- },
4679
- "properties": {
4680
- "description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.",
4681
- "items": {
4682
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntity"
4683
- },
4684
- "type": "array"
4685
- },
4686
- "provenance": {
4687
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
4688
- "description": "Optional. The history of this annotation."
4689
- },
4690
- "redacted": {
4691
- "description": "Optional. Whether the entity will be redacted for de-identification purposes.",
4692
- "type": "boolean"
4693
- },
4694
- "textAnchor": {
4695
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
4696
- "description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text."
4697
- },
4698
- "type": {
4699
- "description": "Required. Entity type from a schema e.g. `Address`.",
4700
- "type": "string"
4701
- }
4702
- },
4703
- "type": "object"
4704
- },
4705
- "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue": {
4706
- "description": "Parsed and normalized entity value.",
4707
- "id": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue",
4708
- "properties": {
4709
- "addressValue": {
4710
- "$ref": "GoogleTypePostalAddress",
4711
- "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto"
4712
- },
4713
- "booleanValue": {
4714
- "description": "Boolean value. Can be used for entities with binary values, or for checkboxes.",
4715
- "type": "boolean"
4716
- },
4717
- "dateValue": {
4718
- "$ref": "GoogleTypeDate",
4719
- "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto"
4720
- },
4721
- "datetimeValue": {
4722
- "$ref": "GoogleTypeDateTime",
4723
- "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto"
4724
- },
4725
- "floatValue": {
4726
- "description": "Float value.",
4727
- "format": "float",
4728
- "type": "number"
4729
- },
4730
- "integerValue": {
4731
- "description": "Integer value.",
4732
- "format": "int32",
4733
- "type": "integer"
4734
- },
4735
- "moneyValue": {
4736
- "$ref": "GoogleTypeMoney",
4737
- "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto"
4738
- },
4739
- "text": {
4740
- "description": "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.",
4741
- "type": "string"
4742
- }
4743
- },
4744
- "type": "object"
4745
- },
4746
- "GoogleCloudDocumentaiV1beta2DocumentEntityRelation": {
4747
- "description": "Relationship between Entities.",
4748
- "id": "GoogleCloudDocumentaiV1beta2DocumentEntityRelation",
4749
- "properties": {
4750
- "objectId": {
4751
- "description": "Object entity id.",
4752
- "type": "string"
4753
- },
4754
- "relation": {
4755
- "description": "Relationship description.",
4756
- "type": "string"
4757
- },
4758
- "subjectId": {
4759
- "description": "Subject entity id.",
4760
- "type": "string"
4761
- }
4762
- },
4763
- "type": "object"
4764
- },
4765
- "GoogleCloudDocumentaiV1beta2DocumentLabel": {
4766
- "description": "Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.",
4767
- "id": "GoogleCloudDocumentaiV1beta2DocumentLabel",
4768
- "properties": {
4769
- "automlModel": {
4770
- "description": "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}`",
4771
- "type": "string"
4772
- },
4773
- "confidence": {
4774
- "description": "Confidence score between 0 and 1 for label assignment.",
4775
- "format": "float",
4776
- "type": "number"
4777
- },
4778
- "name": {
4779
- "description": "Name of the label. When the label is generated from AutoML Text Classification model, this field represents the name of the category.",
4780
- "type": "string"
4781
- }
4782
- },
4783
- "type": "object"
4784
- },
4785
- "GoogleCloudDocumentaiV1beta2DocumentPage": {
4786
- "description": "A page in a Document.",
4787
- "id": "GoogleCloudDocumentaiV1beta2DocumentPage",
4788
- "properties": {
4789
- "blocks": {
4790
- "description": "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.",
4791
- "items": {
4792
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageBlock"
4793
- },
4794
- "type": "array"
4795
- },
4796
- "detectedBarcodes": {
4797
- "description": "A list of detected barcodes.",
4798
- "items": {
4799
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode"
4800
- },
4801
- "type": "array"
4802
- },
4803
- "detectedLanguages": {
4804
- "description": "A list of detected languages together with confidence.",
4805
- "items": {
4806
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
4807
- },
4808
- "type": "array"
4809
- },
4810
- "dimension": {
4811
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDimension",
4812
- "description": "Physical dimension of the page."
4813
- },
4814
- "formFields": {
4815
- "description": "A list of visually detected form fields on the page.",
4816
- "items": {
4817
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageFormField"
4818
- },
4819
- "type": "array"
4820
- },
4821
- "image": {
4822
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImage",
4823
- "description": "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."
4824
- },
4825
- "imageQualityScores": {
4826
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores",
4827
- "description": "Image quality scores."
4828
- },
4829
- "layout": {
4830
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
4831
- "description": "Layout for the page."
4832
- },
4833
- "lines": {
4834
- "description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.",
4835
- "items": {
4836
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLine"
4837
- },
4838
- "type": "array"
4839
- },
4840
- "pageNumber": {
4841
- "description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.",
4842
- "format": "int32",
4843
- "type": "integer"
4844
- },
4845
- "paragraphs": {
4846
- "description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.",
4847
- "items": {
4848
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageParagraph"
4849
- },
4850
- "type": "array"
4851
- },
4852
- "provenance": {
4853
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
4854
- "deprecated": true,
4855
- "description": "The history of this page."
4856
- },
4857
- "symbols": {
4858
- "description": "A list of visually detected symbols on the page.",
4859
- "items": {
4860
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageSymbol"
4861
- },
4862
- "type": "array"
4863
- },
4864
- "tables": {
4865
- "description": "A list of visually detected tables on the page.",
4866
- "items": {
4867
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTable"
4868
- },
4869
- "type": "array"
4870
- },
4871
- "tokens": {
4872
- "description": "A list of visually detected tokens on the page.",
4873
- "items": {
4874
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageToken"
4875
- },
4876
- "type": "array"
4877
- },
4878
- "transforms": {
4879
- "description": "Transformation matrices that were applied to the original document image to produce Page.image.",
4880
- "items": {
4881
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageMatrix"
4882
- },
4883
- "type": "array"
4884
- },
4885
- "visualElements": {
4886
- "description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.",
4887
- "items": {
4888
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement"
4889
- },
4890
- "type": "array"
4891
- }
4892
- },
4893
- "type": "object"
4894
- },
4895
- "GoogleCloudDocumentaiV1beta2DocumentPageAnchor": {
4896
- "description": "Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.",
4897
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageAnchor",
4898
- "properties": {
4899
- "pageRefs": {
4900
- "description": "One or more references to visual page elements",
4901
- "items": {
4902
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef"
4903
- },
4904
- "type": "array"
4905
- }
4906
- },
4907
- "type": "object"
4908
- },
4909
- "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef": {
4910
- "description": "Represents a weak reference to a page element within a document.",
4911
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef",
4912
- "properties": {
4913
- "boundingPoly": {
4914
- "$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly",
4915
- "description": "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."
4916
- },
4917
- "confidence": {
4918
- "description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.",
4919
- "format": "float",
4920
- "type": "number"
4921
- },
4922
- "layoutId": {
4923
- "deprecated": true,
4924
- "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.",
4925
- "type": "string"
4926
- },
4927
- "layoutType": {
4928
- "description": "Optional. The type of the layout element that is being referenced if any.",
4929
- "enum": [
4930
- "LAYOUT_TYPE_UNSPECIFIED",
4931
- "BLOCK",
4932
- "PARAGRAPH",
4933
- "LINE",
4934
- "TOKEN",
4935
- "VISUAL_ELEMENT",
4936
- "TABLE",
4937
- "FORM_FIELD"
4938
- ],
4939
- "enumDescriptions": [
4940
- "Layout Unspecified.",
4941
- "References a Page.blocks element.",
4942
- "References a Page.paragraphs element.",
4943
- "References a Page.lines element.",
4944
- "References a Page.tokens element.",
4945
- "References a Page.visual_elements element.",
4946
- "Refrrences a Page.tables element.",
4947
- "References a Page.form_fields element."
4948
- ],
4949
- "type": "string"
4950
- },
4951
- "page": {
4952
- "description": "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.",
4953
- "format": "int64",
4954
- "type": "string"
4955
- }
4956
- },
4957
- "type": "object"
4958
- },
4959
- "GoogleCloudDocumentaiV1beta2DocumentPageBlock": {
4960
- "description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.",
4961
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageBlock",
4962
- "properties": {
4963
- "detectedLanguages": {
4964
- "description": "A list of detected languages together with confidence.",
4965
- "items": {
4966
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
4967
- },
4968
- "type": "array"
4969
- },
4970
- "layout": {
4971
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
4972
- "description": "Layout for Block."
4973
- },
4974
- "provenance": {
4975
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
4976
- "deprecated": true,
4977
- "description": "The history of this annotation."
4978
- }
4979
- },
4980
- "type": "object"
4981
- },
4982
- "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode": {
4983
- "description": "A detected barcode.",
4984
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode",
4985
- "properties": {
4986
- "barcode": {
4987
- "$ref": "GoogleCloudDocumentaiV1beta2Barcode",
4988
- "description": "Detailed barcode information of the DetectedBarcode."
4989
- },
4990
- "layout": {
4991
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
4992
- "description": "Layout for DetectedBarcode."
4993
- }
4994
- },
4995
- "type": "object"
4996
- },
4997
- "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage": {
4998
- "description": "Detected language for a structural component.",
4999
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage",
5000
- "properties": {
5001
- "confidence": {
5002
- "description": "Confidence of detected language. Range `[0, 1]`.",
5003
- "format": "float",
5004
- "type": "number"
5005
- },
5006
- "languageCode": {
5007
- "description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.",
5008
- "type": "string"
5009
- }
5010
- },
5011
- "type": "object"
5012
- },
5013
- "GoogleCloudDocumentaiV1beta2DocumentPageDimension": {
5014
- "description": "Dimension for the page.",
5015
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageDimension",
5016
- "properties": {
5017
- "height": {
5018
- "description": "Page height.",
5019
- "format": "float",
5020
- "type": "number"
5021
- },
5022
- "unit": {
5023
- "description": "Dimension unit.",
5024
- "type": "string"
5025
- },
5026
- "width": {
5027
- "description": "Page width.",
5028
- "format": "float",
5029
- "type": "number"
5030
- }
5031
- },
5032
- "type": "object"
5033
- },
5034
- "GoogleCloudDocumentaiV1beta2DocumentPageFormField": {
5035
- "description": "A form field detected on the page.",
5036
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageFormField",
5037
- "properties": {
5038
- "correctedKeyText": {
5039
- "description": "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.",
5040
- "type": "string"
5041
- },
5042
- "correctedValueText": {
5043
- "description": "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.",
5044
- "type": "string"
5045
- },
5046
- "fieldName": {
5047
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
5048
- "description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc."
5049
- },
5050
- "fieldValue": {
5051
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
5052
- "description": "Layout for the FormField value."
5053
- },
5054
- "nameDetectedLanguages": {
5055
- "description": "A list of detected languages for name together with confidence.",
5056
- "items": {
5057
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
5058
- },
5059
- "type": "array"
5060
- },
5061
- "provenance": {
5062
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
5063
- "description": "The history of this annotation."
5064
- },
5065
- "valueDetectedLanguages": {
5066
- "description": "A list of detected languages for value together with confidence.",
5067
- "items": {
5068
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
5069
- },
5070
- "type": "array"
5071
- },
5072
- "valueType": {
5073
- "description": "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`",
5074
- "type": "string"
5075
- }
5076
- },
5077
- "type": "object"
5078
- },
5079
- "GoogleCloudDocumentaiV1beta2DocumentPageImage": {
5080
- "description": "Rendered image contents for this page.",
5081
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageImage",
5082
- "properties": {
5083
- "content": {
5084
- "description": "Raw byte content of the image.",
5085
- "format": "byte",
5086
- "type": "string"
5087
- },
5088
- "height": {
5089
- "description": "Height of the image in pixels.",
5090
- "format": "int32",
5091
- "type": "integer"
5092
- },
5093
- "mimeType": {
5094
- "description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.",
5095
- "type": "string"
5096
- },
5097
- "width": {
5098
- "description": "Width of the image in pixels.",
5099
- "format": "int32",
5100
- "type": "integer"
5101
- }
5102
- },
5103
- "type": "object"
5104
- },
5105
- "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores": {
5106
- "description": "Image quality scores for the page image.",
5107
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores",
5108
- "properties": {
5109
- "detectedDefects": {
5110
- "description": "A list of detected defects.",
5111
- "items": {
5112
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect"
5113
- },
5114
- "type": "array"
5115
- },
5116
- "qualityScore": {
5117
- "description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.",
5118
- "format": "float",
5119
- "type": "number"
5120
- }
5121
- },
5122
- "type": "object"
5123
- },
5124
- "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect": {
5125
- "description": "Image Quality Defects",
5126
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect",
5127
- "properties": {
5128
- "confidence": {
5129
- "description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.",
5130
- "format": "float",
5131
- "type": "number"
5132
- },
5133
- "type": {
5134
- "description": "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`",
5135
- "type": "string"
5136
- }
5137
- },
5138
- "type": "object"
5139
- },
5140
- "GoogleCloudDocumentaiV1beta2DocumentPageLayout": {
5141
- "description": "Visual element describing a layout unit on a page.",
5142
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
5143
- "properties": {
5144
- "boundingPoly": {
5145
- "$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly",
5146
- "description": "The bounding polygon for the Layout."
5147
- },
5148
- "confidence": {
5149
- "description": "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]`.",
5150
- "format": "float",
5151
- "type": "number"
5152
- },
5153
- "orientation": {
5154
- "description": "Detected orientation for the Layout.",
5155
- "enum": [
5156
- "ORIENTATION_UNSPECIFIED",
5157
- "PAGE_UP",
5158
- "PAGE_RIGHT",
5159
- "PAGE_DOWN",
5160
- "PAGE_LEFT"
5161
- ],
5162
- "enumDescriptions": [
5163
- "Unspecified orientation.",
5164
- "Orientation is aligned with page up.",
5165
- "Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.",
5166
- "Orientation is aligned with page down. Turn the head 180 degrees from upright to read.",
5167
- "Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read."
5168
- ],
5169
- "type": "string"
5170
- },
5171
- "textAnchor": {
5172
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
5173
- "description": "Text anchor indexing into the Document.text."
5174
- }
5175
- },
5176
- "type": "object"
5177
- },
5178
- "GoogleCloudDocumentaiV1beta2DocumentPageLine": {
5179
- "description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.",
5180
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageLine",
5181
- "properties": {
5182
- "detectedLanguages": {
5183
- "description": "A list of detected languages together with confidence.",
5184
- "items": {
5185
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
5186
- },
5187
- "type": "array"
5188
- },
5189
- "layout": {
5190
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
5191
- "description": "Layout for Line."
5192
- },
5193
- "provenance": {
5194
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
5195
- "deprecated": true,
5196
- "description": "The history of this annotation."
5197
- }
5198
- },
5199
- "type": "object"
5200
- },
5201
- "GoogleCloudDocumentaiV1beta2DocumentPageMatrix": {
5202
- "description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.",
5203
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageMatrix",
5204
- "properties": {
5205
- "cols": {
5206
- "description": "Number of columns in the matrix.",
5207
- "format": "int32",
5208
- "type": "integer"
5209
- },
5210
- "data": {
5211
- "description": "The matrix data.",
5212
- "format": "byte",
5213
- "type": "string"
5214
- },
5215
- "rows": {
5216
- "description": "Number of rows in the matrix.",
5217
- "format": "int32",
5218
- "type": "integer"
5219
- },
5220
- "type": {
5221
- "description": "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",
5222
- "format": "int32",
5223
- "type": "integer"
5224
- }
5225
- },
5226
- "type": "object"
5227
- },
5228
- "GoogleCloudDocumentaiV1beta2DocumentPageParagraph": {
5229
- "description": "A collection of lines that a human would perceive as a paragraph.",
5230
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageParagraph",
5231
- "properties": {
5232
- "detectedLanguages": {
5233
- "description": "A list of detected languages together with confidence.",
5234
- "items": {
5235
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
5236
- },
5237
- "type": "array"
5238
- },
5239
- "layout": {
5240
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
5241
- "description": "Layout for Paragraph."
5242
- },
5243
- "provenance": {
5244
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
5245
- "deprecated": true,
5246
- "description": "The history of this annotation."
5247
- }
5248
- },
5249
- "type": "object"
5250
- },
5251
- "GoogleCloudDocumentaiV1beta2DocumentPageSymbol": {
5252
- "description": "A detected symbol.",
5253
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageSymbol",
5254
- "properties": {
5255
- "detectedLanguages": {
5256
- "description": "A list of detected languages together with confidence.",
5257
- "items": {
5258
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
5259
- },
5260
- "type": "array"
5261
- },
5262
- "layout": {
5263
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
5264
- "description": "Layout for Symbol."
5265
- }
5266
- },
5267
- "type": "object"
5268
- },
5269
- "GoogleCloudDocumentaiV1beta2DocumentPageTable": {
5270
- "description": "A table representation similar to HTML table structure.",
5271
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageTable",
5272
- "properties": {
5273
- "bodyRows": {
5274
- "description": "Body rows of the table.",
5275
- "items": {
5276
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow"
5277
- },
5278
- "type": "array"
5279
- },
5280
- "detectedLanguages": {
5281
- "description": "A list of detected languages together with confidence.",
5282
- "items": {
5283
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
5284
- },
5285
- "type": "array"
5286
- },
5287
- "headerRows": {
5288
- "description": "Header rows of the table.",
5289
- "items": {
5290
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow"
5291
- },
5292
- "type": "array"
5293
- },
5294
- "layout": {
5295
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
5296
- "description": "Layout for Table."
5297
- },
5298
- "provenance": {
5299
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
5300
- "deprecated": true,
5301
- "description": "The history of this table."
5302
- }
5303
- },
5304
- "type": "object"
5305
- },
5306
- "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell": {
5307
- "description": "A cell representation inside the table.",
5308
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell",
5309
- "properties": {
5310
- "colSpan": {
5311
- "description": "How many columns this cell spans.",
5312
- "format": "int32",
5313
- "type": "integer"
5314
- },
5315
- "detectedLanguages": {
5316
- "description": "A list of detected languages together with confidence.",
5317
- "items": {
5318
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
5319
- },
5320
- "type": "array"
5321
- },
5322
- "layout": {
5323
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
5324
- "description": "Layout for TableCell."
5325
- },
5326
- "rowSpan": {
5327
- "description": "How many rows this cell spans.",
5328
- "format": "int32",
5329
- "type": "integer"
5330
- }
5331
- },
5332
- "type": "object"
5333
- },
5334
- "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow": {
5335
- "description": "A row of table cells.",
5336
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow",
5337
- "properties": {
5338
- "cells": {
5339
- "description": "Cells that make up this row.",
5340
- "items": {
5341
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell"
5342
- },
5343
- "type": "array"
5344
- }
5345
- },
5346
- "type": "object"
5347
- },
5348
- "GoogleCloudDocumentaiV1beta2DocumentPageToken": {
5349
- "description": "A detected token.",
5350
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageToken",
5351
- "properties": {
5352
- "detectedBreak": {
5353
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak",
5354
- "description": "Detected break at the end of a Token."
5355
- },
5356
- "detectedLanguages": {
5357
- "description": "A list of detected languages together with confidence.",
5358
- "items": {
5359
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
5360
- },
5361
- "type": "array"
5362
- },
5363
- "layout": {
5364
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
5365
- "description": "Layout for Token."
5366
- },
5367
- "provenance": {
5368
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
5369
- "deprecated": true,
5370
- "description": "The history of this annotation."
5371
- },
5372
- "styleInfo": {
5373
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo",
5374
- "description": "Text style attributes."
5375
- }
5376
- },
5377
- "type": "object"
5378
- },
5379
- "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak": {
5380
- "description": "Detected break at the end of a Token.",
5381
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak",
5382
- "properties": {
5383
- "type": {
5384
- "description": "Detected break type.",
5385
- "enum": [
5386
- "TYPE_UNSPECIFIED",
5387
- "SPACE",
5388
- "WIDE_SPACE",
5389
- "HYPHEN"
5390
- ],
5391
- "enumDescriptions": [
5392
- "Unspecified break type.",
5393
- "A single whitespace.",
5394
- "A wider whitespace.",
5395
- "A hyphen that indicates that a token has been split across lines."
5396
- ],
5397
- "type": "string"
5398
- }
5399
- },
5400
- "type": "object"
5401
- },
5402
- "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo": {
5403
- "description": "Font and other text style attributes.",
5404
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo",
5405
- "properties": {
5406
- "backgroundColor": {
5407
- "$ref": "GoogleTypeColor",
5408
- "description": "Color of the background."
5409
- },
5410
- "bold": {
5411
- "description": "Whether the text is bold (equivalent to font_weight is at least `700`).",
5412
- "type": "boolean"
5413
- },
5414
- "fontSize": {
5415
- "description": "Font size in points (`1` point is `\u00b9\u2044\u2087\u2082` inches).",
5416
- "format": "int32",
5417
- "type": "integer"
5418
- },
5419
- "fontType": {
5420
- "description": "Name or style of the font.",
5421
- "type": "string"
5422
- },
5423
- "fontWeight": {
5424
- "description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.",
5425
- "format": "int32",
5426
- "type": "integer"
5427
- },
5428
- "handwritten": {
5429
- "description": "Whether the text is handwritten.",
5430
- "type": "boolean"
5431
- },
5432
- "italic": {
5433
- "description": "Whether the text is italic.",
5434
- "type": "boolean"
5435
- },
5436
- "letterSpacing": {
5437
- "description": "Letter spacing in points.",
5438
- "format": "double",
5439
- "type": "number"
5440
- },
5441
- "pixelFontSize": {
5442
- "description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ \u00f7 `72.0`.",
5443
- "format": "double",
5444
- "type": "number"
5445
- },
5446
- "smallcaps": {
5447
- "description": "Whether the text is in small caps. This feature is not supported yet.",
5448
- "type": "boolean"
5449
- },
5450
- "strikeout": {
5451
- "description": "Whether the text is strikethrough. This feature is not supported yet.",
5452
- "type": "boolean"
5453
- },
5454
- "subscript": {
5455
- "description": "Whether the text is a subscript. This feature is not supported yet.",
5456
- "type": "boolean"
5457
- },
5458
- "superscript": {
5459
- "description": "Whether the text is a superscript. This feature is not supported yet.",
5460
- "type": "boolean"
5461
- },
5462
- "textColor": {
5463
- "$ref": "GoogleTypeColor",
5464
- "description": "Color of the text."
5465
- },
5466
- "underlined": {
5467
- "description": "Whether the text is underlined.",
5468
- "type": "boolean"
5469
- }
5470
- },
5471
- "type": "object"
5472
- },
5473
- "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement": {
5474
- "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.",
5475
- "id": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement",
5476
- "properties": {
5477
- "detectedLanguages": {
5478
- "description": "A list of detected languages together with confidence.",
5479
- "items": {
5480
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
5481
- },
5482
- "type": "array"
5483
- },
5484
- "layout": {
5485
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
5486
- "description": "Layout for VisualElement."
5487
- },
5488
- "type": {
5489
- "description": "Type of the VisualElement.",
5490
- "type": "string"
5491
- }
5492
- },
5493
- "type": "object"
5494
- },
5495
- "GoogleCloudDocumentaiV1beta2DocumentProvenance": {
5496
- "description": "Structure to identify provenance relationships between annotations in different revisions.",
5497
- "id": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
5498
- "properties": {
5499
- "id": {
5500
- "deprecated": true,
5501
- "description": "The Id of this operation. Needs to be unique within the scope of the revision.",
5502
- "format": "int32",
5503
- "type": "integer"
5504
- },
5505
- "parents": {
5506
- "description": "References to the original elements that are replaced.",
5507
- "items": {
5508
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent"
5509
- },
5510
- "type": "array"
5511
- },
5512
- "revision": {
5513
- "deprecated": true,
5514
- "description": "The index of the revision that produced this element.",
5515
- "format": "int32",
5516
- "type": "integer"
5517
- },
5518
- "type": {
5519
- "description": "The type of provenance operation.",
5520
- "enum": [
5521
- "OPERATION_TYPE_UNSPECIFIED",
5522
- "ADD",
5523
- "REMOVE",
5524
- "UPDATE",
5525
- "REPLACE",
5526
- "EVAL_REQUESTED",
5527
- "EVAL_APPROVED",
5528
- "EVAL_SKIPPED"
5529
- ],
5530
- "enumDeprecated": [
5531
- false,
5532
- false,
5533
- false,
5534
- false,
5535
- false,
5536
- true,
5537
- true,
5538
- true
5539
- ],
5540
- "enumDescriptions": [
5541
- "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.",
5542
- "Add an element.",
5543
- "Remove an element identified by `parent`.",
5544
- "Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.",
5545
- "Currently unused. Replace an element identified by `parent`.",
5546
- "Deprecated. Request human review for the element identified by `parent`.",
5547
- "Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.",
5548
- "Deprecated. Element is skipped in the validation process."
5549
- ],
5550
- "type": "string"
5551
- }
5552
- },
5553
- "type": "object"
5554
- },
5555
- "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent": {
5556
- "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.",
5557
- "id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent",
5558
- "properties": {
5559
- "id": {
5560
- "deprecated": true,
5561
- "description": "The id of the parent provenance.",
5562
- "format": "int32",
5563
- "type": "integer"
5564
- },
5565
- "index": {
5566
- "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.",
5567
- "format": "int32",
5568
- "type": "integer"
5569
- },
5570
- "revision": {
5571
- "description": "The index of the index into current revision's parent_ids list.",
5572
- "format": "int32",
5573
- "type": "integer"
5574
- }
5575
- },
5576
- "type": "object"
5577
- },
5578
- "GoogleCloudDocumentaiV1beta2DocumentRevision": {
5579
- "description": "Contains past or forward revisions of this document.",
5580
- "id": "GoogleCloudDocumentaiV1beta2DocumentRevision",
5581
- "properties": {
5582
- "agent": {
5583
- "description": "If the change was made by a person specify the name or id of that person.",
5584
- "type": "string"
5585
- },
5586
- "createTime": {
5587
- "description": "The time that the revision was created, internally generated by doc proto storage at the time of create.",
5588
- "format": "google-datetime",
5589
- "type": "string"
5590
- },
5591
- "humanReview": {
5592
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview",
5593
- "description": "Human Review information of this revision."
5594
- },
5595
- "id": {
5596
- "description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.",
5597
- "type": "string"
5598
- },
5599
- "parent": {
5600
- "deprecated": true,
5601
- "description": "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.",
5602
- "items": {
5603
- "format": "int32",
5604
- "type": "integer"
5605
- },
5606
- "type": "array"
5607
- },
5608
- "parentIds": {
5609
- "description": "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.",
5610
- "items": {
5611
- "type": "string"
5612
- },
5613
- "type": "array"
5614
- },
5615
- "processor": {
5616
- "description": "If the annotation was made by processor identify the processor by its resource name.",
5617
- "type": "string"
5618
- }
5619
- },
5620
- "type": "object"
5621
- },
5622
- "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview": {
5623
- "description": "Human Review information of the document.",
5624
- "id": "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview",
5625
- "properties": {
5626
- "state": {
5627
- "description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.",
5628
- "type": "string"
5629
- },
5630
- "stateMessage": {
5631
- "description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.",
5632
- "type": "string"
5633
- }
5634
- },
5635
- "type": "object"
5636
- },
5637
- "GoogleCloudDocumentaiV1beta2DocumentShardInfo": {
5638
- "description": "For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.",
5639
- "id": "GoogleCloudDocumentaiV1beta2DocumentShardInfo",
5640
- "properties": {
5641
- "shardCount": {
5642
- "description": "Total number of shards.",
5643
- "format": "int64",
5644
- "type": "string"
5645
- },
5646
- "shardIndex": {
5647
- "description": "The 0-based index of this shard.",
5648
- "format": "int64",
5649
- "type": "string"
5650
- },
5651
- "textOffset": {
5652
- "description": "The index of the first character in Document.text in the overall document global text.",
5653
- "format": "int64",
5654
- "type": "string"
5655
- }
5656
- },
5657
- "type": "object"
5658
- },
5659
- "GoogleCloudDocumentaiV1beta2DocumentStyle": {
5660
- "description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.",
5661
- "id": "GoogleCloudDocumentaiV1beta2DocumentStyle",
5662
- "properties": {
5663
- "backgroundColor": {
5664
- "$ref": "GoogleTypeColor",
5665
- "description": "Text background color."
5666
- },
5667
- "color": {
5668
- "$ref": "GoogleTypeColor",
5669
- "description": "Text color."
5670
- },
5671
- "fontFamily": {
5672
- "description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp",
5673
- "type": "string"
5674
- },
5675
- "fontSize": {
5676
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize",
5677
- "description": "Font size."
5678
- },
5679
- "fontWeight": {
5680
- "description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.",
5681
- "type": "string"
5682
- },
5683
- "textAnchor": {
5684
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
5685
- "description": "Text anchor indexing into the Document.text."
5686
- },
5687
- "textDecoration": {
5688
- "description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ",
5689
- "type": "string"
5690
- },
5691
- "textStyle": {
5692
- "description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.",
5693
- "type": "string"
5694
- }
5695
- },
5696
- "type": "object"
5697
- },
5698
- "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize": {
5699
- "description": "Font size with unit.",
5700
- "id": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize",
5701
- "properties": {
5702
- "size": {
5703
- "description": "Font size for the text.",
5704
- "format": "float",
5705
- "type": "number"
5706
- },
5707
- "unit": {
5708
- "description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).",
5709
- "type": "string"
5710
- }
5711
- },
5712
- "type": "object"
5713
- },
5714
- "GoogleCloudDocumentaiV1beta2DocumentTextAnchor": {
5715
- "description": "Text reference indexing into the Document.text.",
5716
- "id": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
5717
- "properties": {
5718
- "content": {
5719
- "description": "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.",
5720
- "type": "string"
5721
- },
5722
- "textSegments": {
5723
- "description": "The text segments from the Document.text.",
5724
- "items": {
5725
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment"
5726
- },
5727
- "type": "array"
5728
- }
5729
- },
5730
- "type": "object"
5731
- },
5732
- "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment": {
5733
- "description": "A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset",
5734
- "id": "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment",
5735
- "properties": {
5736
- "endIndex": {
5737
- "description": "TextSegment half open end UTF-8 char index in the Document.text.",
5738
- "format": "int64",
5739
- "type": "string"
5740
- },
5741
- "startIndex": {
5742
- "description": "TextSegment start UTF-8 char index in the Document.text.",
5743
- "format": "int64",
5744
- "type": "string"
5745
- }
5746
- },
5747
- "type": "object"
5748
- },
5749
- "GoogleCloudDocumentaiV1beta2DocumentTextChange": {
5750
- "description": "This message is used for text changes aka. OCR corrections.",
5751
- "id": "GoogleCloudDocumentaiV1beta2DocumentTextChange",
5752
- "properties": {
5753
- "changedText": {
5754
- "description": "The text that replaces the text identified in the `text_anchor`.",
5755
- "type": "string"
5756
- },
5757
- "provenance": {
5758
- "deprecated": true,
5759
- "description": "The history of this annotation.",
5760
- "items": {
5761
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance"
5762
- },
5763
- "type": "array"
5764
- },
5765
- "textAnchor": {
5766
- "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
5767
- "description": "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."
5768
- }
5769
- },
5770
- "type": "object"
5771
- },
5772
- "GoogleCloudDocumentaiV1beta2GcsDestination": {
5773
- "description": "The Google Cloud Storage location where the output file will be written to.",
5774
- "id": "GoogleCloudDocumentaiV1beta2GcsDestination",
5775
- "properties": {
5776
- "uri": {
5777
- "type": "string"
5778
- }
5779
- },
5780
- "type": "object"
5781
- },
5782
- "GoogleCloudDocumentaiV1beta2GcsSource": {
5783
- "description": "The Google Cloud Storage location where the input file will be read from.",
5784
- "id": "GoogleCloudDocumentaiV1beta2GcsSource",
5785
- "properties": {
5786
- "uri": {
5787
- "type": "string"
5788
- }
5789
- },
5790
- "type": "object"
5791
- },
5792
- "GoogleCloudDocumentaiV1beta2InputConfig": {
5793
- "description": "The desired input location and metadata.",
5794
- "id": "GoogleCloudDocumentaiV1beta2InputConfig",
5795
- "properties": {
5796
- "contents": {
5797
- "description": "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.",
5798
- "format": "byte",
5799
- "type": "string"
5800
- },
5801
- "gcsSource": {
5802
- "$ref": "GoogleCloudDocumentaiV1beta2GcsSource",
5803
- "description": "The Google Cloud Storage location to read the input from. This must be a single file."
5804
- },
5805
- "mimeType": {
5806
- "description": "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.",
5807
- "type": "string"
5808
- }
5809
- },
5810
- "type": "object"
5811
- },
5812
- "GoogleCloudDocumentaiV1beta2NormalizedVertex": {
5813
- "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.",
5814
- "id": "GoogleCloudDocumentaiV1beta2NormalizedVertex",
5815
- "properties": {
5816
- "x": {
5817
- "description": "X coordinate.",
5818
- "format": "float",
5819
- "type": "number"
5820
- },
5821
- "y": {
5822
- "description": "Y coordinate (starts from the top of the image).",
5823
- "format": "float",
5824
- "type": "number"
5825
- }
5826
- },
5827
- "type": "object"
5828
- },
5829
- "GoogleCloudDocumentaiV1beta2OperationMetadata": {
5830
- "description": "Contains metadata for the BatchProcessDocuments operation.",
5831
- "id": "GoogleCloudDocumentaiV1beta2OperationMetadata",
5832
- "properties": {
5833
- "createTime": {
5834
- "description": "The creation time of the operation.",
5835
- "format": "google-datetime",
5836
- "type": "string"
5837
- },
5838
- "state": {
5839
- "description": "The state of the current batch processing.",
5840
- "enum": [
5841
- "STATE_UNSPECIFIED",
5842
- "ACCEPTED",
5843
- "WAITING",
5844
- "RUNNING",
5845
- "SUCCEEDED",
5846
- "CANCELLED",
5847
- "FAILED"
5848
- ],
5849
- "enumDescriptions": [
5850
- "The default value. This value is used if the state is omitted.",
5851
- "Request is received.",
5852
- "Request operation is waiting for scheduling.",
5853
- "Request is being processed.",
5854
- "The batch processing completed successfully.",
5855
- "The batch processing was cancelled.",
5856
- "The batch processing has failed."
5857
- ],
5858
- "type": "string"
5859
- },
5860
- "stateMessage": {
5861
- "description": "A message providing more details about the current state of processing.",
5862
- "type": "string"
5863
- },
5864
- "updateTime": {
5865
- "description": "The last update time of the operation.",
5866
- "format": "google-datetime",
5867
- "type": "string"
5868
- }
5869
- },
5870
- "type": "object"
5871
- },
5872
- "GoogleCloudDocumentaiV1beta2OutputConfig": {
5873
- "description": "The desired output location and metadata.",
5874
- "id": "GoogleCloudDocumentaiV1beta2OutputConfig",
5875
- "properties": {
5876
- "gcsDestination": {
5877
- "$ref": "GoogleCloudDocumentaiV1beta2GcsDestination",
5878
- "description": "The Google Cloud Storage location to write the output to."
5879
- },
5880
- "pagesPerShard": {
5881
- "description": "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",
5882
- "format": "int32",
5883
- "type": "integer"
5884
- }
5885
- },
5886
- "type": "object"
5887
- },
5888
- "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse": {
5889
- "description": "Response to a single document processing request.",
5890
- "id": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse",
5891
- "properties": {
5892
- "inputConfig": {
5893
- "$ref": "GoogleCloudDocumentaiV1beta2InputConfig",
5894
- "description": "Information about the input file. This is the same as the corresponding input config in the request."
5895
- },
5896
- "outputConfig": {
5897
- "$ref": "GoogleCloudDocumentaiV1beta2OutputConfig",
5898
- "description": "The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects."
5899
- }
5900
- },
5901
- "type": "object"
5902
- },
5903
- "GoogleCloudDocumentaiV1beta2Vertex": {
5904
- "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.",
5905
- "id": "GoogleCloudDocumentaiV1beta2Vertex",
5906
- "properties": {
5907
- "x": {
5908
- "description": "X coordinate.",
5909
- "format": "int32",
5910
- "type": "integer"
5911
- },
5912
- "y": {
5913
- "description": "Y coordinate (starts from the top of the image).",
5914
- "format": "int32",
5915
- "type": "integer"
5916
- }
5917
- },
5918
- "type": "object"
5919
- },
5920
2572
  "GoogleCloudDocumentaiV1beta3Barcode": {
5921
2573
  "description": "Encodes the detailed information of a barcode.",
5922
2574
  "id": "GoogleCloudDocumentaiV1beta3Barcode",
@@ -7945,6 +4597,10 @@ true
7945
4597
  },
7946
4598
  "type": "array"
7947
4599
  },
4600
+ "description": {
4601
+ "description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.",
4602
+ "type": "string"
4603
+ },
7948
4604
  "displayName": {
7949
4605
  "description": "User defined name for the type.",
7950
4606
  "type": "string"
@@ -7989,6 +4645,10 @@ true
7989
4645
  "description": "Defines properties that can be part of the entity type.",
7990
4646
  "id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty",
7991
4647
  "properties": {
4648
+ "description": {
4649
+ "description": "The description of the property. Could be used to provide more information about the property for model calls.",
4650
+ "type": "string"
4651
+ },
7992
4652
  "displayName": {
7993
4653
  "description": "User defined name for the property.",
7994
4654
  "type": "string"