google-cloud-retail-v2 0.14.0 → 0.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/retail/v2/catalog_service/client.rb +2 -2
  4. data/lib/google/cloud/retail/v2/catalog_service/rest/client.rb +2 -2
  5. data/lib/google/cloud/retail/v2/common_pb.rb +6 -0
  6. data/lib/google/cloud/retail/v2/completion_service/client.rb +11 -4
  7. data/lib/google/cloud/retail/v2/completion_service/operations.rb +2 -2
  8. data/lib/google/cloud/retail/v2/completion_service/rest/client.rb +11 -4
  9. data/lib/google/cloud/retail/v2/completion_service/rest/operations.rb +2 -2
  10. data/lib/google/cloud/retail/v2/completion_service/rest.rb +1 -1
  11. data/lib/google/cloud/retail/v2/completion_service.rb +1 -1
  12. data/lib/google/cloud/retail/v2/completion_service_pb.rb +1 -0
  13. data/lib/google/cloud/retail/v2/completion_service_services_pb.rb +1 -1
  14. data/lib/google/cloud/retail/v2/control_service/client.rb +2 -2
  15. data/lib/google/cloud/retail/v2/control_service/rest/client.rb +2 -2
  16. data/lib/google/cloud/retail/v2/model_pb.rb +70 -0
  17. data/lib/google/cloud/retail/v2/model_service/client.rb +1126 -0
  18. data/lib/google/cloud/retail/v2/model_service/credentials.rb +51 -0
  19. data/lib/google/cloud/retail/v2/model_service/operations.rb +768 -0
  20. data/lib/google/cloud/retail/v2/model_service/paths.rb +73 -0
  21. data/lib/google/cloud/retail/v2/model_service/rest/client.rb +904 -0
  22. data/lib/google/cloud/retail/v2/model_service/rest/operations.rb +828 -0
  23. data/lib/google/cloud/retail/v2/model_service/rest/service_stub.rb +525 -0
  24. data/lib/google/cloud/retail/v2/model_service/rest.rb +64 -0
  25. data/lib/google/cloud/retail/v2/model_service.rb +67 -0
  26. data/lib/google/cloud/retail/v2/model_service_pb.rb +80 -0
  27. data/lib/google/cloud/retail/v2/model_service_services_pb.rb +73 -0
  28. data/lib/google/cloud/retail/v2/prediction_service/client.rb +5 -2
  29. data/lib/google/cloud/retail/v2/prediction_service/rest/client.rb +5 -2
  30. data/lib/google/cloud/retail/v2/product_service/client.rb +18 -17
  31. data/lib/google/cloud/retail/v2/product_service/operations.rb +2 -2
  32. data/lib/google/cloud/retail/v2/product_service/rest/client.rb +18 -17
  33. data/lib/google/cloud/retail/v2/product_service/rest/operations.rb +2 -2
  34. data/lib/google/cloud/retail/v2/product_service_services_pb.rb +16 -15
  35. data/lib/google/cloud/retail/v2/rest.rb +1 -0
  36. data/lib/google/cloud/retail/v2/search_service/client.rb +11 -4
  37. data/lib/google/cloud/retail/v2/search_service/rest/client.rb +11 -4
  38. data/lib/google/cloud/retail/v2/search_service_pb.rb +14 -0
  39. data/lib/google/cloud/retail/v2/serving_config_service/client.rb +2 -2
  40. data/lib/google/cloud/retail/v2/serving_config_service/rest/client.rb +2 -2
  41. data/lib/google/cloud/retail/v2/user_event_pb.rb +1 -0
  42. data/lib/google/cloud/retail/v2/user_event_service/client.rb +3 -3
  43. data/lib/google/cloud/retail/v2/user_event_service/operations.rb +2 -2
  44. data/lib/google/cloud/retail/v2/user_event_service/rest/client.rb +3 -3
  45. data/lib/google/cloud/retail/v2/user_event_service/rest/operations.rb +2 -2
  46. data/lib/google/cloud/retail/v2/version.rb +1 -1
  47. data/lib/google/cloud/retail/v2.rb +1 -0
  48. data/proto_docs/google/api/client.rb +57 -3
  49. data/proto_docs/google/cloud/retail/v2/catalog.rb +11 -6
  50. data/proto_docs/google/cloud/retail/v2/common.rb +15 -1
  51. data/proto_docs/google/cloud/retail/v2/completion_service.rb +10 -2
  52. data/proto_docs/google/cloud/retail/v2/import_config.rb +1 -1
  53. data/proto_docs/google/cloud/retail/v2/model.rb +228 -0
  54. data/proto_docs/google/cloud/retail/v2/model_service.rb +172 -0
  55. data/proto_docs/google/cloud/retail/v2/prediction_service.rb +3 -0
  56. data/proto_docs/google/cloud/retail/v2/product.rb +2 -3
  57. data/proto_docs/google/cloud/retail/v2/search_service.rb +56 -2
  58. data/proto_docs/google/cloud/retail/v2/serving_config.rb +3 -3
  59. data/proto_docs/google/cloud/retail/v2/user_event.rb +7 -0
  60. data/proto_docs/google/cloud/retail/v2/user_event_service.rb +1 -1
  61. metadata +16 -2
@@ -0,0 +1,80 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/retail/v2/model_service.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/annotations_pb'
7
+ require 'google/api/client_pb'
8
+ require 'google/api/field_behavior_pb'
9
+ require 'google/api/resource_pb'
10
+ require 'google/cloud/retail/v2/model_pb'
11
+ require 'google/longrunning/operations_pb'
12
+ require 'google/protobuf/empty_pb'
13
+ require 'google/protobuf/field_mask_pb'
14
+
15
+ Google::Protobuf::DescriptorPool.generated_pool.build do
16
+ add_file("google/cloud/retail/v2/model_service.proto", :syntax => :proto3) do
17
+ add_message "google.cloud.retail.v2.CreateModelRequest" do
18
+ optional :parent, :string, 1
19
+ optional :model, :message, 2, "google.cloud.retail.v2.Model"
20
+ optional :dry_run, :bool, 3
21
+ end
22
+ add_message "google.cloud.retail.v2.UpdateModelRequest" do
23
+ optional :model, :message, 1, "google.cloud.retail.v2.Model"
24
+ optional :update_mask, :message, 2, "google.protobuf.FieldMask"
25
+ end
26
+ add_message "google.cloud.retail.v2.GetModelRequest" do
27
+ optional :name, :string, 1
28
+ end
29
+ add_message "google.cloud.retail.v2.PauseModelRequest" do
30
+ optional :name, :string, 1
31
+ end
32
+ add_message "google.cloud.retail.v2.ResumeModelRequest" do
33
+ optional :name, :string, 1
34
+ end
35
+ add_message "google.cloud.retail.v2.ListModelsRequest" do
36
+ optional :parent, :string, 1
37
+ optional :page_size, :int32, 2
38
+ optional :page_token, :string, 3
39
+ end
40
+ add_message "google.cloud.retail.v2.DeleteModelRequest" do
41
+ optional :name, :string, 1
42
+ end
43
+ add_message "google.cloud.retail.v2.ListModelsResponse" do
44
+ repeated :models, :message, 1, "google.cloud.retail.v2.Model"
45
+ optional :next_page_token, :string, 2
46
+ end
47
+ add_message "google.cloud.retail.v2.TuneModelRequest" do
48
+ optional :name, :string, 1
49
+ end
50
+ add_message "google.cloud.retail.v2.CreateModelMetadata" do
51
+ optional :model, :string, 1
52
+ end
53
+ add_message "google.cloud.retail.v2.TuneModelMetadata" do
54
+ optional :model, :string, 1
55
+ end
56
+ add_message "google.cloud.retail.v2.TuneModelResponse" do
57
+ end
58
+ end
59
+ end
60
+
61
+ module Google
62
+ module Cloud
63
+ module Retail
64
+ module V2
65
+ CreateModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CreateModelRequest").msgclass
66
+ UpdateModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UpdateModelRequest").msgclass
67
+ GetModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.GetModelRequest").msgclass
68
+ PauseModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.PauseModelRequest").msgclass
69
+ ResumeModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ResumeModelRequest").msgclass
70
+ ListModelsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ListModelsRequest").msgclass
71
+ DeleteModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.DeleteModelRequest").msgclass
72
+ ListModelsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ListModelsResponse").msgclass
73
+ TuneModelRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.TuneModelRequest").msgclass
74
+ CreateModelMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CreateModelMetadata").msgclass
75
+ TuneModelMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.TuneModelMetadata").msgclass
76
+ TuneModelResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.TuneModelResponse").msgclass
77
+ end
78
+ end
79
+ end
80
+ end
@@ -0,0 +1,73 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/cloud/retail/v2/model_service.proto for package 'Google.Cloud.Retail.V2'
3
+ # Original file comments:
4
+ # Copyright 2021 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/cloud/retail/v2/model_service_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module Retail
25
+ module V2
26
+ module ModelService
27
+ # Service for performing CRUD operations on models.
28
+ # Recommendation models contain all the metadata necessary to generate a set of
29
+ # models for the `Predict()` API. A model is queried
30
+ # indirectly via a ServingConfig, which associates a model with a
31
+ # given Placement (e.g. Frequently Bought Together on Home Page).
32
+ #
33
+ # This service allows you to do the following:
34
+ #
35
+ # * Initiate training of a model.
36
+ # * Pause training of an existing model.
37
+ # * List all the available models along with their metadata.
38
+ # * Control their tuning schedule.
39
+ class Service
40
+
41
+ include ::GRPC::GenericService
42
+
43
+ self.marshal_class_method = :encode
44
+ self.unmarshal_class_method = :decode
45
+ self.service_name = 'google.cloud.retail.v2.ModelService'
46
+
47
+ # Creates a new model.
48
+ rpc :CreateModel, ::Google::Cloud::Retail::V2::CreateModelRequest, ::Google::Longrunning::Operation
49
+ # Gets a model.
50
+ rpc :GetModel, ::Google::Cloud::Retail::V2::GetModelRequest, ::Google::Cloud::Retail::V2::Model
51
+ # Pauses the training of an existing model.
52
+ rpc :PauseModel, ::Google::Cloud::Retail::V2::PauseModelRequest, ::Google::Cloud::Retail::V2::Model
53
+ # Resumes the training of an existing model.
54
+ rpc :ResumeModel, ::Google::Cloud::Retail::V2::ResumeModelRequest, ::Google::Cloud::Retail::V2::Model
55
+ # Deletes an existing model.
56
+ rpc :DeleteModel, ::Google::Cloud::Retail::V2::DeleteModelRequest, ::Google::Protobuf::Empty
57
+ # Lists all the models linked to this event store.
58
+ rpc :ListModels, ::Google::Cloud::Retail::V2::ListModelsRequest, ::Google::Cloud::Retail::V2::ListModelsResponse
59
+ # Update of model metadata. Only fields that
60
+ # currently can be updated are: `filtering_option` and
61
+ # `periodic_tuning_state`.
62
+ # If other values are provided, this API method ignores them.
63
+ rpc :UpdateModel, ::Google::Cloud::Retail::V2::UpdateModelRequest, ::Google::Cloud::Retail::V2::Model
64
+ # Tunes an existing model.
65
+ rpc :TuneModel, ::Google::Cloud::Retail::V2::TuneModelRequest, ::Google::Longrunning::Operation
66
+ end
67
+
68
+ Stub = Service.rpc_stub_class
69
+ end
70
+ end
71
+ end
72
+ end
73
+ end
@@ -255,6 +255,9 @@ module Google
255
255
  # * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
256
256
  # * (availability: ANY("IN_STOCK")) AND
257
257
  # (colors: ANY("Red") OR categories: ANY("Phones"))
258
+ #
259
+ # For more information, see
260
+ # [Filter recommendations](https://cloud.google.com/retail/docs/filter-recs).
258
261
  # @param validate_only [::Boolean]
259
262
  # Use validate only mode for this prediction query. If set to true, a
260
263
  # dummy model will be used that returns arbitrary products.
@@ -409,9 +412,9 @@ module Google
409
412
  # * (`String`) The path to a service account key file in JSON format
410
413
  # * (`Hash`) A service account key as a Hash
411
414
  # * (`Google::Auth::Credentials`) A googleauth credentials object
412
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
415
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
413
416
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
414
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
417
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
415
418
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
416
419
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
417
420
  # * (`nil`) indicating no credentials
@@ -246,6 +246,9 @@ module Google
246
246
  # * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
247
247
  # * (availability: ANY("IN_STOCK")) AND
248
248
  # (colors: ANY("Red") OR categories: ANY("Phones"))
249
+ #
250
+ # For more information, see
251
+ # [Filter recommendations](https://cloud.google.com/retail/docs/filter-recs).
249
252
  # @param validate_only [::Boolean]
250
253
  # Use validate only mode for this prediction query. If set to true, a
251
254
  # dummy model will be used that returns arbitrary products.
@@ -377,9 +380,9 @@ module Google
377
380
  # * (`String`) The path to a service account key file in JSON format
378
381
  # * (`Hash`) A service account key as a Hash
379
382
  # * (`Google::Auth::Credentials`) A googleauth credentials object
380
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
383
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
381
384
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
382
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
385
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
383
386
  # * (`nil`) indicating no credentials
384
387
  # @return [::Object]
385
388
  # @!attribute [rw] scope
@@ -936,9 +936,6 @@ module Google
936
936
  # updates are not marked as {::Google::Longrunning::Operation#done done} until
937
937
  # they are obsolete.
938
938
  #
939
- # This feature is only available for users who have Retail Search enabled.
940
- # Enable Retail Search on Cloud Console before using this feature.
941
- #
942
939
  # @overload set_inventory(request, options = nil)
943
940
  # Pass arguments to `set_inventory` via a request object, either of type
944
941
  # {::Google::Cloud::Retail::V2::SetInventoryRequest} or an equivalent Hash.
@@ -1106,6 +1103,14 @@ module Google
1106
1103
  end
1107
1104
 
1108
1105
  ##
1106
+ # It is recommended to use the
1107
+ # {::Google::Cloud::Retail::V2::ProductService::Client#add_local_inventories ProductService.AddLocalInventories}
1108
+ # method instead of
1109
+ # {::Google::Cloud::Retail::V2::ProductService::Client#add_fulfillment_places ProductService.AddFulfillmentPlaces}.
1110
+ # {::Google::Cloud::Retail::V2::ProductService::Client#add_local_inventories ProductService.AddLocalInventories}
1111
+ # achieves the same results but provides more fine-grained control over
1112
+ # ingesting local inventory data.
1113
+ #
1109
1114
  # Incrementally adds place IDs to
1110
1115
  # {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids Product.fulfillment_info.place_ids}.
1111
1116
  #
@@ -1128,9 +1133,6 @@ module Google
1128
1133
  # updates will not be marked as {::Google::Longrunning::Operation#done done}
1129
1134
  # until being obsolete.
1130
1135
  #
1131
- # This feature is only available for users who have Retail Search enabled.
1132
- # Enable Retail Search on Cloud Console before using this feature.
1133
- #
1134
1136
  # @overload add_fulfillment_places(request, options = nil)
1135
1137
  # Pass arguments to `add_fulfillment_places` via a request object, either of type
1136
1138
  # {::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest} or an equivalent Hash.
@@ -1276,6 +1278,14 @@ module Google
1276
1278
  end
1277
1279
 
1278
1280
  ##
1281
+ # It is recommended to use the
1282
+ # {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
1283
+ # method instead of
1284
+ # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}.
1285
+ # {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
1286
+ # achieves the same results but provides more fine-grained control over
1287
+ # ingesting local inventory data.
1288
+ #
1279
1289
  # Incrementally removes place IDs from a
1280
1290
  # {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids Product.fulfillment_info.place_ids}.
1281
1291
  #
@@ -1298,9 +1308,6 @@ module Google
1298
1308
  # updates will not be marked as {::Google::Longrunning::Operation#done done}
1299
1309
  # until being obsolete.
1300
1310
  #
1301
- # This feature is only available for users who have Retail Search enabled.
1302
- # Enable Retail Search on Cloud Console before using this feature.
1303
- #
1304
1311
  # @overload remove_fulfillment_places(request, options = nil)
1305
1312
  # Pass arguments to `remove_fulfillment_places` via a request object, either of type
1306
1313
  # {::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest} or an equivalent Hash.
@@ -1470,9 +1477,6 @@ module Google
1470
1477
  # updates will not be marked as {::Google::Longrunning::Operation#done done}
1471
1478
  # until being obsolete.
1472
1479
  #
1473
- # This feature is only available for users who have Retail Search enabled.
1474
- # Enable Retail Search on Cloud Console before using this feature.
1475
- #
1476
1480
  # @overload add_local_inventories(request, options = nil)
1477
1481
  # Pass arguments to `add_local_inventories` via a request object, either of type
1478
1482
  # {::Google::Cloud::Retail::V2::AddLocalInventoriesRequest} or an equivalent Hash.
@@ -1627,9 +1631,6 @@ module Google
1627
1631
  # updates will not be marked as {::Google::Longrunning::Operation#done done}
1628
1632
  # until being obsolete.
1629
1633
  #
1630
- # This feature is only available for users who have Retail Search enabled.
1631
- # Enable Retail Search on Cloud Console before using this feature.
1632
- #
1633
1634
  # @overload remove_local_inventories(request, options = nil)
1634
1635
  # Pass arguments to `remove_local_inventories` via a request object, either of type
1635
1636
  # {::Google::Cloud::Retail::V2::RemoveLocalInventoriesRequest} or an equivalent Hash.
@@ -1778,9 +1779,9 @@ module Google
1778
1779
  # * (`String`) The path to a service account key file in JSON format
1779
1780
  # * (`Hash`) A service account key as a Hash
1780
1781
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1781
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
1782
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1782
1783
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1783
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
1784
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1784
1785
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
1785
1786
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1786
1787
  # * (`nil`) indicating no credentials
@@ -620,9 +620,9 @@ module Google
620
620
  # * (`String`) The path to a service account key file in JSON format
621
621
  # * (`Hash`) A service account key as a Hash
622
622
  # * (`Google::Auth::Credentials`) A googleauth credentials object
623
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
623
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
624
624
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
625
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
625
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
626
626
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
627
627
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
628
628
  # * (`nil`) indicating no credentials
@@ -778,9 +778,6 @@ module Google
778
778
  # updates are not marked as {::Google::Longrunning::Operation#done done} until
779
779
  # they are obsolete.
780
780
  #
781
- # This feature is only available for users who have Retail Search enabled.
782
- # Enable Retail Search on Cloud Console before using this feature.
783
- #
784
781
  # @overload set_inventory(request, options = nil)
785
782
  # Pass arguments to `set_inventory` via a request object, either of type
786
783
  # {::Google::Cloud::Retail::V2::SetInventoryRequest} or an equivalent Hash.
@@ -918,6 +915,14 @@ module Google
918
915
  end
919
916
 
920
917
  ##
918
+ # It is recommended to use the
919
+ # {::Google::Cloud::Retail::V2::ProductService::Rest::Client#add_local_inventories ProductService.AddLocalInventories}
920
+ # method instead of
921
+ # {::Google::Cloud::Retail::V2::ProductService::Rest::Client#add_fulfillment_places ProductService.AddFulfillmentPlaces}.
922
+ # {::Google::Cloud::Retail::V2::ProductService::Rest::Client#add_local_inventories ProductService.AddLocalInventories}
923
+ # achieves the same results but provides more fine-grained control over
924
+ # ingesting local inventory data.
925
+ #
921
926
  # Incrementally adds place IDs to
922
927
  # {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids Product.fulfillment_info.place_ids}.
923
928
  #
@@ -940,9 +945,6 @@ module Google
940
945
  # updates will not be marked as {::Google::Longrunning::Operation#done done}
941
946
  # until being obsolete.
942
947
  #
943
- # This feature is only available for users who have Retail Search enabled.
944
- # Enable Retail Search on Cloud Console before using this feature.
945
- #
946
948
  # @overload add_fulfillment_places(request, options = nil)
947
949
  # Pass arguments to `add_fulfillment_places` via a request object, either of type
948
950
  # {::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest} or an equivalent Hash.
@@ -1058,6 +1060,14 @@ module Google
1058
1060
  end
1059
1061
 
1060
1062
  ##
1063
+ # It is recommended to use the
1064
+ # {::Google::Cloud::Retail::V2::ProductService::Rest::Client#remove_local_inventories ProductService.RemoveLocalInventories}
1065
+ # method instead of
1066
+ # {::Google::Cloud::Retail::V2::ProductService::Rest::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}.
1067
+ # {::Google::Cloud::Retail::V2::ProductService::Rest::Client#remove_local_inventories ProductService.RemoveLocalInventories}
1068
+ # achieves the same results but provides more fine-grained control over
1069
+ # ingesting local inventory data.
1070
+ #
1061
1071
  # Incrementally removes place IDs from a
1062
1072
  # {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids Product.fulfillment_info.place_ids}.
1063
1073
  #
@@ -1080,9 +1090,6 @@ module Google
1080
1090
  # updates will not be marked as {::Google::Longrunning::Operation#done done}
1081
1091
  # until being obsolete.
1082
1092
  #
1083
- # This feature is only available for users who have Retail Search enabled.
1084
- # Enable Retail Search on Cloud Console before using this feature.
1085
- #
1086
1093
  # @overload remove_fulfillment_places(request, options = nil)
1087
1094
  # Pass arguments to `remove_fulfillment_places` via a request object, either of type
1088
1095
  # {::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest} or an equivalent Hash.
@@ -1222,9 +1229,6 @@ module Google
1222
1229
  # updates will not be marked as {::Google::Longrunning::Operation#done done}
1223
1230
  # until being obsolete.
1224
1231
  #
1225
- # This feature is only available for users who have Retail Search enabled.
1226
- # Enable Retail Search on Cloud Console before using this feature.
1227
- #
1228
1232
  # @overload add_local_inventories(request, options = nil)
1229
1233
  # Pass arguments to `add_local_inventories` via a request object, either of type
1230
1234
  # {::Google::Cloud::Retail::V2::AddLocalInventoriesRequest} or an equivalent Hash.
@@ -1349,9 +1353,6 @@ module Google
1349
1353
  # updates will not be marked as {::Google::Longrunning::Operation#done done}
1350
1354
  # until being obsolete.
1351
1355
  #
1352
- # This feature is only available for users who have Retail Search enabled.
1353
- # Enable Retail Search on Cloud Console before using this feature.
1354
- #
1355
1356
  # @overload remove_local_inventories(request, options = nil)
1356
1357
  # Pass arguments to `remove_local_inventories` via a request object, either of type
1357
1358
  # {::Google::Cloud::Retail::V2::RemoveLocalInventoriesRequest} or an equivalent Hash.
@@ -1470,9 +1471,9 @@ module Google
1470
1471
  # * (`String`) The path to a service account key file in JSON format
1471
1472
  # * (`Hash`) A service account key as a Hash
1472
1473
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1473
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
1474
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1474
1475
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1475
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
1476
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1476
1477
  # * (`nil`) indicating no credentials
1477
1478
  # @return [::Object]
1478
1479
  # @!attribute [rw] scope
@@ -411,9 +411,9 @@ module Google
411
411
  # * (`String`) The path to a service account key file in JSON format
412
412
  # * (`Hash`) A service account key as a Hash
413
413
  # * (`Google::Auth::Credentials`) A googleauth credentials object
414
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
414
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
415
415
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
416
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
416
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
417
417
  # * (`nil`) indicating no credentials
418
418
  # @return [::Object]
419
419
  # @!attribute [rw] scope
@@ -101,10 +101,15 @@ module Google
101
101
  # [Operation][google.longrunning.Operation]s associated with the stale
102
102
  # updates are not marked as [done][google.longrunning.Operation.done] until
103
103
  # they are obsolete.
104
- #
105
- # This feature is only available for users who have Retail Search enabled.
106
- # Enable Retail Search on Cloud Console before using this feature.
107
104
  rpc :SetInventory, ::Google::Cloud::Retail::V2::SetInventoryRequest, ::Google::Longrunning::Operation
105
+ # It is recommended to use the
106
+ # [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories]
107
+ # method instead of
108
+ # [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces].
109
+ # [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories]
110
+ # achieves the same results but provides more fine-grained control over
111
+ # ingesting local inventory data.
112
+ #
108
113
  # Incrementally adds place IDs to
109
114
  # [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].
110
115
  #
@@ -126,10 +131,15 @@ module Google
126
131
  # [Operation][google.longrunning.Operation]s associated with the stale
127
132
  # updates will not be marked as [done][google.longrunning.Operation.done]
128
133
  # until being obsolete.
129
- #
130
- # This feature is only available for users who have Retail Search enabled.
131
- # Enable Retail Search on Cloud Console before using this feature.
132
134
  rpc :AddFulfillmentPlaces, ::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest, ::Google::Longrunning::Operation
135
+ # It is recommended to use the
136
+ # [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories]
137
+ # method instead of
138
+ # [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
139
+ # [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories]
140
+ # achieves the same results but provides more fine-grained control over
141
+ # ingesting local inventory data.
142
+ #
133
143
  # Incrementally removes place IDs from a
134
144
  # [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].
135
145
  #
@@ -151,9 +161,6 @@ module Google
151
161
  # [Operation][google.longrunning.Operation]s associated with the stale
152
162
  # updates will not be marked as [done][google.longrunning.Operation.done]
153
163
  # until being obsolete.
154
- #
155
- # This feature is only available for users who have Retail Search enabled.
156
- # Enable Retail Search on Cloud Console before using this feature.
157
164
  rpc :RemoveFulfillmentPlaces, ::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest, ::Google::Longrunning::Operation
158
165
  # Updates local inventory information for a
159
166
  # [Product][google.cloud.retail.v2.Product] at a list of places, while
@@ -183,9 +190,6 @@ module Google
183
190
  # [Operation][google.longrunning.Operation]s associated with the stale
184
191
  # updates will not be marked as [done][google.longrunning.Operation.done]
185
192
  # until being obsolete.
186
- #
187
- # This feature is only available for users who have Retail Search enabled.
188
- # Enable Retail Search on Cloud Console before using this feature.
189
193
  rpc :AddLocalInventories, ::Google::Cloud::Retail::V2::AddLocalInventoriesRequest, ::Google::Longrunning::Operation
190
194
  # Remove local inventory information for a
191
195
  # [Product][google.cloud.retail.v2.Product] at a list of places at a removal
@@ -213,9 +217,6 @@ module Google
213
217
  # [Operation][google.longrunning.Operation]s associated with the stale
214
218
  # updates will not be marked as [done][google.longrunning.Operation.done]
215
219
  # until being obsolete.
216
- #
217
- # This feature is only available for users who have Retail Search enabled.
218
- # Enable Retail Search on Cloud Console before using this feature.
219
220
  rpc :RemoveLocalInventories, ::Google::Cloud::Retail::V2::RemoveLocalInventoriesRequest, ::Google::Longrunning::Operation
220
221
  end
221
222
 
@@ -19,6 +19,7 @@
19
19
  require "google/cloud/retail/v2/catalog_service/rest"
20
20
  require "google/cloud/retail/v2/completion_service/rest"
21
21
  require "google/cloud/retail/v2/control_service/rest"
22
+ require "google/cloud/retail/v2/model_service/rest"
22
23
  require "google/cloud/retail/v2/prediction_service/rest"
23
24
  require "google/cloud/retail/v2/product_service/rest"
24
25
  require "google/cloud/retail/v2/search_service/rest"
@@ -182,7 +182,7 @@ module Google
182
182
  # @param options [::Gapic::CallOptions, ::Hash]
183
183
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
184
184
  #
185
- # @overload search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil, search_mode: nil, personalization_spec: nil, labels: nil, spell_correction_spec: nil)
185
+ # @overload search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil, search_mode: nil, personalization_spec: nil, labels: nil, spell_correction_spec: nil, entity: nil)
186
186
  # Pass arguments to `search` via keyword arguments. Note that at
187
187
  # least one keyword argument is required. To specify no parameters, or to keep all
188
188
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -276,7 +276,7 @@ module Google
276
276
  # @param facet_specs [::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec, ::Hash>]
277
277
  # Facet specifications for faceted search. If empty, no facets are returned.
278
278
  #
279
- # A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
279
+ # A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error
280
280
  # is returned.
281
281
  # @param dynamic_facet_spec [::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec, ::Hash]
282
282
  # Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic
@@ -418,6 +418,13 @@ module Google
418
418
  # @param spell_correction_spec [::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec, ::Hash]
419
419
  # The spell correction specification that specifies the mode under
420
420
  # which spell correction will take effect.
421
+ # @param entity [::String]
422
+ # The entity for customers that may run multiple different entities, domains,
423
+ # sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
424
+ # `google.com`, `youtube.com`, etc.
425
+ # If this is set, it should be exactly matched with
426
+ # {::Google::Cloud::Retail::V2::UserEvent#entity UserEvent.entity} to get search
427
+ # results boosted by entity.
421
428
  #
422
429
  # @yield [response, operation] Access the result along with the RPC operation
423
430
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Retail::V2::SearchResponse::SearchResult>]
@@ -526,9 +533,9 @@ module Google
526
533
  # * (`String`) The path to a service account key file in JSON format
527
534
  # * (`Hash`) A service account key as a Hash
528
535
  # * (`Google::Auth::Credentials`) A googleauth credentials object
529
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
536
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
530
537
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
531
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
538
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
532
539
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
533
540
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
534
541
  # * (`nil`) indicating no credentials
@@ -173,7 +173,7 @@ module Google
173
173
  # @param options [::Gapic::CallOptions, ::Hash]
174
174
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
175
175
  #
176
- # @overload search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil, search_mode: nil, personalization_spec: nil, labels: nil, spell_correction_spec: nil)
176
+ # @overload search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil, search_mode: nil, personalization_spec: nil, labels: nil, spell_correction_spec: nil, entity: nil)
177
177
  # Pass arguments to `search` via keyword arguments. Note that at
178
178
  # least one keyword argument is required. To specify no parameters, or to keep all
179
179
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -267,7 +267,7 @@ module Google
267
267
  # @param facet_specs [::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec, ::Hash>]
268
268
  # Facet specifications for faceted search. If empty, no facets are returned.
269
269
  #
270
- # A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
270
+ # A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error
271
271
  # is returned.
272
272
  # @param dynamic_facet_spec [::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec, ::Hash]
273
273
  # Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic
@@ -409,6 +409,13 @@ module Google
409
409
  # @param spell_correction_spec [::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec, ::Hash]
410
410
  # The spell correction specification that specifies the mode under
411
411
  # which spell correction will take effect.
412
+ # @param entity [::String]
413
+ # The entity for customers that may run multiple different entities, domains,
414
+ # sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
415
+ # `google.com`, `youtube.com`, etc.
416
+ # If this is set, it should be exactly matched with
417
+ # {::Google::Cloud::Retail::V2::UserEvent#entity UserEvent.entity} to get search
418
+ # results boosted by entity.
412
419
  # @yield [result, operation] Access the result along with the TransportOperation object
413
420
  # @yieldparam result [::Google::Cloud::Retail::V2::SearchResponse]
414
421
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -489,9 +496,9 @@ module Google
489
496
  # * (`String`) The path to a service account key file in JSON format
490
497
  # * (`Hash`) A service account key as a Hash
491
498
  # * (`Google::Auth::Credentials`) A googleauth credentials object
492
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
499
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
493
500
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
494
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
501
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
495
502
  # * (`nil`) indicating no credentials
496
503
  # @return [::Object]
497
504
  # @!attribute [rw] scope
@@ -36,6 +36,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
36
36
  optional :personalization_spec, :message, 32, "google.cloud.retail.v2.SearchRequest.PersonalizationSpec"
37
37
  map :labels, :string, :string, 34
38
38
  proto3_optional :spell_correction_spec, :message, 35, "google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec"
39
+ optional :entity, :string, 38
39
40
  end
40
41
  add_message "google.cloud.retail.v2.SearchRequest.FacetSpec" do
41
42
  optional :facet_key, :message, 1, "google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey"
@@ -111,6 +112,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
111
112
  optional :redirect_uri, :string, 10
112
113
  repeated :applied_controls, :string, 12
113
114
  repeated :invalid_condition_boost_specs, :message, 14, "google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec"
115
+ repeated :experiment_info, :message, 17, "google.cloud.retail.v2.ExperimentInfo"
114
116
  end
115
117
  add_message "google.cloud.retail.v2.SearchResponse.SearchResult" do
116
118
  optional :id, :string, 1
@@ -138,6 +140,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
138
140
  optional :expanded_query, :bool, 1
139
141
  optional :pinned_result_count, :int64, 2
140
142
  end
143
+ add_message "google.cloud.retail.v2.ExperimentInfo" do
144
+ optional :experiment, :string, 1
145
+ oneof :experiment_metadata do
146
+ optional :serving_config_experiment, :message, 2, "google.cloud.retail.v2.ExperimentInfo.ServingConfigExperiment"
147
+ end
148
+ end
149
+ add_message "google.cloud.retail.v2.ExperimentInfo.ServingConfigExperiment" do
150
+ optional :original_serving_config, :string, 1
151
+ optional :experiment_serving_config, :string, 2
152
+ end
141
153
  end
142
154
  end
143
155
 
@@ -164,6 +176,8 @@ module Google
164
176
  SearchResponse::Facet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.Facet").msgclass
165
177
  SearchResponse::Facet::FacetValue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.Facet.FacetValue").msgclass
166
178
  SearchResponse::QueryExpansionInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.QueryExpansionInfo").msgclass
179
+ ExperimentInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ExperimentInfo").msgclass
180
+ ExperimentInfo::ServingConfigExperiment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ExperimentInfo.ServingConfigExperiment").msgclass
167
181
  end
168
182
  end
169
183
  end
@@ -848,9 +848,9 @@ module Google
848
848
  # * (`String`) The path to a service account key file in JSON format
849
849
  # * (`Hash`) A service account key as a Hash
850
850
  # * (`Google::Auth::Credentials`) A googleauth credentials object
851
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
851
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
852
852
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
853
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
853
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
854
854
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
855
855
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
856
856
  # * (`nil`) indicating no credentials