google-cloud-retail-v2 0.10.0 → 0.12.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/AUTHENTICATION.md +1 -1
  3. data/README.md +1 -1
  4. data/lib/google/cloud/retail/v2/catalog_pb.rb +69 -0
  5. data/lib/google/cloud/retail/v2/catalog_service/client.rb +718 -0
  6. data/lib/google/cloud/retail/v2/catalog_service/paths.rb +38 -0
  7. data/lib/google/cloud/retail/v2/catalog_service.rb +1 -1
  8. data/lib/google/cloud/retail/v2/catalog_service_pb.rb +34 -0
  9. data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb +38 -0
  10. data/lib/google/cloud/retail/v2/common_pb.rb +86 -0
  11. data/lib/google/cloud/retail/v2/completion_service/client.rb +11 -8
  12. data/lib/google/cloud/retail/v2/completion_service.rb +2 -2
  13. data/lib/google/cloud/retail/v2/completion_service_services_pb.rb +3 -3
  14. data/lib/google/cloud/retail/v2/control_pb.rb +33 -0
  15. data/lib/google/cloud/retail/v2/control_service/client.rb +807 -0
  16. data/lib/google/cloud/retail/v2/control_service/credentials.rb +51 -0
  17. data/lib/google/cloud/retail/v2/control_service/paths.rb +73 -0
  18. data/lib/google/cloud/retail/v2/control_service.rb +49 -0
  19. data/lib/google/cloud/retail/v2/control_service_pb.rb +57 -0
  20. data/lib/google/cloud/retail/v2/control_service_services_pb.rb +65 -0
  21. data/lib/google/cloud/retail/v2/prediction_service/client.rb +7 -8
  22. data/lib/google/cloud/retail/v2/prediction_service.rb +1 -1
  23. data/lib/google/cloud/retail/v2/product_pb.rb +1 -0
  24. data/lib/google/cloud/retail/v2/product_service/client.rb +65 -25
  25. data/lib/google/cloud/retail/v2/product_service.rb +1 -1
  26. data/lib/google/cloud/retail/v2/product_service_services_pb.rb +58 -13
  27. data/lib/google/cloud/retail/v2/search_service/client.rb +16 -5
  28. data/lib/google/cloud/retail/v2/search_service.rb +2 -2
  29. data/lib/google/cloud/retail/v2/search_service_pb.rb +1 -0
  30. data/lib/google/cloud/retail/v2/search_service_services_pb.rb +2 -2
  31. data/lib/google/cloud/retail/v2/serving_config_pb.rb +51 -0
  32. data/lib/google/cloud/retail/v2/serving_config_service/client.rb +998 -0
  33. data/lib/google/cloud/retail/v2/serving_config_service/credentials.rb +51 -0
  34. data/lib/google/cloud/retail/v2/serving_config_service/paths.rb +73 -0
  35. data/lib/google/cloud/retail/v2/serving_config_service.rb +49 -0
  36. data/lib/google/cloud/retail/v2/serving_config_service_pb.rb +66 -0
  37. data/lib/google/cloud/retail/v2/serving_config_service_services_pb.rb +74 -0
  38. data/lib/google/cloud/retail/v2/user_event_service/client.rb +27 -14
  39. data/lib/google/cloud/retail/v2/user_event_service.rb +1 -1
  40. data/lib/google/cloud/retail/v2/user_event_service_pb.rb +5 -0
  41. data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb +10 -10
  42. data/lib/google/cloud/retail/v2/version.rb +1 -1
  43. data/lib/google/cloud/retail/v2.rb +4 -2
  44. data/proto_docs/google/api/client.rb +318 -0
  45. data/proto_docs/google/api/launch_stage.rb +71 -0
  46. data/proto_docs/google/cloud/retail/v2/catalog.rb +271 -0
  47. data/proto_docs/google/cloud/retail/v2/catalog_service.rb +133 -0
  48. data/proto_docs/google/cloud/retail/v2/common.rb +316 -4
  49. data/proto_docs/google/cloud/retail/v2/completion_service.rb +6 -3
  50. data/proto_docs/google/cloud/retail/v2/control.rb +75 -0
  51. data/proto_docs/google/cloud/retail/v2/control_service.rb +122 -0
  52. data/proto_docs/google/cloud/retail/v2/import_config.rb +20 -35
  53. data/proto_docs/google/cloud/retail/v2/prediction_service.rb +7 -8
  54. data/proto_docs/google/cloud/retail/v2/product.rb +33 -5
  55. data/proto_docs/google/cloud/retail/v2/search_service.rb +44 -10
  56. data/proto_docs/google/cloud/retail/v2/serving_config.rb +255 -0
  57. data/proto_docs/google/cloud/retail/v2/serving_config_service.rb +143 -0
  58. data/proto_docs/google/cloud/retail/v2/user_event.rb +1 -1
  59. data/proto_docs/google/cloud/retail/v2/user_event_service.rb +24 -8
  60. data/proto_docs/google/rpc/status.rb +4 -2
  61. metadata +24 -4
@@ -0,0 +1,255 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Retail
23
+ module V2
24
+ # Configures metadata that is used to generate serving time results (e.g.
25
+ # search results or recommendation predictions).
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Immutable. Fully qualified name
29
+ # `projects/*/locations/global/catalogs/*/servingConfig/*`
30
+ # @!attribute [rw] display_name
31
+ # @return [::String]
32
+ # Required. The human readable serving config display name. Used in Retail
33
+ # UI.
34
+ #
35
+ # This field must be a UTF-8 encoded string with a length limit of 128
36
+ # characters. Otherwise, an INVALID_ARGUMENT error is returned.
37
+ # @!attribute [rw] model_id
38
+ # @return [::String]
39
+ # The id of the model in the same {::Google::Cloud::Retail::V2::Catalog Catalog}
40
+ # to use at serving time. Currently only RecommendationModels are supported:
41
+ # https://cloud.google.com/retail/recommendations-ai/docs/create-models
42
+ # Can be changed but only to a compatible model (e.g.
43
+ # others-you-may-like CTR to others-you-may-like CVR).
44
+ #
45
+ # Required when
46
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
47
+ # [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
48
+ # @!attribute [rw] price_reranking_level
49
+ # @return [::String]
50
+ # How much price ranking we want in serving results.
51
+ # Price reranking causes product items with a similar
52
+ # recommendation probability to be ordered by price, with the
53
+ # highest-priced items first. This setting could result in a decrease in
54
+ # click-through and conversion rates.
55
+ # Allowed values are:
56
+ #
57
+ # * `no-price-reranking`
58
+ # * `low-price-raranking`
59
+ # * `medium-price-reranking`
60
+ # * `high-price-reranking`
61
+ #
62
+ # If not specified, we choose default based on model type. Default value:
63
+ # `no-price-reranking`.
64
+ #
65
+ # Can only be set if
66
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
67
+ # [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
68
+ # @!attribute [rw] facet_control_ids
69
+ # @return [::Array<::String>]
70
+ # Facet specifications for faceted search. If empty, no facets are returned.
71
+ # The ids refer to the ids of {::Google::Cloud::Retail::V2::Control Control}
72
+ # resources with only the Facet control set. These controls are assumed to be
73
+ # in the same {::Google::Cloud::Retail::V2::Catalog Catalog} as the
74
+ # {::Google::Cloud::Retail::V2::ServingConfig ServingConfig}.
75
+ # A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
76
+ # is returned.
77
+ #
78
+ # Can only be set if
79
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
80
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
81
+ # @!attribute [rw] dynamic_facet_spec
82
+ # @return [::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec]
83
+ # The specification for dynamically generated facets. Notice that only
84
+ # textual facets can be dynamically generated.
85
+ #
86
+ # Can only be set if
87
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
88
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
89
+ # @!attribute [rw] boost_control_ids
90
+ # @return [::Array<::String>]
91
+ # Condition boost specifications. If a product matches multiple conditions
92
+ # in the specifications, boost scores from these specifications are all
93
+ # applied and combined in a non-linear way. Maximum number of
94
+ # specifications is 100.
95
+ #
96
+ # Notice that if both
97
+ # {::Google::Cloud::Retail::V2::ServingConfig#boost_control_ids ServingConfig.boost_control_ids}
98
+ # and
99
+ # {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}
100
+ # are set, the boost conditions from both places are evaluated. If a search
101
+ # request matches multiple boost conditions, the final boost score is equal
102
+ # to the sum of the boost scores from all matched boost conditions.
103
+ #
104
+ # Can only be set if
105
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
106
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
107
+ # @!attribute [rw] filter_control_ids
108
+ # @return [::Array<::String>]
109
+ # Condition filter specifications. If a product matches multiple conditions
110
+ # in the specifications, filters from these specifications are all
111
+ # applied and combined via the AND operator. Maximum number of
112
+ # specifications is 100.
113
+ #
114
+ # Can only be set if
115
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
116
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
117
+ # @!attribute [rw] redirect_control_ids
118
+ # @return [::Array<::String>]
119
+ # Condition redirect specifications. Only the first triggered redirect action
120
+ # is applied, even if multiple apply. Maximum number of specifications is
121
+ # 1000.
122
+ #
123
+ # Can only be set if
124
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
125
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
126
+ # @!attribute [rw] twoway_synonyms_control_ids
127
+ # @return [::Array<::String>]
128
+ # Condition synonyms specifications. If multiple syonyms conditions match,
129
+ # all matching synonyms control in the list will execute. Order of controls
130
+ # in the list will not matter. Maximum number of specifications is
131
+ # 100.
132
+ #
133
+ # Can only be set if
134
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
135
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
136
+ # @!attribute [rw] oneway_synonyms_control_ids
137
+ # @return [::Array<::String>]
138
+ # Condition oneway synonyms specifications. If multiple oneway synonyms
139
+ # conditions match, all matching oneway synonyms controls in the list will
140
+ # execute. Order of controls in the list will not matter. Maximum number of
141
+ # specifications is 100.
142
+ #
143
+ # Can only be set if
144
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
145
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
146
+ # @!attribute [rw] do_not_associate_control_ids
147
+ # @return [::Array<::String>]
148
+ # Condition do not associate specifications. If multiple do not associate
149
+ # conditions match, all matching do not associate controls in the list will
150
+ # execute.
151
+ # - Order does not matter.
152
+ # - Maximum number of specifications is 100.
153
+ #
154
+ # Can only be set if
155
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
156
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
157
+ # @!attribute [rw] replacement_control_ids
158
+ # @return [::Array<::String>]
159
+ # Condition replacement specifications.
160
+ # - Applied according to the order in the list.
161
+ # - A previously replaced term can not be re-replaced.
162
+ # - Maximum number of specifications is 100.
163
+ #
164
+ # Can only be set if
165
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
166
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
167
+ # @!attribute [rw] ignore_control_ids
168
+ # @return [::Array<::String>]
169
+ # Condition ignore specifications. If multiple ignore
170
+ # conditions match, all matching ignore controls in the list will
171
+ # execute.
172
+ # - Order does not matter.
173
+ # - Maximum number of specifications is 100.
174
+ #
175
+ # Can only be set if
176
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
177
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
178
+ # @!attribute [rw] diversity_level
179
+ # @return [::String]
180
+ # How much diversity to use in recommendation model results e.g.
181
+ # `medium-diversity` or `high-diversity`. Currently supported values:
182
+ #
183
+ # * `no-diversity`
184
+ # * `low-diversity`
185
+ # * `medium-diversity`
186
+ # * `high-diversity`
187
+ # * `auto-diversity`
188
+ #
189
+ # If not specified, we choose default based on recommendation model
190
+ # type. Default value: `no-diversity`.
191
+ #
192
+ # Can only be set if
193
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
194
+ # [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
195
+ # @!attribute [rw] diversity_type
196
+ # @return [::Google::Cloud::Retail::V2::ServingConfig::DiversityType]
197
+ # What kind of diversity to use - data driven or rule based. If unset,
198
+ # the server behavior defaults to
199
+ # {::Google::Cloud::Retail::V2::ServingConfig::DiversityType::RULE_BASED_DIVERSITY RULE_BASED_DIVERSITY}.
200
+ # @!attribute [rw] enable_category_filter_level
201
+ # @return [::String]
202
+ # Whether to add additional category filters on the `similar-items` model.
203
+ # If not specified, we enable it by default.
204
+ # Allowed values are:
205
+ #
206
+ # * `no-category-match`: No additional filtering of original results from
207
+ # the model and the customer's filters.
208
+ # * `relaxed-category-match`: Only keep results with categories that match
209
+ # at least one item categories in the PredictRequests's context item.
210
+ # * If customer also sends filters in the PredictRequest, then the results
211
+ # will satisfy both conditions (user given and category match).
212
+ #
213
+ # Can only be set if
214
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
215
+ # [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
216
+ # @!attribute [rw] personalization_spec
217
+ # @return [::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec]
218
+ # The specification for personalization spec.
219
+ #
220
+ # Can only be set if
221
+ # {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
222
+ # [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
223
+ #
224
+ # Notice that if both
225
+ # {::Google::Cloud::Retail::V2::ServingConfig#personalization_spec ServingConfig.personalization_spec}
226
+ # and
227
+ # {::Google::Cloud::Retail::V2::SearchRequest#personalization_spec SearchRequest.personalization_spec}
228
+ # are set.
229
+ # {::Google::Cloud::Retail::V2::SearchRequest#personalization_spec SearchRequest.personalization_spec}
230
+ # will override
231
+ # {::Google::Cloud::Retail::V2::ServingConfig#personalization_spec ServingConfig.personalization_spec}.
232
+ # @!attribute [rw] solution_types
233
+ # @return [::Array<::Google::Cloud::Retail::V2::SolutionType>]
234
+ # Required. Immutable. Specifies the solution types that a serving config can
235
+ # be associated with. Currently we support setting only one type of solution.
236
+ class ServingConfig
237
+ include ::Google::Protobuf::MessageExts
238
+ extend ::Google::Protobuf::MessageExts::ClassMethods
239
+
240
+ # What type of diversity - data or rule based.
241
+ module DiversityType
242
+ # Default value.
243
+ DIVERSITY_TYPE_UNSPECIFIED = 0
244
+
245
+ # Rule based diversity.
246
+ RULE_BASED_DIVERSITY = 2
247
+
248
+ # Data driven diversity.
249
+ DATA_DRIVEN_DIVERSITY = 3
250
+ end
251
+ end
252
+ end
253
+ end
254
+ end
255
+ end
@@ -0,0 +1,143 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Retail
23
+ module V2
24
+ # Request for CreateServingConfig method.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. Full resource name of parent. Format:
28
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
29
+ # @!attribute [rw] serving_config
30
+ # @return [::Google::Cloud::Retail::V2::ServingConfig]
31
+ # Required. The ServingConfig to create.
32
+ # @!attribute [rw] serving_config_id
33
+ # @return [::String]
34
+ # Required. The ID to use for the ServingConfig, which will become the final
35
+ # component of the ServingConfig's resource name.
36
+ #
37
+ # This value should be 4-63 characters, and valid characters
38
+ # are /[a-z][0-9]-_/.
39
+ class CreateServingConfigRequest
40
+ include ::Google::Protobuf::MessageExts
41
+ extend ::Google::Protobuf::MessageExts::ClassMethods
42
+ end
43
+
44
+ # Request for UpdateServingConfig method.
45
+ # @!attribute [rw] serving_config
46
+ # @return [::Google::Cloud::Retail::V2::ServingConfig]
47
+ # Required. The ServingConfig to update.
48
+ # @!attribute [rw] update_mask
49
+ # @return [::Google::Protobuf::FieldMask]
50
+ # Indicates which fields in the provided
51
+ # {::Google::Cloud::Retail::V2::ServingConfig ServingConfig} to update. The
52
+ # following are NOT supported:
53
+ #
54
+ # * {::Google::Cloud::Retail::V2::ServingConfig#name ServingConfig.name}
55
+ #
56
+ # If not set, all supported fields are updated.
57
+ class UpdateServingConfigRequest
58
+ include ::Google::Protobuf::MessageExts
59
+ extend ::Google::Protobuf::MessageExts::ClassMethods
60
+ end
61
+
62
+ # Request for DeleteServingConfig method.
63
+ # @!attribute [rw] name
64
+ # @return [::String]
65
+ # Required. The resource name of the ServingConfig to delete. Format:
66
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
67
+ class DeleteServingConfigRequest
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+ end
71
+
72
+ # Request for GetServingConfig method.
73
+ # @!attribute [rw] name
74
+ # @return [::String]
75
+ # Required. The resource name of the ServingConfig to get. Format:
76
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
77
+ class GetServingConfigRequest
78
+ include ::Google::Protobuf::MessageExts
79
+ extend ::Google::Protobuf::MessageExts::ClassMethods
80
+ end
81
+
82
+ # Request for ListServingConfigs method.
83
+ # @!attribute [rw] parent
84
+ # @return [::String]
85
+ # Required. The catalog resource name. Format:
86
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
87
+ # @!attribute [rw] page_size
88
+ # @return [::Integer]
89
+ # Optional. Maximum number of results to return. If unspecified, defaults
90
+ # to 100. If a value greater than 100 is provided, at most 100 results are
91
+ # returned.
92
+ # @!attribute [rw] page_token
93
+ # @return [::String]
94
+ # Optional. A page token, received from a previous `ListServingConfigs` call.
95
+ # Provide this to retrieve the subsequent page.
96
+ class ListServingConfigsRequest
97
+ include ::Google::Protobuf::MessageExts
98
+ extend ::Google::Protobuf::MessageExts::ClassMethods
99
+ end
100
+
101
+ # Response for ListServingConfigs method.
102
+ # @!attribute [rw] serving_configs
103
+ # @return [::Array<::Google::Cloud::Retail::V2::ServingConfig>]
104
+ # All the ServingConfigs for a given catalog.
105
+ # @!attribute [rw] next_page_token
106
+ # @return [::String]
107
+ # Pagination token, if not returned indicates the last page.
108
+ class ListServingConfigsResponse
109
+ include ::Google::Protobuf::MessageExts
110
+ extend ::Google::Protobuf::MessageExts::ClassMethods
111
+ end
112
+
113
+ # Request for AddControl method.
114
+ # @!attribute [rw] serving_config
115
+ # @return [::String]
116
+ # Required. The source ServingConfig resource name . Format:
117
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
118
+ # @!attribute [rw] control_id
119
+ # @return [::String]
120
+ # Required. The id of the control to apply. Assumed to be in the same catalog
121
+ # as the serving config - if id is not found a NOT_FOUND error is returned.
122
+ class AddControlRequest
123
+ include ::Google::Protobuf::MessageExts
124
+ extend ::Google::Protobuf::MessageExts::ClassMethods
125
+ end
126
+
127
+ # Request for RemoveControl method.
128
+ # @!attribute [rw] serving_config
129
+ # @return [::String]
130
+ # Required. The source ServingConfig resource name . Format:
131
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
132
+ # @!attribute [rw] control_id
133
+ # @return [::String]
134
+ # Required. The id of the control to apply. Assumed to be in the same catalog
135
+ # as the serving config.
136
+ class RemoveControlRequest
137
+ include ::Google::Protobuf::MessageExts
138
+ extend ::Google::Protobuf::MessageExts::ClassMethods
139
+ end
140
+ end
141
+ end
142
+ end
143
+ end
@@ -217,7 +217,7 @@ module Google
217
217
  # The categories associated with a category page.
218
218
  #
219
219
  # To represent full path of category, use '>' sign to separate different
220
- # hierarchies. If '>' is part of the category name, please replace it with
220
+ # hierarchies. If '>' is part of the category name, replace it with
221
221
  # other character(s).
222
222
  #
223
223
  # Category pages include special pages such as sales or promotions. For
@@ -29,12 +29,22 @@ module Google
29
29
  # @!attribute [rw] user_event
30
30
  # @return [::Google::Cloud::Retail::V2::UserEvent]
31
31
  # Required. User event to write.
32
+ # @!attribute [rw] write_async
33
+ # @return [::Boolean]
34
+ # If set to true, the user event will be written asynchronously after
35
+ # validation, and the API will respond without waiting for the write.
36
+ # Therefore, silent failures can occur even if the API returns success. In
37
+ # case of silent failures, error messages can be found in Stackdriver logs.
32
38
  class WriteUserEventRequest
33
39
  include ::Google::Protobuf::MessageExts
34
40
  extend ::Google::Protobuf::MessageExts::ClassMethods
35
41
  end
36
42
 
37
43
  # Request message for CollectUserEvent method.
44
+ # @!attribute [rw] prebuilt_rule
45
+ # @return [::String]
46
+ # The prebuilt rule name that can convert a specific type of raw_json.
47
+ # For example: "default_schema/v1.0"
38
48
  # @!attribute [rw] parent
39
49
  # @return [::String]
40
50
  # Required. The parent catalog name, such as
@@ -54,6 +64,12 @@ module Google
54
64
  # The event timestamp in milliseconds. This prevents browser caching of
55
65
  # otherwise identical get requests. The name is abbreviated to reduce the
56
66
  # payload bytes.
67
+ # @!attribute [rw] raw_json
68
+ # @return [::String]
69
+ # An arbitrary serialized JSON string that contains necessary information
70
+ # that can comprise a user event. When this field is specified, the
71
+ # user_event field will be ignored. Note: line-delimited JSON is not
72
+ # supported, a single JSON only.
57
73
  class CollectUserEventRequest
58
74
  include ::Google::Protobuf::MessageExts
59
75
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -68,19 +84,19 @@ module Google
68
84
  # @return [::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope]
69
85
  # The type of the user event rejoin to define the scope and range of the user
70
86
  # events to be rejoined with the latest product catalog. Defaults to
71
- # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
72
- # invalid integer value.
87
+ # `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to
88
+ # an invalid integer value.
73
89
  class RejoinUserEventsRequest
74
90
  include ::Google::Protobuf::MessageExts
75
91
  extend ::Google::Protobuf::MessageExts::ClassMethods
76
92
 
77
93
  # The scope of user events to be rejoined with the latest product catalog.
78
94
  # If the rejoining aims at reducing number of unjoined events, set
79
- # UserEventRejoinScope to UNJOINED_EVENTS.
95
+ # `UserEventRejoinScope` to `UNJOINED_EVENTS`.
80
96
  # If the rejoining aims at correcting product catalog information in joined
81
- # events, set UserEventRejoinScope to JOINED_EVENTS.
82
- # If all events needs to be rejoined, set UserEventRejoinScope to
83
- # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED.
97
+ # events, set `UserEventRejoinScope` to `JOINED_EVENTS`.
98
+ # If all events needs to be rejoined, set `UserEventRejoinScope` to
99
+ # `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED`.
84
100
  module UserEventRejoinScope
85
101
  # Rejoin all events with the latest product catalog, including both joined
86
102
  # events and unjoined events.
@@ -94,7 +110,7 @@ module Google
94
110
  end
95
111
  end
96
112
 
97
- # Response message for RejoinUserEvents method.
113
+ # Response message for `RejoinUserEvents` method.
98
114
  # @!attribute [rw] rejoined_user_events_count
99
115
  # @return [::Integer]
100
116
  # Number of user events that were joined with latest product catalog.
@@ -103,7 +119,7 @@ module Google
103
119
  extend ::Google::Protobuf::MessageExts::ClassMethods
104
120
  end
105
121
 
106
- # Metadata for RejoinUserEvents method.
122
+ # Metadata for `RejoinUserEvents` method.
107
123
  class RejoinUserEventsMetadata
108
124
  include ::Google::Protobuf::MessageExts
109
125
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -28,12 +28,14 @@ module Google
28
28
  # [API Design Guide](https://cloud.google.com/apis/design/errors).
29
29
  # @!attribute [rw] code
30
30
  # @return [::Integer]
31
- # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
31
+ # The status code, which should be an enum value of
32
+ # [google.rpc.Code][google.rpc.Code].
32
33
  # @!attribute [rw] message
33
34
  # @return [::String]
34
35
  # A developer-facing error message, which should be in English. Any
35
36
  # user-facing error message should be localized and sent in the
36
- # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
37
+ # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
38
+ # by the client.
37
39
  # @!attribute [rw] details
38
40
  # @return [::Array<::Google::Protobuf::Any>]
39
41
  # A list of messages that carry the error details. There is a common set of
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-retail-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.0
4
+ version: 0.12.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: 2022-08-04 00:00:00.000000000 Z
11
+ date: 2023-01-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.10'
19
+ version: 0.16.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.10'
29
+ version: 0.16.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -187,6 +187,13 @@ files:
187
187
  - lib/google/cloud/retail/v2/completion_service/paths.rb
188
188
  - lib/google/cloud/retail/v2/completion_service_pb.rb
189
189
  - lib/google/cloud/retail/v2/completion_service_services_pb.rb
190
+ - lib/google/cloud/retail/v2/control_pb.rb
191
+ - lib/google/cloud/retail/v2/control_service.rb
192
+ - lib/google/cloud/retail/v2/control_service/client.rb
193
+ - lib/google/cloud/retail/v2/control_service/credentials.rb
194
+ - lib/google/cloud/retail/v2/control_service/paths.rb
195
+ - lib/google/cloud/retail/v2/control_service_pb.rb
196
+ - lib/google/cloud/retail/v2/control_service_services_pb.rb
190
197
  - lib/google/cloud/retail/v2/import_config_pb.rb
191
198
  - lib/google/cloud/retail/v2/prediction_service.rb
192
199
  - lib/google/cloud/retail/v2/prediction_service/client.rb
@@ -210,6 +217,13 @@ files:
210
217
  - lib/google/cloud/retail/v2/search_service/paths.rb
211
218
  - lib/google/cloud/retail/v2/search_service_pb.rb
212
219
  - lib/google/cloud/retail/v2/search_service_services_pb.rb
220
+ - lib/google/cloud/retail/v2/serving_config_pb.rb
221
+ - lib/google/cloud/retail/v2/serving_config_service.rb
222
+ - lib/google/cloud/retail/v2/serving_config_service/client.rb
223
+ - lib/google/cloud/retail/v2/serving_config_service/credentials.rb
224
+ - lib/google/cloud/retail/v2/serving_config_service/paths.rb
225
+ - lib/google/cloud/retail/v2/serving_config_service_pb.rb
226
+ - lib/google/cloud/retail/v2/serving_config_service_services_pb.rb
213
227
  - lib/google/cloud/retail/v2/user_event_pb.rb
214
228
  - lib/google/cloud/retail/v2/user_event_service.rb
215
229
  - lib/google/cloud/retail/v2/user_event_service/client.rb
@@ -220,13 +234,17 @@ files:
220
234
  - lib/google/cloud/retail/v2/user_event_service_services_pb.rb
221
235
  - lib/google/cloud/retail/v2/version.rb
222
236
  - proto_docs/README.md
237
+ - proto_docs/google/api/client.rb
223
238
  - proto_docs/google/api/field_behavior.rb
224
239
  - proto_docs/google/api/httpbody.rb
240
+ - proto_docs/google/api/launch_stage.rb
225
241
  - proto_docs/google/api/resource.rb
226
242
  - proto_docs/google/cloud/retail/v2/catalog.rb
227
243
  - proto_docs/google/cloud/retail/v2/catalog_service.rb
228
244
  - proto_docs/google/cloud/retail/v2/common.rb
229
245
  - proto_docs/google/cloud/retail/v2/completion_service.rb
246
+ - proto_docs/google/cloud/retail/v2/control.rb
247
+ - proto_docs/google/cloud/retail/v2/control_service.rb
230
248
  - proto_docs/google/cloud/retail/v2/import_config.rb
231
249
  - proto_docs/google/cloud/retail/v2/prediction_service.rb
232
250
  - proto_docs/google/cloud/retail/v2/product.rb
@@ -234,6 +252,8 @@ files:
234
252
  - proto_docs/google/cloud/retail/v2/promotion.rb
235
253
  - proto_docs/google/cloud/retail/v2/purge_config.rb
236
254
  - proto_docs/google/cloud/retail/v2/search_service.rb
255
+ - proto_docs/google/cloud/retail/v2/serving_config.rb
256
+ - proto_docs/google/cloud/retail/v2/serving_config_service.rb
237
257
  - proto_docs/google/cloud/retail/v2/user_event.rb
238
258
  - proto_docs/google/cloud/retail/v2/user_event_service.rb
239
259
  - proto_docs/google/longrunning/operations.rb