Skip to content

Commit 2bd259f

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: [documentai] updated comments (#10015)
* docs: updated comments PiperOrigin-RevId: 578242041 Source-Link: googleapis/googleapis@f9bd3d0 Source-Link: https://github.com/googleapis/googleapis-gen/commit/ee681d8ecb3421017d94dcc4f05423d93deb4a0d Copy-Tag: eyJwIjoiamF2YS1kb2N1bWVudC1haS8uT3dsQm90LnlhbWwiLCJoIjoiZWU2ODFkOGVjYjM0MjEwMTdkOTRkY2M0ZjA1NDIzZDkzZGViNGEwZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent d80aa3c commit 2bd259f

7 files changed

Lines changed: 45 additions & 43 deletions

File tree

‎java-document-ai/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
2020
<dependency>
2121
<groupId>com.google.cloud</groupId>
2222
<artifactId>libraries-bom</artifactId>
23-
<version>26.25.0</version>
23+
<version>26.26.0</version>
2424
<type>pom</type>
2525
<scope>import</scope>
2626
</dependency>
@@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
195195
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
196196
[stability-image]: https://img.shields.io/badge/stability-stable-green
197197
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-document-ai.svg
198-
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-document-ai/2.32.0
198+
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-document-ai/2.33.0
199199
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
200200
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
201201
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

‎java-document-ai/proto-google-cloud-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/OcrConfig.java‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -918,8 +918,8 @@ public interface PremiumFeaturesOrBuilder
918918
*
919919
*
920920
* <pre>
921-
* Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
922-
* processors.
921+
* Turn on selection mark detector in OCR engine. Only available in OCR 2.0
922+
* (and later) processors.
923923
* </pre>
924924
*
925925
* <code>bool enable_selection_mark_detection = 3;</code>
@@ -1002,8 +1002,8 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
10021002
*
10031003
*
10041004
* <pre>
1005-
* Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
1006-
* processors.
1005+
* Turn on selection mark detector in OCR engine. Only available in OCR 2.0
1006+
* (and later) processors.
10071007
* </pre>
10081008
*
10091009
* <code>bool enable_selection_mark_detection = 3;</code>
@@ -1448,8 +1448,8 @@ public Builder mergeFrom(
14481448
*
14491449
*
14501450
* <pre>
1451-
* Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
1452-
* processors.
1451+
* Turn on selection mark detector in OCR engine. Only available in OCR 2.0
1452+
* (and later) processors.
14531453
* </pre>
14541454
*
14551455
* <code>bool enable_selection_mark_detection = 3;</code>
@@ -1464,8 +1464,8 @@ public boolean getEnableSelectionMarkDetection() {
14641464
*
14651465
*
14661466
* <pre>
1467-
* Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
1468-
* processors.
1467+
* Turn on selection mark detector in OCR engine. Only available in OCR 2.0
1468+
* (and later) processors.
14691469
* </pre>
14701470
*
14711471
* <code>bool enable_selection_mark_detection = 3;</code>
@@ -1484,8 +1484,8 @@ public Builder setEnableSelectionMarkDetection(boolean value) {
14841484
*
14851485
*
14861486
* <pre>
1487-
* Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
1488-
* processors.
1487+
* Turn on selection mark detector in OCR engine. Only available in OCR 2.0
1488+
* (and later) processors.
14891489
* </pre>
14901490
*
14911491
* <code>bool enable_selection_mark_detection = 3;</code>
@@ -1895,7 +1895,7 @@ public boolean getComputeStyleInfo() {
18951895
*
18961896
* <pre>
18971897
* Turn off character box detector in OCR engine. Character box detection is
1898-
* enabled by default in OCR 2.0+ processors.
1898+
* enabled by default in OCR 2.0 (and later) processors.
18991899
* </pre>
19001900
*
19011901
* <code>bool disable_character_boxes_detection = 10;</code>
@@ -3146,7 +3146,7 @@ public Builder clearComputeStyleInfo() {
31463146
*
31473147
* <pre>
31483148
* Turn off character box detector in OCR engine. Character box detection is
3149-
* enabled by default in OCR 2.0+ processors.
3149+
* enabled by default in OCR 2.0 (and later) processors.
31503150
* </pre>
31513151
*
31523152
* <code>bool disable_character_boxes_detection = 10;</code>
@@ -3162,7 +3162,7 @@ public boolean getDisableCharacterBoxesDetection() {
31623162
*
31633163
* <pre>
31643164
* Turn off character box detector in OCR engine. Character box detection is
3165-
* enabled by default in OCR 2.0+ processors.
3165+
* enabled by default in OCR 2.0 (and later) processors.
31663166
* </pre>
31673167
*
31683168
* <code>bool disable_character_boxes_detection = 10;</code>
@@ -3182,7 +3182,7 @@ public Builder setDisableCharacterBoxesDetection(boolean value) {
31823182
*
31833183
* <pre>
31843184
* Turn off character box detector in OCR engine. Character box detection is
3185-
* enabled by default in OCR 2.0+ processors.
3185+
* enabled by default in OCR 2.0 (and later) processors.
31863186
* </pre>
31873187
*
31883188
* <code>bool disable_character_boxes_detection = 10;</code>

‎java-document-ai/proto-google-cloud-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/OcrConfigOrBuilder.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ public interface OcrConfigOrBuilder
199199
*
200200
* <pre>
201201
* Turn off character box detector in OCR engine. Character box detection is
202-
* enabled by default in OCR 2.0+ processors.
202+
* enabled by default in OCR 2.0 (and later) processors.
203203
* </pre>
204204
*
205205
* <code>bool disable_character_boxes_detection = 10;</code>

‎java-document-ai/proto-google-cloud-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/ProcessOptions.java‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -907,8 +907,8 @@ public boolean hasIndividualPageSelector() {
907907
*
908908
*
909909
* <pre>
910-
* Only process certain pages from the start, process all if the document
911-
* has less pages.
910+
* Only process certain pages from the start. Process all if the document
911+
* has fewer pages.
912912
* </pre>
913913
*
914914
* <code>int32 from_start = 6;</code>
@@ -923,8 +923,8 @@ public boolean hasFromStart() {
923923
*
924924
*
925925
* <pre>
926-
* Only process certain pages from the start, process all if the document
927-
* has less pages.
926+
* Only process certain pages from the start. Process all if the document
927+
* has fewer pages.
928928
* </pre>
929929
*
930930
* <code>int32 from_start = 6;</code>
@@ -1743,8 +1743,8 @@ public Builder clearIndividualPageSelector() {
17431743
*
17441744
*
17451745
* <pre>
1746-
* Only process certain pages from the start, process all if the document
1747-
* has less pages.
1746+
* Only process certain pages from the start. Process all if the document
1747+
* has fewer pages.
17481748
* </pre>
17491749
*
17501750
* <code>int32 from_start = 6;</code>
@@ -1758,8 +1758,8 @@ public boolean hasFromStart() {
17581758
*
17591759
*
17601760
* <pre>
1761-
* Only process certain pages from the start, process all if the document
1762-
* has less pages.
1761+
* Only process certain pages from the start. Process all if the document
1762+
* has fewer pages.
17631763
* </pre>
17641764
*
17651765
* <code>int32 from_start = 6;</code>
@@ -1776,8 +1776,8 @@ public int getFromStart() {
17761776
*
17771777
*
17781778
* <pre>
1779-
* Only process certain pages from the start, process all if the document
1780-
* has less pages.
1779+
* Only process certain pages from the start. Process all if the document
1780+
* has fewer pages.
17811781
* </pre>
17821782
*
17831783
* <code>int32 from_start = 6;</code>
@@ -1796,8 +1796,8 @@ public Builder setFromStart(int value) {
17961796
*
17971797
*
17981798
* <pre>
1799-
* Only process certain pages from the start, process all if the document
1800-
* has less pages.
1799+
* Only process certain pages from the start. Process all if the document
1800+
* has fewer pages.
18011801
* </pre>
18021802
*
18031803
* <code>int32 from_start = 6;</code>

‎java-document-ai/proto-google-cloud-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/ProcessOptionsOrBuilder.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ public interface ProcessOptionsOrBuilder
6969
*
7070
*
7171
* <pre>
72-
* Only process certain pages from the start, process all if the document
73-
* has less pages.
72+
* Only process certain pages from the start. Process all if the document
73+
* has fewer pages.
7474
* </pre>
7575
*
7676
* <code>int32 from_start = 6;</code>
@@ -82,8 +82,8 @@ public interface ProcessOptionsOrBuilder
8282
*
8383
*
8484
* <pre>
85-
* Only process certain pages from the start, process all if the document
86-
* has less pages.
85+
* Only process certain pages from the start. Process all if the document
86+
* has fewer pages.
8787
* </pre>
8888
*
8989
* <code>int32 from_start = 6;</code>

‎java-document-ai/proto-google-cloud-document-ai-v1/src/main/proto/google/cloud/documentai/v1/document_io.proto‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ message OcrConfig {
124124

125125
// Configurations for premium OCR features.
126126
message PremiumFeatures {
127-
// Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
128-
// processors.
127+
// Turn on selection mark detector in OCR engine. Only available in OCR 2.0
128+
// (and later) processors.
129129
bool enable_selection_mark_detection = 3;
130130

131131
// Turn on font identification model and return font style information.
@@ -166,7 +166,7 @@ message OcrConfig {
166166
bool compute_style_info = 8 [deprecated = true];
167167

168168
// Turn off character box detector in OCR engine. Character box detection is
169-
// enabled by default in OCR 2.0+ processors.
169+
// enabled by default in OCR 2.0 (and later) processors.
170170
bool disable_character_boxes_detection = 10;
171171

172172
// Configurations for premium OCR features.

‎java-document-ai/proto-google-cloud-document-ai-v1/src/main/proto/google/cloud/documentai/v1/document_processor_service.proto‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -334,17 +334,19 @@ message ProcessOptions {
334334
repeated int32 pages = 1 [(google.api.field_behavior) = OPTIONAL];
335335
}
336336

337-
// A subset of pages to process. If not specified, all pages will be
338-
// processed. NOTICE: If any of the page range is set, we will extract and
339-
// process only the given pages from the document. In the output document,
340-
// the page_number is referring to the page number in the original document.
341-
// This config only applies to sync requests.
337+
// A subset of pages to process. If not specified, all pages are processed.
338+
// If a page range is set, only the given pages are extracted and processed
339+
// from the document. In the output document,
340+
// [Document.Page.page_number][google.cloud.documentai.v1.Document.Page.page_number]
341+
// refers to the page number in the original document. This configuration
342+
// only applies to sync requests. `page_range` can be only one of the
343+
// following:
342344
oneof page_range {
343345
// Which pages to process (1-indexed).
344346
IndividualPageSelector individual_page_selector = 5;
345347

346-
// Only process certain pages from the start, process all if the document
347-
// has less pages.
348+
// Only process certain pages from the start. Process all if the document
349+
// has fewer pages.
348350
int32 from_start = 6;
349351

350352
// Only process certain pages from the end, same as above.

0 commit comments

Comments
 (0)