google-apis-discoveryengine_v1 0.23.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 +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/discoveryengine_v1/classes.rb +639 -2
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1/representations.rb +206 -0
- data/lib/google/apis/discoveryengine_v1/service.rb +282 -12
- metadata +4 -4
@@ -1901,6 +1901,47 @@ module Google
|
|
1901
1901
|
execute_or_queue_command(command, &block)
|
1902
1902
|
end
|
1903
1903
|
|
1904
|
+
# Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
|
1905
|
+
# not exist.
|
1906
|
+
# @param [String] name
|
1907
|
+
# Immutable. Fully qualified name `projects/`project`/locations/`location`/
|
1908
|
+
# collections/`collection_id`/engines/`engine_id`/servingConfigs/`
|
1909
|
+
# serving_config_id``
|
1910
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig] google_cloud_discoveryengine_v1_serving_config_object
|
1911
|
+
# @param [String] update_mask
|
1912
|
+
# Indicates which fields in the provided ServingConfig to update. The following
|
1913
|
+
# are NOT supported: * ServingConfig.name If not set, all supported fields are
|
1914
|
+
# updated.
|
1915
|
+
# @param [String] fields
|
1916
|
+
# Selector specifying which fields to include in a partial response.
|
1917
|
+
# @param [String] quota_user
|
1918
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1919
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1920
|
+
# @param [Google::Apis::RequestOptions] options
|
1921
|
+
# Request-specific options
|
1922
|
+
#
|
1923
|
+
# @yield [result, err] Result & error if block supplied
|
1924
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig] parsed result object
|
1925
|
+
# @yieldparam err [StandardError] error object if request failed
|
1926
|
+
#
|
1927
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig]
|
1928
|
+
#
|
1929
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1930
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1931
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1932
|
+
def patch_project_location_collection_data_store_serving_config(name, google_cloud_discoveryengine_v1_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1933
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
1934
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig::Representation
|
1935
|
+
command.request_object = google_cloud_discoveryengine_v1_serving_config_object
|
1936
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig::Representation
|
1937
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig
|
1938
|
+
command.params['name'] = name unless name.nil?
|
1939
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1940
|
+
command.query['fields'] = fields unless fields.nil?
|
1941
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1942
|
+
execute_or_queue_command(command, &block)
|
1943
|
+
end
|
1944
|
+
|
1904
1945
|
# Makes a recommendation, which requires a contextual user event.
|
1905
1946
|
# @param [String] serving_config
|
1906
1947
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
@@ -2024,6 +2065,45 @@ module Google
|
|
2024
2065
|
execute_or_queue_command(command, &block)
|
2025
2066
|
end
|
2026
2067
|
|
2068
|
+
# Answer query method (streaming). It takes one AnswerQueryRequest and returns
|
2069
|
+
# multiple AnswerQueryResponse messages in a stream.
|
2070
|
+
# @param [String] serving_config
|
2071
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
2072
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
2073
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
2074
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
2075
|
+
# field is used to identify the serving configuration name, set of models used
|
2076
|
+
# to make the search.
|
2077
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest] google_cloud_discoveryengine_v1_answer_query_request_object
|
2078
|
+
# @param [String] fields
|
2079
|
+
# Selector specifying which fields to include in a partial response.
|
2080
|
+
# @param [String] quota_user
|
2081
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2082
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2083
|
+
# @param [Google::Apis::RequestOptions] options
|
2084
|
+
# Request-specific options
|
2085
|
+
#
|
2086
|
+
# @yield [result, err] Result & error if block supplied
|
2087
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse] parsed result object
|
2088
|
+
# @yieldparam err [StandardError] error object if request failed
|
2089
|
+
#
|
2090
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse]
|
2091
|
+
#
|
2092
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2093
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2094
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2095
|
+
def stream_project_location_collection_data_store_serving_config_answer(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2096
|
+
command = make_simple_command(:post, 'v1/{+servingConfig}:streamAnswer', options)
|
2097
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
|
2098
|
+
command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
|
2099
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
|
2100
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
|
2101
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
2102
|
+
command.query['fields'] = fields unless fields.nil?
|
2103
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2104
|
+
execute_or_queue_command(command, &block)
|
2105
|
+
end
|
2106
|
+
|
2027
2107
|
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
2028
2108
|
# error is returned.
|
2029
2109
|
# @param [String] parent
|
@@ -2097,6 +2177,9 @@ module Google
|
|
2097
2177
|
# Required. The resource name of the Session to get. Format: `projects/`project`/
|
2098
2178
|
# locations/`location`/collections/`collection`/dataStores/`data_store_id`/
|
2099
2179
|
# sessions/`session_id``
|
2180
|
+
# @param [Boolean] include_answer_details
|
2181
|
+
# Optional. If set to true, the full session including all answer details will
|
2182
|
+
# be returned.
|
2100
2183
|
# @param [String] fields
|
2101
2184
|
# Selector specifying which fields to include in a partial response.
|
2102
2185
|
# @param [String] quota_user
|
@@ -2114,11 +2197,12 @@ module Google
|
|
2114
2197
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2115
2198
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2116
2199
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2117
|
-
def get_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
2200
|
+
def get_project_location_collection_data_store_session(name, include_answer_details: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2118
2201
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
2119
2202
|
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
2120
2203
|
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
2121
2204
|
command.params['name'] = name unless name.nil?
|
2205
|
+
command.query['includeAnswerDetails'] = include_answer_details unless include_answer_details.nil?
|
2122
2206
|
command.query['fields'] = fields unless fields.nil?
|
2123
2207
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2124
2208
|
execute_or_queue_command(command, &block)
|
@@ -2134,7 +2218,9 @@ module Google
|
|
2134
2218
|
# @param [String] order_by
|
2135
2219
|
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
2136
2220
|
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
2137
|
-
# create_time` * `session_name` Example: "update_time desc" "
|
2221
|
+
# create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
|
2222
|
+
# create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
|
2223
|
+
# first, then by update_time.
|
2138
2224
|
# @param [Fixnum] page_size
|
2139
2225
|
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
2140
2226
|
# allowed value is 1000.
|
@@ -2864,8 +2950,12 @@ module Google
|
|
2864
2950
|
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
2865
2951
|
# Users should not call this method directly.
|
2866
2952
|
# @param [String] parent
|
2867
|
-
# Required. The parent
|
2868
|
-
#
|
2953
|
+
# Required. The parent resource name. If the collect user event action is
|
2954
|
+
# applied in DataStore level, the format is: `projects/`project`/locations/`
|
2955
|
+
# location`/collections/`collection`/dataStores/`data_store``. If the collect
|
2956
|
+
# user event action is applied in Location level, for example, the event with
|
2957
|
+
# Document across multiple DataStore, the format is: `projects/`project`/
|
2958
|
+
# locations/`location``.
|
2869
2959
|
# @param [Fixnum] ets
|
2870
2960
|
# The event timestamp in milliseconds. This prevents browser caching of
|
2871
2961
|
# otherwise identical get requests. The name is abbreviated to reduce the
|
@@ -3742,6 +3832,47 @@ module Google
|
|
3742
3832
|
execute_or_queue_command(command, &block)
|
3743
3833
|
end
|
3744
3834
|
|
3835
|
+
# Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
|
3836
|
+
# not exist.
|
3837
|
+
# @param [String] name
|
3838
|
+
# Immutable. Fully qualified name `projects/`project`/locations/`location`/
|
3839
|
+
# collections/`collection_id`/engines/`engine_id`/servingConfigs/`
|
3840
|
+
# serving_config_id``
|
3841
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig] google_cloud_discoveryengine_v1_serving_config_object
|
3842
|
+
# @param [String] update_mask
|
3843
|
+
# Indicates which fields in the provided ServingConfig to update. The following
|
3844
|
+
# are NOT supported: * ServingConfig.name If not set, all supported fields are
|
3845
|
+
# updated.
|
3846
|
+
# @param [String] fields
|
3847
|
+
# Selector specifying which fields to include in a partial response.
|
3848
|
+
# @param [String] quota_user
|
3849
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3850
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3851
|
+
# @param [Google::Apis::RequestOptions] options
|
3852
|
+
# Request-specific options
|
3853
|
+
#
|
3854
|
+
# @yield [result, err] Result & error if block supplied
|
3855
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig] parsed result object
|
3856
|
+
# @yieldparam err [StandardError] error object if request failed
|
3857
|
+
#
|
3858
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig]
|
3859
|
+
#
|
3860
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3861
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3862
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3863
|
+
def patch_project_location_collection_engine_serving_config(name, google_cloud_discoveryengine_v1_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3864
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
3865
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig::Representation
|
3866
|
+
command.request_object = google_cloud_discoveryengine_v1_serving_config_object
|
3867
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig::Representation
|
3868
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig
|
3869
|
+
command.params['name'] = name unless name.nil?
|
3870
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
3871
|
+
command.query['fields'] = fields unless fields.nil?
|
3872
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3873
|
+
execute_or_queue_command(command, &block)
|
3874
|
+
end
|
3875
|
+
|
3745
3876
|
# Makes a recommendation, which requires a contextual user event.
|
3746
3877
|
# @param [String] serving_config
|
3747
3878
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
@@ -3865,6 +3996,45 @@ module Google
|
|
3865
3996
|
execute_or_queue_command(command, &block)
|
3866
3997
|
end
|
3867
3998
|
|
3999
|
+
# Answer query method (streaming). It takes one AnswerQueryRequest and returns
|
4000
|
+
# multiple AnswerQueryResponse messages in a stream.
|
4001
|
+
# @param [String] serving_config
|
4002
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
4003
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
4004
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
4005
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
4006
|
+
# field is used to identify the serving configuration name, set of models used
|
4007
|
+
# to make the search.
|
4008
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest] google_cloud_discoveryengine_v1_answer_query_request_object
|
4009
|
+
# @param [String] fields
|
4010
|
+
# Selector specifying which fields to include in a partial response.
|
4011
|
+
# @param [String] quota_user
|
4012
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4013
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4014
|
+
# @param [Google::Apis::RequestOptions] options
|
4015
|
+
# Request-specific options
|
4016
|
+
#
|
4017
|
+
# @yield [result, err] Result & error if block supplied
|
4018
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse] parsed result object
|
4019
|
+
# @yieldparam err [StandardError] error object if request failed
|
4020
|
+
#
|
4021
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse]
|
4022
|
+
#
|
4023
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4024
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4025
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4026
|
+
def stream_project_location_collection_engine_serving_config_answer(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4027
|
+
command = make_simple_command(:post, 'v1/{+servingConfig}:streamAnswer', options)
|
4028
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
|
4029
|
+
command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
|
4030
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
|
4031
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
|
4032
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
4033
|
+
command.query['fields'] = fields unless fields.nil?
|
4034
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4035
|
+
execute_or_queue_command(command, &block)
|
4036
|
+
end
|
4037
|
+
|
3868
4038
|
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
3869
4039
|
# error is returned.
|
3870
4040
|
# @param [String] parent
|
@@ -3938,6 +4108,9 @@ module Google
|
|
3938
4108
|
# Required. The resource name of the Session to get. Format: `projects/`project`/
|
3939
4109
|
# locations/`location`/collections/`collection`/dataStores/`data_store_id`/
|
3940
4110
|
# sessions/`session_id``
|
4111
|
+
# @param [Boolean] include_answer_details
|
4112
|
+
# Optional. If set to true, the full session including all answer details will
|
4113
|
+
# be returned.
|
3941
4114
|
# @param [String] fields
|
3942
4115
|
# Selector specifying which fields to include in a partial response.
|
3943
4116
|
# @param [String] quota_user
|
@@ -3955,11 +4128,12 @@ module Google
|
|
3955
4128
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3956
4129
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3957
4130
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3958
|
-
def get_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
4131
|
+
def get_project_location_collection_engine_session(name, include_answer_details: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3959
4132
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
3960
4133
|
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
3961
4134
|
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
3962
4135
|
command.params['name'] = name unless name.nil?
|
4136
|
+
command.query['includeAnswerDetails'] = include_answer_details unless include_answer_details.nil?
|
3963
4137
|
command.query['fields'] = fields unless fields.nil?
|
3964
4138
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3965
4139
|
execute_or_queue_command(command, &block)
|
@@ -3975,7 +4149,9 @@ module Google
|
|
3975
4149
|
# @param [String] order_by
|
3976
4150
|
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
3977
4151
|
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
3978
|
-
# create_time` * `session_name` Example: "update_time desc" "
|
4152
|
+
# create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
|
4153
|
+
# create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
|
4154
|
+
# first, then by update_time.
|
3979
4155
|
# @param [Fixnum] page_size
|
3980
4156
|
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
3981
4157
|
# allowed value is 1000.
|
@@ -5760,6 +5936,47 @@ module Google
|
|
5760
5936
|
execute_or_queue_command(command, &block)
|
5761
5937
|
end
|
5762
5938
|
|
5939
|
+
# Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does
|
5940
|
+
# not exist.
|
5941
|
+
# @param [String] name
|
5942
|
+
# Immutable. Fully qualified name `projects/`project`/locations/`location`/
|
5943
|
+
# collections/`collection_id`/engines/`engine_id`/servingConfigs/`
|
5944
|
+
# serving_config_id``
|
5945
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig] google_cloud_discoveryengine_v1_serving_config_object
|
5946
|
+
# @param [String] update_mask
|
5947
|
+
# Indicates which fields in the provided ServingConfig to update. The following
|
5948
|
+
# are NOT supported: * ServingConfig.name If not set, all supported fields are
|
5949
|
+
# updated.
|
5950
|
+
# @param [String] fields
|
5951
|
+
# Selector specifying which fields to include in a partial response.
|
5952
|
+
# @param [String] quota_user
|
5953
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5954
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5955
|
+
# @param [Google::Apis::RequestOptions] options
|
5956
|
+
# Request-specific options
|
5957
|
+
#
|
5958
|
+
# @yield [result, err] Result & error if block supplied
|
5959
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig] parsed result object
|
5960
|
+
# @yieldparam err [StandardError] error object if request failed
|
5961
|
+
#
|
5962
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig]
|
5963
|
+
#
|
5964
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5965
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5966
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5967
|
+
def patch_project_location_data_store_serving_config(name, google_cloud_discoveryengine_v1_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
5968
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
5969
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig::Representation
|
5970
|
+
command.request_object = google_cloud_discoveryengine_v1_serving_config_object
|
5971
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig::Representation
|
5972
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig
|
5973
|
+
command.params['name'] = name unless name.nil?
|
5974
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
5975
|
+
command.query['fields'] = fields unless fields.nil?
|
5976
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5977
|
+
execute_or_queue_command(command, &block)
|
5978
|
+
end
|
5979
|
+
|
5763
5980
|
# Makes a recommendation, which requires a contextual user event.
|
5764
5981
|
# @param [String] serving_config
|
5765
5982
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
@@ -5883,6 +6100,45 @@ module Google
|
|
5883
6100
|
execute_or_queue_command(command, &block)
|
5884
6101
|
end
|
5885
6102
|
|
6103
|
+
# Answer query method (streaming). It takes one AnswerQueryRequest and returns
|
6104
|
+
# multiple AnswerQueryResponse messages in a stream.
|
6105
|
+
# @param [String] serving_config
|
6106
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
6107
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
6108
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
6109
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
6110
|
+
# field is used to identify the serving configuration name, set of models used
|
6111
|
+
# to make the search.
|
6112
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest] google_cloud_discoveryengine_v1_answer_query_request_object
|
6113
|
+
# @param [String] fields
|
6114
|
+
# Selector specifying which fields to include in a partial response.
|
6115
|
+
# @param [String] quota_user
|
6116
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6117
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6118
|
+
# @param [Google::Apis::RequestOptions] options
|
6119
|
+
# Request-specific options
|
6120
|
+
#
|
6121
|
+
# @yield [result, err] Result & error if block supplied
|
6122
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse] parsed result object
|
6123
|
+
# @yieldparam err [StandardError] error object if request failed
|
6124
|
+
#
|
6125
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse]
|
6126
|
+
#
|
6127
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6128
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6129
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6130
|
+
def stream_project_location_data_store_serving_config_answer(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
6131
|
+
command = make_simple_command(:post, 'v1/{+servingConfig}:streamAnswer', options)
|
6132
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
|
6133
|
+
command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
|
6134
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
|
6135
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
|
6136
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
6137
|
+
command.query['fields'] = fields unless fields.nil?
|
6138
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6139
|
+
execute_or_queue_command(command, &block)
|
6140
|
+
end
|
6141
|
+
|
5886
6142
|
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
5887
6143
|
# error is returned.
|
5888
6144
|
# @param [String] parent
|
@@ -5956,6 +6212,9 @@ module Google
|
|
5956
6212
|
# Required. The resource name of the Session to get. Format: `projects/`project`/
|
5957
6213
|
# locations/`location`/collections/`collection`/dataStores/`data_store_id`/
|
5958
6214
|
# sessions/`session_id``
|
6215
|
+
# @param [Boolean] include_answer_details
|
6216
|
+
# Optional. If set to true, the full session including all answer details will
|
6217
|
+
# be returned.
|
5959
6218
|
# @param [String] fields
|
5960
6219
|
# Selector specifying which fields to include in a partial response.
|
5961
6220
|
# @param [String] quota_user
|
@@ -5973,11 +6232,12 @@ module Google
|
|
5973
6232
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5974
6233
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5975
6234
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5976
|
-
def get_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
6235
|
+
def get_project_location_data_store_session(name, include_answer_details: nil, fields: nil, quota_user: nil, options: nil, &block)
|
5977
6236
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
5978
6237
|
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
5979
6238
|
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
5980
6239
|
command.params['name'] = name unless name.nil?
|
6240
|
+
command.query['includeAnswerDetails'] = include_answer_details unless include_answer_details.nil?
|
5981
6241
|
command.query['fields'] = fields unless fields.nil?
|
5982
6242
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5983
6243
|
execute_or_queue_command(command, &block)
|
@@ -5993,7 +6253,9 @@ module Google
|
|
5993
6253
|
# @param [String] order_by
|
5994
6254
|
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
5995
6255
|
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
5996
|
-
# create_time` * `session_name` Example: "update_time desc" "
|
6256
|
+
# create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
|
6257
|
+
# create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
|
6258
|
+
# first, then by update_time.
|
5997
6259
|
# @param [Fixnum] page_size
|
5998
6260
|
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
5999
6261
|
# allowed value is 1000.
|
@@ -6500,8 +6762,12 @@ module Google
|
|
6500
6762
|
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
6501
6763
|
# Users should not call this method directly.
|
6502
6764
|
# @param [String] parent
|
6503
|
-
# Required. The parent
|
6504
|
-
#
|
6765
|
+
# Required. The parent resource name. If the collect user event action is
|
6766
|
+
# applied in DataStore level, the format is: `projects/`project`/locations/`
|
6767
|
+
# location`/collections/`collection`/dataStores/`data_store``. If the collect
|
6768
|
+
# user event action is applied in Location level, for example, the event with
|
6769
|
+
# Document across multiple DataStore, the format is: `projects/`project`/
|
6770
|
+
# locations/`location``.
|
6505
6771
|
# @param [Fixnum] ets
|
6506
6772
|
# The event timestamp in milliseconds. This prevents browser caching of
|
6507
6773
|
# otherwise identical get requests. The name is abbreviated to reduce the
|
@@ -6876,8 +7142,12 @@ module Google
|
|
6876
7142
|
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
6877
7143
|
# Users should not call this method directly.
|
6878
7144
|
# @param [String] parent
|
6879
|
-
# Required. The parent
|
6880
|
-
#
|
7145
|
+
# Required. The parent resource name. If the collect user event action is
|
7146
|
+
# applied in DataStore level, the format is: `projects/`project`/locations/`
|
7147
|
+
# location`/collections/`collection`/dataStores/`data_store``. If the collect
|
7148
|
+
# user event action is applied in Location level, for example, the event with
|
7149
|
+
# Document across multiple DataStore, the format is: `projects/`project`/
|
7150
|
+
# locations/`location``.
|
6881
7151
|
# @param [Fixnum] ets
|
6882
7152
|
# The event timestamp in milliseconds. This prevents browser caching of
|
6883
7153
|
# otherwise identical get requests. The name is abbreviated to reduce the
|
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.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: 2024-12-
|
11
|
+
date: 2024-12-08 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.24.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: []
|
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
75
|
- !ruby/object:Gem::Version
|
76
76
|
version: '0'
|
77
77
|
requirements: []
|
78
|
-
rubygems_version: 3.5.
|
78
|
+
rubygems_version: 3.5.23
|
79
79
|
signing_key:
|
80
80
|
specification_version: 4
|
81
81
|
summary: Simple REST client for Discovery Engine API V1
|