RubyGems - google-apis-recommendationengine_v1beta1 - Versions diffs - 0.1.0 → 0.6.0 - Mend

google-apis-recommendationengine_v1beta1 0.1.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +22 -0
data/OVERVIEW.md +3 -3
data/lib/google/apis/recommendationengine_v1beta1.rb +9 -6
data/lib/google/apis/recommendationengine_v1beta1/classes.rb +20 -10
data/lib/google/apis/recommendationengine_v1beta1/gem_version.rb +3 -3
data/lib/google/apis/recommendationengine_v1beta1/service.rb +36 -33
metadata +11 -11

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80ab1fa68850e120723d0d506930fbb0c79fb13d45ccfe3381780163190ad3d6
-  data.tar.gz: 6c1df3c74ae12894360ea40868fe6c6f4da98c437d56418148ea8158a2cf6a32
+  metadata.gz: 3ff116b70ca69f1bb684a162173112ec40c1dc803d3cb4ebd638f843b2801767
+  data.tar.gz: d4e86e39b9fcdb02dac05850bc428a4ab72d0a428bbe85c8715c04911b5de264
 SHA512:
-  metadata.gz: e48599fb8c8d1e9fa20171f2db21a3b2ca8da4705a6936c9cc1a9f1279fb96be2c353217d23ff3de9dd0a7f1af5a79d1728a4e8dd69741bf9fc839e0e1b9c9f0
-  data.tar.gz: 5ce1a5fc89db3c63bbb5dc5267d88160a871b5355d47e920c69343ececabef6eec01d31f5b26a374049342f656a217db87c6237b565db6d1f251b532fed29a1e
+  metadata.gz: cac46a0adf93b5ef055d72c30debc2fc5ca406a87065cad5bb69315f2cdbd3618807688a4377f3a44cb954310f51e177f43a9a0cbf4cb918c28c1aa3d8ba4bc9
+  data.tar.gz: ce7d4714b20918d2069dc31753ac3d56bfe053ca2069bd252ec54058053d224103bfa9364206368270a2f06a0d04a83752a1ef494fdda0243b0c950db9e6e16b

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,27 @@
 # Release history for google-apis-recommendationengine_v1beta1
+### v0.6.0 (2021-05-19)
+* Unspecified changes
+### v0.5.0 (2021-05-15)
+* Regenerated from discovery document revision 20210513
+### v0.4.0 (2021-03-27)
+* Regenerated from discovery document revision 20210319
+* Regenerated using generator version 0.2.0
+### v0.3.0 (2021-03-04)
+* Unspecified changes
+### v0.2.0 (2021-02-06)
+* Regenerated from discovery document revision 20210202
+* Regenerated using generator version 0.1.2
 ### v0.1.0 (2021-01-07)
 * Regenerated using generator version 0.1.1

data/OVERVIEW.md CHANGED Viewed

@@ -1,6 +1,6 @@
-# Simple REST client for version V1beta1 of the Recommendations AI
+# Simple REST client for version V1beta1 of the Recommendations AI (Beta)
-This is a simple client library for version V1beta1 of the Recommendations AI. It provides:
+This is a simple client library for version V1beta1 of the Recommendations AI (Beta). It provides:
 * A client object that connects to the HTTP/JSON REST endpoint for the service.
 * Ruby objects for data structures related to the service.
@@ -65,7 +65,7 @@ More detailed descriptions of the Google simple REST clients are available in tw
 (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Recommendationengine service in particular.)
-For reference information on specific calls in the Recommendations AI, see the {Google::Apis::RecommendationengineV1beta1::RecommendationsAIService class reference docs}.
+For reference information on specific calls in the Recommendations AI (Beta), see the {Google::Apis::RecommendationengineV1beta1::RecommendationsAIService class reference docs}.
 ## Which client should I use?

data/lib/google/apis/recommendationengine_v1beta1.rb CHANGED Viewed

@@ -19,19 +19,22 @@ require 'google/apis/recommendationengine_v1beta1/gem_version.rb'
 module Google
   module Apis
-    # Recommendations AI
+    # Recommendations AI (Beta)
     #
-    # Recommendations AI service enables customers to build end-to-end personalized
-    # recommendation systems without requiring a high level of expertise in machine
-    # learning, recommendation system, or Google Cloud.
+    # Note that we now highly recommend new customers to use Retail API, which
+    # incorporates the GA version of the Recommendations AI funtionalities. To
+    # enable Retail API, please visit https://console.cloud.google.com/apis/library/
+    # retail.googleapis.com. The Recommendations AI service enables customers to
+    # build end-to-end personalized recommendation systems without requiring a high
+    # level of expertise in machine learning, recommendation system, or Google Cloud.
     #
     # @see https://cloud.google.com/recommendations-ai/docs
     module RecommendationengineV1beta1
-      # Version of the Recommendations AI this client connects to.
+      # Version of the Recommendations AI (Beta) this client connects to.
       # This is NOT the gem version.
       VERSION = 'V1beta1'
-      # View and manage your data across Google Cloud Platform services
+      # See, edit, configure, and delete your Google Cloud Platform data
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
     end
   end

data/lib/google/apis/recommendationengine_v1beta1/classes.rb CHANGED Viewed

@@ -549,11 +549,12 @@ module Google
         include Google::Apis::Core::Hashable
         # Required. Google Cloud Storage URIs to input files. URI can be up to 2000
-        # characters long. URIs can match the full object path (for example, gs://bucket/
-        # directory/object.json) or a pattern matching one or more 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 catalog information](/recommendations-
-        # ai/docs/upload-catalog) for the expected file format and setup instructions.
+        # characters long. URIs can match the full object path (for example, `gs://
+        # bucket/directory/object.json`) or a pattern matching one or more 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 catalog information](/
+        # recommendations-ai/docs/upload-catalog) for the expected file format and setup
+        # instructions.
         # Corresponds to the JSON property `inputUris`
         # @return [Array<String>]
         attr_accessor :input_uris
@@ -1023,7 +1024,14 @@ module Google
         # indicates the probability of an item being clicked/purchased given the user's
         # context and history. * `strictFiltering`: Boolean. True by default. If set to
         # false, the service will return generic (unfiltered) popular items instead of
-        # empty if your filter blocks all prediction results.
+        # 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 adjust 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 adjust prediction results based on product category.
         # Corresponds to the JSON property `params`
         # @return [Hash<String,Object>]
         attr_accessor :params
@@ -1366,8 +1374,9 @@ module Google
         # @return [String]
         attr_accessor :list_id
-        # Required for `category-page-view` events. Other event types should not set
-        # this field. The categories associated with a category page. Category pages
+        # Required for `category-page-view` events. At least one of search_query or
+        # page_categories is required for `search` events. Other event types should not
+        # set this field. The categories associated with a category page. Category pages
         # include special pages such as sales or promotions. For instance, a special
         # sale page may have the category hierarchy: categories : ["Sales", "2017 Black
         # Friday Deals"].
@@ -1397,8 +1406,9 @@ module Google
         # @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PurchaseTransaction]
         attr_accessor :purchase_transaction
-        # Required for `search` events. Other event types should not set this field. The
-        # user's search query as UTF-8 encoded text with a length limit of 5 KiB.
+        # At least one of search_query or page_categories is required for `search`
+        # events. Other event types should not set this field. The user's search query
+        # as UTF-8 encoded text with a length limit of 5 KiB.
         # Corresponds to the JSON property `searchQuery`
         # @return [String]
         attr_accessor :search_query

data/lib/google/apis/recommendationengine_v1beta1/gem_version.rb CHANGED Viewed

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RecommendationengineV1beta1
       # Version of the google-apis-recommendationengine_v1beta1 gem
-      GEM_VERSION = "0.1.0"
+      GEM_VERSION = "0.6.0"
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.1.1"
+      GENERATOR_VERSION = "0.2.0"
       # Revision of the discovery document this client was generated from
-      REVISION = "20201212"
+      REVISION = "20210513"
     end
   end
 end

data/lib/google/apis/recommendationengine_v1beta1/service.rb CHANGED Viewed

@@ -20,11 +20,14 @@ require 'google/apis/errors'
 module Google
   module Apis
     module RecommendationengineV1beta1
-      # Recommendations AI
+      # Recommendations AI (Beta)
       #
-      # Recommendations AI service enables customers to build end-to-end personalized
-      #  recommendation systems without requiring a high level of expertise in machine
-      #  learning, recommendation system, or Google Cloud.
+      # Note that we now highly recommend new customers to use Retail API, which
+      #  incorporates the GA version of the Recommendations AI funtionalities. To
+      #  enable Retail API, please visit https://console.cloud.google.com/apis/library/
+      #  retail.googleapis.com. The Recommendations AI service enables customers to
+      #  build end-to-end personalized recommendation systems without requiring a high
+      #  level of expertise in machine learning, recommendation system, or Google Cloud.
       #
       # @example
       #    require 'google/apis/recommendationengine_v1beta1'
@@ -129,8 +132,8 @@ module Google
         # Creates a catalog item.
         # @param [String] parent
-        #   Required. The parent catalog resource name, such as "projects/*/locations/
-        #   global/catalogs/default_catalog".
+        #   Required. The parent catalog resource name, such as `projects/*/locations/
+        #   global/catalogs/default_catalog`.
         # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem] google_cloud_recommendationengine_v1beta1_catalog_item_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -163,8 +166,8 @@ module Google
         # Deletes a catalog item.
         # @param [String] name
-        #   Required. Full resource name of catalog item, such as "projects/*/locations/
-        #   global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
+        #   Required. Full resource name of catalog item, such as `projects/*/locations/
+        #   global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -194,8 +197,8 @@ module Google
         # Gets a specific catalog item.
         # @param [String] name
-        #   Required. Full resource name of catalog item, such as "projects/*/locations/
-        #   global/catalogs/default_catalog/catalogitems/some_catalog_item_id".
+        #   Required. Full resource name of catalog item, such as `projects/*/locations/
+        #   global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -228,7 +231,7 @@ module Google
         # response is of type ImportResponse. Note that it is possible for a subset of
         # the items to be successfully updated.
         # @param [String] parent
-        #   Required. "projects/1234/locations/global/catalogs/default_catalog" If no
+        #   Required. `projects/1234/locations/global/catalogs/default_catalog` If no
         #   updateMask is specified, requires catalogItems.create permission. If
         #   updateMask is specified, requires catalogItems.update permission.
         # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest] google_cloud_recommendationengine_v1beta1_import_catalog_items_request_object
@@ -263,8 +266,8 @@ module Google
         # Gets a list of catalog items.
         # @param [String] parent
-        #   Required. The parent catalog resource name, such as "projects/*/locations/
-        #   global/catalogs/default_catalog".
+        #   Required. The parent catalog resource name, such as `projects/*/locations/
+        #   global/catalogs/default_catalog`.
         # @param [String] filter
         #   Optional. A filter to apply on the list results.
         # @param [Fixnum] page_size
@@ -305,8 +308,8 @@ module Google
         # Updates a catalog item. Partial updating is supported. Non-existing items will
         # be created.
         # @param [String] name
-        #   Required. Full resource name of catalog item, such as "projects/*/locations/
-        #   global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
+        #   Required. Full resource name of catalog item, such as `projects/*/locations/
+        #   global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
         # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem] google_cloud_recommendationengine_v1beta1_catalog_item_object
         # @param [String] update_mask
         #   Optional. Indicates which fields in the provided 'item' to update. If not set,
@@ -423,8 +426,8 @@ module Google
         # more](https://cloud.google.com/recommendations-ai/docs/setting-up#register-key)
         # .
         # @param [String] name
-        #   Required. Full resource name of the format: `name=projects/*/locations/global/
-        #   catalogs/default_catalog/eventStores/default_event_store/placements/*` The id
+        #   Required. Full resource name of the format: ``name=projects/*/locations/global/
+        #   catalogs/default_catalog/eventStores/default_event_store/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
@@ -475,8 +478,8 @@ module Google
         # Register an API key for use with predict method.
         # @param [String] parent
-        #   Required. The parent resource path. "projects/*/locations/global/catalogs/
-        #   default_catalog/eventStores/default_event_store".
+        #   Required. The parent resource path. `projects/*/locations/global/catalogs/
+        #   default_catalog/eventStores/default_event_store`.
         # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest] google_cloud_recommendationengine_v1beta1_create_prediction_api_key_registration_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -509,9 +512,9 @@ module Google
         # Unregister an apiKey from using for predict method.
         # @param [String] name
-        #   Required. The API key to unregister including full resource path. "projects/*/
+        #   Required. The API key to unregister including full resource path. `projects/*/
         #   locations/global/catalogs/default_catalog/eventStores/default_event_store/
-        #   predictionApiKeyRegistrations/"
+        #   predictionApiKeyRegistrations/`
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -541,8 +544,8 @@ module Google
         # List the registered apiKeys for use with predict method.
         # @param [String] parent
-        #   Required. The parent placement resource name such as "projects/1234/locations/
-        #   global/catalogs/default_catalog/eventStores/default_event_store"
+        #   Required. The parent placement resource name such as `projects/1234/locations/
+        #   global/catalogs/default_catalog/eventStores/default_event_store`
         # @param [Fixnum] page_size
         #   Optional. Maximum number of results to return per page. If unset, the service
         #   will choose a reasonable default.
@@ -582,8 +585,8 @@ module Google
         # only by the Recommendations AI JavaScript pixel. Users should not call this
         # method directly.
         # @param [String] parent
-        #   Required. The parent eventStore name, such as "projects/1234/locations/global/
-        #   catalogs/default_catalog/eventStores/default_event_store".
+        #   Required. The parent eventStore name, such as `projects/1234/locations/global/
+        #   catalogs/default_catalog/eventStores/default_event_store`.
         # @param [Fixnum] ets
         #   Optional. The event timestamp in milliseconds. This prevents browser caching
         #   of otherwise identical get requests. The name is abbreviated to reduce the
@@ -631,8 +634,8 @@ module Google
         # possible for a subset of the items to be successfully inserted. Operation.
         # metadata is of type ImportMetadata.
         # @param [String] parent
-        #   Required. "projects/1234/locations/global/catalogs/default_catalog/eventStores/
-        #   default_event_store"
+        #   Required. `projects/1234/locations/global/catalogs/default_catalog/eventStores/
+        #   default_event_store`
         # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest] google_cloud_recommendationengine_v1beta1_import_user_events_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -670,8 +673,8 @@ module Google
         # If a catalog item of the ingested event is not in the current catalog, it
         # could lead to degraded model quality. This is called an unjoined event.
         # @param [String] parent
-        #   Required. The parent eventStore resource name, such as "projects/*/locations/*/
-        #   catalogs/default_catalog/eventStores/default_event_store".
+        #   Required. The parent eventStore resource name, such as `projects/*/locations/*/
+        #   catalogs/default_catalog/eventStores/default_event_store`.
         # @param [String] filter
         #   Optional. Filtering expression to specify restrictions over returned events.
         #   This is a sequence of terms, where each term applies some kind of a
@@ -732,8 +735,8 @@ module Google
         # first.
         # @param [String] parent
         #   Required. The resource name of the event_store under which the events are
-        #   created. The format is "projects/$`projectId`/locations/global/catalogs/$`
-        #   catalogId`/eventStores/$`eventStoreId`"
+        #   created. The format is `projects/$`projectId`/locations/global/catalogs/$`
+        #   catalogId`/eventStores/$`eventStoreId``
         # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest] google_cloud_recommendationengine_v1beta1_purge_user_events_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -772,8 +775,8 @@ module Google
         # catalog items. It can also be used to correct events joined with wrong catalog
         # items.
         # @param [String] parent
-        #   Required. Full resource name of user event, such as "projects/*/locations/*/
-        #   catalogs/default_catalog/eventStores/default_event_store".
+        #   Required. Full resource name of user event, such as `projects/*/locations/*/
+        #   catalogs/default_catalog/eventStores/default_event_store`.
         # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest] google_cloud_recommendationengine_v1beta1_rejoin_user_events_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-recommendationengine_v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -24,13 +24,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description: This is the simple REST client for Recommendations AI V1beta1. Simple
-  REST clients are Ruby client libraries that provide access to Google services via
-  their HTTP REST API endpoints. These libraries are generated and updated automatically
+description: This is the simple REST client for Recommendations AI (Beta) V1beta1.
+  Simple REST clients are Ruby client libraries that provide access to Google services
+  via their HTTP REST API endpoints. These libraries are generated and updated automatically
   based on the discovery documents published by the service, and they handle most
   concerns such as authentication, pagination, retry, timeouts, and logging. You can
-  use this client to access the Recommendations AI, but note that some services may
-  provide a separate modern client that is easier to use.
+  use this client to access the Recommendations AI (Beta), but note that some services
+  may provide a separate modern client that is easier to use.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -52,7 +52,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-recommendationengine_v1beta1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-recommendationengine_v1beta1/v0.1.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-recommendationengine_v1beta1/v0.6.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-recommendationengine_v1beta1
 post_install_message:
 rdoc_options: []
@@ -62,15 +62,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.17
 signing_key:
 specification_version: 4
-summary: Simple REST client for Recommendations AI V1beta1
+summary: Simple REST client for Recommendations AI (Beta) V1beta1
 test_files: []