Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [documentai] minor clarification on fields related to page range #9955

Merged
merged 2 commits into from Oct 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions java-document-ai/README.md
Expand Up @@ -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.23.0</version>
<version>26.25.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down Expand Up @@ -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.28.0
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-document-ai/2.32.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
Expand Down
Expand Up @@ -907,8 +907,8 @@ public boolean hasIndividualPageSelector() {
*
*
* <pre>
* Only process certain pages from the start. Process all if the document
* has fewer pages.
* Only process certain pages from the start, process all if the document
* has less pages.
* </pre>
*
* <code>int32 from_start = 6;</code>
Expand All @@ -923,8 +923,8 @@ public boolean hasFromStart() {
*
*
* <pre>
* Only process certain pages from the start. Process all if the document
* has fewer pages.
* Only process certain pages from the start, process all if the document
* has less pages.
* </pre>
*
* <code>int32 from_start = 6;</code>
Expand Down Expand Up @@ -1743,8 +1743,8 @@ public Builder clearIndividualPageSelector() {
*
*
* <pre>
* Only process certain pages from the start. Process all if the document
* has fewer pages.
* Only process certain pages from the start, process all if the document
* has less pages.
* </pre>
*
* <code>int32 from_start = 6;</code>
Expand All @@ -1758,8 +1758,8 @@ public boolean hasFromStart() {
*
*
* <pre>
* Only process certain pages from the start. Process all if the document
* has fewer pages.
* Only process certain pages from the start, process all if the document
* has less pages.
* </pre>
*
* <code>int32 from_start = 6;</code>
Expand All @@ -1776,8 +1776,8 @@ public int getFromStart() {
*
*
* <pre>
* Only process certain pages from the start. Process all if the document
* has fewer pages.
* Only process certain pages from the start, process all if the document
* has less pages.
* </pre>
*
* <code>int32 from_start = 6;</code>
Expand All @@ -1796,8 +1796,8 @@ public Builder setFromStart(int value) {
*
*
* <pre>
* Only process certain pages from the start. Process all if the document
* has fewer pages.
* Only process certain pages from the start, process all if the document
* has less pages.
* </pre>
*
* <code>int32 from_start = 6;</code>
Expand Down
Expand Up @@ -69,8 +69,8 @@ public interface ProcessOptionsOrBuilder
*
*
* <pre>
* Only process certain pages from the start. Process all if the document
* has fewer pages.
* Only process certain pages from the start, process all if the document
* has less pages.
* </pre>
*
* <code>int32 from_start = 6;</code>
Expand All @@ -82,8 +82,8 @@ public interface ProcessOptionsOrBuilder
*
*
* <pre>
* Only process certain pages from the start. Process all if the document
* has fewer pages.
* Only process certain pages from the start, process all if the document
* has less pages.
* </pre>
*
* <code>int32 from_start = 6;</code>
Expand Down
Expand Up @@ -337,15 +337,14 @@ message ProcessOptions {
// 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,
// [Document.Page.page_number][google.cloud.documentai.v1.Document.Page.page_number]
// is referring to the page number in the original document. This
// configuration only applies to sync requests.
// the page_number is referring to the page number in the original document.
// This config only applies to sync requests.
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 fewer pages.
// Only process certain pages from the start, process all if the document
// has less pages.
int32 from_start = 6;

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