docs: [documentai] updated comments (#10015)

* docs: updated comments PiperOrigin-RevId: 578242041 Source-Link: googleapis/googleapis@f9bd3d0 Source-Link: googleapis/googleapis-gen@ee681d8 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>
googleapis · Nov 1, 2023 · 2bd259f · 2bd259f
1 parent d80aa3c
commit 2bd259f
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 43 deletions.
diff --git a/java-document-ai/README.md b/java-document-ai/README.md
@@ -20,7 +20,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
     <dependency>
       <groupId>com.google.cloud</groupId>
       <artifactId>libraries-bom</artifactId>
-      <version>26.25.0</version>
+      <version>26.26.0</version>
       <type>pom</type>
       <scope>import</scope>
     </dependency>
@@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
 [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
 [stability-image]: https://img.shields.io/badge/stability-stable-green
 [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-document-ai.svg
-[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-document-ai/2.32.0
+[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-document-ai/2.33.0
 [authentication]: https://github.com/googleapis/google-cloud-java#authentication
 [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
 [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

diff --git a/...o-google-cloud-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/OcrConfig.java b/...o-google-cloud-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/OcrConfig.java
@@ -918,8 +918,8 @@ public interface PremiumFeaturesOrBuilder
      *
      *
      * <pre>
-     * Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
-     * processors.
+     * Turn on selection mark detector in OCR engine. Only available in OCR 2.0
+     * (and later) processors.
      * </pre>
      *
      * <code>bool enable_selection_mark_detection = 3;</code>
@@ -1002,8 +1002,8 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
      *
      *
      * <pre>
-     * Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
-     * processors.
+     * Turn on selection mark detector in OCR engine. Only available in OCR 2.0
+     * (and later) processors.
      * </pre>
      *
      * <code>bool enable_selection_mark_detection = 3;</code>
@@ -1448,8 +1448,8 @@ public Builder mergeFrom(
        *
        *
        * <pre>
-       * Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
-       * processors.
+       * Turn on selection mark detector in OCR engine. Only available in OCR 2.0
+       * (and later) processors.
        * </pre>
        *
        * <code>bool enable_selection_mark_detection = 3;</code>
@@ -1464,8 +1464,8 @@ public boolean getEnableSelectionMarkDetection() {
        *
        *
        * <pre>
-       * Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
-       * processors.
+       * Turn on selection mark detector in OCR engine. Only available in OCR 2.0
+       * (and later) processors.
        * </pre>
        *
        * <code>bool enable_selection_mark_detection = 3;</code>
@@ -1484,8 +1484,8 @@ public Builder setEnableSelectionMarkDetection(boolean value) {
        *
        *
        * <pre>
-       * Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
-       * processors.
+       * Turn on selection mark detector in OCR engine. Only available in OCR 2.0
+       * (and later) processors.
        * </pre>
        *
        * <code>bool enable_selection_mark_detection = 3;</code>
@@ -1895,7 +1895,7 @@ public boolean getComputeStyleInfo() {
    *
    * <pre>
    * Turn off character box detector in OCR engine. Character box detection is
-   * enabled by default in OCR 2.0+ processors.
+   * enabled by default in OCR 2.0 (and later) processors.
    * </pre>
    *
    * <code>bool disable_character_boxes_detection = 10;</code>
@@ -3146,7 +3146,7 @@ public Builder clearComputeStyleInfo() {
      *
      * <pre>
      * Turn off character box detector in OCR engine. Character box detection is
-     * enabled by default in OCR 2.0+ processors.
+     * enabled by default in OCR 2.0 (and later) processors.
      * </pre>
      *
      * <code>bool disable_character_boxes_detection = 10;</code>
@@ -3162,7 +3162,7 @@ public boolean getDisableCharacterBoxesDetection() {
      *
      * <pre>
      * Turn off character box detector in OCR engine. Character box detection is
-     * enabled by default in OCR 2.0+ processors.
+     * enabled by default in OCR 2.0 (and later) processors.
      * </pre>
      *
      * <code>bool disable_character_boxes_detection = 10;</code>
@@ -3182,7 +3182,7 @@ public Builder setDisableCharacterBoxesDetection(boolean value) {
      *
      * <pre>
      * Turn off character box detector in OCR engine. Character box detection is
-     * enabled by default in OCR 2.0+ processors.
+     * enabled by default in OCR 2.0 (and later) processors.
      * </pre>
      *
      * <code>bool disable_character_boxes_detection = 10;</code>

diff --git a/...cloud-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/OcrConfigOrBuilder.java b/...cloud-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/OcrConfigOrBuilder.java
@@ -199,7 +199,7 @@ public interface OcrConfigOrBuilder
    *
    * <pre>
    * Turn off character box detector in OCR engine. Character box detection is
-   * enabled by default in OCR 2.0+ processors.
+   * enabled by default in OCR 2.0 (and later) processors.
    * </pre>
    *
    * <code>bool disable_character_boxes_detection = 10;</code>

diff --git a/...gle-cloud-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/ProcessOptions.java b/...gle-cloud-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/ProcessOptions.java
@@ -907,8 +907,8 @@ public boolean hasIndividualPageSelector() {
    *
    *
    * <pre>
-   * Only process certain pages from the start, process all if the document
-   * has less pages.
+   * Only process certain pages from the start. Process all if the document
+   * has fewer pages.
    * </pre>
    *
    * <code>int32 from_start = 6;</code>
@@ -923,8 +923,8 @@ public boolean hasFromStart() {
    *
    *
    * <pre>
-   * Only process certain pages from the start, process all if the document
-   * has less pages.
+   * Only process certain pages from the start. Process all if the document
+   * has fewer pages.
    * </pre>
    *
    * <code>int32 from_start = 6;</code>
@@ -1743,8 +1743,8 @@ public Builder clearIndividualPageSelector() {
      *
      *
      * <pre>
-     * Only process certain pages from the start, process all if the document
-     * has less pages.
+     * Only process certain pages from the start. Process all if the document
+     * has fewer pages.
      * </pre>
      *
      * <code>int32 from_start = 6;</code>
@@ -1758,8 +1758,8 @@ public boolean hasFromStart() {
      *
      *
      * <pre>
-     * Only process certain pages from the start, process all if the document
-     * has less pages.
+     * Only process certain pages from the start. Process all if the document
+     * has fewer pages.
      * </pre>
      *
      * <code>int32 from_start = 6;</code>
@@ -1776,8 +1776,8 @@ public int getFromStart() {
      *
      *
      * <pre>
-     * Only process certain pages from the start, process all if the document
-     * has less pages.
+     * Only process certain pages from the start. Process all if the document
+     * has fewer pages.
      * </pre>
      *
      * <code>int32 from_start = 6;</code>
@@ -1796,8 +1796,8 @@ public Builder setFromStart(int value) {
      *
      *
      * <pre>
-     * Only process certain pages from the start, process all if the document
-     * has less pages.
+     * Only process certain pages from the start. Process all if the document
+     * has fewer pages.
      * </pre>
      *
      * <code>int32 from_start = 6;</code>

diff --git a/...-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/ProcessOptionsOrBuilder.java b/...-document-ai-v1/src/main/java/com/google/cloud/documentai/v1/ProcessOptionsOrBuilder.java
@@ -69,8 +69,8 @@ public interface ProcessOptionsOrBuilder
    *
    *
    * <pre>
-   * Only process certain pages from the start, process all if the document
-   * has less pages.
+   * Only process certain pages from the start. Process all if the document
+   * has fewer pages.
    * </pre>
    *
    * <code>int32 from_start = 6;</code>
@@ -82,8 +82,8 @@ public interface ProcessOptionsOrBuilder
    *
    *
    * <pre>
-   * Only process certain pages from the start, process all if the document
-   * has less pages.
+   * Only process certain pages from the start. Process all if the document
+   * has fewer pages.
    * </pre>
    *
    * <code>int32 from_start = 6;</code>

diff --git a/...o-google-cloud-document-ai-v1/src/main/proto/google/cloud/documentai/v1/document_io.proto b/...o-google-cloud-document-ai-v1/src/main/proto/google/cloud/documentai/v1/document_io.proto
@@ -124,8 +124,8 @@ message OcrConfig {
 
   // Configurations for premium OCR features.
   message PremiumFeatures {
-    // Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
-    // processors.
+    // Turn on selection mark detector in OCR engine. Only available in OCR 2.0
+    // (and later) processors.
     bool enable_selection_mark_detection = 3;
 
     // Turn on font identification model and return font style information.
@@ -166,7 +166,7 @@ message OcrConfig {
   bool compute_style_info = 8 [deprecated = true];
 
   // Turn off character box detector in OCR engine. Character box detection is
-  // enabled by default in OCR 2.0+ processors.
+  // enabled by default in OCR 2.0 (and later) processors.
   bool disable_character_boxes_detection = 10;
 
   // Configurations for premium OCR features.

diff --git a/...document-ai-v1/src/main/proto/google/cloud/documentai/v1/document_processor_service.proto b/...document-ai-v1/src/main/proto/google/cloud/documentai/v1/document_processor_service.proto
@@ -334,17 +334,19 @@ message ProcessOptions {
     repeated int32 pages = 1 [(google.api.field_behavior) = OPTIONAL];
   }
 
-  // A subset of pages to process. If not specified, all pages will be
-  // processed. NOTICE: If any of the page range is set, we will extract and
-  // process only the given pages from the document. In the output document,
-  // the page_number is referring to the page number in the original document.
-  // This config only applies to sync requests.
+  // A subset of pages to process. If not specified, all pages are processed.
+  //  If a page range is set, only the given pages are extracted and processed
+  //  from the document. In the output document,
+  //  [Document.Page.page_number][google.cloud.documentai.v1.Document.Page.page_number]
+  //  refers to the page number in the original document. This configuration
+  //  only applies to sync requests. `page_range` can be only one of the
+  //  following:
   oneof page_range {
     // Which pages to process (1-indexed).
     IndividualPageSelector individual_page_selector = 5;
 
-    // Only process certain pages from the start, process all if the document
-    // has less pages.
+    // Only process certain pages from the start. Process all if the document
+    // has fewer pages.
     int32 from_start = 6;
 
     // Only process certain pages from the end, same as above.