google-cloud-retail-v2 0.8.0 → 0.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/lib/google/cloud/retail/v2/catalog_pb.rb +55 -0
  4. data/lib/google/cloud/retail/v2/catalog_service/client.rb +718 -0
  5. data/lib/google/cloud/retail/v2/catalog_service/paths.rb +38 -0
  6. data/lib/google/cloud/retail/v2/catalog_service_pb.rb +34 -0
  7. data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb +38 -0
  8. data/lib/google/cloud/retail/v2/common_pb.rb +86 -0
  9. data/lib/google/cloud/retail/v2/completion_service/client.rb +7 -3
  10. data/lib/google/cloud/retail/v2/completion_service/operations.rb +3 -0
  11. data/lib/google/cloud/retail/v2/control_pb.rb +33 -0
  12. data/lib/google/cloud/retail/v2/control_service/client.rb +807 -0
  13. data/lib/google/cloud/retail/v2/control_service/credentials.rb +51 -0
  14. data/lib/google/cloud/retail/v2/control_service/paths.rb +73 -0
  15. data/lib/google/cloud/retail/v2/control_service.rb +49 -0
  16. data/lib/google/cloud/retail/v2/control_service_pb.rb +57 -0
  17. data/lib/google/cloud/retail/v2/control_service_services_pb.rb +65 -0
  18. data/lib/google/cloud/retail/v2/prediction_service/client.rb +28 -13
  19. data/lib/google/cloud/retail/v2/product_pb.rb +1 -0
  20. data/lib/google/cloud/retail/v2/product_service/client.rb +87 -42
  21. data/lib/google/cloud/retail/v2/product_service/operations.rb +3 -0
  22. data/lib/google/cloud/retail/v2/product_service_services_pb.rb +67 -23
  23. data/lib/google/cloud/retail/v2/search_service/client.rb +15 -2
  24. data/lib/google/cloud/retail/v2/search_service_pb.rb +5 -0
  25. data/lib/google/cloud/retail/v2/serving_config_pb.rb +44 -0
  26. data/lib/google/cloud/retail/v2/serving_config_service/client.rb +998 -0
  27. data/lib/google/cloud/retail/v2/serving_config_service/credentials.rb +51 -0
  28. data/lib/google/cloud/retail/v2/serving_config_service/paths.rb +73 -0
  29. data/lib/google/cloud/retail/v2/serving_config_service.rb +49 -0
  30. data/lib/google/cloud/retail/v2/serving_config_service_pb.rb +66 -0
  31. data/lib/google/cloud/retail/v2/serving_config_service_services_pb.rb +74 -0
  32. data/lib/google/cloud/retail/v2/user_event_service/client.rb +2 -2
  33. data/lib/google/cloud/retail/v2/user_event_service/operations.rb +3 -0
  34. data/lib/google/cloud/retail/v2/user_event_service_pb.rb +0 -1
  35. data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb +2 -2
  36. data/lib/google/cloud/retail/v2/version.rb +1 -1
  37. data/lib/google/cloud/retail/v2.rb +2 -0
  38. data/proto_docs/google/cloud/retail/v2/catalog.rb +233 -0
  39. data/proto_docs/google/cloud/retail/v2/catalog_service.rb +133 -0
  40. data/proto_docs/google/cloud/retail/v2/common.rb +314 -4
  41. data/proto_docs/google/cloud/retail/v2/completion_service.rb +9 -4
  42. data/proto_docs/google/cloud/retail/v2/control.rb +76 -0
  43. data/proto_docs/google/cloud/retail/v2/control_service.rb +122 -0
  44. data/proto_docs/google/cloud/retail/v2/import_config.rb +20 -35
  45. data/proto_docs/google/cloud/retail/v2/prediction_service.rb +27 -12
  46. data/proto_docs/google/cloud/retail/v2/product.rb +7 -1
  47. data/proto_docs/google/cloud/retail/v2/product_service.rb +49 -21
  48. data/proto_docs/google/cloud/retail/v2/search_service.rb +72 -13
  49. data/proto_docs/google/cloud/retail/v2/serving_config.rb +238 -0
  50. data/proto_docs/google/cloud/retail/v2/serving_config_service.rb +143 -0
  51. data/proto_docs/google/protobuf/empty.rb +0 -2
  52. metadata +29 -11
@@ -62,18 +62,21 @@ module Google
62
62
  # enqueued and processed downstream. As a consequence, when a response is
63
63
  # returned, updates are not immediately manifested in the
64
64
  # [Product][google.cloud.retail.v2.Product] queried by
65
- # [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or
66
- # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
65
+ # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
66
+ # or
67
+ # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
67
68
  #
68
69
  # When inventory is updated with
69
- # [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and
70
- # [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct], the
71
- # specified inventory field value(s) will overwrite any existing value(s)
70
+ # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
71
+ # and
72
+ # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct],
73
+ # the specified inventory field value(s) will overwrite any existing value(s)
72
74
  # while ignoring the last update time for this field. Furthermore, the last
73
75
  # update time for the specified inventory fields will be overwritten to the
74
76
  # time of the
75
- # [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] or
76
- # [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
77
+ # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
78
+ # or
79
+ # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
77
80
  # request.
78
81
  #
79
82
  # If no inventory fields are set in
@@ -85,10 +88,17 @@ module Google
85
88
  # then any existing inventory information will be preserved.
86
89
  #
87
90
  # Pre-existing inventory information can only be updated with
88
- # [SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
91
+ # [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
89
92
  # [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces],
90
93
  # and
91
- # [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
94
+ # [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
95
+ #
96
+ # The returned [Operation][]s will be obsolete after 1 day, and
97
+ # [GetOperation][] API will return NOT_FOUND afterwards.
98
+ #
99
+ # If conflicting updates are issued, the [Operation][]s associated with the
100
+ # stale updates will not be marked as [done][Operation.done] until being
101
+ # obsolete.
92
102
  #
93
103
  # This feature is only available for users who have Retail Search enabled.
94
104
  # Please enable Retail Search on Cloud Console before using this feature.
@@ -102,8 +112,16 @@ module Google
102
112
  # enqueued and processed downstream. As a consequence, when a response is
103
113
  # returned, the added place IDs are not immediately manifested in the
104
114
  # [Product][google.cloud.retail.v2.Product] queried by
105
- # [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or
106
- # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
115
+ # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
116
+ # or
117
+ # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
118
+ #
119
+ # The returned [Operation][]s will be obsolete after 1 day, and
120
+ # [GetOperation][] API will return NOT_FOUND afterwards.
121
+ #
122
+ # If conflicting updates are issued, the [Operation][]s associated with the
123
+ # stale updates will not be marked as [done][Operation.done] until being
124
+ # obsolete.
107
125
  #
108
126
  # This feature is only available for users who have Retail Search enabled.
109
127
  # Please enable Retail Search on Cloud Console before using this feature.
@@ -117,8 +135,16 @@ module Google
117
135
  # enqueued and processed downstream. As a consequence, when a response is
118
136
  # returned, the removed place IDs are not immediately manifested in the
119
137
  # [Product][google.cloud.retail.v2.Product] queried by
120
- # [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or
121
- # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
138
+ # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
139
+ # or
140
+ # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
141
+ #
142
+ # The returned [Operation][]s will be obsolete after 1 day, and
143
+ # [GetOperation][] API will return NOT_FOUND afterwards.
144
+ #
145
+ # If conflicting updates are issued, the [Operation][]s associated with the
146
+ # stale updates will not be marked as [done][Operation.done] until being
147
+ # obsolete.
122
148
  #
123
149
  # This feature is only available for users who have Retail Search enabled.
124
150
  # Please enable Retail Search on Cloud Console before using this feature.
@@ -133,13 +159,22 @@ module Google
133
159
  # and processed downstream. As a consequence, when a response is returned,
134
160
  # updates are not immediately manifested in the
135
161
  # [Product][google.cloud.retail.v2.Product] queried by
136
- # [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or
137
- # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
162
+ # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
163
+ # or
164
+ # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
138
165
  #
139
166
  # Local inventory information can only be modified using this method.
140
- # [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and
141
- # [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] has no
142
- # effect on local inventories.
167
+ # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
168
+ # and
169
+ # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
170
+ # has no effect on local inventories.
171
+ #
172
+ # The returned [Operation][]s will be obsolete after 1 day, and
173
+ # [GetOperation][] API will return NOT_FOUND afterwards.
174
+ #
175
+ # If conflicting updates are issued, the [Operation][]s associated with the
176
+ # stale updates will not be marked as [done][Operation.done] until being
177
+ # obsolete.
143
178
  #
144
179
  # This feature is only available for users who have Retail Search enabled.
145
180
  # Please enable Retail Search on Cloud Console before using this feature.
@@ -152,13 +187,22 @@ module Google
152
187
  # enqueued and processed downstream. As a consequence, when a response is
153
188
  # returned, removals are not immediately manifested in the
154
189
  # [Product][google.cloud.retail.v2.Product] queried by
155
- # [GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or
156
- # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
190
+ # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
191
+ # or
192
+ # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
157
193
  #
158
194
  # Local inventory information can only be removed using this method.
159
- # [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and
160
- # [UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] has no
161
- # effect on local inventories.
195
+ # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
196
+ # and
197
+ # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
198
+ # has no effect on local inventories.
199
+ #
200
+ # The returned [Operation][]s will be obsolete after 1 day, and
201
+ # [GetOperation][] API will return NOT_FOUND afterwards.
202
+ #
203
+ # If conflicting updates are issued, the [Operation][]s associated with the
204
+ # stale updates will not be marked as [done][Operation.done] until being
205
+ # obsolete.
162
206
  #
163
207
  # This feature is only available for users who have Retail Search enabled.
164
208
  # Please enable Retail Search on Cloud Console before using this feature.
@@ -174,7 +174,9 @@ module Google
174
174
  # the default parameter values, pass an empty Hash as a request object (see above).
175
175
  #
176
176
  # @param placement [::String]
177
- # Required. The resource name of the search engine placement, such as
177
+ # Required. The resource name of the Retail Search serving config, such as
178
+ # `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
179
+ # or the name of the legacy placement resource, such as
178
180
  # `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
179
181
  # This field is used to identify the serving configuration name and the set
180
182
  # of models that will be used to make the search.
@@ -272,7 +274,9 @@ module Google
272
274
  # Boost specification to boost certain products. See more details at this
273
275
  # [user guide](https://cloud.google.com/retail/docs/boosting).
274
276
  #
275
- # Notice that if both [ServingConfig.boost_control_ids][] and
277
+ # Notice that if both
278
+ # {::Google::Cloud::Retail::V2::ServingConfig#boost_control_ids ServingConfig.boost_control_ids}
279
+ # and
276
280
  # {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}
277
281
  # are set, the boost conditions from both places are evaluated. If a search
278
282
  # request matches multiple boost conditions, the final boost score is equal
@@ -370,6 +374,15 @@ module Google
370
374
  # request triggers both product search and faceted search.
371
375
  # @param personalization_spec [::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec, ::Hash]
372
376
  # The specification for personalization.
377
+ #
378
+ # Notice that if both
379
+ # {::Google::Cloud::Retail::V2::ServingConfig#personalization_spec ServingConfig.personalization_spec}
380
+ # and
381
+ # {::Google::Cloud::Retail::V2::SearchRequest#personalization_spec SearchRequest.personalization_spec}
382
+ # are set.
383
+ # {::Google::Cloud::Retail::V2::SearchRequest#personalization_spec SearchRequest.personalization_spec}
384
+ # will override
385
+ # {::Google::Cloud::Retail::V2::ServingConfig#personalization_spec ServingConfig.personalization_spec}.
373
386
  # @param labels [::Hash{::String => ::String}]
374
387
  # The labels applied to a resource must meet the following requirements:
375
388
  #
@@ -49,8 +49,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
49
49
  repeated :restricted_values, :string, 3
50
50
  repeated :prefixes, :string, 8
51
51
  repeated :contains, :string, 9
52
+ optional :case_insensitive, :bool, 10
52
53
  optional :order_by, :string, 4
53
54
  optional :query, :string, 5
55
+ optional :return_min_max, :bool, 11
54
56
  end
55
57
  add_message "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec" do
56
58
  optional :mode, :enum, 1, "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode"
@@ -116,6 +118,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
116
118
  optional :matching_variant_count, :int32, 3
117
119
  map :matching_variant_fields, :string, :message, 4, "google.protobuf.FieldMask"
118
120
  map :variant_rollup_values, :string, :message, 5, "google.protobuf.Value"
121
+ repeated :personal_labels, :string, 7
119
122
  end
120
123
  add_message "google.cloud.retail.v2.SearchResponse.Facet" do
121
124
  optional :key, :string, 1
@@ -124,6 +127,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
124
127
  end
125
128
  add_message "google.cloud.retail.v2.SearchResponse.Facet.FacetValue" do
126
129
  optional :count, :int64, 3
130
+ optional :min_value, :double, 5
131
+ optional :max_value, :double, 6
127
132
  oneof :facet_value do
128
133
  optional :value, :string, 1
129
134
  optional :interval, :message, 2, "google.cloud.retail.v2.Interval"
@@ -0,0 +1,44 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/retail/v2/serving_config.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
7
+ require 'google/api/resource_pb'
8
+ require 'google/cloud/retail/v2/common_pb'
9
+ require 'google/cloud/retail/v2/search_service_pb'
10
+
11
+ Google::Protobuf::DescriptorPool.generated_pool.build do
12
+ add_file("google/cloud/retail/v2/serving_config.proto", :syntax => :proto3) do
13
+ add_message "google.cloud.retail.v2.ServingConfig" do
14
+ optional :name, :string, 1
15
+ optional :display_name, :string, 2
16
+ optional :model_id, :string, 3
17
+ optional :price_reranking_level, :string, 4
18
+ repeated :facet_control_ids, :string, 5
19
+ optional :dynamic_facet_spec, :message, 6, "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec"
20
+ repeated :boost_control_ids, :string, 7
21
+ repeated :filter_control_ids, :string, 9
22
+ repeated :redirect_control_ids, :string, 10
23
+ repeated :twoway_synonyms_control_ids, :string, 18
24
+ repeated :oneway_synonyms_control_ids, :string, 12
25
+ repeated :do_not_associate_control_ids, :string, 13
26
+ repeated :replacement_control_ids, :string, 14
27
+ repeated :ignore_control_ids, :string, 15
28
+ optional :diversity_level, :string, 8
29
+ optional :enable_category_filter_level, :string, 16
30
+ optional :personalization_spec, :message, 21, "google.cloud.retail.v2.SearchRequest.PersonalizationSpec"
31
+ repeated :solution_types, :enum, 19, "google.cloud.retail.v2.SolutionType"
32
+ end
33
+ end
34
+ end
35
+
36
+ module Google
37
+ module Cloud
38
+ module Retail
39
+ module V2
40
+ ServingConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ServingConfig").msgclass
41
+ end
42
+ end
43
+ end
44
+ end