google-cloud-discovery_engine-v1 0.6.0 → 0.7.0

data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb

@@ -47,11 +47,11 @@ module Google
         #       bits of SHA256(URI) encoded as a hex string.
         #     * `custom`: One custom data JSON per row in arbitrary format that conforms
         #       to the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the
-        #       data store. This can only be used by Gen App Builder.
+        #       data store. This can only be used by the GENERIC Data Store vertical.
         #     * `csv`: A CSV file with header conforming to the defined
         #     {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the
         #       data store. Each entry after the header is imported as a Document.
-        #       This can only be used by Gen App Builder.
+        #       This can only be used by the GENERIC Data Store vertical.
         #
         #     Supported values for user even imports:
         #
@@ -104,12 +104,267 @@ module Google
         #       {::Google::Cloud::DiscoveryEngine::V1::Document#struct_data Document.struct_data}.
         #     * `custom`: One custom data per row in arbitrary format that conforms to
         #       the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the data
-        #       store. This can only be used by Gen App Builder.
+        #       store. This can only be used by the GENERIC Data Store vertical.
         class BigQuerySource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The Spanner source for importing data
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     The project ID that the Spanner source is in with a length limit of 128
+        #     characters. If not specified, inherits the project ID from the parent
+        #     request.
+        # @!attribute [rw] instance_id
+        #   @return [::String]
+        #     Required. The instance ID of the source Spanner table.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     Required. The database ID of the source Spanner table.
+        # @!attribute [rw] table_id
+        #   @return [::String]
+        #     Required. The table name of the Spanner database that needs to be imported.
+        # @!attribute [rw] enable_data_boost
+        #   @return [::Boolean]
+        #     Whether to apply data boost on Spanner export. Enabling this option will
+        #     incur additional cost. More info can be found
+        #     [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).
+        class SpannerSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The Bigtable Options object that contains information to support
+        # the import.
+        # @!attribute [rw] key_field_name
+        #   @return [::String]
+        #     The field name used for saving row key value in the document. The name has
+        #     to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
+        # @!attribute [rw] families
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily}]
+        #     The mapping from family names to an object that contains column families
+        #     level information for the given column family. If a family is not present
+        #     in this map it will be ignored.
+        class BigtableOptions
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The column family of the Bigtable.
+          # @!attribute [rw] field_name
+          #   @return [::String]
+          #     The field name to use for this column family in the document. The
+          #     name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set,
+          #     it is parsed from the family name with best effort. However, due to
+          #     different naming patterns, field name collisions could happen, where
+          #     parsing behavior is undefined.
+          # @!attribute [rw] encoding
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Encoding]
+          #     The encoding mode of the values when the type is not STRING.
+          #     Acceptable encoding values are:
+          #
+          #     * `TEXT`: indicates values are alphanumeric text strings.
+          #     * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
+          #     family of functions. This can be overridden for a specific column
+          #     by listing that column in `columns` and specifying an encoding for it.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Type]
+          #     The type of values in this column family.
+          #     The values are expected to be encoded using `HBase Bytes.toBytes`
+          #     function when the encoding value is set to `BINARY`.
+          # @!attribute [rw] columns
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumn>]
+          #     The list of objects that contains column level information for each
+          #     column. If a column is not present in this list it will be ignored.
+          class BigtableColumnFamily
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The column of the Bigtable.
+          # @!attribute [rw] qualifier
+          #   @return [::String]
+          #     Required. Qualifier of the column. If it cannot be decoded with utf-8,
+          #     use a base-64 encoded string instead.
+          # @!attribute [rw] field_name
+          #   @return [::String]
+          #     The field name to use for this column in the document. The name has to
+          #     match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
+          #     If not set, it is parsed from the qualifier bytes with best effort.
+          #     However, due to different naming patterns, field name collisions could
+          #     happen, where parsing behavior is undefined.
+          # @!attribute [rw] encoding
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Encoding]
+          #     The encoding mode of the values when the type is not `STRING`.
+          #     Acceptable encoding values are:
+          #
+          #     * `TEXT`: indicates values are alphanumeric text strings.
+          #     * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes`
+          #     family of functions. This can be overridden for a specific column
+          #     by listing that column in `columns` and specifying an encoding for it.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Type]
+          #     The type of values in this column family.
+          #     The values are expected to be encoded using `HBase Bytes.toBytes`
+          #     function when the encoding value is set to `BINARY`.
+          class BigtableColumn
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily]
+          class FamiliesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The type of values in a Bigtable column or column family.
+          # The values are expected to be encoded using
+          # [HBase
+          # Bytes.toBytes](https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Bytes.html)
+          # function when the encoding value is set to `BINARY`.
+          module Type
+            # The type is unspecified.
+            TYPE_UNSPECIFIED = 0
+
+            # String type.
+            STRING = 1
+
+            # Numerical type.
+            NUMBER = 2
+
+            # Integer type.
+            INTEGER = 3
+
+            # Variable length integer type.
+            VAR_INTEGER = 4
+
+            # BigDecimal type.
+            BIG_NUMERIC = 5
+
+            # Boolean type.
+            BOOLEAN = 6
+
+            # JSON type.
+            JSON = 7
+          end
+
+          # The encoding mode of a Bigtable column or column family.
+          module Encoding
+            # The encoding is unspecified.
+            ENCODING_UNSPECIFIED = 0
+
+            # Text encoding.
+            TEXT = 1
+
+            # Binary encoding.
+            BINARY = 2
+          end
+        end
+
+        # The Cloud Bigtable source for importing data.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     The project ID that the Bigtable source is in with a length limit of 128
+        #     characters. If not specified, inherits the project ID from the parent
+        #     request.
+        # @!attribute [rw] instance_id
+        #   @return [::String]
+        #     Required. The instance ID of the Cloud Bigtable that needs to be imported.
+        # @!attribute [rw] table_id
+        #   @return [::String]
+        #     Required. The table ID of the Cloud Bigtable that needs to be imported.
+        # @!attribute [rw] bigtable_options
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions]
+        #     Required. Bigtable options that contains information needed when parsing
+        #     data into typed structures. For example, column type annotations.
+        class BigtableSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Cloud FhirStore source import data from.
+        # @!attribute [rw] fhir_store
+        #   @return [::String]
+        #     Required. The full resource name of the FHIR store to import data from, in
+        #     the format of
+        #     `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
+        # @!attribute [rw] gcs_staging_dir
+        #   @return [::String]
+        #     Intermediate Cloud Storage directory used for the import with a length
+        #     limit of 2,000 characters. Can be specified if one wants to have the
+        #     FhirStore export to a specific Cloud Storage directory.
+        class FhirStoreSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Cloud SQL source import data from.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     The project ID that the Cloud SQL source is in with a length limit of 128
+        #     characters. If not specified, inherits the project ID from the parent
+        #     request.
+        # @!attribute [rw] instance_id
+        #   @return [::String]
+        #     Required. The Cloud SQL instance to copy the data from with a length limit
+        #     of 256 characters.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     Required. The Cloud SQL database to copy the data from with a length limit
+        #     of 256 characters.
+        # @!attribute [rw] table_id
+        #   @return [::String]
+        #     Required. The Cloud SQL table to copy the data from with a length limit of
+        #     256 characters.
+        # @!attribute [rw] gcs_staging_dir
+        #   @return [::String]
+        #     Intermediate Cloud Storage directory used for the import with a length
+        #     limit of 2,000 characters. Can be specified if one wants to have the
+        #     Cloud SQL export to a specific Cloud Storage directory.
+        #
+        #     Ensure that the Cloud SQL service account has the necessary Cloud
+        #     Storage Admin permissions to access the specified Cloud Storage directory.
+        # @!attribute [rw] offload
+        #   @return [::Boolean]
+        #     Option for serverless export. Enabling this option will incur additional
+        #     cost. More info can be found
+        #     [here](https://cloud.google.com/sql/pricing#serverless).
+        class CloudSqlSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Firestore source import data from.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     The project ID that the Cloud SQL source is in with a length limit of 128
+        #     characters. If not specified, inherits the project ID from the parent
+        #     request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     Required. The Firestore database to copy the data from with a length limit
+        #     of 256 characters.
+        # @!attribute [rw] collection_id
+        #   @return [::String]
+        #     Required. The Firestore collection to copy the data from with a length
+        #     limit of 1,500 characters.
+        # @!attribute [rw] gcs_staging_dir
+        #   @return [::String]
+        #     Intermediate Cloud Storage directory used for the import with a length
+        #     limit of 2,000 characters. Can be specified if one wants to have the
+        #     Firestore export to a specific Cloud Storage directory.
+        #
+        #     Ensure that the Firestore service account has the necessary Cloud
+        #     Storage Admin permissions to access the specified Cloud Storage directory.
+        class FirestoreSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Configuration of destination for Import related errors.
         # @!attribute [rw] gcs_prefix
         #   @return [::String]
@@ -211,6 +466,9 @@ module Google
         # @!attribute [rw] failure_count
         #   @return [::Integer]
         #     Count of entries that encountered errors while processing.
+        # @!attribute [rw] total_count
+        #   @return [::Integer]
+        #     Total count of entries that were processed.
         class ImportDocumentsMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -226,6 +484,21 @@ module Google
         # @!attribute [rw] bigquery_source
         #   @return [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource]
         #     BigQuery input source.
+        # @!attribute [rw] fhir_store_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::FhirStoreSource]
+        #     FhirStore input source.
+        # @!attribute [rw] spanner_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SpannerSource]
+        #     Spanner input source.
+        # @!attribute [rw] cloud_sql_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource]
+        #     Cloud SQL input source.
+        # @!attribute [rw] firestore_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::FirestoreSource]
+        #     Firestore input source.
+        # @!attribute [rw] bigtable_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableSource]
+        #     Cloud Bigtable input source.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent branch resource name, such as
@@ -239,6 +512,10 @@ module Google
         #     The mode of reconciliation between existing documents and the documents to
         #     be imported. Defaults to
         #     {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided imported documents to update. If
+        #     not set, the default is to update all fields.
         # @!attribute [rw] auto_generate_ids
         #   @return [::Boolean]
         #     Whether to automatically generate IDs for the documents if absent.
@@ -254,42 +531,54 @@ module Google
         #     {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#id_field id_field},
         #     otherwise, documents without IDs fail to be imported.
         #
-        #     Only set this field when using
-        #     {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
-        #     {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}, and when
+        #     Supported data sources:
+        #
+        #     * {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource}.
         #     {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
-        #     or
+        #     must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+        #     * {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}.
         #     {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
-        #     is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+        #     must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+        #     * {::Google::Cloud::DiscoveryEngine::V1::SpannerSource SpannerSource}.
+        #     * {::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource CloudSqlSource}.
+        #     * {::Google::Cloud::DiscoveryEngine::V1::FirestoreSource FirestoreSource}.
+        #     * {::Google::Cloud::DiscoveryEngine::V1::BigtableSource BigtableSource}.
         # @!attribute [rw] id_field
         #   @return [::String]
-        #     The field in the Cloud Storage and BigQuery sources that indicates the
-        #     unique IDs of the documents.
+        #     The field indicates the ID field or column to be used as unique IDs of
+        #     the documents.
         #
         #     For {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} it is the key of
         #     the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`.
-        #     For {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource} it is
-        #     the column name of the BigQuery table where the unique ids are stored.
+        #     For others, it may be the column name of the table where the unique ids are
+        #     stored.
         #
-        #     The values of the JSON field or the BigQuery column are used as the
+        #     The values of the JSON field or the table column are used as the
         #     {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}s. The JSON field
-        #     or the BigQuery column must be of string type, and the values must be set
-        #     as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
+        #     or the table column must be of string type, and the values must be set as
+        #     valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
         #     with 1-63 characters. Otherwise, documents without valid IDs fail to be
         #     imported.
         #
-        #     Only set this field when using
-        #     {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
-        #     {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}, and when
-        #     {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
-        #     or
-        #     {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
-        #     is `custom`. And only set this field when
+        #     Only set this field when
         #     {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#auto_generate_ids auto_generate_ids}
         #     is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
         #
         #     If it is unset, a default value `_id` is used when importing from the
         #     allowed data sources.
+        #
+        #     Supported data sources:
+        #
+        #     * {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource}.
+        #     {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
+        #     must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+        #     * {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}.
+        #     {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
+        #     must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
+        #     * {::Google::Cloud::DiscoveryEngine::V1::SpannerSource SpannerSource}.
+        #     * {::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource CloudSqlSource}.
+        #     * {::Google::Cloud::DiscoveryEngine::V1::FirestoreSource FirestoreSource}.
+        #     * {::Google::Cloud::DiscoveryEngine::V1::BigtableSource BigtableSource}.
         class ImportDocumentsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb

@@ -74,6 +74,9 @@ module Google
         # @!attribute [rw] failure_count
         #   @return [::Integer]
         #     Count of entries that encountered errors while processing.
+        # @!attribute [rw] ignored_count
+        #   @return [::Integer]
+        #     Count of entries that were ignored as entries were not found.
         class PurgeDocumentsMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        # Request message for Recommend method.
+        # @!attribute [rw] serving_config
+        #   @return [::String]
+        #     Required. Full resource name of a [ServingConfig][]:
+        #     `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
+        #     `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
+        #
+        #     One default serving config is created along with your recommendation engine
+        #     creation. The engine ID will be used as the ID of the default serving
+        #     config. For example, for Engine
+        #     `projects/*/locations/global/collections/*/engines/my-engine`, you can use
+        #     `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
+        #     for your
+        #     {::Google::Cloud::DiscoveryEngine::V1::RecommendationService::Client#recommend RecommendationService.Recommend}
+        #     requests.
+        # @!attribute [rw] user_event
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::UserEvent]
+        #     Required. Context about the user, what they are looking at and what action
+        #     they took to trigger the Recommend request. Note that this user event
+        #     detail won't be ingested to userEvent logs. Thus, a separate userEvent
+        #     write request is required for event logging.
+        #
+        #     Don't set
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
+        #     or
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserInfo#user_id UserEvent.user_info.user_id}
+        #     to the same fixed ID for different users. If you are trying to receive
+        #     non-personalized recommendations (not recommended; this can negatively
+        #     impact model performance), instead set
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
+        #     to a random unique ID and leave
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserInfo#user_id UserEvent.user_info.user_id}
+        #     unset.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of results to return. Set this property
+        #     to the number of recommendation results needed. If zero, the service will
+        #     choose a reasonable default. The maximum allowed value is 100. Values
+        #     above 100 will be coerced to 100.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Filter for restricting recommendation results with a length limit of 5,000
+        #     characters. Currently, only filter expressions on the `filter_tags`
+        #     attribute is supported.
+        #
+        #
+        #     Examples:
+        #
+        #      * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
+        #      * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
+        #
+        #     If `attributeFilteringSyntax` is set to true under the `params` field, then
+        #     attribute-based expressions are expected instead of the above described
+        #     tag-based syntax. Examples:
+        #
+        #      * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
+        #      * (available: true) AND
+        #        (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
+        #
+        #     If your filter blocks all results, the API will return generic
+        #     (unfiltered) popular Documents. If you only want results strictly matching
+        #     the filters, set `strictFiltering` to True in
+        #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}
+        #     to receive empty results instead.
+        #
+        #     Note that the API will never return
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}s with `storageStatus`
+        #     of `EXPIRED` or `DELETED` regardless of filter choices.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Use validate only mode for this recommendation query. If set to true, a
+        #     fake model will be used that returns arbitrary Document IDs.
+        #     Note that the validate only mode should only be used for testing the API,
+        #     or if the model is not ready.
+        # @!attribute [rw] params
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
+        #     Additional domain specific parameters for the recommendations.
+        #
+        #     Allowed values:
+        #
+        #     * `returnDocument`: Boolean. If set to true, the associated Document
+        #        object will be returned in
+        #        {::Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult#document RecommendResponse.RecommendationResult.document}.
+        #     * `returnScore`: Boolean. If set to true, the recommendation 'score'
+        #        corresponding to each returned Document will be set in
+        #        {::Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult#metadata RecommendResponse.RecommendationResult.metadata}.
+        #        The given 'score' indicates the probability of a Document conversion
+        #        given the user's context and history.
+        #     * `strictFiltering`: Boolean. True by default. If set to false, the service
+        #        will return generic (unfiltered) popular Documents instead of empty if
+        #        your filter blocks all recommendation results.
+        #     * `diversityLevel`: String. Default empty. If set to be non-empty, then
+        #        it needs to be one of:
+        #         *  `no-diversity`
+        #         *  `low-diversity`
+        #         *  `medium-diversity`
+        #         *  `high-diversity`
+        #         *  `auto-diversity`
+        #        This gives request-level control and adjusts recommendation results
+        #        based on Document category.
+        #     * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
+        #        the `filter` field is interpreted according to the new,
+        #        attribute-based syntax.
+        # @!attribute [rw] user_labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The user labels applied to a resource must meet the following requirements:
+        #
+        #     * Each resource can have multiple labels, up to a maximum of 64.
+        #     * Each label must be a key-value pair.
+        #     * Keys have a minimum length of 1 character and a maximum length of 63
+        #       characters and cannot be empty. Values can be empty and have a maximum
+        #       length of 63 characters.
+        #     * Keys and values can contain only lowercase letters, numeric characters,
+        #       underscores, and dashes. All characters must use UTF-8 encoding, and
+        #       international characters are allowed.
+        #     * The key portion of a label must be unique. However, you can use the same
+        #       key with multiple resources.
+        #     * Keys must start with a lowercase letter or international character.
+        #
+        #     See [Requirements for
+        #     labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+        #     for more details.
+        class RecommendRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Protobuf::Value]
+          class ParamsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class UserLabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for Recommend method.
+        # @!attribute [rw] results
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult>]
+        #     A list of recommended Documents. The order represents the ranking (from the
+        #     most relevant Document to the least).
+        # @!attribute [rw] attribution_token
+        #   @return [::String]
+        #     A unique attribution token. This should be included in the
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent UserEvent} logs resulting from
+        #     this recommendation, which enables accurate attribution of recommendation
+        #     model performance.
+        # @!attribute [rw] missing_ids
+        #   @return [::Array<::String>]
+        #     IDs of documents in the request that were missing from the default Branch
+        #     associated with the requested ServingConfig.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     True if
+        #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#validate_only RecommendRequest.validate_only}
+        #     was set.
+        class RecommendResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # RecommendationResult represents a generic recommendation result with
+          # associated metadata.
+          # @!attribute [rw] id
+          #   @return [::String]
+          #     Resource ID of the recommended Document.
+          # @!attribute [rw] document
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Document]
+          #     Set if `returnDocument` is set to true in
+          #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
+          # @!attribute [rw] metadata
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
+          #     Additional Document metadata / annotations.
+          #
+          #     Possible values:
+          #
+          #     * `score`: Recommendation score in double value. Is set if
+          #       `returnScore` is set to true in
+          #       {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
+          class RecommendationResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Protobuf::Value]
+            class MetadataEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end