google-apis-recommendationengine_v1beta1 0.1.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 80ab1fa68850e120723d0d506930fbb0c79fb13d45ccfe3381780163190ad3d6
4
- data.tar.gz: 6c1df3c74ae12894360ea40868fe6c6f4da98c437d56418148ea8158a2cf6a32
3
+ metadata.gz: 3ff116b70ca69f1bb684a162173112ec40c1dc803d3cb4ebd638f843b2801767
4
+ data.tar.gz: d4e86e39b9fcdb02dac05850bc428a4ab72d0a428bbe85c8715c04911b5de264
5
5
  SHA512:
6
- metadata.gz: e48599fb8c8d1e9fa20171f2db21a3b2ca8da4705a6936c9cc1a9f1279fb96be2c353217d23ff3de9dd0a7f1af5a79d1728a4e8dd69741bf9fc839e0e1b9c9f0
7
- data.tar.gz: 5ce1a5fc89db3c63bbb5dc5267d88160a871b5355d47e920c69343ececabef6eec01d31f5b26a374049342f656a217db87c6237b565db6d1f251b532fed29a1e
6
+ metadata.gz: cac46a0adf93b5ef055d72c30debc2fc5ca406a87065cad5bb69315f2cdbd3618807688a4377f3a44cb954310f51e177f43a9a0cbf4cb918c28c1aa3d8ba4bc9
7
+ data.tar.gz: ce7d4714b20918d2069dc31753ac3d56bfe053ca2069bd252ec54058053d224103bfa9364206368270a2f06a0d04a83752a1ef494fdda0243b0c950db9e6e16b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Release history for google-apis-recommendationengine_v1beta1
2
2
 
3
+ ### v0.6.0 (2021-05-19)
4
+
5
+ * Unspecified changes
6
+
7
+ ### v0.5.0 (2021-05-15)
8
+
9
+ * Regenerated from discovery document revision 20210513
10
+
11
+ ### v0.4.0 (2021-03-27)
12
+
13
+ * Regenerated from discovery document revision 20210319
14
+ * Regenerated using generator version 0.2.0
15
+
16
+ ### v0.3.0 (2021-03-04)
17
+
18
+ * Unspecified changes
19
+
20
+ ### v0.2.0 (2021-02-06)
21
+
22
+ * Regenerated from discovery document revision 20210202
23
+ * Regenerated using generator version 0.1.2
24
+
3
25
  ### v0.1.0 (2021-01-07)
4
26
 
5
27
  * Regenerated using generator version 0.1.1
data/OVERVIEW.md CHANGED
@@ -1,6 +1,6 @@
1
- # Simple REST client for version V1beta1 of the Recommendations AI
1
+ # Simple REST client for version V1beta1 of the Recommendations AI (Beta)
2
2
 
3
- This is a simple client library for version V1beta1 of the Recommendations AI. It provides:
3
+ This is a simple client library for version V1beta1 of the Recommendations AI (Beta). It provides:
4
4
 
5
5
  * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
6
  * 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
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Recommendationengine service in particular.)
67
67
 
68
- For reference information on specific calls in the Recommendations AI, see the {Google::Apis::RecommendationengineV1beta1::RecommendationsAIService class reference docs}.
68
+ For reference information on specific calls in the Recommendations AI (Beta), see the {Google::Apis::RecommendationengineV1beta1::RecommendationsAIService class reference docs}.
69
69
 
70
70
  ## Which client should I use?
71
71
 
@@ -19,19 +19,22 @@ require 'google/apis/recommendationengine_v1beta1/gem_version.rb'
19
19
 
20
20
  module Google
21
21
  module Apis
22
- # Recommendations AI
22
+ # Recommendations AI (Beta)
23
23
  #
24
- # Recommendations AI service enables customers to build end-to-end personalized
25
- # recommendation systems without requiring a high level of expertise in machine
26
- # learning, recommendation system, or Google Cloud.
24
+ # Note that we now highly recommend new customers to use Retail API, which
25
+ # incorporates the GA version of the Recommendations AI funtionalities. To
26
+ # enable Retail API, please visit https://console.cloud.google.com/apis/library/
27
+ # retail.googleapis.com. The Recommendations AI service enables customers to
28
+ # build end-to-end personalized recommendation systems without requiring a high
29
+ # level of expertise in machine learning, recommendation system, or Google Cloud.
27
30
  #
28
31
  # @see https://cloud.google.com/recommendations-ai/docs
29
32
  module RecommendationengineV1beta1
30
- # Version of the Recommendations AI this client connects to.
33
+ # Version of the Recommendations AI (Beta) this client connects to.
31
34
  # This is NOT the gem version.
32
35
  VERSION = 'V1beta1'
33
36
 
34
- # View and manage your data across Google Cloud Platform services
37
+ # See, edit, configure, and delete your Google Cloud Platform data
35
38
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
36
39
  end
37
40
  end
@@ -549,11 +549,12 @@ module Google
549
549
  include Google::Apis::Core::Hashable
550
550
 
551
551
  # Required. Google Cloud Storage URIs to input files. URI can be up to 2000
552
- # characters long. URIs can match the full object path (for example, gs://bucket/
553
- # directory/object.json) or a pattern matching one or more files, such as gs://
554
- # bucket/directory/*.json. A request can contain at most 100 files, and each
555
- # file can be up to 2 GB. See [Importing catalog information](/recommendations-
556
- # ai/docs/upload-catalog) for the expected file format and setup instructions.
552
+ # characters long. URIs can match the full object path (for example, `gs://
553
+ # bucket/directory/object.json`) or a pattern matching one or more files, such
554
+ # as `gs://bucket/directory/*.json`. A request can contain at most 100 files,
555
+ # and each file can be up to 2 GB. See [Importing catalog information](/
556
+ # recommendations-ai/docs/upload-catalog) for the expected file format and setup
557
+ # instructions.
557
558
  # Corresponds to the JSON property `inputUris`
558
559
  # @return [Array<String>]
559
560
  attr_accessor :input_uris
@@ -1023,7 +1024,14 @@ module Google
1023
1024
  # indicates the probability of an item being clicked/purchased given the user's
1024
1025
  # context and history. * `strictFiltering`: Boolean. True by default. If set to
1025
1026
  # false, the service will return generic (unfiltered) popular items instead of
1026
- # empty if your filter blocks all prediction results.
1027
+ # empty if your filter blocks all prediction results. * `priceRerankLevel`:
1028
+ # String. Default empty. If set to be non-empty, then it needs to be one of `'no-
1029
+ # price-reranking', 'low-price-reranking', 'medium-price-reranking', 'high-price-
1030
+ # reranking'`. This gives request level control and adjust prediction results
1031
+ # based on product price. * `diversityLevel`: String. Default empty. If set to
1032
+ # be non-empty, then it needs to be one of `'no-diversity', 'low-diversity', '
1033
+ # medium-diversity', 'high-diversity', 'auto-diversity'`. This gives request
1034
+ # level control and adjust prediction results based on product category.
1027
1035
  # Corresponds to the JSON property `params`
1028
1036
  # @return [Hash<String,Object>]
1029
1037
  attr_accessor :params
@@ -1366,8 +1374,9 @@ module Google
1366
1374
  # @return [String]
1367
1375
  attr_accessor :list_id
1368
1376
 
1369
- # Required for `category-page-view` events. Other event types should not set
1370
- # this field. The categories associated with a category page. Category pages
1377
+ # Required for `category-page-view` events. At least one of search_query or
1378
+ # page_categories is required for `search` events. Other event types should not
1379
+ # set this field. The categories associated with a category page. Category pages
1371
1380
  # include special pages such as sales or promotions. For instance, a special
1372
1381
  # sale page may have the category hierarchy: categories : ["Sales", "2017 Black
1373
1382
  # Friday Deals"].
@@ -1397,8 +1406,9 @@ module Google
1397
1406
  # @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PurchaseTransaction]
1398
1407
  attr_accessor :purchase_transaction
1399
1408
 
1400
- # Required for `search` events. Other event types should not set this field. The
1401
- # user's search query as UTF-8 encoded text with a length limit of 5 KiB.
1409
+ # At least one of search_query or page_categories is required for `search`
1410
+ # events. Other event types should not set this field. The user's search query
1411
+ # as UTF-8 encoded text with a length limit of 5 KiB.
1402
1412
  # Corresponds to the JSON property `searchQuery`
1403
1413
  # @return [String]
1404
1414
  attr_accessor :search_query
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RecommendationengineV1beta1
18
18
  # Version of the google-apis-recommendationengine_v1beta1 gem
19
- GEM_VERSION = "0.1.0"
19
+ GEM_VERSION = "0.6.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.1"
22
+ GENERATOR_VERSION = "0.2.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20201212"
25
+ REVISION = "20210513"
26
26
  end
27
27
  end
28
28
  end
@@ -20,11 +20,14 @@ require 'google/apis/errors'
20
20
  module Google
21
21
  module Apis
22
22
  module RecommendationengineV1beta1
23
- # Recommendations AI
23
+ # Recommendations AI (Beta)
24
24
  #
25
- # Recommendations AI service enables customers to build end-to-end personalized
26
- # recommendation systems without requiring a high level of expertise in machine
27
- # learning, recommendation system, or Google Cloud.
25
+ # Note that we now highly recommend new customers to use Retail API, which
26
+ # incorporates the GA version of the Recommendations AI funtionalities. To
27
+ # enable Retail API, please visit https://console.cloud.google.com/apis/library/
28
+ # retail.googleapis.com. The Recommendations AI service enables customers to
29
+ # build end-to-end personalized recommendation systems without requiring a high
30
+ # level of expertise in machine learning, recommendation system, or Google Cloud.
28
31
  #
29
32
  # @example
30
33
  # require 'google/apis/recommendationengine_v1beta1'
@@ -129,8 +132,8 @@ module Google
129
132
 
130
133
  # Creates a catalog item.
131
134
  # @param [String] parent
132
- # Required. The parent catalog resource name, such as "projects/*/locations/
133
- # global/catalogs/default_catalog".
135
+ # Required. The parent catalog resource name, such as `projects/*/locations/
136
+ # global/catalogs/default_catalog`.
134
137
  # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem] google_cloud_recommendationengine_v1beta1_catalog_item_object
135
138
  # @param [String] fields
136
139
  # Selector specifying which fields to include in a partial response.
@@ -163,8 +166,8 @@ module Google
163
166
 
164
167
  # Deletes a catalog item.
165
168
  # @param [String] name
166
- # Required. Full resource name of catalog item, such as "projects/*/locations/
167
- # global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
169
+ # Required. Full resource name of catalog item, such as `projects/*/locations/
170
+ # global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
168
171
  # @param [String] fields
169
172
  # Selector specifying which fields to include in a partial response.
170
173
  # @param [String] quota_user
@@ -194,8 +197,8 @@ module Google
194
197
 
195
198
  # Gets a specific catalog item.
196
199
  # @param [String] name
197
- # Required. Full resource name of catalog item, such as "projects/*/locations/
198
- # global/catalogs/default_catalog/catalogitems/some_catalog_item_id".
200
+ # Required. Full resource name of catalog item, such as `projects/*/locations/
201
+ # global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.
199
202
  # @param [String] fields
200
203
  # Selector specifying which fields to include in a partial response.
201
204
  # @param [String] quota_user
@@ -228,7 +231,7 @@ module Google
228
231
  # response is of type ImportResponse. Note that it is possible for a subset of
229
232
  # the items to be successfully updated.
230
233
  # @param [String] parent
231
- # Required. "projects/1234/locations/global/catalogs/default_catalog" If no
234
+ # Required. `projects/1234/locations/global/catalogs/default_catalog` If no
232
235
  # updateMask is specified, requires catalogItems.create permission. If
233
236
  # updateMask is specified, requires catalogItems.update permission.
234
237
  # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest] google_cloud_recommendationengine_v1beta1_import_catalog_items_request_object
@@ -263,8 +266,8 @@ module Google
263
266
 
264
267
  # Gets a list of catalog items.
265
268
  # @param [String] parent
266
- # Required. The parent catalog resource name, such as "projects/*/locations/
267
- # global/catalogs/default_catalog".
269
+ # Required. The parent catalog resource name, such as `projects/*/locations/
270
+ # global/catalogs/default_catalog`.
268
271
  # @param [String] filter
269
272
  # Optional. A filter to apply on the list results.
270
273
  # @param [Fixnum] page_size
@@ -305,8 +308,8 @@ module Google
305
308
  # Updates a catalog item. Partial updating is supported. Non-existing items will
306
309
  # be created.
307
310
  # @param [String] name
308
- # Required. Full resource name of catalog item, such as "projects/*/locations/
309
- # global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
311
+ # Required. Full resource name of catalog item, such as `projects/*/locations/
312
+ # global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
310
313
  # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem] google_cloud_recommendationengine_v1beta1_catalog_item_object
311
314
  # @param [String] update_mask
312
315
  # Optional. Indicates which fields in the provided 'item' to update. If not set,
@@ -423,8 +426,8 @@ module Google
423
426
  # more](https://cloud.google.com/recommendations-ai/docs/setting-up#register-key)
424
427
  # .
425
428
  # @param [String] name
426
- # Required. Full resource name of the format: `name=projects/*/locations/global/
427
- # catalogs/default_catalog/eventStores/default_event_store/placements/*` The id
429
+ # Required. Full resource name of the format: ``name=projects/*/locations/global/
430
+ # catalogs/default_catalog/eventStores/default_event_store/placements/*`` The id
428
431
  # of the recommendation engine placement. This id is used to identify the set of
429
432
  # models that will be used to make the prediction. We currently support three
430
433
  # placements with the following IDs by default: * `shopping_cart`: Predicts
@@ -475,8 +478,8 @@ module Google
475
478
 
476
479
  # Register an API key for use with predict method.
477
480
  # @param [String] parent
478
- # Required. The parent resource path. "projects/*/locations/global/catalogs/
479
- # default_catalog/eventStores/default_event_store".
481
+ # Required. The parent resource path. `projects/*/locations/global/catalogs/
482
+ # default_catalog/eventStores/default_event_store`.
480
483
  # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest] google_cloud_recommendationengine_v1beta1_create_prediction_api_key_registration_request_object
481
484
  # @param [String] fields
482
485
  # Selector specifying which fields to include in a partial response.
@@ -509,9 +512,9 @@ module Google
509
512
 
510
513
  # Unregister an apiKey from using for predict method.
511
514
  # @param [String] name
512
- # Required. The API key to unregister including full resource path. "projects/*/
515
+ # Required. The API key to unregister including full resource path. `projects/*/
513
516
  # locations/global/catalogs/default_catalog/eventStores/default_event_store/
514
- # predictionApiKeyRegistrations/"
517
+ # predictionApiKeyRegistrations/`
515
518
  # @param [String] fields
516
519
  # Selector specifying which fields to include in a partial response.
517
520
  # @param [String] quota_user
@@ -541,8 +544,8 @@ module Google
541
544
 
542
545
  # List the registered apiKeys for use with predict method.
543
546
  # @param [String] parent
544
- # Required. The parent placement resource name such as "projects/1234/locations/
545
- # global/catalogs/default_catalog/eventStores/default_event_store"
547
+ # Required. The parent placement resource name such as `projects/1234/locations/
548
+ # global/catalogs/default_catalog/eventStores/default_event_store`
546
549
  # @param [Fixnum] page_size
547
550
  # Optional. Maximum number of results to return per page. If unset, the service
548
551
  # will choose a reasonable default.
@@ -582,8 +585,8 @@ module Google
582
585
  # only by the Recommendations AI JavaScript pixel. Users should not call this
583
586
  # method directly.
584
587
  # @param [String] parent
585
- # Required. The parent eventStore name, such as "projects/1234/locations/global/
586
- # catalogs/default_catalog/eventStores/default_event_store".
588
+ # Required. The parent eventStore name, such as `projects/1234/locations/global/
589
+ # catalogs/default_catalog/eventStores/default_event_store`.
587
590
  # @param [Fixnum] ets
588
591
  # Optional. The event timestamp in milliseconds. This prevents browser caching
589
592
  # of otherwise identical get requests. The name is abbreviated to reduce the
@@ -631,8 +634,8 @@ module Google
631
634
  # possible for a subset of the items to be successfully inserted. Operation.
632
635
  # metadata is of type ImportMetadata.
633
636
  # @param [String] parent
634
- # Required. "projects/1234/locations/global/catalogs/default_catalog/eventStores/
635
- # default_event_store"
637
+ # Required. `projects/1234/locations/global/catalogs/default_catalog/eventStores/
638
+ # default_event_store`
636
639
  # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest] google_cloud_recommendationengine_v1beta1_import_user_events_request_object
637
640
  # @param [String] fields
638
641
  # Selector specifying which fields to include in a partial response.
@@ -670,8 +673,8 @@ module Google
670
673
  # If a catalog item of the ingested event is not in the current catalog, it
671
674
  # could lead to degraded model quality. This is called an unjoined event.
672
675
  # @param [String] parent
673
- # Required. The parent eventStore resource name, such as "projects/*/locations/*/
674
- # catalogs/default_catalog/eventStores/default_event_store".
676
+ # Required. The parent eventStore resource name, such as `projects/*/locations/*/
677
+ # catalogs/default_catalog/eventStores/default_event_store`.
675
678
  # @param [String] filter
676
679
  # Optional. Filtering expression to specify restrictions over returned events.
677
680
  # This is a sequence of terms, where each term applies some kind of a
@@ -732,8 +735,8 @@ module Google
732
735
  # first.
733
736
  # @param [String] parent
734
737
  # Required. The resource name of the event_store under which the events are
735
- # created. The format is "projects/$`projectId`/locations/global/catalogs/$`
736
- # catalogId`/eventStores/$`eventStoreId`"
738
+ # created. The format is `projects/$`projectId`/locations/global/catalogs/$`
739
+ # catalogId`/eventStores/$`eventStoreId``
737
740
  # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest] google_cloud_recommendationengine_v1beta1_purge_user_events_request_object
738
741
  # @param [String] fields
739
742
  # Selector specifying which fields to include in a partial response.
@@ -772,8 +775,8 @@ module Google
772
775
  # catalog items. It can also be used to correct events joined with wrong catalog
773
776
  # items.
774
777
  # @param [String] parent
775
- # Required. Full resource name of user event, such as "projects/*/locations/*/
776
- # catalogs/default_catalog/eventStores/default_event_store".
778
+ # Required. Full resource name of user event, such as `projects/*/locations/*/
779
+ # catalogs/default_catalog/eventStores/default_event_store`.
777
780
  # @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest] google_cloud_recommendationengine_v1beta1_rejoin_user_events_request_object
778
781
  # @param [String] fields
779
782
  # Selector specifying which fields to include in a partial response.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-recommendationengine_v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-01-08 00:00:00.000000000 Z
11
+ date: 2021-05-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -24,13 +24,13 @@ dependencies:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '0.1'
27
- description: This is the simple REST client for Recommendations AI V1beta1. Simple
28
- REST clients are Ruby client libraries that provide access to Google services via
29
- their HTTP REST API endpoints. These libraries are generated and updated automatically
27
+ description: This is the simple REST client for Recommendations AI (Beta) V1beta1.
28
+ Simple REST clients are Ruby client libraries that provide access to Google services
29
+ via their HTTP REST API endpoints. These libraries are generated and updated automatically
30
30
  based on the discovery documents published by the service, and they handle most
31
31
  concerns such as authentication, pagination, retry, timeouts, and logging. You can
32
- use this client to access the Recommendations AI, but note that some services may
33
- provide a separate modern client that is easier to use.
32
+ use this client to access the Recommendations AI (Beta), but note that some services
33
+ may provide a separate modern client that is easier to use.
34
34
  email: googleapis-packages@google.com
35
35
  executables: []
36
36
  extensions: []
@@ -52,7 +52,7 @@ licenses:
52
52
  metadata:
53
53
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
54
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-recommendationengine_v1beta1/CHANGELOG.md
55
- documentation_uri: https://googleapis.dev/ruby/google-apis-recommendationengine_v1beta1/v0.1.0
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-recommendationengine_v1beta1/v0.6.0
56
56
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-recommendationengine_v1beta1
57
57
  post_install_message:
58
58
  rdoc_options: []
@@ -62,15 +62,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
62
62
  requirements:
63
63
  - - ">="
64
64
  - !ruby/object:Gem::Version
65
- version: '2.4'
65
+ version: '2.5'
66
66
  required_rubygems_version: !ruby/object:Gem::Requirement
67
67
  requirements:
68
68
  - - ">="
69
69
  - !ruby/object:Gem::Version
70
70
  version: '0'
71
71
  requirements: []
72
- rubygems_version: 3.1.4
72
+ rubygems_version: 3.2.17
73
73
  signing_key:
74
74
  specification_version: 4
75
- summary: Simple REST client for Recommendations AI V1beta1
75
+ summary: Simple REST client for Recommendations AI (Beta) V1beta1
76
76
  test_files: []