google-cloud-retail-v2 0.11.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) 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 +14 -0
  5. data/lib/google/cloud/retail/v2/catalog_service/client.rb +19 -7
  6. data/lib/google/cloud/retail/v2/catalog_service.rb +1 -1
  7. data/lib/google/cloud/retail/v2/completion_service/client.rb +25 -9
  8. data/lib/google/cloud/retail/v2/completion_service/operations.rb +12 -14
  9. data/lib/google/cloud/retail/v2/completion_service.rb +2 -2
  10. data/lib/google/cloud/retail/v2/completion_service_services_pb.rb +3 -3
  11. data/lib/google/cloud/retail/v2/control_service/client.rb +18 -6
  12. data/lib/google/cloud/retail/v2/control_service.rb +1 -1
  13. data/lib/google/cloud/retail/v2/prediction_service/client.rb +21 -8
  14. data/lib/google/cloud/retail/v2/prediction_service.rb +1 -1
  15. data/lib/google/cloud/retail/v2/prediction_service_pb.rb +1 -0
  16. data/lib/google/cloud/retail/v2/product_service/client.rb +90 -68
  17. data/lib/google/cloud/retail/v2/product_service/operations.rb +12 -14
  18. data/lib/google/cloud/retail/v2/product_service.rb +1 -1
  19. data/lib/google/cloud/retail/v2/product_service_services_pb.rb +48 -38
  20. data/lib/google/cloud/retail/v2/search_service/client.rb +22 -10
  21. data/lib/google/cloud/retail/v2/search_service.rb +2 -2
  22. data/lib/google/cloud/retail/v2/search_service_services_pb.rb +2 -2
  23. data/lib/google/cloud/retail/v2/serving_config_pb.rb +7 -0
  24. data/lib/google/cloud/retail/v2/serving_config_service/client.rb +23 -11
  25. data/lib/google/cloud/retail/v2/serving_config_service.rb +1 -1
  26. data/lib/google/cloud/retail/v2/user_event_service/client.rb +51 -24
  27. data/lib/google/cloud/retail/v2/user_event_service/operations.rb +12 -14
  28. data/lib/google/cloud/retail/v2/user_event_service.rb +1 -1
  29. data/lib/google/cloud/retail/v2/user_event_service_pb.rb +6 -0
  30. data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb +8 -8
  31. data/lib/google/cloud/retail/v2/version.rb +1 -1
  32. data/lib/google/cloud/retail/v2.rb +2 -2
  33. data/proto_docs/google/api/client.rb +318 -0
  34. data/proto_docs/google/api/launch_stage.rb +71 -0
  35. data/proto_docs/google/cloud/retail/v2/catalog.rb +51 -13
  36. data/proto_docs/google/cloud/retail/v2/catalog_service.rb +1 -1
  37. data/proto_docs/google/cloud/retail/v2/common.rb +5 -3
  38. data/proto_docs/google/cloud/retail/v2/completion_service.rb +4 -2
  39. data/proto_docs/google/cloud/retail/v2/control.rb +2 -3
  40. data/proto_docs/google/cloud/retail/v2/prediction_service.rb +7 -8
  41. data/proto_docs/google/cloud/retail/v2/product.rb +27 -5
  42. data/proto_docs/google/cloud/retail/v2/search_service.rb +15 -8
  43. data/proto_docs/google/cloud/retail/v2/serving_config.rb +32 -15
  44. data/proto_docs/google/cloud/retail/v2/serving_config_service.rb +5 -5
  45. data/proto_docs/google/cloud/retail/v2/user_event.rb +1 -1
  46. data/proto_docs/google/cloud/retail/v2/user_event_service.rb +24 -8
  47. data/proto_docs/google/rpc/status.rb +4 -2
  48. metadata +29 -7
@@ -0,0 +1,318 @@
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 Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -0,0 +1,71 @@
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 Api
22
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end
@@ -105,13 +105,13 @@ module Google
105
105
  # APIs. This field is `False` for pre-loaded
106
106
  # {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}s.
107
107
  #
108
- # Only pre-loaded
109
- # {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}s that are
110
- # neither in use by products nor predefined can be deleted.
111
- # {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}s that are
112
- # either in use by products or are predefined cannot be deleted; however,
113
- # their configuration properties will reset to default values upon removal
114
- # request.
108
+ # Only pre-loaded [catalog
109
+ # attributes][google.cloud.retail.v2.CatalogAttribute] that are neither in
110
+ # use by products nor predefined can be deleted. [Catalog
111
+ # attributes][google.cloud.retail.v2.CatalogAttribute] that are
112
+ # either in use by products or are predefined attributes cannot be deleted;
113
+ # however, their configuration properties will reset to default values upon
114
+ # removal request.
115
115
  #
116
116
  # After catalog changes, it takes about 10 minutes for this field to update.
117
117
  # @!attribute [r] type
@@ -125,12 +125,16 @@ module Google
125
125
  # is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values
126
126
  # are indexed so that it can be filtered, faceted, or boosted in
127
127
  # {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
128
+ #
129
+ # Must be specified, otherwise throws INVALID_FORMAT error.
128
130
  # @!attribute [rw] dynamic_facetable_option
129
131
  # @return [::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption]
130
132
  # If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
131
133
  # facet. Could only be DYNAMIC_FACETABLE_DISABLED if
132
134
  # {::Google::Cloud::Retail::V2::CatalogAttribute#indexable_option CatalogAttribute.indexable_option}
133
135
  # is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
136
+ #
137
+ # Must be specified, otherwise throws INVALID_FORMAT error.
134
138
  # @!attribute [rw] searchable_option
135
139
  # @return [::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption]
136
140
  # When
@@ -143,6 +147,17 @@ module Google
143
147
  # will not be searchable by text queries in
144
148
  # {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}, as
145
149
  # there are no text values associated to numerical attributes.
150
+ #
151
+ # Must be specified, otherwise throws INVALID_FORMAT error.
152
+ # @!attribute [rw] exact_searchable_option
153
+ # @return [::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption]
154
+ # If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
155
+ # This property only applies to textual custom attributes and requires
156
+ # indexable set to enabled to enable exact-searchable.
157
+ # @!attribute [rw] retrievable_option
158
+ # @return [::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption]
159
+ # If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
160
+ # results.
146
161
  class CatalogAttribute
147
162
  include ::Google::Protobuf::MessageExts
148
163
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -164,8 +179,7 @@ module Google
164
179
 
165
180
  # The status of the indexable option of a catalog attribute.
166
181
  module IndexableOption
167
- # Value used when unset. Defaults to
168
- # {::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption::INDEXABLE_ENABLED INDEXABLE_ENABLED}.
182
+ # Value used when unset.
169
183
  INDEXABLE_OPTION_UNSPECIFIED = 0
170
184
 
171
185
  # Indexable option enabled for an attribute.
@@ -177,8 +191,7 @@ module Google
177
191
 
178
192
  # The status of the dynamic facetable option of a catalog attribute.
179
193
  module DynamicFacetableOption
180
- # Value used when unset. Defaults to
181
- # {::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption::DYNAMIC_FACETABLE_ENABLED DYNAMIC_FACETABLE_ENABLED}.
194
+ # Value used when unset.
182
195
  DYNAMIC_FACETABLE_OPTION_UNSPECIFIED = 0
183
196
 
184
197
  # Dynamic facetable option enabled for an attribute.
@@ -190,8 +203,7 @@ module Google
190
203
 
191
204
  # The status of the searchable option of a catalog attribute.
192
205
  module SearchableOption
193
- # Value used when unset. Defaults to
194
- # {::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption::SEARCHABLE_DISABLED SEARCHABLE_DISABLED}.
206
+ # Value used when unset.
195
207
  SEARCHABLE_OPTION_UNSPECIFIED = 0
196
208
 
197
209
  # Searchable option enabled for an attribute.
@@ -200,6 +212,32 @@ module Google
200
212
  # Searchable option disabled for an attribute.
201
213
  SEARCHABLE_DISABLED = 2
202
214
  end
215
+
216
+ # The status of the exact-searchable option of a catalog attribute.
217
+ module ExactSearchableOption
218
+ # Value used when unset. Defaults to
219
+ # {::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption::EXACT_SEARCHABLE_DISABLED EXACT_SEARCHABLE_DISABLED}.
220
+ EXACT_SEARCHABLE_OPTION_UNSPECIFIED = 0
221
+
222
+ # Exact searchable option enabled for an attribute.
223
+ EXACT_SEARCHABLE_ENABLED = 1
224
+
225
+ # Exact searchable option disabled for an attribute.
226
+ EXACT_SEARCHABLE_DISABLED = 2
227
+ end
228
+
229
+ # The status of the retrievable option of a catalog attribute.
230
+ module RetrievableOption
231
+ # Value used when unset. Defaults to
232
+ # {::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption::RETRIEVABLE_DISABLED RETRIEVABLE_DISABLED}.
233
+ RETRIEVABLE_OPTION_UNSPECIFIED = 0
234
+
235
+ # Retrievable option enabled for an attribute.
236
+ RETRIEVABLE_ENABLED = 1
237
+
238
+ # Retrievable option disabled for an attribute.
239
+ RETRIEVABLE_DISABLED = 2
240
+ end
203
241
  end
204
242
 
205
243
  # Catalog level attribute config.
@@ -165,7 +165,7 @@ module Google
165
165
  # @!attribute [rw] name
166
166
  # @return [::String]
167
167
  # Required. Full CompletionConfig resource name. Format:
168
- # projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/completionConfig
168
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`
169
169
  class GetCompletionConfigRequest
170
170
  include ::Google::Protobuf::MessageExts
171
171
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -48,8 +48,8 @@ module Google
48
48
  # Value cannot be empty.
49
49
  # Value can have at most 3 terms if specified as a partial match. Each
50
50
  # space separated string is considered as one term.
51
- # Example) "a b c" is 3 terms and allowed, " a b c d" is 4 terms and not
52
- # allowed for partial match.
51
+ # For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms
52
+ # and not allowed for a partial match.
53
53
  # @!attribute [rw] full_match
54
54
  # @return [::Boolean]
55
55
  # Whether this is supposed to be a full or partial match.
@@ -73,6 +73,7 @@ module Google
73
73
  end
74
74
 
75
75
  # A rule is a condition-action pair
76
+ #
76
77
  # * A condition defines when a rule is to be triggered.
77
78
  # * An action specifies what occurs on that trigger.
78
79
  # Currently rules only work for {::Google::Cloud::Retail::V2::Control controls} with
@@ -202,7 +203,8 @@ module Google
202
203
  end
203
204
 
204
205
  # Creates a set of terms that will be treated as synonyms of each other.
205
- # Example: synonyms of "sneakers" and "shoes".
206
+ # Example: synonyms of "sneakers" and "shoes":
207
+ #
206
208
  # * "sneakers" will use a synonym of "shoes".
207
209
  # * "shoes" will use a synonym of "sneakers".
208
210
  # @!attribute [rw] synonyms
@@ -55,8 +55,10 @@ module Google
55
55
  # number of language codes is 3.
56
56
  # @!attribute [rw] device_type
57
57
  # @return [::String]
58
- # The device type context for completion suggestions.
59
- # It is useful to apply different suggestions on different device types, e.g.
58
+ # The device type context for completion suggestions. We recommend that you
59
+ # leave this field empty.
60
+ #
61
+ # It can apply different suggestions on different device types, e.g.
60
62
  # `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
61
63
  # types.
62
64
  #
@@ -41,9 +41,8 @@ module Google
41
41
  # characters. Otherwise, an INVALID_ARGUMENT error is thrown.
42
42
  # @!attribute [r] associated_serving_config_ids
43
43
  # @return [::Array<::String>]
44
- # Output only. List of [serving
45
- # configuration][google.cloud.retail.v2.ServingConfig] ids that are
46
- # associated with this control in the same
44
+ # Output only. List of {::Google::Cloud::Retail::V2::ServingConfig serving config}
45
+ # ids that are associated with this control in the same
47
46
  # {::Google::Cloud::Retail::V2::Catalog Catalog}.
48
47
  #
49
48
  # Note the association is managed via the
@@ -33,7 +33,7 @@ module Google
33
33
  # The ID of the Recommendations AI serving config or placement.
34
34
  # Before you can request predictions from your model, you must create at
35
35
  # least one serving config or placement for it. For more information, see
36
- # [Managing serving configurations]
36
+ # [Manage serving configs]
37
37
  # (https://cloud.google.com/retail/docs/manage-configs).
38
38
  #
39
39
  # The full list of available serving configs can be seen at
@@ -88,12 +88,11 @@ module Google
88
88
  # * filterOutOfStockItems tag=(-"promotional")
89
89
  # * filterOutOfStockItems
90
90
  #
91
- # If your filter blocks all prediction results, the API will return generic
92
- # (unfiltered) popular products. If you only want results strictly matching
93
- # the filters, set `strictFiltering` to True in `PredictRequest.params` to
94
- # receive empty results instead.
95
- # Note that the API will never return items with storageStatus of "EXPIRED"
96
- # or "DELETED" regardless of filter choices.
91
+ # If your filter blocks all prediction results, the API will return *no*
92
+ # results. If instead you want empty result sets to return generic
93
+ # (unfiltered) popular products, set `strictFiltering` to False in
94
+ # `PredictRequest.params`. Note that the API will never return items with
95
+ # storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.
97
96
  #
98
97
  # If `filterSyntaxV2` is set to true under the `params` field, then
99
98
  # attribute-based expressions are expected instead of the above described
@@ -120,7 +119,7 @@ module Google
120
119
  # * `returnScore`: Boolean. If set to true, the prediction 'score'
121
120
  # corresponding to each returned product will be set in the
122
121
  # `results.metadata` field in the prediction response. The given
123
- # 'score' indicates the probability of an product being clicked/purchased
122
+ # 'score' indicates the probability of a product being clicked/purchased
124
123
  # given the user's context and history.
125
124
  # * `strictFiltering`: Boolean. True by default. If set to false, the service
126
125
  # will return generic (unfiltered) popular products instead of empty if