google-apis-discoveryengine_v1beta 0.22.0 → 0.24.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: be813845d5d32a7e2cbca0854542fdd8174a53579e9de1a79e9f0764874cb6fc
4
- data.tar.gz: 71eb1d3ccc7fbdd8510366e50ef2c4a20ddd3769dbb9e903910e139e26ede3c0
3
+ metadata.gz: fa300730087756ee24597024b7eaa87866ba68312b54ff6b5213f46098a29533
4
+ data.tar.gz: 6d529abe22a44bdd90328dffd0dc1afc3b0cf5d1566bcbe221efab9a8d451b8f
5
5
  SHA512:
6
- metadata.gz: cae9a2da17593a613dcd643af4f36be90a40e87a3679bf6c5e2291edc2490f5bf9dde13cef4f20da4eb9ac8350d35e85e0895f47bdcb3ce429a5785114ec4e19
7
- data.tar.gz: ecb5df29d11b27f728b6728153db14883846573d36940b03a3e9f291023d082e1e71faf101df829a0e83dc1bc8ea5d1cf74ae4644dd6dc57a455915bf50a954f
6
+ metadata.gz: eb5a33d11ec9880446de0c7736c2381bd9520597acc7ae46dd166b95c54de698a55ed24e373c8061dcfeb4d561feb8deb05f02b8f17865afc2c10c65ac63dfeb
7
+ data.tar.gz: 8b4e68cd386f780eca5bbd785e9be3da903f6032b1591f60d442a899dfacbd4ec6d0f9586a59aac1f3a885995a13ea81583d51901a70665c3c137233ea775830
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-discoveryengine_v1beta
2
2
 
3
+ ### v0.24.0 (2023-10-15)
4
+
5
+ * Regenerated from discovery document revision 20231003
6
+
7
+ ### v0.23.0 (2023-10-08)
8
+
9
+ * Regenerated from discovery document revision 20230928
10
+
3
11
  ### v0.22.0 (2023-10-01)
4
12
 
5
13
  * Regenerated from discovery document revision 20230925
@@ -3799,6 +3799,11 @@ module Google
3799
3799
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseFacet>]
3800
3800
  attr_accessor :facets
3801
3801
 
3802
+ #
3803
+ # Corresponds to the JSON property `geoSearchDebugInfo`
3804
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo>]
3805
+ attr_accessor :geo_search_debug_info
3806
+
3802
3807
  # Guided search result. The guided search helps user to refine the search
3803
3808
  # results and narrow down to the real needs from a broaded search results.
3804
3809
  # Corresponds to the JSON property `guidedSearchResult`
@@ -3851,6 +3856,7 @@ module Google
3851
3856
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
3852
3857
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
3853
3858
  @facets = args[:facets] if args.key?(:facets)
3859
+ @geo_search_debug_info = args[:geo_search_debug_info] if args.key?(:geo_search_debug_info)
3854
3860
  @guided_search_result = args[:guided_search_result] if args.key?(:guided_search_result)
3855
3861
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
3856
3862
  @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
@@ -3925,6 +3931,32 @@ module Google
3925
3931
  end
3926
3932
  end
3927
3933
 
3934
+ # Debug information specifically related to forward geocoding issues arising
3935
+ # from Geolocation Search.
3936
+ class GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo
3937
+ include Google::Apis::Core::Hashable
3938
+
3939
+ # The error produced.
3940
+ # Corresponds to the JSON property `errorMessage`
3941
+ # @return [String]
3942
+ attr_accessor :error_message
3943
+
3944
+ # The address from which forward geocoding ingestion produced issues.
3945
+ # Corresponds to the JSON property `originalAddressQuery`
3946
+ # @return [String]
3947
+ attr_accessor :original_address_query
3948
+
3949
+ def initialize(**args)
3950
+ update!(**args)
3951
+ end
3952
+
3953
+ # Update properties of this object
3954
+ def update!(**args)
3955
+ @error_message = args[:error_message] if args.key?(:error_message)
3956
+ @original_address_query = args[:original_address_query] if args.key?(:original_address_query)
3957
+ end
3958
+ end
3959
+
3928
3960
  # Guided search result. The guided search helps user to refine the search
3929
3961
  # results and narrow down to the real needs from a broaded search results.
3930
3962
  class GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1beta
18
18
  # Version of the google-apis-discoveryengine_v1beta gem
19
- GEM_VERSION = "0.22.0"
19
+ GEM_VERSION = "0.24.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230925"
25
+ REVISION = "20231003"
26
26
  end
27
27
  end
28
28
  end
@@ -628,6 +628,12 @@ module Google
628
628
  include Google::Apis::Core::JsonObjectSupport
629
629
  end
630
630
 
631
+ class GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo
632
+ class Representation < Google::Apis::Core::JsonRepresentation; end
633
+
634
+ include Google::Apis::Core::JsonObjectSupport
635
+ end
636
+
631
637
  class GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult
632
638
  class Representation < Google::Apis::Core::JsonRepresentation; end
633
639
 
@@ -1707,6 +1713,8 @@ module Google
1707
1713
  property :corrected_query, as: 'correctedQuery'
1708
1714
  collection :facets, as: 'facets', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseFacet, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseFacet::Representation
1709
1715
 
1716
+ collection :geo_search_debug_info, as: 'geoSearchDebugInfo', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo::Representation
1717
+
1710
1718
  property :guided_search_result, as: 'guidedSearchResult', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult::Representation
1711
1719
 
1712
1720
  property :next_page_token, as: 'nextPageToken'
@@ -1741,6 +1749,14 @@ module Google
1741
1749
  end
1742
1750
  end
1743
1751
 
1752
+ class GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo
1753
+ # @private
1754
+ class Representation < Google::Apis::Core::JsonRepresentation
1755
+ property :error_message, as: 'errorMessage'
1756
+ property :original_address_query, as: 'originalAddressQuery'
1757
+ end
1758
+ end
1759
+
1744
1760
  class GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult
1745
1761
  # @private
1746
1762
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1490,6 +1490,78 @@ module Google
1490
1490
  execute_or_queue_command(command, &block)
1491
1491
  end
1492
1492
 
1493
+ # Makes a recommendation, which requires a contextual user event.
1494
+ # @param [String] serving_config
1495
+ # Required. Full resource name of the format: `projects/*/locations/global/
1496
+ # collections/*/dataStores/*/servingConfigs/*` Before you can request
1497
+ # recommendations from your model, you must create at least one serving config
1498
+ # for it.
1499
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
1500
+ # @param [String] fields
1501
+ # Selector specifying which fields to include in a partial response.
1502
+ # @param [String] quota_user
1503
+ # Available to use for quota purposes for server-side applications. Can be any
1504
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1505
+ # @param [Google::Apis::RequestOptions] options
1506
+ # Request-specific options
1507
+ #
1508
+ # @yield [result, err] Result & error if block supplied
1509
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse] parsed result object
1510
+ # @yieldparam err [StandardError] error object if request failed
1511
+ #
1512
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse]
1513
+ #
1514
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1515
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1516
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1517
+ def recommend_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1beta_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1518
+ command = make_simple_command(:post, 'v1beta/{+servingConfig}:recommend', options)
1519
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest::Representation
1520
+ command.request_object = google_cloud_discoveryengine_v1beta_recommend_request_object
1521
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse::Representation
1522
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse
1523
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
1524
+ command.query['fields'] = fields unless fields.nil?
1525
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1526
+ execute_or_queue_command(command, &block)
1527
+ end
1528
+
1529
+ # Performs a search.
1530
+ # @param [String] serving_config
1531
+ # Required. The resource name of the Search serving config, such as `projects/*/
1532
+ # locations/global/collections/default_collection/dataStores/default_data_store/
1533
+ # servingConfigs/default_serving_config`. This field is used to identify the
1534
+ # serving configuration name, set of models used to make the search.
1535
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
1536
+ # @param [String] fields
1537
+ # Selector specifying which fields to include in a partial response.
1538
+ # @param [String] quota_user
1539
+ # Available to use for quota purposes for server-side applications. Can be any
1540
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1541
+ # @param [Google::Apis::RequestOptions] options
1542
+ # Request-specific options
1543
+ #
1544
+ # @yield [result, err] Result & error if block supplied
1545
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse] parsed result object
1546
+ # @yieldparam err [StandardError] error object if request failed
1547
+ #
1548
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse]
1549
+ #
1550
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1551
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1552
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1553
+ def search_project_location_collection_engine_serving_configs(serving_config, google_cloud_discoveryengine_v1beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1554
+ command = make_simple_command(:post, 'v1beta/{+servingConfig}:search', options)
1555
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest::Representation
1556
+ command.request_object = google_cloud_discoveryengine_v1beta_search_request_object
1557
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse::Representation
1558
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
1559
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
1560
+ command.query['fields'] = fields unless fields.nil?
1561
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1562
+ execute_or_queue_command(command, &block)
1563
+ end
1564
+
1493
1565
  # Gets the latest state of a long-running operation. Clients can use this method
1494
1566
  # to poll the operation result at intervals as recommended by the API service.
1495
1567
  # @param [String] name
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.22.0
4
+ version: 0.24.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: 2023-10-01 00:00:00.000000000 Z
11
+ date: 2023-10-15 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-discoveryengine_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.22.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.24.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []