google-cloud-retail-v2 0.3.2 → 0.5.0

data/proto_docs/google/cloud/retail/v2/completion_service.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Retail
+      module V2
+        # Auto-complete parameters.
+        # @!attribute [rw] catalog
+        #   @return [::String]
+        #     Required. Catalog for which the completion is performed.
+        #
+        #     Full resource name of catalog, such as
+        #     `projects/*/locations/global/catalogs/default_catalog`.
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     Required. The query used to generate suggestions.
+        #
+        #     The maximum number of allowed characters is 255.
+        # @!attribute [rw] visitor_id
+        #   @return [::String]
+        #     A unique identifier for tracking visitors. For example, this could be
+        #     implemented with an HTTP cookie, which should be able to uniquely identify
+        #     a visitor on a single device. This unique identifier should not change if
+        #     the visitor logs in or out of the website.
+        #
+        #     The field must be a UTF-8 encoded string with a length limit of 128
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] language_codes
+        #   @return [::Array<::String>]
+        #     The list of languages of the query. This is
+        #     the BCP-47 language code, such as "en-US" or "sr-Latn".
+        #     For more information, see
+        #     [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
+        #
+        #     The maximum number of allowed characters is 255.
+        #     Only "en-US" is currently supported.
+        # @!attribute [rw] device_type
+        #   @return [::String]
+        #     The device type context for completion suggestions.
+        #     It is useful to apply different suggestions on different device types, e.g.
+        #     DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+        #     types.
+        #
+        #     Supported formats:
+        #
+        #     * UNKNOWN_DEVICE_TYPE
+        #
+        #     * DESKTOP
+        #
+        #     * MOBILE
+        #
+        #     * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+        # @!attribute [rw] dataset
+        #   @return [::String]
+        #     Determines which dataset to use for fetching completion. "user-data" will
+        #     use the imported dataset through
+        #     {::Google::Cloud::Retail::V2::CompletionService::Client#import_completion_data CompletionService.ImportCompletionData}.
+        #     "cloud-retail" will use the dataset generated by cloud retail based on user
+        #     events. If leave empty, it will use the "user-data".
+        #
+        #     Current supported values:
+        #
+        #     * user-data
+        #
+        #     * cloud-retail
+        #       This option requires additional allowlisting. Before using cloud-retail,
+        #       contact Cloud Retail support team first.
+        # @!attribute [rw] max_suggestions
+        #   @return [::Integer]
+        #     Completion max suggestions. If left unset or set to 0, then will fallback
+        #     to the configured value [CompletionConfig.max_suggestions][].
+        #
+        #     The maximum allowed max suggestions is 20. If it is set higher, it will be
+        #     capped by 20.
+        class CompleteQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the auto-complete query.
+        # @!attribute [rw] completion_results
+        #   @return [::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::CompletionResult>]
+        #     Results of the matching suggestions. The result list is ordered and the
+        #     first result is top suggestion.
+        # @!attribute [rw] attribution_token
+        #   @return [::String]
+        #     A unique complete token. This should be included in the
+        #     {::Google::Cloud::Retail::V2::SearchRequest SearchRequest} resulting from this
+        #     completion, which enables accurate attribution of complete model
+        #     performance.
+        # @!attribute [rw] recent_search_results
+        #   @return [::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>]
+        #     Matched recent searches of this user. The maximum number of recent searches
+        #     is 10. This field is a restricted feature. Contact Retail Search support
+        #     team if you are interested in enabling it.
+        #
+        #     This feature is only available when
+        #     {::Google::Cloud::Retail::V2::CompleteQueryRequest#visitor_id CompleteQueryRequest.visitor_id}
+        #     field is set and {::Google::Cloud::Retail::V2::UserEvent UserEvent} is imported.
+        #     The recent searches satisfy the follow rules:
+        #      * They are ordered from latest to oldest.
+        #      * They are matched with
+        #      {::Google::Cloud::Retail::V2::CompleteQueryRequest#query CompleteQueryRequest.query}
+        #      case insensitively.
+        #      * They are transformed to lower cases.
+        #      * They are UTF-8 safe.
+        #
+        #     Recent searches are deduplicated. More recent searches will be reserved
+        #     when duplication happens.
+        class CompleteQueryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Resource that represents completion results.
+          # @!attribute [rw] suggestion
+          #   @return [::String]
+          #     The suggestion for the query.
+          # @!attribute [rw] attributes
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
+          #     Additional custom attributes ingested through BigQuery.
+          class CompletionResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
+            class AttributesEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Recent search of this user.
+          # @!attribute [rw] recent_search
+          #   @return [::String]
+          #     The recent search query.
+          class RecentSearchResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/retail/v2/import_config.rb

@@ -31,7 +31,7 @@ module Google
         #     files, such as `gs://bucket/directory/*.json`. A request can
         #     contain at most 100 files, and each file can be up to 2 GB. See
         #     [Importing product
-        #     information](https://cloud.google.com/recommendations-ai/docs/upload-catalog)
+        #     information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog)
         #     for the expected file format and setup instructions.
         # @!attribute [rw] data_schema
         #   @return [::String]
@@ -50,18 +50,25 @@ module Google
         #     * `user_event` (default): One JSON
         #     {::Google::Cloud::Retail::V2::UserEvent UserEvent} per line.
         #     * `user_event_ga360`: Using
-        #       https://support.google.com/analytics/answer/3437719?hl=en.
+        #       https://support.google.com/analytics/answer/3437719.
         class GcsSource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
         # BigQuery source import data from.
+        # @!attribute [rw] partition_date
+        #   @return [::Google::Type::Date]
+        #     BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
+        #
+        #     Only supported when
+        #     {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
+        #     is set to `FULL`.
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     The project id (can be project # or id) that the BigQuery source is in with
+        #     The project ID (can be project # or ID) that the BigQuery source is in with
         #     a length limit of 128 characters. If not specified, inherits the project
-        #     id from the parent request.
+        #     ID from the parent request.
         # @!attribute [rw] dataset_id
         #   @return [::String]
         #     Required. The BigQuery data set to copy the data from with a length limit
@@ -92,7 +99,7 @@ module Google
         #     * `user_event` (default): One JSON
         #     {::Google::Cloud::Retail::V2::UserEvent UserEvent} per line.
         #     * `user_event_ga360`: Using
-        #       https://support.google.com/analytics/answer/3437719?hl=en.
+        #       https://support.google.com/analytics/answer/3437719.
         class BigQuerySource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -103,7 +110,7 @@ module Google
         #   @return [::Array<::Google::Cloud::Retail::V2::Product>]
         #     Required. A list of products to update/create. Each product must have a
         #     valid {::Google::Cloud::Retail::V2::Product#id Product.id}. Recommended max of
-        #     10k items.
+        #     100 items.
         class ProductInlineSource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -138,6 +145,17 @@ module Google
         #
         #     If no updateMask is specified, requires products.create permission.
         #     If updateMask is specified, requires products.update permission.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Unique identifier provided by client, within the ancestor
+        #     dataset scope. Ensures idempotency and used for request deduplication.
+        #     Server-generated if unspecified. Up to 128 characters long and must match
+        #     the pattern: "[a-zA-Z0-9_]+". This is returned as [Operation.name][] in
+        #     {::Google::Cloud::Retail::V2::ImportMetadata ImportMetadata}.
+        #
+        #     Only supported when
+        #     {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
+        #     is set to `FULL`.
         # @!attribute [rw] input_config
         #   @return [::Google::Cloud::Retail::V2::ProductInputConfig]
         #     Required. The desired input location of the data.
@@ -148,9 +166,50 @@ module Google
         #   @return [::Google::Protobuf::FieldMask]
         #     Indicates which fields in the provided imported 'products' to update. If
         #     not set, will by default update all fields.
+        # @!attribute [rw] reconciliation_mode
+        #   @return [::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode]
+        #     The mode of reconciliation between existing products and the products to be
+        #     imported. Defaults to
+        #     {::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
+        # @!attribute [rw] notification_pubsub_topic
+        #   @return [::String]
+        #     Pub/Sub topic for receiving notification. If this field is set,
+        #     when the import is finished, a notification will be sent to
+        #     specified Pub/Sub topic. The message data will be JSON string of a
+        #     {::Google::Longrunning::Operation Operation}.
+        #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
+        #
+        #     Only supported when
+        #     {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
+        #     is set to `FULL`.
         class ImportProductsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Indicates how imported products are reconciled with the existing products
+          # created or imported before.
+          module ReconciliationMode
+            # Defaults to INCREMENTAL.
+            RECONCILIATION_MODE_UNSPECIFIED = 0
+
+            # Inserts new products or updates existing products.
+            INCREMENTAL = 1
+
+            # Calculates diff and replaces the entire product dataset. Existing
+            # products may be deleted if they are not present in the source location.
+            #
+            # Can only be while using
+            # {::Google::Cloud::Retail::V2::BigQuerySource BigQuerySource}.
+            #
+            # Add the IAM permission "BigQuery Data Viewer" for
+            # cloud-retail-customer-data-access@system.gserviceaccount.com before
+            # using this feature otherwise an error is thrown.
+            #
+            # This feature is only available for users who have Retail Search enabled.
+            # Please submit a form [here](https://cloud.google.com/contact) to contact
+            # cloud sales if you are interested in using Retail Search.
+            FULL = 2
+          end
         end
 
         # Request message for the ImportUserEvents request.
@@ -169,6 +228,27 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for ImportCompletionData methods.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The catalog which the suggestions dataset belongs to.
+        #
+        #     Format: `projects/1234/locations/global/catalogs/default_catalog`.
+        # @!attribute [rw] input_config
+        #   @return [::Google::Cloud::Retail::V2::CompletionDataInputConfig]
+        #     Required. The desired input location of the data.
+        # @!attribute [rw] notification_pubsub_topic
+        #   @return [::String]
+        #     Pub/Sub topic for receiving notification. If this field is set,
+        #     when the import is finished, a notification will be sent to
+        #     specified Pub/Sub topic. The message data will be JSON string of a
+        #     {::Google::Longrunning::Operation Operation}.
+        #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
+        class ImportCompletionDataRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The input config source for products.
         # @!attribute [rw] product_inline_source
         #   @return [::Google::Cloud::Retail::V2::ProductInlineSource]
@@ -199,6 +279,19 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The input config source for completion data.
+        # @!attribute [rw] big_query_source
+        #   @return [::Google::Cloud::Retail::V2::BigQuerySource]
+        #     Required. BigQuery input source.
+        #
+        #     Add the IAM permission "BigQuery Data Viewer" for
+        #     cloud-retail-customer-data-access@system.gserviceaccount.com before
+        #     using this feature otherwise an error is thrown.
+        class CompletionDataInputConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Metadata related to the progress of the Import operation. This will be
         # returned by the google.longrunning.Operation.metadata field.
         # @!attribute [rw] create_time
@@ -214,6 +307,17 @@ module Google
         # @!attribute [rw] failure_count
         #   @return [::Integer]
         #     Count of entries that encountered errors while processing.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Id of the request / operation. This is parroting back the requestId
+        #     that was passed in the request.
+        # @!attribute [rw] notification_pubsub_topic
+        #   @return [::String]
+        #     Pub/Sub topic for receiving notification. If this field is set,
+        #     when the import is finished, a notification will be sent to
+        #     specified Pub/Sub topic. The message data will be JSON string of a
+        #     {::Google::Longrunning::Operation Operation}.
+        #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
         class ImportMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -265,6 +369,18 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Response of the
+        # {::Google::Cloud::Retail::V2::ImportCompletionDataRequest ImportCompletionDataRequest}.
+        # If the long running operation is done, this message is returned by the
+        # google.longrunning.Operations.response field if the operation is successful.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        class ImportCompletionDataResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/cloud/retail/v2/prediction_service.rb

@@ -26,30 +26,10 @@ module Google
         #   @return [::String]
         #     Required. Full resource name of the format:
         #     \\{name=projects/*/locations/global/catalogs/default_catalog/placements/*}
-        #     The id of the recommendation engine placement. This id is used to identify
-        #     the set of models that will be used to make the prediction.
-        #
-        #     We currently support three placements with the following IDs by default:
-        #
-        #     * `shopping_cart`: Predicts products frequently bought together with one or
-        #       more  products in the same shopping session. Commonly displayed after
-        #       `add-to-cart` events, on product detail pages, or on the shopping cart
-        #       page.
-        #
-        #     * `home_page`: Predicts the next product that a user will most likely
-        #       engage with or purchase based on the shopping or viewing history of the
-        #       specified `userId` or `visitorId`. For example - Recommendations for you.
-        #
-        #     * `product_detail`: Predicts the next product that a user will most likely
-        #       engage with or purchase. The prediction is based on the shopping or
-        #       viewing history of the specified `userId` or `visitorId` and its
-        #       relevance to a specified `CatalogItem`. Typically used on product detail
-        #       pages. For example - More products like this.
-        #
-        #     * `recently_viewed_default`: Returns up to 75 products recently viewed by
-        #       the specified `userId` or `visitorId`, most recent ones first. Returns
-        #       nothing if neither of them has viewed any products yet. For example -
-        #       Recently viewed.
+        #     The ID of the Recommendations AI placement. Before you can request
+        #     predictions from your model, you must create at least one placement for it.
+        #     For more information, see [Managing
+        #     placements](https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
         #
         #     The full list of available placements can be seen at
         #     https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
@@ -80,6 +60,9 @@ module Google
         #        `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
         #        with a size limit of 1,000 characters.
         #
+        #        Note: "Recently viewed" models don't support tag filtering at the
+        #        moment.
+        #
         #      * filterOutOfStockItems. Restricts predictions to products that do not
         #      have a
         #        stockState value of OUT_OF_STOCK.
@@ -116,17 +99,35 @@ module Google
         #     * `strictFiltering`: Boolean. True by default. If set to false, the service
         #        will return generic (unfiltered) popular products instead of empty if
         #        your filter blocks all prediction results.
+        #     * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
+        #        it needs to be one of {'no-price-reranking', 'low-price-reranking',
+        #        'medium-price-reranking', 'high-price-reranking'}. This gives
+        #        request-level control and adjusts prediction results based on product
+        #        price.
+        #     * `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 prediction results based on product
+        #        category.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
-        #     The labels for the predict request.
+        #     The labels applied to a resource must meet the following requirements:
         #
-        #      * Label keys can contain lowercase letters, digits and hyphens, must start
-        #        with a letter, and must end with a letter or digit.
-        #      * Non-zero label values can contain lowercase letters, digits and hyphens,
-        #        must start with a letter, and must end with a letter or digit.
-        #      * No more than 64 labels can be associated with a given request.
+        #     * 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 https://goo.gl/xmQnxf for more information on and examples of labels.
+        #     See [Google Cloud
+        #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+        #     for more details.
         class PredictRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods