feat: [discoveryengine] support extractive content in search (#9554)

- [ ] Regenerate this pull request now. feat: add redirected uri in search response feat: support docx/pptx/txt/csv in allowed data format docs: keep the API doc up-to-date with recent changes PiperOrigin-RevId: 541013898 Source-Link: https://togithub.com/googleapis/googleapis/commit/e491475a0207826f4246e4a69800df84e797d10d Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/2bfb35702b702b338c02b3daea5af58a871c44eb Copy-Tag: eyJwIjoiamF2YS1kaXNjb3ZlcnllbmdpbmUvLk93bEJvdC55YW1sIiwiaCI6IjJiZmIzNTcwMmI3MDJiMzM4YzAyYjNkYWVhNWFmNThhODcxYzQ0ZWIifQ==
googleapis · Jun 22, 2023 · af36e0a · af36e0a
1 parent 3c65d52
commit af36e0a
Show file tree

Hide file tree

Showing 19 changed files with 2,074 additions and 492 deletions.
diff --git a/java-discoveryengine/README.md b/java-discoveryengine/README.md
@@ -23,7 +23,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.16.0</version>
+      <version>26.17.0</version>
       <type>pom</type>
       <scope>import</scope>
     </dependency>
@@ -201,7 +201,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-preview-yellow
 [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-discoveryengine.svg
-[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-discoveryengine/0.14.0
+[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-discoveryengine/0.15.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/...ne-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/CompleteQueryRequest.java b/...ne-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/CompleteQueryRequest.java
@@ -196,6 +196,8 @@ public com.google.protobuf.ByteString getQueryBytes() {
    * API calls. Do not use it when there is no traffic for Search API.
    * * `user-event` - Using suggestions generated from user-imported search
    * events.
+   * * `document-completable` - Using suggestions taken directly from
+   * user-imported document fields marked as completable.
    *
    * Default values:
    *
@@ -234,6 +236,8 @@ public java.lang.String getQueryModel() {
    * API calls. Do not use it when there is no traffic for Search API.
    * * `user-event` - Using suggestions generated from user-imported search
    * events.
+   * * `document-completable` - Using suggestions taken directly from
+   * user-imported document fields marked as completable.
    *
    * Default values:
    *
@@ -1008,6 +1012,8 @@ public Builder setQueryBytes(com.google.protobuf.ByteString value) {
      * API calls. Do not use it when there is no traffic for Search API.
      * * `user-event` - Using suggestions generated from user-imported search
      * events.
+     * * `document-completable` - Using suggestions taken directly from
+     * user-imported document fields marked as completable.
      *
      * Default values:
      *
@@ -1045,6 +1051,8 @@ public java.lang.String getQueryModel() {
      * API calls. Do not use it when there is no traffic for Search API.
      * * `user-event` - Using suggestions generated from user-imported search
      * events.
+     * * `document-completable` - Using suggestions taken directly from
+     * user-imported document fields marked as completable.
      *
      * Default values:
      *
@@ -1082,6 +1090,8 @@ public com.google.protobuf.ByteString getQueryModelBytes() {
      * API calls. Do not use it when there is no traffic for Search API.
      * * `user-event` - Using suggestions generated from user-imported search
      * events.
+     * * `document-completable` - Using suggestions taken directly from
+     * user-imported document fields marked as completable.
      *
      * Default values:
      *
@@ -1118,6 +1128,8 @@ public Builder setQueryModel(java.lang.String value) {
      * API calls. Do not use it when there is no traffic for Search API.
      * * `user-event` - Using suggestions generated from user-imported search
      * events.
+     * * `document-completable` - Using suggestions taken directly from
+     * user-imported document fields marked as completable.
      *
      * Default values:
      *
@@ -1150,6 +1162,8 @@ public Builder clearQueryModel() {
      * API calls. Do not use it when there is no traffic for Search API.
      * * `user-event` - Using suggestions generated from user-imported search
      * events.
+     * * `document-completable` - Using suggestions taken directly from
+     * user-imported document fields marked as completable.
      *
      * Default values:
      *

diff --git a/.../src/main/java/com/google/cloud/discoveryengine/v1beta/CompleteQueryRequestOrBuilder.java b/.../src/main/java/com/google/cloud/discoveryengine/v1beta/CompleteQueryRequestOrBuilder.java
@@ -96,6 +96,8 @@ public interface CompleteQueryRequestOrBuilder
    * API calls. Do not use it when there is no traffic for Search API.
    * * `user-event` - Using suggestions generated from user-imported search
    * events.
+   * * `document-completable` - Using suggestions taken directly from
+   * user-imported document fields marked as completable.
    *
    * Default values:
    *
@@ -123,6 +125,8 @@ public interface CompleteQueryRequestOrBuilder
    * API calls. Do not use it when there is no traffic for Search API.
    * * `user-event` - Using suggestions generated from user-imported search
    * events.
+   * * `document-completable` - Using suggestions taken directly from
+   * user-imported document fields marked as completable.
    *
    * Default values:
    *

diff --git a/...iscoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/Document.java b/...iscoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/Document.java
@@ -159,8 +159,11 @@ public interface ContentOrBuilder
      * <pre>
      * The MIME type of the content. Supported types:
      *
-     * * `application/pdf` (PDF)
+     * * `application/pdf` (PDF, only native PDFs are supported for now)
      * * `text/html` (HTML)
+     * * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+     * * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+     * * `text/plain` (TXT)
      *
      * See https://www.iana.org/assignments/media-types/media-types.xhtml.
      * </pre>
@@ -176,8 +179,11 @@ public interface ContentOrBuilder
      * <pre>
      * The MIME type of the content. Supported types:
      *
-     * * `application/pdf` (PDF)
+     * * `application/pdf` (PDF, only native PDFs are supported for now)
      * * `text/html` (HTML)
+     * * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+     * * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+     * * `text/plain` (TXT)
      *
      * See https://www.iana.org/assignments/media-types/media-types.xhtml.
      * </pre>
@@ -418,8 +424,11 @@ public com.google.protobuf.ByteString getUriBytes() {
      * <pre>
      * The MIME type of the content. Supported types:
      *
-     * * `application/pdf` (PDF)
+     * * `application/pdf` (PDF, only native PDFs are supported for now)
      * * `text/html` (HTML)
+     * * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+     * * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+     * * `text/plain` (TXT)
      *
      * See https://www.iana.org/assignments/media-types/media-types.xhtml.
      * </pre>
@@ -446,8 +455,11 @@ public java.lang.String getMimeType() {
      * <pre>
      * The MIME type of the content. Supported types:
      *
-     * * `application/pdf` (PDF)
+     * * `application/pdf` (PDF, only native PDFs are supported for now)
      * * `text/html` (HTML)
+     * * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+     * * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+     * * `text/plain` (TXT)
      *
      * See https://www.iana.org/assignments/media-types/media-types.xhtml.
      * </pre>
@@ -1160,8 +1172,11 @@ public Builder setUriBytes(com.google.protobuf.ByteString value) {
        * <pre>
        * The MIME type of the content. Supported types:
        *
-       * * `application/pdf` (PDF)
+       * * `application/pdf` (PDF, only native PDFs are supported for now)
        * * `text/html` (HTML)
+       * * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+       * * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+       * * `text/plain` (TXT)
        *
        * See https://www.iana.org/assignments/media-types/media-types.xhtml.
        * </pre>
@@ -1187,8 +1202,11 @@ public java.lang.String getMimeType() {
        * <pre>
        * The MIME type of the content. Supported types:
        *
-       * * `application/pdf` (PDF)
+       * * `application/pdf` (PDF, only native PDFs are supported for now)
        * * `text/html` (HTML)
+       * * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+       * * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+       * * `text/plain` (TXT)
        *
        * See https://www.iana.org/assignments/media-types/media-types.xhtml.
        * </pre>
@@ -1214,8 +1232,11 @@ public com.google.protobuf.ByteString getMimeTypeBytes() {
        * <pre>
        * The MIME type of the content. Supported types:
        *
-       * * `application/pdf` (PDF)
+       * * `application/pdf` (PDF, only native PDFs are supported for now)
        * * `text/html` (HTML)
+       * * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+       * * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+       * * `text/plain` (TXT)
        *
        * See https://www.iana.org/assignments/media-types/media-types.xhtml.
        * </pre>
@@ -1240,8 +1261,11 @@ public Builder setMimeType(java.lang.String value) {
        * <pre>
        * The MIME type of the content. Supported types:
        *
-       * * `application/pdf` (PDF)
+       * * `application/pdf` (PDF, only native PDFs are supported for now)
        * * `text/html` (HTML)
+       * * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+       * * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+       * * `text/plain` (TXT)
        *
        * See https://www.iana.org/assignments/media-types/media-types.xhtml.
        * </pre>
@@ -1262,8 +1286,11 @@ public Builder clearMimeType() {
        * <pre>
        * The MIME type of the content. Supported types:
        *
-       * * `application/pdf` (PDF)
+       * * `application/pdf` (PDF, only native PDFs are supported for now)
        * * `text/html` (HTML)
+       * * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+       * * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+       * * `text/plain` (TXT)
        *
        * See https://www.iana.org/assignments/media-types/media-types.xhtml.
        * </pre>

diff --git a/...scoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/GcsSource.java b/...scoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/GcsSource.java
@@ -178,6 +178,10 @@ public com.google.protobuf.ByteString getInputUrisBytes(int index) {
    * * `custom`: One custom data JSON per row in arbitrary format that conforms
    *   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
    *   data store. This can only be used by the GENERIC Data Store vertical.
+   * * `csv`: A CSV file with header conforming the defined
+   * [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
+   *   data store. Each entry after the header will be imported as a Document.
+   *   This can only be used by the GENERIC Data Store vertical.
    *
    * Supported values for user even imports:
    *
@@ -220,6 +224,10 @@ public java.lang.String getDataSchema() {
    * * `custom`: One custom data JSON per row in arbitrary format that conforms
    *   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
    *   data store. This can only be used by the GENERIC Data Store vertical.
+   * * `csv`: A CSV file with header conforming the defined
+   * [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
+   *   data store. Each entry after the header will be imported as a Document.
+   *   This can only be used by the GENERIC Data Store vertical.
    *
    * Supported values for user even imports:
    *
@@ -881,6 +889,10 @@ public Builder addInputUrisBytes(com.google.protobuf.ByteString value) {
      * * `custom`: One custom data JSON per row in arbitrary format that conforms
      *   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
      *   data store. This can only be used by the GENERIC Data Store vertical.
+     * * `csv`: A CSV file with header conforming the defined
+     * [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
+     *   data store. Each entry after the header will be imported as a Document.
+     *   This can only be used by the GENERIC Data Store vertical.
      *
      * Supported values for user even imports:
      *
@@ -922,6 +934,10 @@ public java.lang.String getDataSchema() {
      * * `custom`: One custom data JSON per row in arbitrary format that conforms
      *   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
      *   data store. This can only be used by the GENERIC Data Store vertical.
+     * * `csv`: A CSV file with header conforming the defined
+     * [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
+     *   data store. Each entry after the header will be imported as a Document.
+     *   This can only be used by the GENERIC Data Store vertical.
      *
      * Supported values for user even imports:
      *
@@ -963,6 +979,10 @@ public com.google.protobuf.ByteString getDataSchemaBytes() {
      * * `custom`: One custom data JSON per row in arbitrary format that conforms
      *   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
      *   data store. This can only be used by the GENERIC Data Store vertical.
+     * * `csv`: A CSV file with header conforming the defined
+     * [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
+     *   data store. Each entry after the header will be imported as a Document.
+     *   This can only be used by the GENERIC Data Store vertical.
      *
      * Supported values for user even imports:
      *
@@ -1003,6 +1023,10 @@ public Builder setDataSchema(java.lang.String value) {
      * * `custom`: One custom data JSON per row in arbitrary format that conforms
      *   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
      *   data store. This can only be used by the GENERIC Data Store vertical.
+     * * `csv`: A CSV file with header conforming the defined
+     * [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
+     *   data store. Each entry after the header will be imported as a Document.
+     *   This can only be used by the GENERIC Data Store vertical.
      *
      * Supported values for user even imports:
      *
@@ -1039,6 +1063,10 @@ public Builder clearDataSchema() {
      * * `custom`: One custom data JSON per row in arbitrary format that conforms
      *   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
      *   data store. This can only be used by the GENERIC Data Store vertical.
+     * * `csv`: A CSV file with header conforming the defined
+     * [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
+     *   data store. Each entry after the header will be imported as a Document.
+     *   This can only be used by the GENERIC Data Store vertical.
      *
      * Supported values for user even imports:
      *

diff --git a/...gine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/GcsSourceOrBuilder.java b/...gine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/GcsSourceOrBuilder.java
@@ -121,6 +121,10 @@ public interface GcsSourceOrBuilder
    * * `custom`: One custom data JSON per row in arbitrary format that conforms
    *   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
    *   data store. This can only be used by the GENERIC Data Store vertical.
+   * * `csv`: A CSV file with header conforming the defined
+   * [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
+   *   data store. Each entry after the header will be imported as a Document.
+   *   This can only be used by the GENERIC Data Store vertical.
    *
    * Supported values for user even imports:
    *
@@ -152,6 +156,10 @@ public interface GcsSourceOrBuilder
    * * `custom`: One custom data JSON per row in arbitrary format that conforms
    *   the defined [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
    *   data store. This can only be used by the GENERIC Data Store vertical.
+   * * `csv`: A CSV file with header conforming the defined
+   * [Schema][google.cloud.discoveryengine.v1beta.Schema] of the
+   *   data store. Each entry after the header will be imported as a Document.
+   *   This can only be used by the GENERIC Data Store vertical.
    *
    * Supported values for user even imports:
    *