google-apis-retail_v2alpha 0.37.0 → 0.40.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: caea85e4dc8a3c22833aa7302515b8e21035a770cc0be655122536284b33c4ba
4
- data.tar.gz: 2a40905b2e51af4d99ceff5d672ba74d77e84752427ae54c7419ba4f8c4fb5bd
3
+ metadata.gz: 44ef2bee884e2a8c93ee4268acf06f7446811fd0014b197dd60e96af99fbb13a
4
+ data.tar.gz: 23edf9bc572404b7b07a4d6ee298de46ba1255012d2074cdb0f698189230c771
5
5
  SHA512:
6
- metadata.gz: 5093e1e3bbd1f1666e27b98e9790922611226c3e668e287aa7fad5397db44c692c85dbe42857db9f848173083dc46c48fd9b1c1429f82a04aa65a2e2faa4582e
7
- data.tar.gz: 20a3171589e843b72530a88b00881c15bc0093f37a9b0ab6ee6bb02f5d1f179f57c76998a319167481951b646d1e541fab513956bc8878def75749abade94a9f
6
+ metadata.gz: 56f362bba0bca18125e0a2885b4aee78d1aea4105f30e857b9dd5bc74b06e9e9dd5588039f3ce428a177c1d734601c8a3d7c027af8164068da92e2acd2758aa5
7
+ data.tar.gz: 2206ecb4d022eb2b5190ce5f248a9886d3ed4b30761b3ab6f0809a660bfacd8ffb2a9f556fcfcf4f24bca6bcac3ef6412f040e64b96a994ae48661fbde4e3833
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.40.0 (2022-05-12)
4
+
5
+ * Regenerated from discovery document revision 20220505
6
+
7
+ ### v0.39.0 (2022-05-05)
8
+
9
+ * Regenerated from discovery document revision 20220430
10
+
11
+ ### v0.38.0 (2022-04-28)
12
+
13
+ * Regenerated from discovery document revision 20220421
14
+
3
15
  ### v0.37.0 (2022-04-22)
4
16
 
5
17
  * Regenerated from discovery document revision 20220414
@@ -281,7 +281,7 @@ module Google
281
281
 
282
282
  # Metadata related to the progress of the AddFulfillmentPlaces operation.
283
283
  # Currently empty because there is no meaningful metadata populated from the
284
- # AddFulfillmentPlaces method.
284
+ # ProductService.AddFulfillmentPlaces method.
285
285
  class GoogleCloudRetailV2AddFulfillmentPlacesMetadata
286
286
  include Google::Apis::Core::Hashable
287
287
 
@@ -295,7 +295,8 @@ module Google
295
295
  end
296
296
 
297
297
  # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
298
- # no meaningful response populated from the AddFulfillmentPlaces method.
298
+ # no meaningful response populated from the ProductService.AddFulfillmentPlaces
299
+ # method.
299
300
  class GoogleCloudRetailV2AddFulfillmentPlacesResponse
300
301
  include Google::Apis::Core::Hashable
301
302
 
@@ -310,7 +311,7 @@ module Google
310
311
 
311
312
  # Metadata related to the progress of the AddLocalInventories operation.
312
313
  # Currently empty because there is no meaningful metadata populated from the
313
- # AddLocalInventories method.
314
+ # ProductService.AddLocalInventories method.
314
315
  class GoogleCloudRetailV2AddLocalInventoriesMetadata
315
316
  include Google::Apis::Core::Hashable
316
317
 
@@ -323,8 +324,9 @@ module Google
323
324
  end
324
325
  end
325
326
 
326
- # Response of the AddLocalInventories API. Currently empty because there is no
327
- # meaningful response populated from the AddLocalInventories method.
327
+ # Response of the ProductService.AddLocalInventories API. Currently empty
328
+ # because there is no meaningful response populated from the ProductService.
329
+ # AddLocalInventories method.
328
330
  class GoogleCloudRetailV2AddLocalInventoriesResponse
329
331
  include Google::Apis::Core::Hashable
330
332
 
@@ -717,7 +719,7 @@ module Google
717
719
 
718
720
  # Metadata related to the progress of the AddFulfillmentPlaces operation.
719
721
  # Currently empty because there is no meaningful metadata populated from the
720
- # AddFulfillmentPlaces method.
722
+ # ProductService.AddFulfillmentPlaces method.
721
723
  class GoogleCloudRetailV2alphaAddFulfillmentPlacesMetadata
722
724
  include Google::Apis::Core::Hashable
723
725
 
@@ -730,7 +732,7 @@ module Google
730
732
  end
731
733
  end
732
734
 
733
- # Request message for AddFulfillmentPlaces method.
735
+ # Request message for ProductService.AddFulfillmentPlaces method.
734
736
  class GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest
735
737
  include Google::Apis::Core::Hashable
736
738
 
@@ -787,7 +789,8 @@ module Google
787
789
  end
788
790
 
789
791
  # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
790
- # no meaningful response populated from the AddFulfillmentPlaces method.
792
+ # no meaningful response populated from the ProductService.AddFulfillmentPlaces
793
+ # method.
791
794
  class GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse
792
795
  include Google::Apis::Core::Hashable
793
796
 
@@ -802,7 +805,7 @@ module Google
802
805
 
803
806
  # Metadata related to the progress of the AddLocalInventories operation.
804
807
  # Currently empty because there is no meaningful metadata populated from the
805
- # AddLocalInventories method.
808
+ # ProductService.AddLocalInventories method.
806
809
  class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
807
810
  include Google::Apis::Core::Hashable
808
811
 
@@ -815,7 +818,7 @@ module Google
815
818
  end
816
819
  end
817
820
 
818
- # Request message for AddLocalInventories method.
821
+ # Request message for ProductService.AddLocalInventories method.
819
822
  class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
820
823
  include Google::Apis::Core::Hashable
821
824
 
@@ -866,8 +869,9 @@ module Google
866
869
  end
867
870
  end
868
871
 
869
- # Response of the AddLocalInventories API. Currently empty because there is no
870
- # meaningful response populated from the AddLocalInventories method.
872
+ # Response of the ProductService.AddLocalInventories API. Currently empty
873
+ # because there is no meaningful response populated from the ProductService.
874
+ # AddLocalInventories method.
871
875
  class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
872
876
  include Google::Apis::Core::Hashable
873
877
 
@@ -1084,12 +1088,13 @@ module Google
1084
1088
  # Output only. Indicates whether this attribute has been used by any products. `
1085
1089
  # True` if at least one Product is using this attribute in Product.attributes.
1086
1090
  # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
1087
- # AddCatalogAttribute, ImportCatalogAttributes, or UpdateAttributesConfig APIs.
1088
- # This field is `False` for pre-loaded CatalogAttributes. Only CatalogAttributes
1089
- # that are not in use by products can be deleted. CatalogAttributes that are in
1090
- # use by products cannot be deleted; however, their configuration properties
1091
- # will reset to default values upon removal request. After catalog changes, it
1092
- # takes about 10 minutes for this field to update.
1091
+ # CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or
1092
+ # CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-
1093
+ # loaded CatalogAttributes. Only CatalogAttributes that are not in use by
1094
+ # products can be deleted. CatalogAttributes that are in use by products cannot
1095
+ # be deleted; however, their configuration properties will reset to default
1096
+ # values upon removal request. After catalog changes, it takes about 10 minutes
1097
+ # for this field to update.
1093
1098
  # Corresponds to the JSON property `inUse`
1094
1099
  # @return [Boolean]
1095
1100
  attr_accessor :in_use
@@ -1567,12 +1572,14 @@ module Google
1567
1572
  class GoogleCloudRetailV2alphaCustomAttribute
1568
1573
  include Google::Apis::Core::Hashable
1569
1574
 
1570
- # This field will only be used when AttributesConfig.attribute_config_level of
1571
- # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
1572
- # values are indexed, so that it can be filtered, faceted or boosted in
1573
- # SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.
1574
- # filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more
1575
- # details.
1575
+ # This field is normally ignored unless AttributesConfig.attribute_config_level
1576
+ # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
1577
+ # For information about product-level attribute configuration, see [
1578
+ # Configuration modes](https://cloud.google.com/retail/docs/attribute-config#
1579
+ # config-modes). If true, custom attribute values are indexed, so that they can
1580
+ # be filtered, faceted or boosted in SearchService.Search. This field is ignored
1581
+ # in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and
1582
+ # SearchRequest.boost_spec for more details.
1576
1583
  # Corresponds to the JSON property `indexable`
1577
1584
  # @return [Boolean]
1578
1585
  attr_accessor :indexable
@@ -1585,11 +1592,13 @@ module Google
1585
1592
  # @return [Array<Float>]
1586
1593
  attr_accessor :numbers
1587
1594
 
1588
- # This field will only be used when AttributesConfig.attribute_config_level of
1589
- # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
1590
- # values are searchable by text queries in SearchService.Search. This field is
1591
- # ignored in a UserEvent. Only set if type text is set. Otherwise, a
1592
- # INVALID_ARGUMENT error is returned.
1595
+ # This field is normally ignored unless AttributesConfig.attribute_config_level
1596
+ # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
1597
+ # For information about product-level attribute configuration, see [
1598
+ # Configuration modes](https://cloud.google.com/retail/docs/attribute-config#
1599
+ # config-modes). If true, custom attribute values are searchable by text queries
1600
+ # in SearchService.Search. This field is ignored in a UserEvent. Only set if
1601
+ # type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
1593
1602
  # Corresponds to the JSON property `searchable`
1594
1603
  # @return [Boolean]
1595
1604
  attr_accessor :searchable
@@ -2456,7 +2465,7 @@ module Google
2456
2465
  # The labels applied to a resource must meet the following requirements: * Each
2457
2466
  # resource can have multiple labels, up to a maximum of 64. * Each label must be
2458
2467
  # a key-value pair. * Keys have a minimum length of 1 character and a maximum
2459
- # length of 63 characters, and cannot be empty. Values can be empty, and have a
2468
+ # length of 63 characters and cannot be empty. Values can be empty and have a
2460
2469
  # maximum length of 63 characters. * Keys and values can contain only lowercase
2461
2470
  # letters, numeric characters, underscores, and dashes. All characters must use
2462
2471
  # UTF-8 encoding, and international characters are allowed. * The key portion of
@@ -2584,9 +2593,9 @@ module Google
2584
2593
  attr_accessor :id
2585
2594
 
2586
2595
  # Additional product metadata / annotations. Possible values: * `product`: JSON
2587
- # representation of the product. Will be set if `returnProduct` is set to true
2588
- # in `PredictRequest.params`. * `score`: Prediction score in double value. Will
2589
- # be set if `returnScore` is set to true in `PredictRequest.params`.
2596
+ # representation of the product. Is set if `returnProduct` is set to true in `
2597
+ # PredictRequest.params`. * `score`: Prediction score in double value. Is set if
2598
+ # `returnScore` is set to true in `PredictRequest.params`.
2590
2599
  # Corresponds to the JSON property `metadata`
2591
2600
  # @return [Hash<String,Object>]
2592
2601
  attr_accessor :metadata
@@ -2949,9 +2958,9 @@ module Google
2949
2958
  # attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION,
2950
2959
  # the following fields are always returned in SearchResponse by default: * name
2951
2960
  # For Type.VARIANT, the following fields are always returned in by default: *
2952
- # name * color_info Maximum number of paths is 30. Otherwise, an
2961
+ # name * color_info The maximum number of paths is 30. Otherwise, an
2953
2962
  # INVALID_ARGUMENT error is returned. Note: Returning more fields in
2954
- # SearchResponse may increase response payload size and serving latency.
2963
+ # SearchResponse can increase response payload size and serving latency.
2955
2964
  # Corresponds to the JSON property `retrievableFields`
2956
2965
  # @return [String]
2957
2966
  attr_accessor :retrievable_fields
@@ -4135,7 +4144,7 @@ module Google
4135
4144
  # The labels applied to a resource must meet the following requirements: * Each
4136
4145
  # resource can have multiple labels, up to a maximum of 64. * Each label must be
4137
4146
  # a key-value pair. * Keys have a minimum length of 1 character and a maximum
4138
- # length of 63 characters, and cannot be empty. Values can be empty, and have a
4147
+ # length of 63 characters and cannot be empty. Values can be empty and have a
4139
4148
  # maximum length of 63 characters. * Keys and values can contain only lowercase
4140
4149
  # letters, numeric characters, underscores, and dashes. All characters must use
4141
4150
  # UTF-8 encoding, and international characters are allowed. * The key portion of
@@ -4221,6 +4230,11 @@ module Google
4221
4230
  # @return [String]
4222
4231
  attr_accessor :search_mode
4223
4232
 
4233
+ # The specification for query spell correction.
4234
+ # Corresponds to the JSON property `spellCorrectionSpec`
4235
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec]
4236
+ attr_accessor :spell_correction_spec
4237
+
4224
4238
  # Information of an end user.
4225
4239
  # Corresponds to the JSON property `userInfo`
4226
4240
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo]
@@ -4236,8 +4250,8 @@ module Google
4236
4250
  # the store ID. Supported keys are: * colorFamilies * price * originalPrice *
4237
4251
  # discount * variantId * inventory(place_id,price) * inventory(place_id,
4238
4252
  # original_price) * inventory(place_id,attributes.key), where key is any key in
4239
- # the Product.inventories.attributes map. * attributes.key, where key is any key
4240
- # in the Product.attributes map. * pickupInStore.id, where id is any
4253
+ # the Product.local_inventories.attributes map. * attributes.key, where key is
4254
+ # any key in the Product.attributes map. * pickupInStore.id, where id is any
4241
4255
  # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
4242
4256
  # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
4243
4257
  # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
@@ -4289,6 +4303,7 @@ module Google
4289
4303
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
4290
4304
  @relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
4291
4305
  @search_mode = args[:search_mode] if args.key?(:search_mode)
4306
+ @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
4292
4307
  @user_info = args[:user_info] if args.key?(:user_info)
4293
4308
  @variant_rollup_keys = args[:variant_rollup_keys] if args.key?(:variant_rollup_keys)
4294
4309
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
@@ -4592,6 +4607,26 @@ module Google
4592
4607
  end
4593
4608
  end
4594
4609
 
4610
+ # The specification for query spell correction.
4611
+ class GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec
4612
+ include Google::Apis::Core::Hashable
4613
+
4614
+ # The mode under which spell correction should take effect to replace the
4615
+ # original search query. Default to Mode.AUTO.
4616
+ # Corresponds to the JSON property `mode`
4617
+ # @return [String]
4618
+ attr_accessor :mode
4619
+
4620
+ def initialize(**args)
4621
+ update!(**args)
4622
+ end
4623
+
4624
+ # Update properties of this object
4625
+ def update!(**args)
4626
+ @mode = args[:mode] if args.key?(:mode)
4627
+ end
4628
+ end
4629
+
4595
4630
  # Response message for SearchService.Search method.
4596
4631
  class GoogleCloudRetailV2alphaSearchResponse
4597
4632
  include Google::Apis::Core::Hashable
@@ -4609,7 +4644,9 @@ module Google
4609
4644
  # @return [String]
4610
4645
  attr_accessor :attribution_token
4611
4646
 
4612
- # If spell correction applies, the corrected query. Otherwise, empty.
4647
+ # Contains the spell corrected query, if found. If the spell correction type is
4648
+ # AUTOMATIC, then the search results are based on corrected_query. Otherwise the
4649
+ # original query will be used for search.
4613
4650
  # Corresponds to the JSON property `correctedQuery`
4614
4651
  # @return [String]
4615
4652
  attr_accessor :corrected_query
@@ -4638,8 +4675,8 @@ module Google
4638
4675
  attr_accessor :query_expansion_info
4639
4676
 
4640
4677
  # The URI of a customer-defined redirect page. If redirect action is triggered,
4641
- # no search will be performed, and only redirect_uri and attribution_token will
4642
- # be set in the response.
4678
+ # no search is performed, and only redirect_uri and attribution_token are set in
4679
+ # the response.
4643
4680
  # Corresponds to the JSON property `redirectUri`
4644
4681
  # @return [String]
4645
4682
  attr_accessor :redirect_uri
@@ -4836,11 +4873,11 @@ module Google
4836
4873
  # Condition boost specifications. If a product matches multiple conditions in
4837
4874
  # the specifications, boost scores from these specifications are all applied and
4838
4875
  # combined in a non-linear way. Maximum number of specifications is 100. Notice
4839
- # that if both ServingConfig.boost_control_ids and [SearchRequest.boost_spec]
4840
- # are set, the boost conditions from both places are evaluated. If a search
4841
- # request matches multiple boost conditions, the final boost score is equal to
4842
- # the sum of the boost scores from all matched boost conditions. Can only be set
4843
- # if solution_types is SOLUTION_TYPE_SEARCH.
4876
+ # that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are
4877
+ # set, the boost conditions from both places are evaluated. If a search request
4878
+ # matches multiple boost conditions, the final boost score is equal to the sum
4879
+ # of the boost scores from all matched boost conditions. Can only be set if
4880
+ # solution_types is SOLUTION_TYPE_SEARCH.
4844
4881
  # Corresponds to the JSON property `boostControlIds`
4845
4882
  # @return [Array<String>]
4846
4883
  attr_accessor :boost_control_ids
@@ -5247,9 +5284,9 @@ module Google
5247
5284
  # @return [String]
5248
5285
  attr_accessor :page_view_id
5249
5286
 
5250
- # The main product details related to the event. This field is required for the
5251
- # following event types: * `add-to-cart` * `detail-page-view` * `purchase-
5252
- # complete` * `search` In a `search` event, this field represents the products
5287
+ # The main product details related to the event. This field is optional except
5288
+ # for the following event types: * `add-to-cart` * `detail-page-view` * `
5289
+ # purchase-complete` In a `search` event, this field represents the products
5253
5290
  # returned to the end user on the current page (the end user may have not
5254
5291
  # finished browsing the whole page yet). When a new page is returned to the end
5255
5292
  # user, after pagination/filtering/ordering even for the same query, a new `
@@ -5481,7 +5518,7 @@ module Google
5481
5518
 
5482
5519
  # Metadata related to the progress of the AddFulfillmentPlaces operation.
5483
5520
  # Currently empty because there is no meaningful metadata populated from the
5484
- # AddFulfillmentPlaces method.
5521
+ # ProductService.AddFulfillmentPlaces method.
5485
5522
  class GoogleCloudRetailV2betaAddFulfillmentPlacesMetadata
5486
5523
  include Google::Apis::Core::Hashable
5487
5524
 
@@ -5495,7 +5532,8 @@ module Google
5495
5532
  end
5496
5533
 
5497
5534
  # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
5498
- # no meaningful response populated from the AddFulfillmentPlaces method.
5535
+ # no meaningful response populated from the ProductService.AddFulfillmentPlaces
5536
+ # method.
5499
5537
  class GoogleCloudRetailV2betaAddFulfillmentPlacesResponse
5500
5538
  include Google::Apis::Core::Hashable
5501
5539
 
@@ -5510,7 +5548,7 @@ module Google
5510
5548
 
5511
5549
  # Metadata related to the progress of the AddLocalInventories operation.
5512
5550
  # Currently empty because there is no meaningful metadata populated from the
5513
- # AddLocalInventories method.
5551
+ # ProductService.AddLocalInventories method.
5514
5552
  class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
5515
5553
  include Google::Apis::Core::Hashable
5516
5554
 
@@ -5523,8 +5561,9 @@ module Google
5523
5561
  end
5524
5562
  end
5525
5563
 
5526
- # Response of the AddLocalInventories API. Currently empty because there is no
5527
- # meaningful response populated from the AddLocalInventories method.
5564
+ # Response of the ProductService.AddLocalInventories API. Currently empty
5565
+ # because there is no meaningful response populated from the ProductService.
5566
+ # AddLocalInventories method.
5528
5567
  class GoogleCloudRetailV2betaAddLocalInventoriesResponse
5529
5568
  include Google::Apis::Core::Hashable
5530
5569
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2alpha
18
18
  # Version of the google-apis-retail_v2alpha gem
19
- GEM_VERSION = "0.37.0"
19
+ GEM_VERSION = "0.40.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220414"
25
+ REVISION = "20220505"
26
26
  end
27
27
  end
28
28
  end
@@ -766,6 +766,12 @@ module Google
766
766
  include Google::Apis::Core::JsonObjectSupport
767
767
  end
768
768
 
769
+ class GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec
770
+ class Representation < Google::Apis::Core::JsonRepresentation; end
771
+
772
+ include Google::Apis::Core::JsonObjectSupport
773
+ end
774
+
769
775
  class GoogleCloudRetailV2alphaSearchResponse
770
776
  class Representation < Google::Apis::Core::JsonRepresentation; end
771
777
 
@@ -2123,6 +2129,8 @@ module Google
2123
2129
 
2124
2130
  property :relevance_threshold, as: 'relevanceThreshold'
2125
2131
  property :search_mode, as: 'searchMode'
2132
+ property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec::Representation
2133
+
2126
2134
  property :user_info, as: 'userInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo::Representation
2127
2135
 
2128
2136
  collection :variant_rollup_keys, as: 'variantRollupKeys'
@@ -2194,6 +2202,13 @@ module Google
2194
2202
  end
2195
2203
  end
2196
2204
 
2205
+ class GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec
2206
+ # @private
2207
+ class Representation < Google::Apis::Core::JsonRepresentation
2208
+ property :mode, as: 'mode'
2209
+ end
2210
+ end
2211
+
2197
2212
  class GoogleCloudRetailV2alphaSearchResponse
2198
2213
  # @private
2199
2214
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -62,8 +62,9 @@ module Google
62
62
  # the imported dataset through CompletionService.ImportCompletionData. "cloud-
63
63
  # retail" will use the dataset generated by cloud retail based on user events.
64
64
  # If leave empty, it will use the "user-data". Current supported values: * user-
65
- # data * cloud-retail This option requires additional allowlisting. Before using
66
- # cloud-retail, contact Cloud Retail support team first.
65
+ # data * cloud-retail: This option requires enabling auto-learning function
66
+ # first. See [guidelines](https://cloud.google.com/retail/docs/completion-
67
+ # overview#generated-completion-dataset).
67
68
  # @param [String] device_type
68
69
  # The device type context for completion suggestions. It is useful to apply
69
70
  # different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If
@@ -1073,9 +1074,9 @@ module Google
1073
1074
  # this product will be used. If no inventory fields are set in
1074
1075
  # SetInventoryRequest.set_mask, then any existing inventory information will be
1075
1076
  # preserved. Pre-existing inventory information can only be updated with
1076
- # SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
1077
- # is only available for users who have Retail Search enabled. Please enable
1078
- # Retail Search on Cloud Console before using this feature.
1077
+ # SetInventory, ProductService.AddFulfillmentPlaces, and RemoveFulfillmentPlaces.
1078
+ # This feature is only available for users who have Retail Search enabled.
1079
+ # Please enable Retail Search on Cloud Console before using this feature.
1079
1080
  # @param [String] name
1080
1081
  # Immutable. Full resource name of the product, such as `projects/*/locations/
1081
1082
  # global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -1419,15 +1420,12 @@ module Google
1419
1420
  # Makes a recommendation prediction.
1420
1421
  # @param [String] placement
1421
1422
  # Required. Full resource name of the format: `name=projects/*/locations/global/
1422
- # catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
1423
- # global/catalogs/default_catalog/placements/*`. We recommend using the `
1424
- # servingConfigs` resource. `placements` is a legacy resource. The ID of the
1425
- # Recommendations AI serving config or placement. Before you can request
1426
- # predictions from your model, you must create at least one serving config or
1427
- # placement for it. For more information, see [Managing serving configurations] (
1428
- # https://cloud.google.com/retail/docs/manage-configs). The full list of
1429
- # available serving configs can be seen at https://console.cloud.google.com/ai/
1430
- # retail/catalogs/default_catalog/configs
1423
+ # catalogs/default_catalog/placements/*` The ID of the Recommendations AI
1424
+ # placement. Before you can request predictions from your model, you must create
1425
+ # at least one placement for it. For more information, see [Managing placements](
1426
+ # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
1427
+ # The full list of available placements can be seen at https://console.cloud.
1428
+ # google.com/recommendation/catalogs/default_catalog/placements
1431
1429
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
1432
1430
  # @param [String] fields
1433
1431
  # Selector specifying which fields to include in a partial response.
@@ -1462,12 +1460,10 @@ module Google
1462
1460
  # Search enabled. Please enable Retail Search on Cloud Console before using this
1463
1461
  # feature.
1464
1462
  # @param [String] placement
1465
- # Required. The resource name of the Retail Search serving config, such as `
1466
- # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1467
- # default_serving_config` or the name of the legacy placement resource, such as `
1468
- # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1469
- # . This field is used to identify the serving configuration name and the set of
1470
- # models that will be used to make the search.
1463
+ # Required. The resource name of the search engine placement, such as `projects/*
1464
+ # /locations/global/catalogs/default_catalog/placements/default_search`. This
1465
+ # field is used to identify the serving configuration name and the set of models
1466
+ # that will be used to make the search.
1471
1467
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1472
1468
  # @param [String] fields
1473
1469
  # Selector specifying which fields to include in a partial response.
@@ -1722,48 +1718,6 @@ module Google
1722
1718
  execute_or_queue_command(command, &block)
1723
1719
  end
1724
1720
 
1725
- # Makes a recommendation prediction.
1726
- # @param [String] placement
1727
- # Required. Full resource name of the format: `name=projects/*/locations/global/
1728
- # catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
1729
- # global/catalogs/default_catalog/placements/*`. We recommend using the `
1730
- # servingConfigs` resource. `placements` is a legacy resource. The ID of the
1731
- # Recommendations AI serving config or placement. Before you can request
1732
- # predictions from your model, you must create at least one serving config or
1733
- # placement for it. For more information, see [Managing serving configurations] (
1734
- # https://cloud.google.com/retail/docs/manage-configs). The full list of
1735
- # available serving configs can be seen at https://console.cloud.google.com/ai/
1736
- # retail/catalogs/default_catalog/configs
1737
- # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
1738
- # @param [String] fields
1739
- # Selector specifying which fields to include in a partial response.
1740
- # @param [String] quota_user
1741
- # Available to use for quota purposes for server-side applications. Can be any
1742
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1743
- # @param [Google::Apis::RequestOptions] options
1744
- # Request-specific options
1745
- #
1746
- # @yield [result, err] Result & error if block supplied
1747
- # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse] parsed result object
1748
- # @yieldparam err [StandardError] error object if request failed
1749
- #
1750
- # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse]
1751
- #
1752
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1753
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1754
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1755
- def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1756
- command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
1757
- command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
1758
- command.request_object = google_cloud_retail_v2alpha_predict_request_object
1759
- command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
1760
- command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
1761
- command.params['placement'] = placement unless placement.nil?
1762
- command.query['fields'] = fields unless fields.nil?
1763
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1764
- execute_or_queue_command(command, &block)
1765
- end
1766
-
1767
1721
  # Disables a Control on the specified ServingConfig. The control is removed from
1768
1722
  # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
1769
1723
  # the ServingConfig.
@@ -1801,46 +1755,6 @@ module Google
1801
1755
  execute_or_queue_command(command, &block)
1802
1756
  end
1803
1757
 
1804
- # Performs a search. This feature is only available for users who have Retail
1805
- # Search enabled. Please enable Retail Search on Cloud Console before using this
1806
- # feature.
1807
- # @param [String] placement
1808
- # Required. The resource name of the Retail Search serving config, such as `
1809
- # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1810
- # default_serving_config` or the name of the legacy placement resource, such as `
1811
- # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1812
- # . This field is used to identify the serving configuration name and the set of
1813
- # models that will be used to make the search.
1814
- # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1815
- # @param [String] fields
1816
- # Selector specifying which fields to include in a partial response.
1817
- # @param [String] quota_user
1818
- # Available to use for quota purposes for server-side applications. Can be any
1819
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1820
- # @param [Google::Apis::RequestOptions] options
1821
- # Request-specific options
1822
- #
1823
- # @yield [result, err] Result & error if block supplied
1824
- # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse] parsed result object
1825
- # @yieldparam err [StandardError] error object if request failed
1826
- #
1827
- # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse]
1828
- #
1829
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1830
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1831
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1832
- def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1833
- command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
1834
- command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
1835
- command.request_object = google_cloud_retail_v2alpha_search_request_object
1836
- command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
1837
- command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
1838
- command.params['placement'] = placement unless placement.nil?
1839
- command.query['fields'] = fields unless fields.nil?
1840
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1841
- execute_or_queue_command(command, &block)
1842
- end
1843
-
1844
1758
  # Writes a single user event from the browser. This uses a GET request to due to
1845
1759
  # browser restriction of POST-ing to a 3rd party domain. This method is used
1846
1760
  # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.37.0
4
+ version: 0.40.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-04-25 00:00:00.000000000 Z
11
+ date: 2022-05-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.37.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.40.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
63
63
  post_install_message:
64
64
  rdoc_options: []