google-apis-retail_v2alpha 0.43.0 → 0.46.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:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 64a427f5a6e48062fd4037b102518525f364246731a9f47c0de21a6a36fbd172
|
4
|
+
data.tar.gz: '0364182dd92a137a753202ab45dbe87de8273420b53626418003e44da13e2945'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 16a0999e673d0a757d481125d755c81f783ed5fcce0f582139c6022f4eaa45c715c1a3b8ac13b83f3b6b53a88cc5f55024c0fb6c7dd42c6d2aef3b59bf15c295
|
7
|
+
data.tar.gz: 38b4c0cd7965479a02eaa50cb01ce1153d8a085ffefd0471483a4f73b57a4082d5c7ff9d5ee60d0d893f38d935a2fe0c297eec022dbf61638e8f9994313ad889
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,20 @@
|
|
1
1
|
# Release history for google-apis-retail_v2alpha
|
2
2
|
|
3
|
+
### v0.46.0 (2022-07-01)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20220623
|
6
|
+
* Regenerated using generator version 0.8.0
|
7
|
+
|
8
|
+
### v0.45.0 (2022-06-23)
|
9
|
+
|
10
|
+
* Regenerated from discovery document revision 20220617
|
11
|
+
* Regenerated using generator version 0.7.0
|
12
|
+
|
13
|
+
### v0.44.0 (2022-06-14)
|
14
|
+
|
15
|
+
* Regenerated from discovery document revision 20220609
|
16
|
+
* Regenerated using generator version 0.6.0
|
17
|
+
|
3
18
|
### v0.43.0 (2022-06-07)
|
4
19
|
|
5
20
|
* Regenerated from discovery document revision 20220602
|
@@ -1108,11 +1108,22 @@ module Google
|
|
1108
1108
|
attr_accessor :indexable_option
|
1109
1109
|
|
1110
1110
|
# Required. Attribute name. For example: `color`, `brands`, `attributes.
|
1111
|
-
# custom_attribute`, such as `attributes.xyz`.
|
1111
|
+
# custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute
|
1112
|
+
# name can contain only alpha-numeric characters and underscores. For example,
|
1113
|
+
# an attribute named `attributes.abc_xyz` can be indexed, but an attribute named
|
1114
|
+
# `attributes.abc-xyz` cannot be indexed.
|
1112
1115
|
# Corresponds to the JSON property `key`
|
1113
1116
|
# @return [String]
|
1114
1117
|
attr_accessor :key
|
1115
1118
|
|
1119
|
+
# When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
|
1120
|
+
# if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for
|
1121
|
+
# recommendations. This option works for categorical features only, does not
|
1122
|
+
# work for numerical features, inventory filtering.
|
1123
|
+
# Corresponds to the JSON property `recommendationsFilteringOption`
|
1124
|
+
# @return [String]
|
1125
|
+
attr_accessor :recommendations_filtering_option
|
1126
|
+
|
1116
1127
|
# When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
|
1117
1128
|
# if SEARCHABLE_ENABLED, attribute values are searchable by text queries in
|
1118
1129
|
# SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical,
|
@@ -1138,6 +1149,7 @@ module Google
|
|
1138
1149
|
@in_use = args[:in_use] if args.key?(:in_use)
|
1139
1150
|
@indexable_option = args[:indexable_option] if args.key?(:indexable_option)
|
1140
1151
|
@key = args[:key] if args.key?(:key)
|
1152
|
+
@recommendations_filtering_option = args[:recommendations_filtering_option] if args.key?(:recommendations_filtering_option)
|
1141
1153
|
@searchable_option = args[:searchable_option] if args.key?(:searchable_option)
|
1142
1154
|
@type = args[:type] if args.key?(:type)
|
1143
1155
|
end
|
@@ -1297,14 +1309,16 @@ module Google
|
|
1297
1309
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
|
1298
1310
|
attr_accessor :denylist_input_config
|
1299
1311
|
|
1300
|
-
# Output only. LRO corresponding to the latest allowlist import. Can
|
1301
|
-
# GetOperation API to retrieve the latest state of the Long Running
|
1312
|
+
# Output only. Name of the LRO corresponding to the latest allowlist import. Can
|
1313
|
+
# use GetOperation API to retrieve the latest state of the Long Running
|
1314
|
+
# Operation.
|
1302
1315
|
# Corresponds to the JSON property `lastAllowlistImportOperation`
|
1303
1316
|
# @return [String]
|
1304
1317
|
attr_accessor :last_allowlist_import_operation
|
1305
1318
|
|
1306
|
-
# Output only. LRO corresponding to the latest denylist import. Can
|
1307
|
-
# GetOperation API to retrieve the latest state of the Long Running
|
1319
|
+
# Output only. Name of the LRO corresponding to the latest denylist import. Can
|
1320
|
+
# use GetOperation API to retrieve the latest state of the Long Running
|
1321
|
+
# Operation.
|
1308
1322
|
# Corresponds to the JSON property `lastDenylistImportOperation`
|
1309
1323
|
# @return [String]
|
1310
1324
|
attr_accessor :last_denylist_import_operation
|
@@ -2459,7 +2473,11 @@ module Google
|
|
2459
2473
|
# only want results strictly matching the filters, set `strictFiltering` to True
|
2460
2474
|
# in `PredictRequest.params` to receive empty results instead. Note that the API
|
2461
2475
|
# will never return items with storageStatus of "EXPIRED" or "DELETED"
|
2462
|
-
# regardless of filter choices.
|
2476
|
+
# regardless of filter choices. If `filterSyntaxV2` is set to true under the `
|
2477
|
+
# params` field, then attribute based expressions are expected instead of the
|
2478
|
+
# above described tag-based syntax. Examples: * (colors: ANY("Red", "Blue")) AND
|
2479
|
+
# NOT (categories: ANY("Phones")) * (availability: ANY("IN_STOCK")) AND (colors:
|
2480
|
+
# ANY("Red") OR categories: ANY("Phones"))
|
2463
2481
|
# Corresponds to the JSON property `filter`
|
2464
2482
|
# @return [String]
|
2465
2483
|
attr_accessor :filter
|
@@ -2508,7 +2526,9 @@ module Google
|
|
2508
2526
|
# price. * `diversityLevel`: String. Default empty. If set to be non-empty, then
|
2509
2527
|
# it needs to be one of `'no-diversity', 'low-diversity', 'medium-diversity', '
|
2510
2528
|
# high-diversity', 'auto-diversity'`. This gives request-level control and
|
2511
|
-
# adjusts prediction results based on product category.
|
2529
|
+
# adjusts prediction results based on product category. * `filterSyntaxV2`:
|
2530
|
+
# Boolean. False by default. If set to true, the `filter` field will be
|
2531
|
+
# interpreteted according to the new, attribute-based syntax.
|
2512
2532
|
# Corresponds to the JSON property `params`
|
2513
2533
|
# @return [Hash<String,Object>]
|
2514
2534
|
attr_accessor :params
|
@@ -4479,8 +4499,8 @@ module Google
|
|
4479
4499
|
class GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey
|
4480
4500
|
include Google::Apis::Core::Hashable
|
4481
4501
|
|
4482
|
-
#
|
4483
|
-
# prefixes or contains.
|
4502
|
+
# True to make facet keys case insensitive when getting faceting values with
|
4503
|
+
# prefixes or contains; false otherwise.
|
4484
4504
|
# Corresponds to the JSON property `caseInsensitive`
|
4485
4505
|
# @return [Boolean]
|
4486
4506
|
attr_accessor :case_insensitive
|
@@ -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.
|
19
|
+
GEM_VERSION = "0.46.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.8.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20220623"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -1358,6 +1358,7 @@ module Google
|
|
1358
1358
|
property :in_use, as: 'inUse'
|
1359
1359
|
property :indexable_option, as: 'indexableOption'
|
1360
1360
|
property :key, as: 'key'
|
1361
|
+
property :recommendations_filtering_option, as: 'recommendationsFilteringOption'
|
1361
1362
|
property :searchable_option, as: 'searchableOption'
|
1362
1363
|
property :type, as: 'type'
|
1363
1364
|
end
|
@@ -1419,13 +1419,16 @@ module Google
|
|
1419
1419
|
|
1420
1420
|
# Makes a recommendation prediction.
|
1421
1421
|
# @param [String] placement
|
1422
|
-
# Required. Full resource name of the format:
|
1423
|
-
# catalogs/default_catalog/
|
1424
|
-
#
|
1425
|
-
#
|
1426
|
-
#
|
1427
|
-
#
|
1428
|
-
#
|
1422
|
+
# Required. Full resource name of the format: `placement=projects/*/locations/
|
1423
|
+
# global/catalogs/default_catalog/servingConfigs/*` or `placement=projects/*/
|
1424
|
+
# locations/global/catalogs/default_catalog/placements/*`. We recommend using
|
1425
|
+
# the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
1426
|
+
# the Recommendations AI serving config or placement. Before you can request
|
1427
|
+
# predictions from your model, you must create at least one serving config or
|
1428
|
+
# placement for it. For more information, see [Managing serving configurations] (
|
1429
|
+
# https://cloud.google.com/retail/docs/manage-configs). The full list of
|
1430
|
+
# available serving configs can be seen at https://console.cloud.google.com/ai/
|
1431
|
+
# retail/catalogs/default_catalog/configs
|
1429
1432
|
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
|
1430
1433
|
# @param [String] fields
|
1431
1434
|
# Selector specifying which fields to include in a partial response.
|
@@ -1460,10 +1463,12 @@ module Google
|
|
1460
1463
|
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
1461
1464
|
# feature.
|
1462
1465
|
# @param [String] placement
|
1463
|
-
# Required. The resource name of the
|
1464
|
-
#
|
1465
|
-
#
|
1466
|
-
#
|
1466
|
+
# Required. The resource name of the Retail Search serving config, such as `
|
1467
|
+
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
1468
|
+
# default_serving_config` or the name of the legacy placement resource, such as `
|
1469
|
+
# projects/*/locations/global/catalogs/default_catalog/placements/default_search`
|
1470
|
+
# . This field is used to identify the serving configuration name and the set of
|
1471
|
+
# models that will be used to make the search.
|
1467
1472
|
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
|
1468
1473
|
# @param [String] fields
|
1469
1474
|
# Selector specifying which fields to include in a partial response.
|
@@ -1718,6 +1723,48 @@ module Google
|
|
1718
1723
|
execute_or_queue_command(command, &block)
|
1719
1724
|
end
|
1720
1725
|
|
1726
|
+
# Makes a recommendation prediction.
|
1727
|
+
# @param [String] placement
|
1728
|
+
# Required. Full resource name of the format: `placement=projects/*/locations/
|
1729
|
+
# global/catalogs/default_catalog/servingConfigs/*` or `placement=projects/*/
|
1730
|
+
# locations/global/catalogs/default_catalog/placements/*`. We recommend using
|
1731
|
+
# the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
1732
|
+
# the Recommendations AI serving config or placement. Before you can request
|
1733
|
+
# predictions from your model, you must create at least one serving config or
|
1734
|
+
# placement for it. For more information, see [Managing serving configurations] (
|
1735
|
+
# https://cloud.google.com/retail/docs/manage-configs). The full list of
|
1736
|
+
# available serving configs can be seen at https://console.cloud.google.com/ai/
|
1737
|
+
# retail/catalogs/default_catalog/configs
|
1738
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
|
1739
|
+
# @param [String] fields
|
1740
|
+
# Selector specifying which fields to include in a partial response.
|
1741
|
+
# @param [String] quota_user
|
1742
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1743
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1744
|
+
# @param [Google::Apis::RequestOptions] options
|
1745
|
+
# Request-specific options
|
1746
|
+
#
|
1747
|
+
# @yield [result, err] Result & error if block supplied
|
1748
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse] parsed result object
|
1749
|
+
# @yieldparam err [StandardError] error object if request failed
|
1750
|
+
#
|
1751
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse]
|
1752
|
+
#
|
1753
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1754
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1755
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1756
|
+
def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1757
|
+
command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
|
1758
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
|
1759
|
+
command.request_object = google_cloud_retail_v2alpha_predict_request_object
|
1760
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
|
1761
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
|
1762
|
+
command.params['placement'] = placement unless placement.nil?
|
1763
|
+
command.query['fields'] = fields unless fields.nil?
|
1764
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1765
|
+
execute_or_queue_command(command, &block)
|
1766
|
+
end
|
1767
|
+
|
1721
1768
|
# Disables a Control on the specified ServingConfig. The control is removed from
|
1722
1769
|
# the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
|
1723
1770
|
# the ServingConfig.
|
@@ -1755,6 +1802,46 @@ module Google
|
|
1755
1802
|
execute_or_queue_command(command, &block)
|
1756
1803
|
end
|
1757
1804
|
|
1805
|
+
# Performs a search. This feature is only available for users who have Retail
|
1806
|
+
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
1807
|
+
# feature.
|
1808
|
+
# @param [String] placement
|
1809
|
+
# Required. The resource name of the Retail Search serving config, such as `
|
1810
|
+
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
1811
|
+
# default_serving_config` or the name of the legacy placement resource, such as `
|
1812
|
+
# projects/*/locations/global/catalogs/default_catalog/placements/default_search`
|
1813
|
+
# . This field is used to identify the serving configuration name and the set of
|
1814
|
+
# models that will be used to make the search.
|
1815
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
|
1816
|
+
# @param [String] fields
|
1817
|
+
# Selector specifying which fields to include in a partial response.
|
1818
|
+
# @param [String] quota_user
|
1819
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1820
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1821
|
+
# @param [Google::Apis::RequestOptions] options
|
1822
|
+
# Request-specific options
|
1823
|
+
#
|
1824
|
+
# @yield [result, err] Result & error if block supplied
|
1825
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse] parsed result object
|
1826
|
+
# @yieldparam err [StandardError] error object if request failed
|
1827
|
+
#
|
1828
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse]
|
1829
|
+
#
|
1830
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1831
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1832
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1833
|
+
def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1834
|
+
command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
|
1835
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
|
1836
|
+
command.request_object = google_cloud_retail_v2alpha_search_request_object
|
1837
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
|
1838
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
|
1839
|
+
command.params['placement'] = placement unless placement.nil?
|
1840
|
+
command.query['fields'] = fields unless fields.nil?
|
1841
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1842
|
+
execute_or_queue_command(command, &block)
|
1843
|
+
end
|
1844
|
+
|
1758
1845
|
# Writes a single user event from the browser. This uses a GET request to due to
|
1759
1846
|
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
1760
1847
|
# 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.
|
4
|
+
version: 0.46.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-
|
11
|
+
date: 2022-07-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '0.
|
19
|
+
version: '0.7'
|
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.
|
29
|
+
version: '0.7'
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -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.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.46.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: []
|