-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
documentai_v1.projects.locations.processors.processorVersions.html
2526 lines (2458 loc) 路 261 KB
/
documentai_v1.projects.locations.processors.processorVersions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="documentai_v1.html">Cloud Document AI API</a> . <a href="documentai_v1.projects.html">projects</a> . <a href="documentai_v1.projects.locations.html">locations</a> . <a href="documentai_v1.projects.locations.processors.html">processors</a> . <a href="documentai_v1.projects.locations.processors.processorVersions.html">processorVersions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="documentai_v1.projects.locations.processors.processorVersions.evaluations.html">evaluations()</a></code>
</p>
<p class="firstline">Returns the evaluations Resource.</p>
<p class="toc_element">
<code><a href="#batchProcess">batchProcess(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the processor version, all artifacts under the processor version will be deleted.</p>
<p class="toc_element">
<code><a href="#deploy">deploy(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deploys the processor version.</p>
<p class="toc_element">
<code><a href="#evaluateProcessorVersion">evaluateProcessorVersion(processorVersion, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a processor version detail.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all versions of a processor.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#process">process(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Processes a single document.</p>
<p class="toc_element">
<code><a href="#train">train(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata.</p>
<p class="toc_element">
<code><a href="#undeploy">undeploy(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Undeploys the processor version.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchProcess">batchProcess(name, body=None, x__xgafv=None)</code>
<pre>LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Args:
name: string, Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BatchProcessDocuments.
"documentOutputConfig": { # Config that controls the output of documents. All documents will be written as a JSON file. # The output configuration for the BatchProcessDocuments method.
"gcsOutputConfig": { # The configuration used when outputting documents. # Output config to write the results to Cloud Storage.
"fieldMask": "A String", # Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.
"gcsUri": "A String", # The Cloud Storage uri (a directory) of the output.
"shardingConfig": { # The sharding config for the output document. # Specifies the sharding config for the output document.
"pagesOverlap": 42, # The number of overlapping pages between consecutive shards.
"pagesPerShard": 42, # The number of pages per shard.
},
},
},
"inputDocuments": { # The common config to specify a set of documents used as input. # The input documents for the BatchProcessDocuments method.
"gcsDocuments": { # Specifies a set of documents on Cloud Storage. # The set of documents individually specified on Cloud Storage.
"documents": [ # The list of documents.
{ # Specifies a document stored on Cloud Storage.
"gcsUri": "A String", # The Cloud Storage object uri.
"mimeType": "A String", # An IANA MIME type (RFC6838) of the content.
},
],
},
"gcsPrefix": { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
"gcsUriPrefix": "A String", # The URI prefix.
},
},
"processOptions": { # Options for Process API # Inference-time options for the process API
"fromEnd": 42, # Only process certain pages from the end, same as above.
"fromStart": 42, # Only process certain pages from the start. Process all if the document has fewer pages.
"individualPageSelector": { # A list of individual page numbers. # Which pages to process (1-indexed).
"pages": [ # Optional. Indices of the pages (starting from 1).
42,
],
},
"ocrConfig": { # Config for Document OCR. # Only applicable to `OCR_PROCESSOR`. Returns error if set on other processor types.
"advancedOcrOptions": [ # A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.
"A String",
],
"computeStyleInfo": True or False, # Turn on font identification model and return font style information. Deprecated, use PremiumFeatures.compute_style_info instead.
"disableCharacterBoxesDetection": True or False, # Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors.
"enableImageQualityScores": True or False, # Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to regular OCR to the process call.
"enableNativePdfParsing": True or False, # Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs.
"enableSymbol": True or False, # Includes symbol level OCR information if set to true.
"hints": { # Hints for OCR Engine # Hints for the OCR model.
"languageHints": [ # List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong).
"A String",
],
},
"premiumFeatures": { # Configurations for premium OCR features. # Configurations for premium OCR features.
"computeStyleInfo": True or False, # Turn on font identification model and return font style information.
"enableMathOcr": True or False, # Turn on the model that can extract LaTeX math formulas.
"enableSelectionMarkDetection": True or False, # Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors.
},
},
},
"skipHumanReview": True or False, # Whether human review should be skipped for this request. Default to `false`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes the processor version, all artifacts under the processor version will be deleted.
Args:
name: string, Required. The processor version resource name to be deleted. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="deploy">deploy(name, body=None, x__xgafv=None)</code>
<pre>Deploys the processor version.
Args:
name: string, Required. The processor version resource name to be deployed. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the DeployProcessorVersion method.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="evaluateProcessorVersion">evaluateProcessorVersion(processorVersion, body=None, x__xgafv=None)</code>
<pre>Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.
Args:
processorVersion: string, Required. The resource name of the ProcessorVersion to evaluate. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
body: object, The request body.
The object takes the form of:
{ # Evaluates the given ProcessorVersion against the supplied documents.
"evaluationDocuments": { # The common config to specify a set of documents used as input. # Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input.
"gcsDocuments": { # Specifies a set of documents on Cloud Storage. # The set of documents individually specified on Cloud Storage.
"documents": [ # The list of documents.
{ # Specifies a document stored on Cloud Storage.
"gcsUri": "A String", # The Cloud Storage object uri.
"mimeType": "A String", # An IANA MIME type (RFC6838) of the content.
},
],
},
"gcsPrefix": { # Specifies all documents on Cloud Storage with a common prefix. # The set of documents that match the specified Cloud Storage `gcs_prefix`.
"gcsUriPrefix": "A String", # The URI prefix.
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a processor version detail.
Args:
name: string, Required. The processor resource name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.
"createTime": "A String", # The time the processor version was created.
"deprecationInfo": { # Information about the upcoming deprecation of this processor version. # If set, information about the eventual deprecation of this version.
"deprecationTime": "A String", # The time at which this processor version will be deprecated.
"replacementProcessorVersion": "A String", # If set, the processor version that will be used as a replacement.
},
"displayName": "A String", # The display name of the processor version.
"documentSchema": { # The schema defines the output of the processed document by a processor. # The schema of the processor version. Describes the output.
"description": "A String", # Description of the schema.
"displayName": "A String", # Display name to show to users.
"entityTypes": [ # Entity types of the schema.
{ # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
"baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
"A String",
],
"displayName": "A String", # User defined name for the type.
"enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
"values": [ # The individual values that this enum values type can include.
"A String",
],
},
"name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
"properties": [ # Description the nested structure, or composition of an entity.
{ # Defines properties that can be part of the entity type.
"name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
"occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
"valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
},
],
},
],
"metadata": { # Metadata for global schema behavior. # Metadata of the schema.
"documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
"documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
"prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
},
},
"googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
"kmsKeyName": "A String", # The KMS key name used for encryption.
"kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted.
"latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version.
"aggregateMetrics": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation with fuzzy matching on.
"f1Score": 3.14, # The calculated f1 score.
"falseNegativesCount": 42, # The amount of false negatives.
"falsePositivesCount": 42, # The amount of false positives.
"groundTruthDocumentCount": 42, # The amount of documents with a ground truth occurrence.
"groundTruthOccurrencesCount": 42, # The amount of occurrences in ground truth documents.
"precision": 3.14, # The calculated precision.
"predictedDocumentCount": 42, # The amount of documents with a predicted occurrence.
"predictedOccurrencesCount": 42, # The amount of occurrences in predicted documents.
"recall": 3.14, # The calculated recall.
"totalDocumentsCount": 42, # The amount of documents that had an occurrence of this label.
"truePositivesCount": 42, # The amount of true positives.
},
"aggregateMetricsExact": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation with fuzzy matching off.
"f1Score": 3.14, # The calculated f1 score.
"falseNegativesCount": 42, # The amount of false negatives.
"falsePositivesCount": 42, # The amount of false positives.
"groundTruthDocumentCount": 42, # The amount of documents with a ground truth occurrence.
"groundTruthOccurrencesCount": 42, # The amount of occurrences in ground truth documents.
"precision": 3.14, # The calculated precision.
"predictedDocumentCount": 42, # The amount of documents with a predicted occurrence.
"predictedOccurrencesCount": 42, # The amount of occurrences in predicted documents.
"recall": 3.14, # The calculated recall.
"totalDocumentsCount": 42, # The amount of documents that had an occurrence of this label.
"truePositivesCount": 42, # The amount of true positives.
},
"evaluation": "A String", # The resource name of the evaluation.
"operation": "A String", # The resource name of the Long Running Operation for the evaluation.
},
"name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
"state": "A String", # The state of the processor version.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all versions of a processor.
Args:
parent: string, Required. The parent (project, location and processor) to list all versions. Format: `projects/{project}/locations/{location}/processors/{processor}` (required)
pageSize: integer, The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.
pageToken: string, We will return the processor versions sorted by creation time. The page token will point to the next processor version.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the ListProcessorVersions method.
"nextPageToken": "A String", # Points to the next processor, otherwise empty.
"processorVersions": [ # The list of processors.
{ # A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.
"createTime": "A String", # The time the processor version was created.
"deprecationInfo": { # Information about the upcoming deprecation of this processor version. # If set, information about the eventual deprecation of this version.
"deprecationTime": "A String", # The time at which this processor version will be deprecated.
"replacementProcessorVersion": "A String", # If set, the processor version that will be used as a replacement.
},
"displayName": "A String", # The display name of the processor version.
"documentSchema": { # The schema defines the output of the processed document by a processor. # The schema of the processor version. Describes the output.
"description": "A String", # Description of the schema.
"displayName": "A String", # Display name to show to users.
"entityTypes": [ # Entity types of the schema.
{ # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
"baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
"A String",
],
"displayName": "A String", # User defined name for the type.
"enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
"values": [ # The individual values that this enum values type can include.
"A String",
],
},
"name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
"properties": [ # Description the nested structure, or composition of an entity.
{ # Defines properties that can be part of the entity type.
"name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
"occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
"valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
},
],
},
],
"metadata": { # Metadata for global schema behavior. # Metadata of the schema.
"documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
"documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
"prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
},
},
"googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google.
"kmsKeyName": "A String", # The KMS key name used for encryption.
"kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted.
"latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version.
"aggregateMetrics": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation with fuzzy matching on.
"f1Score": 3.14, # The calculated f1 score.
"falseNegativesCount": 42, # The amount of false negatives.
"falsePositivesCount": 42, # The amount of false positives.
"groundTruthDocumentCount": 42, # The amount of documents with a ground truth occurrence.
"groundTruthOccurrencesCount": 42, # The amount of occurrences in ground truth documents.
"precision": 3.14, # The calculated precision.
"predictedDocumentCount": 42, # The amount of documents with a predicted occurrence.
"predictedOccurrencesCount": 42, # The amount of occurrences in predicted documents.
"recall": 3.14, # The calculated recall.
"totalDocumentsCount": 42, # The amount of documents that had an occurrence of this label.
"truePositivesCount": 42, # The amount of true positives.
},
"aggregateMetricsExact": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation with fuzzy matching off.
"f1Score": 3.14, # The calculated f1 score.
"falseNegativesCount": 42, # The amount of false negatives.
"falsePositivesCount": 42, # The amount of false positives.
"groundTruthDocumentCount": 42, # The amount of documents with a ground truth occurrence.
"groundTruthOccurrencesCount": 42, # The amount of occurrences in ground truth documents.
"precision": 3.14, # The calculated precision.
"predictedDocumentCount": 42, # The amount of documents with a predicted occurrence.
"predictedOccurrencesCount": 42, # The amount of occurrences in predicted documents.
"recall": 3.14, # The calculated recall.
"totalDocumentsCount": 42, # The amount of documents that had an occurrence of this label.
"truePositivesCount": 42, # The amount of true positives.
},
"evaluation": "A String", # The resource name of the evaluation.
"operation": "A String", # The resource name of the Long Running Operation for the evaluation.
},
"name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
"state": "A String", # The state of the processor version.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="process">process(name, body=None, x__xgafv=None)</code>
<pre>Processes a single document.
Args:
name: string, Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the ProcessDocument method.
"fieldMask": "A String", # Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.
"gcsDocument": { # Specifies a document stored on Cloud Storage. # A raw document on Google Cloud Storage.
"gcsUri": "A String", # The Cloud Storage object uri.
"mimeType": "A String", # An IANA MIME type (RFC6838) of the content.
},
"inlineDocument": { # 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. # An inline document proto.
"content": "A String", # 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.
"entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
{ # 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.
"confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
"id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
"mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
"mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
"normalizedValue": { # Parsed and normalized entity value. # 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.
"addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
"A String",
],
"administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
"languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
"locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
"organization": "A String", # Optional. The name of the organization at the address.
"postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
"recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
"A String",
],
"regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
"revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
"sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. C么te d'Ivoire).
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
},
"booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
"dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
"day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
"hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
"month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
"nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
"seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
"id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
},
"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
"year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
},
"floatValue": 3.14, # Float value.
"integerValue": 42, # Integer value.
"moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"text": "A String", # 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.
},
"pageAnchor": { # 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. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
"pageRefs": [ # One or more references to visual page elements
{ # Represents a weak reference to a page element within a document.
"boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # 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.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate (starts from the top of the image).
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
"x": 42, # X coordinate.
"y": 42, # Y coordinate (starts from the top of the image).
},
],
},
"confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
"layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
"layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
"page": "A String", # 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.
},
],
},
"properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity
],
"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
"id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
"parents": [ # References to the original elements that are replaced.
{ # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
"id": 42, # The id of the parent provenance.
"index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
"revision": 42, # The index of the index into current revision's parent_ids list.
},
],
"revision": 42, # The index of the revision that produced this element.
"type": "A String", # The type of provenance operation.
},
"redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
"textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
"content": "A String", # 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.
"textSegments": [ # The text segments from the Document.text.
{ # 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
"endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
"startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
},
],
},
"type": "A String", # Required. Entity type from a schema e.g. `Address`.
},
],
"entityRelations": [ # Placeholder. Relationship among Document.entities.
{ # Relationship between Entities.
"objectId": "A String", # Object entity id.
"relation": "A String", # Relationship description.
"subjectId": "A String", # Subject entity id.
},
],
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error that occurred while processing this document.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"mimeType": "A String", # An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
"pages": [ # Visual page layout for the Document.
{ # A page in a Document.
"blocks": [ # 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.
{ # A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
"detectedLanguages": [ # A list of detected languages together with confidence.
{ # Detected language for a structural component.
"confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
"languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
},
],
"layout": { # Visual element describing a layout unit on a page. # Layout for Block.
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # 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.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate (starts from the top of the image).
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
"x": 42, # X coordinate.
"y": 42, # Y coordinate (starts from the top of the image).
},
],
},
"confidence": 3.14, # 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]`.
"orientation": "A String", # Detected orientation for the Layout.
"textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
"content": "A String", # 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.
"textSegments": [ # The text segments from the Document.text.
{ # 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
"endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
"startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
},
],
},
},
"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
"id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
"parents": [ # References to the original elements that are replaced.
{ # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
"id": 42, # The id of the parent provenance.
"index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
"revision": 42, # The index of the index into current revision's parent_ids list.
},
],
"revision": 42, # The index of the revision that produced this element.
"type": "A String", # The type of provenance operation.
},
},
],
"detectedBarcodes": [ # A list of detected barcodes.
{ # A detected barcode.
"barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode.
"format": "A String", # 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.
"rawValue": "A String", # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
"valueFormat": "A String", # 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.
},
"layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode.
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # 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.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate (starts from the top of the image).
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
"x": 42, # X coordinate.
"y": 42, # Y coordinate (starts from the top of the image).
},
],
},
"confidence": 3.14, # 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]`.
"orientation": "A String", # Detected orientation for the Layout.
"textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
"content": "A String", # 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.
"textSegments": [ # The text segments from the Document.text.
{ # 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
"endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
"startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
},
],
},
},
},
],
"detectedLanguages": [ # A list of detected languages together with confidence.
{ # Detected language for a structural component.
"confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
"languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
},
],
"dimension": { # Dimension for the page. # Physical dimension of the page.
"height": 3.14, # Page height.
"unit": "A String", # Dimension unit.
"width": 3.14, # Page width.
},
"formFields": [ # A list of visually detected form fields on the page.
{ # A form field detected on the page.
"correctedKeyText": "A String", # 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.
"correctedValueText": "A String", # 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.
"fieldName": { # Visual element describing a layout unit on a page. # Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # 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.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate (starts from the top of the image).
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
"x": 42, # X coordinate.
"y": 42, # Y coordinate (starts from the top of the image).
},
],
},
"confidence": 3.14, # 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]`.
"orientation": "A String", # Detected orientation for the Layout.
"textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
"content": "A String", # 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.
"textSegments": [ # The text segments from the Document.text.
{ # 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
"endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
"startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
},
],
},
},
"fieldValue": { # Visual element describing a layout unit on a page. # Layout for the FormField value.
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # 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.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate (starts from the top of the image).
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
"x": 42, # X coordinate.
"y": 42, # Y coordinate (starts from the top of the image).
},
],
},
"confidence": 3.14, # 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]`.
"orientation": "A String", # Detected orientation for the Layout.
"textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
"content": "A String", # 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.
"textSegments": [ # The text segments from the Document.text.
{ # 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
"endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
"startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
},
],
},
},
"nameDetectedLanguages": [ # A list of detected languages for name together with confidence.
{ # Detected language for a structural component.
"confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
"languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
},
],
"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
"id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
"parents": [ # References to the original elements that are replaced.
{ # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
"id": 42, # The id of the parent provenance.
"index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
"revision": 42, # The index of the index into current revision's parent_ids list.
},
],
"revision": 42, # The index of the revision that produced this element.
"type": "A String", # The type of provenance operation.
},
"valueDetectedLanguages": [ # A list of detected languages for value together with confidence.
{ # Detected language for a structural component.
"confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
"languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
},
],
"valueType": "A String", # 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`
},
],
"image": { # Rendered image contents for this page. # 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.
"content": "A String", # Raw byte content of the image.
"height": 42, # Height of the image in pixels.
"mimeType": "A String", # Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.
"width": 42, # Width of the image in pixels.
},
"imageQualityScores": { # Image quality scores for the page image. # Image quality scores.
"detectedDefects": [ # A list of detected defects.
{ # Image Quality Defects
"confidence": 3.14, # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.
"type": "A String", # 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`
},
],
"qualityScore": 3.14, # The overall quality score. Range `[0, 1]` where `1` is perfect quality.
},
"layout": { # Visual element describing a layout unit on a page. # Layout for the page.
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # 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.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate (starts from the top of the image).
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
"x": 42, # X coordinate.
"y": 42, # Y coordinate (starts from the top of the image).
},
],
},
"confidence": 3.14, # 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]`.
"orientation": "A String", # Detected orientation for the Layout.
"textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
"content": "A String", # 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.
"textSegments": [ # The text segments from the Document.text.
{ # 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
"endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
"startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
},
],
},
},
"lines": [ # A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
{ # A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
"detectedLanguages": [ # A list of detected languages together with confidence.
{ # Detected language for a structural component.
"confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
"languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
},
],
"layout": { # Visual element describing a layout unit on a page. # Layout for Line.
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # 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.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate (starts from the top of the image).
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
"x": 42, # X coordinate.
"y": 42, # Y coordinate (starts from the top of the image).
},
],
},
"confidence": 3.14, # 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]`.
"orientation": "A String", # Detected orientation for the Layout.
"textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
"content": "A String", # 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.
"textSegments": [ # The text segments from the Document.text.
{ # 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
"endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
"startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
},
],
},
},
"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
"id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
"parents": [ # References to the original elements that are replaced.
{ # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
"id": 42, # The id of the parent provenance.
"index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
"revision": 42, # The index of the index into current revision's parent_ids list.
},
],
"revision": 42, # The index of the revision that produced this element.
"type": "A String", # The type of provenance operation.
},
},
],
"pageNumber": 42, # 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
"paragraphs": [ # A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
{ # A collection of lines that a human would perceive as a paragraph.
"detectedLanguages": [ # A list of detected languages together with confidence.
{ # Detected language for a structural component.
"confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
"languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
},
],
"layout": { # Visual element describing a layout unit on a page. # Layout for Paragraph.
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
"normalizedVertices": [ # The bounding polygon normalized vertices.
{ # 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.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate (starts from the top of the image).
},
],
"vertices": [ # The bounding polygon vertices.
{ # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
"x": 42, # X coordinate.
"y": 42, # Y coordinate (starts from the top of the image).
},
],
},
"confidence": 3.14, # 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]`.
"orientation": "A String", # Detected orientation for the Layout.
"textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
"content": "A String", # 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.
"textSegments": [ # The text segments from the Document.text.
{ # 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
"endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
"startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
},
],
},
},
"provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
"id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
"parents": [ # References to the original elements that are replaced.
{ # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
"id": 42, # The id of the parent provenance.
"index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.