google-apis-discoveryengine_v1 0.20.0 → 0.21.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 +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/discoveryengine_v1/classes.rb +1047 -15
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1/representations.rb +448 -0
- data/lib/google/apis/discoveryengine_v1/service.rb +135 -0
- metadata +3 -3
@@ -1979,6 +1979,51 @@ module Google
|
|
1979
1979
|
execute_or_queue_command(command, &block)
|
1980
1980
|
end
|
1981
1981
|
|
1982
|
+
# Performs a search. Similar to the SearchService.Search method, but a lite
|
1983
|
+
# version that allows API key for authentication, where OAuth and IAM checks are
|
1984
|
+
# not required. Only public website search is supported by this method. If data
|
1985
|
+
# stores and engines not associated with public website search are specified, a `
|
1986
|
+
# FAILED_PRECONDITION` error is returned. This method can be used for easy
|
1987
|
+
# onboarding without having to implement an authentication backend. However, it
|
1988
|
+
# is strongly recommended to use SearchService.Search instead with required
|
1989
|
+
# OAuth and IAM checks to provide better data security.
|
1990
|
+
# @param [String] serving_config
|
1991
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
1992
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
1993
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
1994
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
1995
|
+
# default_serving_config`. This field is used to identify the serving
|
1996
|
+
# configuration name, set of models used to make the search.
|
1997
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest] google_cloud_discoveryengine_v1_search_request_object
|
1998
|
+
# @param [String] fields
|
1999
|
+
# Selector specifying which fields to include in a partial response.
|
2000
|
+
# @param [String] quota_user
|
2001
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2002
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2003
|
+
# @param [Google::Apis::RequestOptions] options
|
2004
|
+
# Request-specific options
|
2005
|
+
#
|
2006
|
+
# @yield [result, err] Result & error if block supplied
|
2007
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse] parsed result object
|
2008
|
+
# @yieldparam err [StandardError] error object if request failed
|
2009
|
+
#
|
2010
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse]
|
2011
|
+
#
|
2012
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2013
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2014
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2015
|
+
def search_project_location_collection_data_store_serving_config_lite(serving_config, google_cloud_discoveryengine_v1_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2016
|
+
command = make_simple_command(:post, 'v1/{+servingConfig}:searchLite', options)
|
2017
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest::Representation
|
2018
|
+
command.request_object = google_cloud_discoveryengine_v1_search_request_object
|
2019
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse::Representation
|
2020
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse
|
2021
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
2022
|
+
command.query['fields'] = fields unless fields.nil?
|
2023
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2024
|
+
execute_or_queue_command(command, &block)
|
2025
|
+
end
|
2026
|
+
|
1982
2027
|
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
1983
2028
|
# error is returned.
|
1984
2029
|
# @param [String] parent
|
@@ -3775,6 +3820,51 @@ module Google
|
|
3775
3820
|
execute_or_queue_command(command, &block)
|
3776
3821
|
end
|
3777
3822
|
|
3823
|
+
# Performs a search. Similar to the SearchService.Search method, but a lite
|
3824
|
+
# version that allows API key for authentication, where OAuth and IAM checks are
|
3825
|
+
# not required. Only public website search is supported by this method. If data
|
3826
|
+
# stores and engines not associated with public website search are specified, a `
|
3827
|
+
# FAILED_PRECONDITION` error is returned. This method can be used for easy
|
3828
|
+
# onboarding without having to implement an authentication backend. However, it
|
3829
|
+
# is strongly recommended to use SearchService.Search instead with required
|
3830
|
+
# OAuth and IAM checks to provide better data security.
|
3831
|
+
# @param [String] serving_config
|
3832
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
3833
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
3834
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
3835
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
3836
|
+
# default_serving_config`. This field is used to identify the serving
|
3837
|
+
# configuration name, set of models used to make the search.
|
3838
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest] google_cloud_discoveryengine_v1_search_request_object
|
3839
|
+
# @param [String] fields
|
3840
|
+
# Selector specifying which fields to include in a partial response.
|
3841
|
+
# @param [String] quota_user
|
3842
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3843
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3844
|
+
# @param [Google::Apis::RequestOptions] options
|
3845
|
+
# Request-specific options
|
3846
|
+
#
|
3847
|
+
# @yield [result, err] Result & error if block supplied
|
3848
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse] parsed result object
|
3849
|
+
# @yieldparam err [StandardError] error object if request failed
|
3850
|
+
#
|
3851
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse]
|
3852
|
+
#
|
3853
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3854
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3855
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3856
|
+
def search_project_location_collection_engine_serving_config_lite(serving_config, google_cloud_discoveryengine_v1_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3857
|
+
command = make_simple_command(:post, 'v1/{+servingConfig}:searchLite', options)
|
3858
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest::Representation
|
3859
|
+
command.request_object = google_cloud_discoveryengine_v1_search_request_object
|
3860
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse::Representation
|
3861
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse
|
3862
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
3863
|
+
command.query['fields'] = fields unless fields.nil?
|
3864
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3865
|
+
execute_or_queue_command(command, &block)
|
3866
|
+
end
|
3867
|
+
|
3778
3868
|
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
3779
3869
|
# error is returned.
|
3780
3870
|
# @param [String] parent
|
@@ -5748,6 +5838,51 @@ module Google
|
|
5748
5838
|
execute_or_queue_command(command, &block)
|
5749
5839
|
end
|
5750
5840
|
|
5841
|
+
# Performs a search. Similar to the SearchService.Search method, but a lite
|
5842
|
+
# version that allows API key for authentication, where OAuth and IAM checks are
|
5843
|
+
# not required. Only public website search is supported by this method. If data
|
5844
|
+
# stores and engines not associated with public website search are specified, a `
|
5845
|
+
# FAILED_PRECONDITION` error is returned. This method can be used for easy
|
5846
|
+
# onboarding without having to implement an authentication backend. However, it
|
5847
|
+
# is strongly recommended to use SearchService.Search instead with required
|
5848
|
+
# OAuth and IAM checks to provide better data security.
|
5849
|
+
# @param [String] serving_config
|
5850
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
5851
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
5852
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
5853
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
5854
|
+
# default_serving_config`. This field is used to identify the serving
|
5855
|
+
# configuration name, set of models used to make the search.
|
5856
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest] google_cloud_discoveryengine_v1_search_request_object
|
5857
|
+
# @param [String] fields
|
5858
|
+
# Selector specifying which fields to include in a partial response.
|
5859
|
+
# @param [String] quota_user
|
5860
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5861
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5862
|
+
# @param [Google::Apis::RequestOptions] options
|
5863
|
+
# Request-specific options
|
5864
|
+
#
|
5865
|
+
# @yield [result, err] Result & error if block supplied
|
5866
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse] parsed result object
|
5867
|
+
# @yieldparam err [StandardError] error object if request failed
|
5868
|
+
#
|
5869
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse]
|
5870
|
+
#
|
5871
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5872
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5873
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5874
|
+
def search_project_location_data_store_serving_config_lite(serving_config, google_cloud_discoveryengine_v1_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5875
|
+
command = make_simple_command(:post, 'v1/{+servingConfig}:searchLite', options)
|
5876
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequest::Representation
|
5877
|
+
command.request_object = google_cloud_discoveryengine_v1_search_request_object
|
5878
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse::Representation
|
5879
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse
|
5880
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
5881
|
+
command.query['fields'] = fields unless fields.nil?
|
5882
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5883
|
+
execute_or_queue_command(command, &block)
|
5884
|
+
end
|
5885
|
+
|
5751
5886
|
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
5752
5887
|
# error is returned.
|
5753
5888
|
# @param [String] parent
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-discoveryengine_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.21.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: 2024-
|
11
|
+
date: 2024-11-03 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_v1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.21.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|